Template:ElementDocu: Difference between revisions
Jump to navigation
Jump to search
| [checked revision] | [checked revision] |
(syntax) |
No edit summary |
||
| Line 1: | Line 1: | ||
<includeonly> | <includeonly> | ||
{{#if:{{{intro|}}}|{{note|{{intro|{{{intro}}}}}<br>This element was introduced with '''version {{{intro}}}'''|reminder}}}} | |||
{{#if:{{{depr|}}}|{{note|{{depr|{{{depr}}}}}<br>This element was deprecated with '''version {{{depr}}}'''|reminder}}}} | |||
== 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 83: | Line 85: | ||
**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. | **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 | **bestpractice — use ''example'', as the paragraphs ''Best Practice'' and ''Examples'' have been merged | ||
**intro – You can optionally enter the version when the element was introduced. It will produce a reminder at the top of the article | |||
**depr – You can optionally enter the version when the element was deprecated. It will produce a reminder at the top of the article | |||
===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 13:04, 31 August 2018
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
- intro – You can optionally enter the version when the element was introduced. It will produce a reminder at the top of the article
- depr – You can optionally enter the version when the element was deprecated. It will produce a reminder at the top of the article
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. Attributes of FIXME / Attribute von FIXME /Not yet described. / Noch nicht beschrieben. / Constraints / Beschränkungen /Not yet described. / Noch nicht beschrieben. / Best practice & Examples / Empfohlene Anwendung & Beispiele /Not yet described. / Noch nicht beschrieben. / Notes / Anmerkungen /Not yet described. / Noch nicht beschrieben. / 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.