Générer la documentation HTML - 7.0

Guide utilisateur de Talend Open Studio for ESB

author
Talend Documentation Team
EnrichVersion
7.0
EnrichProdName
Talend Open Studio for ESB
task
Création et développement
EnrichPlatform
Studio Talend

Le Studio Talend vous permet de générer de la documentation détaillée au format HTML des Jobs ou des Routes sélectionné(e)s dans le Repository de votre Studio, dans la perspective Integration . Cette auto-documentation comprend :

  • les propriétés du projet dans lequel les Jobs ou les Routes ont été créés,

  • les propriétés et les paramètres des Jobs ou des Routes sélectionnés ainsi qu'une image de chaque Job ou Route,

  • la liste de tous les composants utilisés dans chaque Job ou Route sélectionné(e), ainsi que les paramètres de ces composants.

Pour générer un document HTML pour un Job ou une Route, procédez comme suit :

Procédure

  1. Dans le Repository, cliquez-droit sur l'un de vos Jobs ou Route ou sélectionnez plusieurs éléments pour générer une documentation multiple.
  2. Sélectionnez Generate Doc as HTML dans le menu contextuel.
  3. Renseignez le répertoire dans lequel doit être enregistré la documentation générée.
  4. Dans le même champ, renseignez le nom de l'archive regroupant les documents générés.
  5. Si vous souhaitez utiliser un fichier CSS, cochez la case Use CSS file as a template to export afin d'activer le champ CSS File.
  6. Dans le champ CSS File, parcourez votre répertoire, ou saisissez le chemin d'accès au fichier CSS à utiliser.
  7. Cliquez sur Finish pour valider.

Résultats

Le fichier archive contient les fichiers HTML ainsi que les dossiers correspondants. Le fichier archive contient les fichiers HTML ainsi que les dossiers correspondants. Ouvrez le fichier HTML dans votre navigateur Web.