W3TPL/tags

from HTYP, the free directory anyone can edit if they can prove to me that they're not a spambot
Jump to: navigation, search

About

Although the main "meat" of W3TPL is the (as-yet-unfinished) parser for text within <w3tpl></w3tpl> 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

alphabetical by function
  • Text block inclusion:
    • <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
    • <echo>: overrides the "hide" attribute (and eventually the <hide> tag), i.e. displays contents
    • <load>: includes the contents of another page – like templates, but without creating a separate instance of the page object
  • <let>, <get>: much like PageVars extension, but using XML tags instead of {{#parser}} functions
  • <func>: defines a function which can be called with arguments later
    • <arg>: optional method of passing arguments to a function
    • <call>: call a previously defined function
  • Control structures:
    • <if>, <else>
    • <for>
    • <xploop>: Same as {{#xploop}}, but uses varname instead of $s$
      • syntax: xploop list="\demarcated\list" repl=string-to-replace sep=separator
  • Debugging:
    • <dump>: show list of all variables (with values) and functions (with code)
  • In development:
    • <class>
    • <w3tpl>: currently, is only used for disabling cache; will later enclose blocks of executable w3tpl code
  • Content management:
    • <load>
    • <save> - experimental; may not be useful without a lot more support

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 <echo><echo> tags. If absent, the contents of the <echo><echo> tags are ignored and only the remainder of the content is shown. (At present, contents of the <hide> tag itself are never displayed; this will be changed to enable the <echo> tag at some point.)
  • parse: parse any wikitext when reading the value of a variable