Jeroen De Dauw/Describe test
From Whitespace (Hackerspace Gent)
< Jeroen De Dauw(Difference between revisions)
| Line 1: | Line 1: | ||
| − | {{#describe:}} | + | {{#describe:describe}} |
Revision as of 22:57, 28 February 2011
describe
Description: Generates documentation for one or more parser hooks defined via Validator.
Implemented as both parser function and as tag extension.
Parameters
| # | Parameter | Aliases | Type | Default | Description |
|---|---|---|---|---|---|
| 1 | hooks | hook | List of text items | listerrors, describe, smwdoc, info, coordinates, display_map, display_point, distance, finddestination, geocode, geodistance, mapsdoc, subpages, subpagecount | The parser hooks for which to display documentation. |
| - | pre | - | Yes/no | off | Allows you to get the actual wikitext for the documentation, without it being rendered on the page. |
| - | language | - | Text | en | The language to display the descriptions in |
Syntax
Tag extension with only the required parameters.
<describe />
Tag extension with all parameters.
<describe hooks="{List of text items}" pre="{Yes/no}" language="{Text}" />
Tag extension with all parameters using the default parameter notation.
<describe pre="{Yes/no}" language="{Text}">{hooks, List of text items}</describe>
Parser function with only the required parameters.
{{#describe:}}
Parser function with all parameters.
{{#describe:hooks={List of text items}|pre={Yes/no}|language={Text}}}
Parser function with all parameters using the default parameter notation.
{{#describe:{hooks, List of text items}|pre=Yes/no|language=Text}}
