Up ! Document Generator

Options d'exécution...

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 :

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

D'autre part, les séparateurs de répertoire peuvent être indifféremment division / ou division inversée \.

Les options sont lues successivement dans :

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

Up ! Document Generator étant un programme Up ! Application System particulier, les options 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/upssft.ini. 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 :

ActionValeur 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.

Revenir en haut de la page...