Template:Repo link/doc design intro: Difference between revisions

From FlightGear wiki
Jump to navigation Jump to search
(Added the 'Design' section title.)
(Switch from == to <h2> for the heading. This is needed as the Mediawiki requirement of the heading starting on a new line may not be satisfied.)
 
Line 1: Line 1:
== Design ==
<h2>Design</h2>
In this section, the following notation will be used:
In this section, the following notation will be used:
; Angular brackets + lower case text <code><nowiki><xyz></nowiki></code>: Template parameters.
; Angular brackets + lower case text <code><nowiki><xyz></nowiki></code>: Template parameters.

Latest revision as of 18:58, 7 March 2016

Design

In this section, the following notation will be used:

Angular brackets + lower case text <xyz>
Template parameters.
Angular brackets + upper case text <XYZ>
Template constructed text.
Square brackets [xyz]
Optional text, only added if the parameter is set.
Or symbol |
The value on the left, if present, otherwise the value on the right of the symbol.


The following template description is not displayed when the template is inserted in an article.

Goal

To provide documentation of the design of the {{repo link}} family of templates. This is only for use within documentation of the subtemplates.