data/TWiki/VarMETA.txt
author Colas Nahaboo <colas@nahaboo.net>
Sat, 26 Jan 2008 15:50:53 +0100
changeset 0 414e01d06fd5
permissions -rw-r--r--
RELEASE 4.2.0 freetown
     1 %META:TOPICINFO{author="TWikiContributor" date="1111929255" format="1.1" version="3"}%
     2 %META:TOPICPARENT{name="TWikiVariables"}%
     3 #VarMETA
     4 ---+++ META -- displays meta-data
     5    * Provided mainly for use in templates, this variable generates the parts of the topic view that relate to meta-data (attachments, forms etc.) The =formfield= item is the most likely to be useful to casual users.
     6    * Syntax: =%<nop>META{ "item" ...}%=
     7    * Parameters:
     8      | *Item* | *Options* | *Description* |
     9      | ="formfield"= | =name="..."=: name of the field. The field value can be shortened as described in %SYSTEMWEB%.FormattedSearch for =$formfield= %BR% \
    10                        =newline="..."=: by default, each newline character will be rewritten to =&lt;br /&gt;= to allow metadata that contains newlines to be used in tables, etc. =$n= indicates a newline character. %BR% \
    11                        =bar="..."=: by default, each vertical bar is rewritten to an HTML entity so as to not be mistaken for a table separator. \
    12                     | Show a single form field |
    13      | ="form"= | _none_ | Generates the table showing the form fields. See [[TWikiDocumentation#Form_Templates][Form Templates]] |
    14      | ="attachments"= | =all="on"= to show hidden attachments. %BR% \
    15      					 =title="..."= to show a title - only if attachments are displayed. %BR% \
    16      					 =template="..."= to use a custom template for the rendering of attachments; default =attachtables= is used. \
    17       			| Generates the list of attachments |
    18      | ="moved"= | _none_ | Details of any topic moves |
    19      | ="parent"= | =dontrecurse="on"=: By default recurses up tree, this has some cost. %BR% \
    20                     =nowebhome="on"=: Suppress <nop>%HOMETOPIC%. %BR% \
    21 		    =prefix="..."=: Prefix that goes before parents, but only if there are parents, default =""=. %BR% \
    22 		    =format="..."=: Format string used to display each parent topic where =$web= expands to the web name, and =$topic= expands to the topic name; default: ="[<nop>[$web.$topic][$topic]]"= %BR% \
    23 		    =suffix="..."=: Suffix, only appears if there are parents; default =""=. %BR% \
    24 		    =separator="..."=: Separator between parents; default =" &gt; "=. \
    25                   | Generates the parent link |
    26    * Related: [[%IF{"'%INCLUDINGTOPIC%'='TWikiVariables'" then="#"}%VarMETASEARCH][METASEARCH]]
    27