Template:Para

From Official Kodi Wiki
Jump to navigation Jump to search

|

[edit] Template documentation

1 Usage

This template is for giving examples of template parameter source code (useful in template documentation and talk page discussions of template code). It must have one or two parameters itself. The first is the name of the example parameter to display (this may be empty, but it must be present), and the second (optional) one is a value for the first example parameter, or (if the first {{Para}} parameter is empty) an unnamed example parameter.

1.1 Examples

  1.   {{Para|name}}
    renders as |name=
  2.   {{Para|‍|section}}
    renders as |section (for unnamed parameters in the example code; note the empty first parameter in the {{Para}} template)
  3.   {{Para|title|<var>book title</var>}}
    renders as |title=book title
  4.   {{Para|<var>parameter</var>|<var>value</var>}}
    renders as |parameter=value

1.2 Semantic distinctions

When using literal, pre-specified values, simply provide the value (appearance as in example 2). When illustrating hypothetical, variable or user-definable values, wrap them in <var>value</var> tags (as in example 3), and the same should be done for non-literal, example parameters (as in example 4). This is preferable to the use of the wikicode markup for italics (wrapping in paired single quotation marks, e.g. '''') for accessibility reasons, as it allows those using assistive technologies like screen readers to be made aware of the intention behind such uses of italics.