Template:ElementDocu: Difference between revisions
Jump to navigation
Jump to search
| [unchecked revision] | [unchecked revision] |
No edit summary |
|||
| Line 82: | Line 82: | ||
**example | **example | ||
**openissues — comments on open issues | **openissues — comments on open issues | ||
===Dependencies=== | |||
The template depends on [[Template:Deu]] and [[Template:Fra]]. There is abig number of templates building on Template:ElementDocu, eg: [[Template:InheritContractor]] | |||
==Example== | ==Example== | ||
[[Category:ContentTemplate]]</noinclude> | [[Category:ContentTemplate]]</noinclude> | ||
Revision as of 20:09, 11 February 2016
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
- Inherited attributes from other data types
- Specific Attributes
- Constraints
- Best practice
- Additional information
- Notes
- Example
- Open issues
Parameters
- 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
- inheritedAttributes — inherited attributes from other data types
- ownAttributes — specific, not inherited attributes of this element
- constraints
- bestpractice — comments about best practice
- notes — general notes
- example
- openissues — comments on open issues
Dependencies
The template depends on Template:Deu and Template:Fra. There is abig number of templates building on Template:ElementDocu, eg: Template:InheritContractor