Jeroen De Dauw/Describe test
From Whitespace (Hackerspace Gent)
< Jeroen De Dauw(Difference between revisions)
| Line 1: | Line 1: | ||
| − | {{#describe:describe}} | + | {{#describe:describe|pre=on}} |
Latest revision as of 22:57, 28 February 2011
== describe ==
<!-- The contents of this section was auto-generated by the "describe" parser hook of the Validator extension. -->
'''Description''': Generates documentation for one or more parser hooks defined via Validator.
Implemented as both parser function and as tag extension.
=== Parameters ===
{| class="wikitable sortable"
! #
!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.'''
<pre>
<describe />
</pre>
'''Tag extension with all parameters.'''
<pre>
<describe hooks="{List of text items}" pre="{Yes/no}" language="{Text}" />
</pre>
'''Tag extension with all parameters using the default parameter notation.'''
<pre>
<describe pre="{Yes/no}" language="{Text}">{hooks, List of text items}</describe>
</pre>
'''Parser function with only the required parameters.'''
<pre>
{{#describe:}}
</pre>
'''Parser function with all parameters.'''
<pre>
{{#describe:hooks={List of text items}|pre={Yes/no}|language={Text}}}
</pre>
'''Parser function with all parameters using the default parameter notation.'''
<pre>
{{#describe:{hooks, List of text items}|pre=Yes/no|language=Text}}
</pre>
