From: <de...@de...> - 2010-04-28 05:00:00
|
Author: PeterThoeny Date: 2010-04-27 23:59:54 -0500 (Tue, 27 Apr 2010) New Revision: 18541 Trac url: http://develop.twiki.org/trac/changeset/18541 Modified: twiki/trunk/core/data/TWiki/VarMETA.txt Log: Item6438: Docs for topic parameter in %META variable Modified: twiki/trunk/core/data/TWiki/VarMETA.txt =================================================================== --- twiki/trunk/core/data/TWiki/VarMETA.txt 2010-04-28 04:24:17 UTC (rev 18540) +++ twiki/trunk/core/data/TWiki/VarMETA.txt 2010-04-28 04:59:54 UTC (rev 18541) @@ -1,4 +1,4 @@ -%META:TOPICINFO{author="TWikiContributor" date="1270874781" format="1.1" version="$Rev$"}% +%META:TOPICINFO{author="TWikiContributor" date="1272429972" format="1.1" version="$Rev$"}% %META:TOPICPARENT{name="TWikiVariables"}% #VarMETA ---+++ META -- displays meta-data @@ -7,21 +7,27 @@ * Parameters: | *Item* | *Options* | *Description* | | ="formfield"= | =name="..."=: name of the field. The field value can be shortened as described in %SYSTEMWEB%.FormattedSearch for =$formfield=. %BR% \ - =newline="..."=: by default, each newline character will be rewritten to =<br />= to allow metadata that contains newlines to be used in tables, etc. =$n= indicates a newline character. %BR% \ - =bar="..."=: by default, each vertical bar is rewritten to an HTML entity so as to not be mistaken for a table separator. \ + =newline="..."=: by default, each newline character will be rewritten to =<br />= to allow metadata that contains newlines to be used in tables, etc. =$n= indicates a newline character.%BR% \ + =bar="..."=: by default, each vertical bar is rewritten to an HTML entity so as to not be mistaken for a table separator.%BR% \ + =topic="..."=: Get meta info of "Topic" or "Web.Topic"; default ="%<nop>BASEWEB%.%<nop>BASETOPIC%"=. \ | Show a single form field | - | ="form"= | _none_ | Generates the table showing the form fields. See [[TWikiDocumentation#Form_Templates][Form Templates]] | - | ="attachments"= | =all="on"= to show hidden attachments. %BR% \ - =title="..."= to show a title - only if attachments are displayed. %BR% \ - =template="..."= to use a custom template for the rendering of attachments; default =attachtables= is used. \ - | Generates the list of attachments | - | ="moved"= | _none_ | Details of any topic moves | - | ="parent"= | =dontrecurse="on"=: By default recurses up tree, this has some cost. %BR% \ + | ="form"= | =topic="..."=: Get meta info of "Topic" or "Web.Topic"; default ="%<nop>BASEWEB%.%<nop>BASETOPIC%"=. \ + | Generates the table showing the form fields. See [[TWikiDocumentation#Form_Templates][Form Templates]] | + | ="attachments"= | =all="on"= to show hidden attachments.%BR% \ + =title="..."= to show a title - only if attachments are displayed.%BR% \ + =template="..."= to use a custom template for the rendering of attachments; default =attachtables= is used.%BR% \ + =topic="..."=: Get meta info of "Topic" or "Web.Topic"; default ="%<nop>BASEWEB%.%<nop>BASETOPIC%"=. \ + | Generates the list of attachments | + | ="moved"= | =topic="..."=: Get meta info of "Topic" or "Web.Topic"; default ="%<nop>BASEWEB%.%<nop>BASETOPIC%"=. \ + | Details of any topic moves | + | ="parent"= | =dontrecurse="on"=: By default recurses up tree, this has some cost.%BR% \ =nowebhome="on"=: Suppress <nop>%HOMETOPIC%. %BR% \ - =prefix="..."=: Prefix that goes before parents, but only if there are parents, default =""=. %BR% \ - =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% \ - =suffix="..."=: Suffix, only appears if there are parents; default =""=. %BR% \ - =separator="..."=: Separator between parents; default =" > "=. \ + =prefix="..."=: Prefix that goes before parents, but only if there are parents, default =""=. %BR% \ + =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% \ + =suffix="..."=: Suffix, only appears if there are parents; default =""=. %BR% \ + =separator="..."=: Separator between parents; default =" > "=. %BR% \ + =topic="..."=: Get meta info of "Topic" or "Web.Topic"; default ="%<nop>BASEWEB%.%<nop>BASETOPIC%"=. \ | Generates the parent link | + * __Attention:__ The base topic, not the current topic, is used if =%<nop>META{}%= is placed in an included topic. Add a =topic="%<nop>WEB%.%<nop>TOPIC%"= parameter if you need meta info of the current topic. * __Note:__ [[FormatTokens][Formatting tokens]] can be used for =newline=, =prefix=, =format=, =suffix= and =separator= options, such as =separator="$n * "= * Related: [[%IF{"'%INCLUDINGTOPIC%'='TWikiVariables'" then="#"}%VarMETASEARCH][METASEARCH]], [[%IF{"'%INCLUDINGTOPIC%'='TWikiVariables'" then="#"}%VarSEARCH][SEARCH]], FormattedSearch |