Template:ElementDocu: Difference between revisions
Jump to navigation
Jump to search
| [unchecked revision] | [unchecked revision] |
Dirk Bräuer (talk | contribs) (Änderung 4113 von Dirk Bräuer (Diskussion) rückgängig gemacht.) |
No edit summary |
||
| Line 1: | Line 1: | ||
<includeonly> | |||
== Scheme description / {{Deu|Schemenbeschreibung}} / {{Fra|Description du schéma}} == | == Scheme description / {{Deu|Schemenbeschreibung}} / {{Fra|Description du schéma}} == | ||
=== Position of {{{elementName|FIXME}}} in the XML-Tree / {{Deu|Position von {{{elementName|FIXME}}} im XML-Baum}} / {{Fra|position de {{{elementName|FIXME}}} dans l’aborescence XML}} === | === Position of {{{elementName|FIXME}}} in the XML-Tree / {{Deu|Position von {{{elementName|FIXME}}} im XML-Baum}} / {{Fra|position de {{{elementName|FIXME}}} dans l’aborescence XML}} === | ||
| Line 40: | Line 41: | ||
{{{openissues|''Not yet described. / {{Deu|Noch nicht beschrieben.}} / {{Fra|Pas encore décrit.}}''}}} | {{{openissues|''Not yet described. / {{Deu|Noch nicht beschrieben.}} / {{Fra|Pas encore décrit.}}''}}} | ||
[[Category:{{ | [[Category:{{ | ||
#switch: {{#explode:{{FULLPAGENAME}}|:}} | #switch: {{#explode:{{FULLPAGENAME}}|:}} | ||
| Line 50: | Line 50: | ||
|FIXME | |FIXME | ||
}}|{{#explode:{{FULLPAGENAME}}|:|-1}}]] | }}|{{#explode:{{FULLPAGENAME}}|:|-1}}]] | ||
</includeonly> | </includeonly><noinclude> | ||
<noinclude>[[Category:ContentTemplate]]</noinclude> | ==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: {{{childs|''Not yet described. / {{Deu|Noch nicht beschrieben.}} / {{Fra|Pas encore décrit.}}''}}} | |||
*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 | |||
==Example== | |||
[[Category:ContentTemplate]]</noinclude> | |||
Revision as of 20:05, 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