diff options
Diffstat (limited to 'TWiki/MetaDataRendering.mdwn')
-rw-r--r-- | TWiki/MetaDataRendering.mdwn | 65 |
1 files changed, 65 insertions, 0 deletions
diff --git a/TWiki/MetaDataRendering.mdwn b/TWiki/MetaDataRendering.mdwn new file mode 100644 index 00000000..08838cfc --- /dev/null +++ b/TWiki/MetaDataRendering.mdwn @@ -0,0 +1,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 [[TWikiDocumentation]]</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 " &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 /> |