Template:ElementDocu: Difference between revisions
Jump to navigation
Jump to search
| [checked revision] | [checked revision] |
(Example changed) |
|||
| Line 104: | Line 104: | ||
''This is an example. For readability reasons it is boxed.'' | ''This is an example. For readability reasons it is boxed.'' | ||
=== | ===Attributes of FIXME / {{Deu|Attribute von FIXME}} / {{Fra|Attributs de FIXME}} === | ||
{{#if:{{Boolandnoteq||{{{inheritedAttributes}}}|''None''}} | |||
|{{#if:{{Boolandnoteq||{{{ownAttributes}}}|''None''}} | |||
|<!--beide if treffen zu-->{{{inheritedAttributes}}} | |||
{{{ownAttributes}}} | |||
|<!--nur inherited besteht-->{{{inheritedAttributes}}}<!--zweites if zu-->}} | |||
''Not yet described. / {{Deu|Noch nicht beschrieben.}} / {{Fra|Pas encore décrit.}}'' | |<!--inherited nicht-->{{#if:{{Boolandnoteq||{{{ownAttributes}}}|''None''}} | ||
|<!--nur own-->{{{ownAttributes}}} | |||
|<!--keines-->{{#if:|''None''|''Not yet described. / {{Deu|Noch nicht beschrieben.}} / {{Fra|Pas encore décrit.}}''}}<!--viertes if zu-->}}<!--drittes if zu--> | |||
}}<!--erstes if zu--> | |||
=== Constraints / {{Deu|Beschränkungen}} / {{Fra|Contraintes}} === | === Constraints / {{Deu|Beschränkungen}} / {{Fra|Contraintes}} === | ||
''Not yet described. / {{Deu|Noch nicht beschrieben.}} / {{Fra|Pas encore décrit.}}'' | ''Not yet described. / {{Deu|Noch nicht beschrieben.}} / {{Fra|Pas encore décrit.}}'' | ||
== Best practice / {{Deu|Empfohlene Anwendung}} / {{Fra|Bonnes pratiques}} == | == Best practice & Examples / {{Deu|Empfohlene Anwendung & Beispiele}} / {{Fra|Bonnes pratiques & exemples}} == | ||
{{#if:|{{{bestpractice}}}|{{#if:|{{{example}}}|''Not yet described. / {{Deu|Noch nicht beschrieben.}} / {{Fra|Pas encore décrit.}}''}}}} | |||
<!--{{{bestpractice|''Not yet described. / {{Deu|Noch nicht beschrieben.}} / {{Fra|Pas encore décrit.}}''}}}--> | |||
<!-- | |||
== Additional information / {{Deu|Zusätzliche Informationen}} / {{Fra|Information supplémentaire}} == | == Additional information / {{Deu|Zusätzliche Informationen}} / {{Fra|Information supplémentaire}} == | ||
--> | |||
== Notes / {{Deu|Anmerkungen}} / {{Fra|Notes}} == | |||
''Not yet described. / {{Deu|Noch nicht beschrieben.}} / {{Fra|Pas encore décrit.}}'' | ''Not yet described. / {{Deu|Noch nicht beschrieben.}} / {{Fra|Pas encore décrit.}}'' | ||
<!-- | |||
=== Example / {{Deu|Beispiel}} / {{Fra|Exemple}} === | === Example / {{Deu|Beispiel}} / {{Fra|Exemple}} === | ||
--> | |||
''Not yet described. / {{Deu|Noch nicht beschrieben.}} / {{Fra|Pas encore décrit.}}'' | ''Not yet described. / {{Deu|Noch nicht beschrieben.}} / {{Fra|Pas encore décrit.}}'' | ||
Revision as of 14:28, 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. 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.