From 33150b75b71fa5eddb6cef2269724110ce0e5b57 Mon Sep 17 00:00:00 2001 From: Peter Thoeny Date: Fri, 14 Sep 2001 09:05:09 +0000 Subject: none --- TWiki/TWikiMetaData.mdwn | 82 ++++++++++++++++++++++++------------------------ 1 file changed, 41 insertions(+), 41 deletions(-) (limited to 'TWiki') diff --git a/TWiki/TWikiMetaData.mdwn b/TWiki/TWikiMetaData.mdwn index 3e4b8503..667ed43f 100644 --- a/TWiki/TWikiMetaData.mdwn +++ b/TWiki/TWikiMetaData.mdwn @@ -1,5 +1,3 @@ -%INCLUDE\{"UtilTempDocNote"\}% - %TOC% %STARTINCLUDE% # TWiki Meta Data @@ -8,12 +6,12 @@ _Topic data not editable from main freeform text box, stored in name/value `META ## Overview -TWikiMetaData uses `META` variables to store topic data that's separate from the main free-form content. This includes program-generated info like [[FileAttachment]] data, and user-defined [[TWikiDocumentation]] info. +TWikiMetaData uses `META` variables to store topic data that's separate from the main free-form content. This includes program-generated info like [[FileAttachment]] data, and user-defined [[TWikiForms]] info. ## Meta Data Syntax -* Format is the same as in [[TWikiDocumentation]], except all fields have a key. - * %META:<type>\{key1="value1" [key2="value2" [...]]\}% +* Format is the same as in [[TWikiVariables]], except all fields have a key. + * %META:<type>\{key1="value1" key2="value2" ...\}% * Order of fields within the meta variables is not defined, except that if there is a field with key `name`, this appears first for easier searching (note the order of the variables themselves is defined). @@ -23,22 +21,24 @@ TWikiMetaData uses `META` variables to store topic data that's separate from the > **Example of Format** > -> %META:TOPICINFO{version="1.6" date="976762663" author="PeterThoeny" format="1.0"}% -> text of the topic -> %META:TOPICMOVED{from="Codev.OldName" to="CoDev.NewName" -> by="JohnTalintyre" date="976762680"}% -> %META:TOPICPARENT{name="NavigationByTopicContext"}% -> %META:FILEATTACHMENT{name="Sample.txt" version="1.3" ... }% -> %META:FILEATTACHMENT{name="Smile.gif" version="1.1" ... }% -> %META:FORM{name="WebFormTemplate"}% -> %META:FIELD{name="OperatingSystem" value="OsWin"}% -> %META:FIELD{name="TopicClassification" value="PublicFAQ"}% - -### Specifications +> 
+> %META:TOPICINFO{version="1.6" date="976762663" author="PeterThoeny" format="1.0"}%
+>    text of the topic
+> %META:TOPICMOVED{from="Codev.OldName" to="Codev.NewName"
+>    by="JohnTalintyre" date="976762680"}%
+> %META:TOPICPARENT{name="NavigationByTopicContext"}%
+> %META:FILEATTACHMENT{name="Sample.txt" version="1.3" ... }%
+> %META:FILEATTACHMENT{name="Smile.gif" version="1.1" ... }%
+> %META:FORM{name="WebFormTemplate"}%
+> %META:FIELD{name="OperatingSystem" value="OsWin"}%
+> %META:FIELD{name="TopicClassification" value="PublicFAQ"}%
+>
+ +## Meta Data Specifications The current version of Meta Data is 1.0, with support for the following variables. -#### TOPICINFO +### META:TOPICINFO @@ -63,11 +63,11 @@ The current version of Meta Data is 1.0, with support for the following variable
-#### TOPICMOVED +### META: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. +This is optional, exists if topic has ever been moved. If a topic is moved more than once, only the most recent META:TOPICMOVED meta variable exists in the topic, older ones are to be found in the rcs history. -%META:TOPICMOVED\{from="Codev.OldName" to="CoDev.NewName" by="talintj" date="976762680"\}% +%META:TOPICMOVED\{from="Codev.OldName" to="Codev.NewName" by="talintj" date="976762680"\}% @@ -97,7 +97,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 +### META:TOPICPARENT
@@ -110,7 +110,7 @@ Notes:
-#### FILEATTACHMENT +### META:FILEATTACHMENT @@ -154,6 +154,10 @@ Notes: Extra fields that are added if an attachment is moved:
+ + + + @@ -172,7 +176,7 @@ Extra fields that are added if an attachment is moved:
KeyComment
movedfrom full topic name - web.topic
-#### FORM +### META:FORM @@ -181,13 +185,13 @@ Extra fields that are added if an attachment is moved: - +
name A topic name - the topic is a Form Template?. Can optionally include the web name i.e. web.topic, but doesn't normally A topic name - the topic represents one of the TWiki Forms?. Can optionally include the web name i.e. web.topic, but doesn't normally
-#### FIELD +### META: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. +Should only be present if there is a META:FORM entry. Note that this data is used when viewing a topic, the form template definition is not read. @@ -196,11 +200,11 @@ Should only be present if there is a FORM entry. Note that this data is used whe - + - + @@ -217,13 +221,13 @@ There is no absolute need for Meta Data variables to be listed in a specific ord The recommended sequence is: -* TOPICINFO +* META:TOPICINFO * `text of topic` -* TOPICMOVED (optional) -* TOPICPARENT (optional) -* FILEATTACHMENT (0 or more entries) -* FORM (optional) -* FIELD (0 or more entries; FORM required) +* META:TOPICMOVED (optional) +* META:TOPICPARENT (optional) +* META:FILEATTACHMENT (0 or more entries) +* META:FORM (optional) +* META:FIELD (0 or more entries; FORM required) ## Viewing Meta Data in Page Source @@ -244,7 +248,7 @@ Current support covers: - + @@ -283,15 +287,11 @@ Current support covers: - +
name Ties to entry in Form Template?, is title with all bar alphanumerics and . removed Ties to entry in TWiki Forms? template, is title with all bar alphanumerics and . removed
title Full text from Form Template? Full text from TWiki Forms? template
value
%META{"form"}% Show form data, see Form Templates? Show form data, see TWiki Forms?
%META{"attachments"}% Suffix, only appears if there are parents; default ""
seperator="..." separator="..." Separator between parents, default is " &gt; "
-* **Future Development:** There are numerous development directions and specific features to consider. A couple of obvious possibilities: - * Rendering to formats other than tables: bullet lists, formatted body text; - * Specifying templates to be used for rendering. - ## Known Issues 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. -- cgit v1.2.3