Template:ElementDocu

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

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 / Parent: Not yet described. / Noch nicht beschrieben. / Children: Not yet described. / Noch nicht beschrieben. / 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. /