...
Notes for the documentation template: Each section contains a description about its purpose, if it is mandatory or optional and an example that begins or contains the words "Lorem ipsum".
Description
Mandatory Required section. The description should follow the title directly without a heading. Use this section to provide a general, high-level overview about the step or job entry. For example:
...
This section may include the following subsections:
Context
Mandatory Required section. Use this section to describe the context surrounding when this step or job entry is used. It is also possible to link to another page which has workflows and tasks.
...
Optional section. Use when configuration tasks need to be performed.
Options
Mandatory Required section. This section describes the Options and Description for each property of the step or job entry using a table. When multiple tabs are included in a dialog box, use subsections titled by tab such as "Sample 1 Tab" and "Sample 2 Tab". Optionally, you can preface the table with information, if needed.
...
Option | Description |
|---|---|
Lorem ipsum option1 | Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam. |
Lorem ipsum option2 | Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy eirmod tempor invidunt ut labore et dolore magna aliquyam |
Example
Mandatory Required section. Describe at least one example, link to another page, or reference a sample within the PDI distribution.
...