Documentation Editor/en: Unterschied zwischen den Versionen
Cg (Diskussion | Beiträge) |
Cg (Diskussion | Beiträge) |
||
| Zeile 16: | Zeile 16: | ||
Folders also do not have separate function- and version IDs. However, they may have tags. |
Folders also do not have separate function- and version IDs. However, they may have tags. |
||
These folder tags are useful for grouping and coloring (see also below). |
These folder tags are useful for grouping and coloring (see also below). |
||
If no documentation has been given explicitly for a folder, |
|||
a summary consisting of all of the folder's child element documentation texts is shown. |
|||
==== Item Documentation Editor ==== |
==== Item Documentation Editor ==== |
||
Version vom 1. April 2014, 19:53 Uhr
Both the documentation of a tree element and documentation elements themselves are created & modified in the documentation editor. The editor is found in the documentation tab of every tree element.
The editor provides the usual editing commands on its right-button menu. More special functions are found in the "Tools" and "More" sub-menus. (detailed info about the editor's features is also found in the ST/X manual)
Documentation Element Editor[Bearbeiten]
Pure documentation tree elements do not have separate function- and version IDs and no tags can be associated with them. Therefore, those fields are not shown in the editor.
Folder Element Editor[Bearbeiten]
Folders also do not have separate function- and version IDs. However, they may have tags. These folder tags are useful for grouping and coloring (see also below).
If no documentation has been given explicitly for a folder, a summary consisting of all of the folder's child element documentation texts is shown.
Item Documentation Editor[Bearbeiten]
For any non-documentation element (i.e. especially action block definitions), the item's Functional-ID and Version-ID of the element are shown (read only) and an input field allows for a set of tags to be given to the element. Multiple tags are to be separated by ";". Tags are useful to help grouping actions by their operation and as an aid when searching items (in the tree view). It is also possible to associate individual per-tag drawing colors to blocks via the "Settings" dialog.
