diff options
| -rw-r--r-- | TWiki/TWikiMetaData.mdwn | 33 |
1 files changed, 14 insertions, 19 deletions
diff --git a/TWiki/TWikiMetaData.mdwn b/TWiki/TWikiMetaData.mdwn index 1d8d024a..db50ec43 100644 --- a/TWiki/TWikiMetaData.mdwn +++ b/TWiki/TWikiMetaData.mdwn @@ -208,25 +208,20 @@ Should only be present if there is a FORM entry. Note that this data is used whe ### <a name="Recommended_Sequence"> Recommended Sequence </a> -There no absolute need for meta data variables to be in a specific order, however, it does for the following reasons: +There is no absolute need for Meta Data variables to be listed in a specific order within a topic, but it makes sense to do so a couple of good reasons: -* Keep (form) fields in the order they are defined -* Allow diff command to give output in a logically sensible order +* form fields remain in the order they are defined +* the `diff` function output appears in a logical order -These could be done in other ways, but this adds complexity - -* Order fields - definition could be read on each rendering (expensive) -* Diff - render data before doing diff, has something to offer, but not likely to be available for next TWiki release - -So the order is: +The recommended sequence is: * TOPICINFO -* text of topic -* TOPICMOVED - optional -* TOPICPARENT - optional -* FILEATTACHMENT - 0 or more entries -* FORM - optional -* FIELD - 0 or more entries (FORM required) +* `text of topic` +* TOPICMOVED (optional) +* TOPICPARENT (optional) +* FILEATTACHMENT (0 or more entries) +* FORM (optional) +* FIELD (0 or more entries; FORM required) ## <a name="Viewing_Meta_Data_in_Page_Source"> Viewing Meta Data in Page Source </a> @@ -236,9 +231,9 @@ When viewing a topic the <code>**Raw Text**</code> link can be clicked to show t ## <a name="Rendering_Meta_Data"> Rendering Meta Data </a> -Meta Data is rendered with the %META% variable. This is mostly used in the <code>**view**</code>, <code>**preview**</code> and <code>**edit**</code> scripts. +Meta Data is rendered with the %META% variable. This is mostly used in the `view`, `preview` and `edit` scripts. -Current support is fairly basic: +Current support covers: <table border="1" cellpadding="1" cellspacing="0"> <tr> @@ -254,7 +249,7 @@ Current support is fairly basic: <td> Show attachments, exclude hidden </td> </tr> <tr> - <td> Options for attachments: </td> + <td> Options for <span style="background:"><font color="">Attachments</font></span><a href="http://LOCATION/FileAttachments">?</a>: </td> <td> </td> </tr> <tr> @@ -297,6 +292,6 @@ Current support is fairly basic: ## <a name="Known_Issues"> Known Issues </a> -There is currently no support for meta data for Plugins. However, the format is readily extendable and the `Meta.pm` code that supports the format needs only minor alteration. +At present, there is no Meta Data support for Plugins. However, the format is readily extendable and the `Meta.pm` code that supports the format needs only minor alteration. -- [[JohnTalintyre]] - 29 Aug 2001 <br /> |