TWiki/VarMETA.mdwn

   1 <a name="VarMETA"></a>
   2
   3 ### <a name="META -- displays meta-data"></a> META -- displays meta-data
   4
   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: `%META{ "item" ...}%`
   7 - Parameters: <table border="1" cellpadding="0" cellspacing="0">
   8   <tr>
   9     <th bgcolor="#99CCCC"><strong> Item </strong></th>
  10     <th bgcolor="#99CCCC"><strong> Options </strong></th>
  11     <th bgcolor="#99CCCC"><strong> Description </strong></th>
  12   </tr>
  13   <tr>
  14     <td><code>"formfield"</code></td>
  15     <td><code>name="..."</code>: name of the field. The field value can be shortened as described in %SYSTEMWEB%.FormattedSearch for <code>$formfield</code> %BR% <code>newline="..."</code>: by default, each newline character will be rewritten to <code>&lt;br /&gt;</code> to allow metadata that contains newlines to be used in tables, etc. <code>$n</code> indicates a newline character. %BR% <code>bar="..."</code>: by default, each vertical bar is rewritten to an HTML entity so as to not be mistaken for a table separator. </td>
  16     <td> Show a single form field </td>
  17   </tr>
  18   <tr>
  19     <td><code>"form"</code></td>
  20     <td><em>none</em></td>
  21     <td> Generates the table showing the form fields. See [[Main/TWikiDocumentation#Form_Templates]]</td>
  22   </tr>
  23   <tr>
  24     <td><code>"attachments"</code></td>
  25     <td><code>all="on"</code> to show hidden attachments. %BR% <code>title="..."</code> to show a title - only if attachments are displayed. %BR% <code>template="..."</code> to use a custom template for the rendering of attachments; default <code>attachtables</code> is used. </td>
  26     <td> Generates the list of attachments </td>
  27   </tr>
  28   <tr>
  29     <td><code>"moved"</code></td>
  30     <td><em>none</em></td>
  31     <td> Details of any topic moves </td>
  32   </tr>
  33   <tr>
  34     <td><code>"parent"</code></td>
  35     <td><code>dontrecurse="on"</code>: By default recurses up tree, this has some cost. %BR% <code>nowebhome="on"</code>: Suppress WebHome. %BR% <code>prefix="..."</code>: Prefix that goes before parents, but only if there are parents, default <code>""</code>. %BR% <code>format="..."</code>: Format string used to display each parent topic where <code>$web</code> expands to the web name, and <code>$topic</code> expands to the topic name; default: <code>"[[$web.$topic][$topic]]"</code> %BR% <code>suffix="..."</code>: Suffix, only appears if there are parents; default <code>""</code>. %BR% <code>separator="..."</code>: Separator between parents; default <code>" &gt; "</code>. </td>
  36     <td> Generates the parent link </td>
  37   </tr>
  38 </table>
  39 - Related: [[METASEARCH|Main/VarMETASEARCH]]