Paramètres d'Up ! Document Generator

Up ! Document Generator est l'outil permettant de corriger et de vérifier l'intégrité de la documentation en vue de la publier sur Internet :

Harmonisation du style des pages Html.
Indexation des pages en fonction du contenu.
Vérification des liens entre les pages Html.
Génération du fichier robots.txt.

Quel que soit son mode d'invocation, Up ! Document Generator possède les mêmes paramètres cités dans la section suivante. La commande est, selon les plates-formes, upsdgn, upsdgn.exe ou upsdgn.com.

Certains paramètres font référence à des fichiers ou à des chemins d'accès. En ce cas, il est possible d'employer des variables environnement dans l'expression des chemins d'accès. Exemple :

Tmp=${UPS_HOME}/demo/tmp/${UPS_USER}

D'autre part, le séparateur de répertoire est le caractère division / et les noms de fichiers ou de répertoires peuvent utiliser les partitions montées automatiquement par Up ! System.

Les paramètres sont lus successivement dans :

Les variables environnement.
Le fichier d'initialisation.
${UPS_HOME}/ini/${UPS_LANGUAGE}/upsdgn.ini en mode mono-utilisateur ou ${UPS_HOME}/ini/${UPS_USER}/upsdgn.ini en mode multi-utilisateur.
La section est UpsDgn.
Le fichier de paramètres.
S'il existe.
La ligne de commande.
Il s'agit soit de :
- La ligne de commande stricto sensu.
- La valeur de la variable environnement QUERY_STRING.
  En ce cas, le programme s'exécute automatiquement et obligatoirement en mode batch en respectant la norme Common Gateway Interface (CGI).
Les paramètres peuvent être préfixés par UpsDgn.

Les valeurs des paramètres comportant des caractères espace doivent être mises entre caractères guillemet " ou entre caractères apostrophe ' .

Up ! Document Generator nécessite que la variable environnement UPS_DOCUMENT soit renseignée avec la valeur de la racine de la documentation.

Pour connaître le source d'Up ! Document Generator, merci de se référer à la fiche Source d'Up ! Document Generator.

Paramètres d'exécution

Up ! Document Generator étant un programme Up ! Application System particulier, les paramètres de lancement de Up ! Virtual Technical Machine et celles d'exécution de Up ! Kernel s'appliquent. En revanche, la configuration de Up ! Object Management System est imposée. Elle correspond au fichier ${UPS_HOME}/ini/upssdk.ini.

Action

Action permet de spécifier l'action que l'automate de documentation doit exécuter. Il n'y a pas de valeur par défaut et cette option est obligatoire.

Voici la liste des valeurs possibles :

Action	Valeur de l'option
Indexer les pages Html et apporte des corrections de présentation.	`Indexer`
Générer le fichier robots.txt.	`Robot`
Vérifier les liens des pages Html.	`Verifier`

Pour l'action Indexer, une copie servant de référentiel de la documentation doit être préalablement disponible dans ${UPS_DOCUMENT}.ref. Le résultat est alors dans ${UPS_DOCUMENT}.ref.

Pour l'action Robot, le fichier généré est rangé dans ${UPS_DOCUMENT}/robots.txt.

Pour l'action Verifier, tous les liens internes sont véifiés pour toutes les pages depuis ${UPS_DOCUMENT}.ref.

Action=Indexer

Exemple de configuration d'Up ! Document Generator


; ------------------------------------------------------------------- 

; Fichier    : upsdgn.ini                                             

; Objet      : Initialisation d'Up ! Document Generator.        
   
;                                                                     

; Module      : Up ! Application System.                              

; Auteur-Date : DUVAL Jean-Pierre - Novembre 2003.                    

; ------------------------------------------------------------------- 

;                          Observations

;                                                                      

;                                                                      

; ------------------------------------------------------------------- 



[UpsDgn]

Action=Indexer