Generating HTML documentation - Cloud - 8.0

Talend Studio User Guide

Version
Cloud
8.0
Language
English
Product
Talend Big Data
Talend Big Data Platform
Talend Cloud
Talend Data Fabric
Talend Data Integration
Talend Data Management Platform
Talend Data Services Platform
Talend ESB
Talend MDM Platform
Talend Real-Time Big Data Platform
Module
Talend Studio
Content
Design and Development
Last publication date
2024-04-15

Talend Studio allows you to generate detailed documentation in HTML of the Jobs or Routes you select in the Repository tree view of Talend Studio in the Integration perspective. This auto-documentation offers the following:

  • The properties of the project where the selected Jobs or Routes have been created,

  • The properties and settings of the selected Jobs or Routes along with preview pictures of each of the Jobs or Routes,

  • The list of all the components used in each of the selected Jobs or Routes and component parameters.

  • If you have installed the 8.0 R2022-06 Talend Studio monthly update or a later one provided by Talend, and if your Job or Route has any Joblets, Routelets, or child Jobs, when generating documentation for the Job or Route, the documentation for its Joblets, Routelets, or child Jobs is also generated. You can navigate to the documentation for the Joblet, Routelet, or child Job via its corresponding link in the documentation for the Job or Route.

To generate an HTML document for a Job or a Route, complete the following:

Procedure

  1. In the Repository tree view, right-click a Job or Route entry or select several items to produce multiple documentations.
  2. Select Generate Doc as HTML on the contextual menu.
    Generate Documentation dialog box.
  3. Browse to the location where the generated documentation archive should be stored.
  4. In the same field, type in a name for the archive gathering all generated documents.
  5. Select the Use CSS file as a template to export check box to activate the CSS File field if you need to use a CSS file.
  6. In the CSS File field, browse to, or enter the path to the CSS file to be used.
  7. Click Finish to validate the generation operation.

Results

The archive file is generated in the defined path. It contains all required files along with the HTML output file. You can open the HTML file in your favorite browser.