W3TPL/tags: Difference between revisions
< W3TPL
Jump to navigation
Jump to search
(→Overview: MW parser can't do nested tags) |
(replaced xmltag template with w3tpl/tag template so we can set up subpages) |
||
| Line 8: | Line 8: | ||
==Tags== | ==Tags== | ||
* '''Text block inclusion''': | * '''Text block inclusion''': | ||
** '''{{ | ** '''{{w3tpl/tag|hide}}''': Runs the parser on everything in between the tags, but doesn't display the result. Useful for doing a lot of "programmish" stuff, so you can format it nicely and comment it without messing up your display | ||
** '''{{ | ** '''{{w3tpl/tag|echo}}''': overrides the "hide" attribute (and eventually the {{xmltag|hide}} tag), i.e. displays contents | ||
** '''{{ | ** '''{{w3tpl/tag|load}}''': includes the contents of another page – like templates, but without creating a separate instance of the page object | ||
* '''{{ | * '''{{w3tpl/tag|let}}, {{w3tpl/tag|get}}''': much like PageVars extension, but using XML tags instead of <nowiki>{{#parser}}</nowiki> functions | ||
* '''{{ | * '''{{w3tpl/tag|func}}''': defines a function which can be called with arguments later | ||
** '''{{ | ** '''{{w3tpl/tag|arg}}''': optional method of passing arguments to a function | ||
** '''{{ | ** '''{{w3tpl/tag|call}}''': call a previously defined function | ||
* '''Control structures''': | * '''Control structures''': | ||
** '''{{ | ** '''{{w3tpl/tag|if}}, {{w3tpl/tag|else}}''' | ||
** '''{{ | ** '''{{w3tpl/tag|1=xploop list="\demarcated\list" repl=string-to-replace sep=separator}}''': Same as <nowiki>{{#xploop}}</nowiki>, but uses varname instead of $s$ | ||
* '''Debugging''': | * '''Debugging''': | ||
** '''{{ | ** '''{{w3tpl/tag|dump}}''': show list of all variables (with values) and functions (with code) | ||
==Common Attributes== | ==Common Attributes== | ||
* '''name'''=: name of variable being accessed (usage depends on tag) | * '''name'''=: name of variable being accessed (usage depends on tag) | ||
* '''hide''': if present, the contents of the tag will not be displayed except for those enclosed by {{ | * '''hide''': if present, the contents of the tag will not be displayed except for those enclosed by {{w3tpl/tag|echo}}{{w3tpl/tag|echo}} tags. If absent, the contents of the {{w3tpl/tag|echo}}{{w3tpl/tag|echo}} tags are ignored and only the remainder of the content is shown. (At present, contents of the {{w3tpl/tag|hide}} tag itself are never displayed; this will be changed to enable the {{xmltag|echo}} tag at some point.) | ||
** '''Used in''': {{ | ** '''Used in''': {{w3tpl/tag|if}}/{{w3tpl/tag|else}}, {{w3tpl/tag|for}} | ||
* '''parse''': parse any wikitext when reading the value of a variable | * '''parse''': parse any wikitext when reading the value of a variable | ||
Revision as of 21:10, 11 September 2010
Overview
Although the main "meat" of W3TPL is the (as-yet-unfinished) parser for text within Template:XmltagTemplate:Xmltag tags, there are a number of other tags which replicate much of the same functionality and may be suitable for simpler tasks.
In order to get around the parser, most of these tags have ways of using internal data for their values rather than depending on the parser to get things in the right order. to be documented
One of the weaknesses of the MediaWiki parser is that it cannot deal with nested tags properly; the ending-tag of a tag-pair nested inside another tag-pair results in closure of the outer tag-pair as well, and any text past the internal closing-tag is displayed rather than being passed to the tag handler. W3TPL allows you to get around this limitation by defining functions which are parsed separately from the code-block in which they are executing.
Tags
- Text block inclusion:
- Template:W3tpl/tag: Runs the parser on everything in between the tags, but doesn't display the result. Useful for doing a lot of "programmish" stuff, so you can format it nicely and comment it without messing up your display
- Template:W3tpl/tag: overrides the "hide" attribute (and eventually the Template:Xmltag tag), i.e. displays contents
- Template:W3tpl/tag: includes the contents of another page – like templates, but without creating a separate instance of the page object
- Template:W3tpl/tag, Template:W3tpl/tag: much like PageVars extension, but using XML tags instead of {{#parser}} functions
- Template:W3tpl/tag: defines a function which can be called with arguments later
- Template:W3tpl/tag: optional method of passing arguments to a function
- Template:W3tpl/tag: call a previously defined function
- Control structures:
- Template:W3tpl/tag, Template:W3tpl/tag
- Template:W3tpl/tag: Same as {{#xploop}}, but uses varname instead of $s$
- Debugging:
- Template:W3tpl/tag: show list of all variables (with values) and functions (with code)
Common Attributes
- name=: name of variable being accessed (usage depends on tag)
- hide: if present, the contents of the tag will not be displayed except for those enclosed by Template:W3tpl/tagTemplate:W3tpl/tag tags. If absent, the contents of the Template:W3tpl/tagTemplate:W3tpl/tag tags are ignored and only the remainder of the content is shown. (At present, contents of the Template:W3tpl/tag tag itself are never displayed; this will be changed to enable the Template:Xmltag tag at some point.)
- parse: parse any wikitext when reading the value of a variable