summaryrefslogtreecommitdiff
path: root/TWiki/MetaDataRendering.mdwn
blob: 0f637bbf24a7d529ceac6d83ca55a1c5eb8122dc (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
%STARTINCLUDE%

## <a name="Meta_Data_Rendering"> Meta Data Rendering </a>

Various meta data can be stored in topics - [[MetaDataDefinition]]

This is rendered using the %META% variable. This is mostly used in the `view`, `preview` and `edit` scripts.

At present support is fairly basic:

<table border="1" cellpadding="1" cellspacing="0">
  <tr>
    <th bgcolor="#99CCCC"><strong>Variable usage:</strong></th>
    <th bgcolor="#99CCCC"><strong>Comment:</strong></th>
  </tr>
  <tr>
    <td> %<nop>META{"form"}% </nop></td>
    <td> Show form data, see <span style="background:"><font color="">Form Templates</font></span><a href="http://LOCATION/TWikiDocumentation">?</a></td>
  </tr>
  <tr>
    <td> %<nop>META{"attachments"}% </nop></td>
    <td> Show attachments, excluding hidden ones </td>
  </tr>
  <tr>
    <td> options for attachments: </td>
  </tr>
  <tr>
    <td> all="on" </td>
    <td> Show all attachments i.e. including hidden ones </td>
  </tr>
  <tr>
    <td> %<nop>META{"moved"}% </nop></td>
    <td> Details of any topic moves </td>
  </tr>
  <tr>
    <td> %<nop>META{"parent [options]"}% </nop></td>
    <td> Show topic parent </td>
  </tr>
  <tr>
    <td> options for parent: </td>
  </tr>
  <tr>
    <td> dontrecurse="on" </td>
    <td> By default recurses up tree, this has some cost </td>
  </tr>
  <tr>
    <td> prefix="..." </td>
    <td> Prefix that goes before parents, but only if there are parents, default "" </td>
  </tr>
  <tr>
    <td> suffix="..." </td>
    <td> Suffix, only appears if there are parents, default "" </td>
  </tr>
  <tr>
    <td> seperator="..." </td>
    <td> Seperator between parents, default is " &amp;gt; " </td>
  </tr>
</table>

Possible future additions:

* Rendering of form data to alternate formats e.g. bullet lists
* Specify a template to be used for rendering

%STOPINCLUDE% -- [[JohnTalintyre]] - 29 Aug 2001 <br />