Difference between revisions of "Indexing"
From SAP Enable Now Wiki
(Created page with "__NOTOC__ ==Where to find it== * ['''Resources''' > ] '''Documentation Settings''' > ''{Document Type}'' > ''Numbering'' category > '''{{PAGENAME}}''' setting ==Purpose== Thi...") |
|||
| (2 intermediate revisions by the same user not shown) | |||
| Line 6: | Line 6: | ||
This setting defines the way in which 'action' steps for simulations will be numbered in the generated document. The following options are available: | This setting defines the way in which 'action' steps for simulations will be numbered in the generated document. The following options are available: | ||
* '''Step - highlights only''': Numbering will (re)start at '''1''' for each Step, and only the 'actions' will be numbered. | * '''Step - highlights only''': Numbering will (re)start at '''1''' for each Step, and only the 'actions' will be numbered. | ||
| − | * '''Step - all objects''': Numbering will (re)start at '''1''' for each Step, and all | + | * '''Step - all objects''': Numbering will (re)start at '''1''' for each Step, and all applicable objects (see below) will be numbered. |
* '''Global - highlights only''': Numbering will start at '''1''' for the document, and all 'actions' will be numbered sequentially as as single list. | * '''Global - highlights only''': Numbering will start at '''1''' for the document, and all 'actions' will be numbered sequentially as as single list. | ||
| − | * '''Global - all objects''': Numbering will start at '''1''' for the document, and all 'actions' | + | * '''Global - all objects''': Numbering will start at '''1''' for the document, and all applicable objects (see below) will be numbered sequentially as as single list. |
| − | * ''' | + | * '''None''': All applicable objects (see below) will be formatted as standard paragraphs, and not as numbered lists. Note that markers will also not be displayed on the screenshots. |
| + | |||
| + | '''Applicable objects:''' | ||
| + | * All 'actions' | ||
| + | * Explanations that have a defined Highlight and an '''[[Icon (Explanation macro property)|Icon]]''' of '''None''' | ||
| + | * Document '''[[Highlight (Documentation macro)|Highlight]]s''' that include a text | ||
| + | Documentation '''[[Arrow (Documentation macro)|Arrow]]s''' and '''[[Note (Documentation macro)|Note]]s''' are not included as applicable objects | ||
==See Also== | ==See Also== | ||
Latest revision as of 20:51, 2 April 2021
Where to find it
- [Resources > ] Documentation Settings > {Document Type} > Numbering category > Indexing setting
Purpose
This setting defines the way in which 'action' steps for simulations will be numbered in the generated document. The following options are available:
- Step - highlights only: Numbering will (re)start at 1 for each Step, and only the 'actions' will be numbered.
- Step - all objects: Numbering will (re)start at 1 for each Step, and all applicable objects (see below) will be numbered.
- Global - highlights only: Numbering will start at 1 for the document, and all 'actions' will be numbered sequentially as as single list.
- Global - all objects: Numbering will start at 1 for the document, and all applicable objects (see below) will be numbered sequentially as as single list.
- None: All applicable objects (see below) will be formatted as standard paragraphs, and not as numbered lists. Note that markers will also not be displayed on the screenshots.
Applicable objects:
- All 'actions'
- Explanations that have a defined Highlight and an Icon of None
- Document Highlights that include a text
Documentation Arrows and Notes are not included as applicable objects
See Also
- Style (Documentation Settings Numbering setting)
