Difference between revisions of "Jeroen De Dauw/Describe test"

From Whitespace (Hackerspace Gent)
Jump to: navigation, search
 
(One intermediate revision by one user not shown)
Line 1: Line 1:
{{#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 texts
| listerrors, describe, coordinates, display_map, distance, finddestination, geocode, geodistance, mapsdoc, layer, smwdoc, info
| The parser hooks for which to display documentation.
|-
| -
| pre
| -
| yes/no
| no
| 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 texts}" 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 texts}</describe>
</pre>

'''Parser function with only the required parameters.'''

<pre>
{{#describe:}}
</pre>

'''Parser function with all parameters.'''

<pre>
{{#describe:hooks={list of texts}|pre={yes/no}|language={text}}}
</pre>

'''Parser function with all parameters using the default parameter notation.'''

<pre>
{{#describe:{hooks, list of texts}|pre=yes/no|language=text}}
</pre>