Template:ElementDocu: Difference between revisions
[checked revision] | [checked revision] |
(→Usage: New structure (Merger of BP&Examples and Attributes) |
|||
Line 68: | Line 68: | ||
*Notes | *Notes | ||
*Open issues | *Open issues | ||
=== | ===Arguments=== | ||
*Obligatory: | *Obligatory: | ||
**elementName — the name of the element | **elementName — the name of the element | ||
Line 75: | Line 75: | ||
**parent — the name of the parent node within the XML tree | **parent — the name of the parent node within the XML tree | ||
**childs — the children nodes | **childs — the children nodes | ||
**ownAttributes — specific, not inherited attributes of this element | **ownAttributes — specific, not inherited attributes of this element | ||
**constraints | **constraints | ||
**notes — general notes | **notes — general notes | ||
**example | **example | ||
**openissues — comments on open issues | **openissues — comments on open issues | ||
*Arguments to be discontinued — '''Do not use them anymore''' | |||
**inheritedAttributes — inherited attributes from other data types — use ''ownAttributes'', as the distinction between own and inherited attributes will no longer be presented in this wiki. | |||
**bestpractice — use ''example'', as the paragraphs ''Best Practice'' and ''Examples'' have been merged | |||
===Dependencies=== | ===Dependencies=== | ||
The template depends on [[Template:Deu]] and [[Template:Fra]]. There is abig number of templates building on Template:ElementDocu. | The template depends on [[Template:Deu]] and [[Template:Fra]]. There is abig number of templates building on Template:ElementDocu. |
Revision as of 14:25, 18 April 2017
Usage
This template is the working horse of element documentation. It provides a standardized framework on which a number of ohter templates build upon.
Aricles employing the template have the following structure:
- Scheme description
- Position in the XML-Tree
- Parent
- Children: Not yet described. / Noch nicht beschrieben. /
- Semantics
- Attributes
- Constraints
- Best practice & Examples
- Notes
- Open issues
Arguments
- Obligatory:
- elementName — the name of the element
- semantics — a human readable explanation of the function of the described element
- Optional:
- parent — the name of the parent node within the XML tree
- childs — the children nodes
- ownAttributes — specific, not inherited attributes of this element
- constraints
- notes — general notes
- example
- openissues — comments on open issues
- Arguments to be discontinued — Do not use them anymore
- inheritedAttributes — inherited attributes from other data types — use ownAttributes, as the distinction between own and inherited attributes will no longer be presented in this wiki.
- bestpractice — use example, as the paragraphs Best Practice and Examples have been merged
Dependencies
The template depends on Template:Deu and Template:Fra. There is abig number of templates building on Template:ElementDocu.
Example
{{Template:ElementDocu|ElementName=SomeSampleElement|semantics=''This is an example. For readability reasons it is boxed.''}}
delivers
Scheme description / Schemenbeschreibung /Position of FIXME in the XML-Tree / Position von FIXME im XML-Baum /
Semantics / Bedeutung /This is an example. For readability reasons it is boxed. Inherited attributes from other data types / Abgeleitete Attribute von anderen Datentypen /Not yet described. / Noch nicht beschrieben. / Specific Attributes of FIXME / Spezielle Attribute von FIXME /Not yet described. / Noch nicht beschrieben. / Constraints / Beschränkungen /Not yet described. / Noch nicht beschrieben. / Best practice / Empfohlene Anwendung /Not yet described. / Noch nicht beschrieben. / Additional information / Zusätzliche Informationen /Notes / Anmerkungen /Not yet described. / Noch nicht beschrieben. / Example / Beispiel /Not yet described. / Noch nicht beschrieben. / Open issues / Offene Punkte/Pedenzen /Not yet described. / Noch nicht beschrieben. / |
An example of the application of this template afield is IS:signal.