From ffb34810509d9c70a7a93dee11cb8c6b184974b2 Mon Sep 17 00:00:00 2001 From: MikeMannix Date: Fri, 7 Sep 2001 10:09:54 +0000 Subject: none --- TWiki/MetaDataDefinition.mdwn | 28 ++++++++++++++-------------- 1 file changed, 14 insertions(+), 14 deletions(-) diff --git a/TWiki/MetaDataDefinition.mdwn b/TWiki/MetaDataDefinition.mdwn index 0bd6dcd9..6c22e00d 100644 --- a/TWiki/MetaDataDefinition.mdwn +++ b/TWiki/MetaDataDefinition.mdwn @@ -1,8 +1,8 @@ %TOC% %STARTINCLUDE% -## TWiki Meta Data +# TWiki Meta Data -### What is Meta Data in TWiki? +## What is Meta Data in TWiki? **_What, indeed!_** @@ -12,7 +12,7 @@ See Meta Data Rendering for variables used to display meta data. Current version: **1\.0** -#### Syntax +### Syntax * Format is as for \[[TWikiDocumentation#TWiki\_Variables, except all fields have a key. * %META:<type>\{key1="value1" [key2="value2" [...]]\}% @@ -33,9 +33,9 @@ Current version: **1\.0** > %META:FIELD{name="OperatingSystem" value="OsWin"}% > %META:FIELD{name="TopicClassification" value="PublicFAQ"}% -#### Specifications +### Specifications -##### TOPICINFO +#### TOPICINFO @@ -60,7 +60,7 @@ Current version: **1\.0**
-##### TOPICMOVED +#### TOPICMOVED This is optional, exists if topic has ever been moved. If a topic is moved more than once, only the most recent TOPICMOVED meta variable exists in the topic, older ones are to be found in the rcs history. @@ -94,7 +94,7 @@ Notes: * at present version number is not supported directly, it can be inferred from the RCS history. * there is only one META:TOPICMOVED in a topic, older move information can be found in the RCS history. -##### TOPICPARENT +#### TOPICPARENT @@ -107,7 +107,7 @@ Notes:
-##### FILEATTACHMENT +#### FILEATTACHMENT @@ -169,7 +169,7 @@ Extra field that are added if an attachment is moved:
-##### FORM +#### FORM @@ -182,7 +182,7 @@ Extra field that are added if an attachment is moved:
-##### FIELD +#### FIELD Should only be present if there is a FORM entry. Note that this data is used when viewing a topic, the form template definition is not read. @@ -205,7 +205,7 @@ Should only be present if there is a FORM entry. Note that this data is used whe -#### Recommended Sequence +### Recommended Sequence There no absolute need for meta data variables to be in a specific order, however, it does for the following reasons: @@ -227,17 +227,17 @@ So the order is: * FORM - optional * FIELD - 0 or more entries (FORM required) -#### Viewing Meta Data in Page Source +### Viewing Meta Data in Page Source When viewing a topic the **Raw Text** link can be clicked to show the text of a topic (ie: as seen when editing). This is done by adding `raw=on` to URL. `raw=debug` shows the meta data as well as the topic data, ex: [debug view for this topic](%SCRIPTURLPATH%/view%SCRIPTSUFFIX%/%WEB%/%TOPIC%?raw=debug) -#### Future Support for Plugins +### Future Support for Plugins 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. -### Rendering Meta Data +## Rendering Meta Data Various types of meta data can be stored in topics. The data is rendered using the %META% variable. This is mostly used in the **view**, **preview** and **edit** scripts. -- cgit v1.2.3