summaryrefslogtreecommitdiff
path: root/TWiki/TWikiMetaData.mdwn
diff options
context:
space:
mode:
authorPeter Thoeny <web-hurd@gnu.org>2001-09-14 09:05:09 +0000
committerPeter Thoeny <web-hurd@gnu.org>2001-09-14 09:05:09 +0000
commit33150b75b71fa5eddb6cef2269724110ce0e5b57 (patch)
tree7400e18769da5ab95d6052f2f2542a2ea1b17585 /TWiki/TWikiMetaData.mdwn
parentc0c593e2a6fbe247982d7286aadbd6da4ce5cc55 (diff)
none
Diffstat (limited to 'TWiki/TWikiMetaData.mdwn')
-rw-r--r--TWiki/TWikiMetaData.mdwn82
1 files changed, 41 insertions, 41 deletions
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% <a name="MetaDataDefinition"></a>
# <a name="TWiki_Meta_Data"> TWiki Meta Data </a>
@@ -8,12 +6,12 @@ _Topic data not editable from main freeform text box, stored in name/value `META
## <a name="Overview"> Overview </a>
-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.
## <a name="Meta_Data_Syntax"> Meta Data Syntax </a>
-* Format is the same as in [[TWikiDocumentation]], except all fields have a key.
- * %META:&lt;type&gt;\{key1="value1" [key2="value2" [...]]\}%
+* Format is the same as in [[TWikiVariables]], except all fields have a key.
+ * <code>%META:&lt;type&gt;\{key1="value1" key2="value2" ...\}%</code>
* 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**
>
-> %<nop>META:TOPICINFO{version="1.6" date="976762663" author="PeterThoeny" format="1.0"}%
-> text of the topic
-> %<nop>META:TOPICMOVED{from="Codev.OldName" to="CoDev.NewName"
-> by="JohnTalintyre" date="976762680"}%
-> %<nop>META:TOPICPARENT{name="NavigationByTopicContext"}%
-> %<nop>META:FILEATTACHMENT{name="Sample.txt" version="1.3" ... }%
-> %<nop>META:FILEATTACHMENT{name="Smile.gif" version="1.1" ... }%
-> %<nop>META:FORM{name="WebFormTemplate"}%
-> %<nop>META:FIELD{name="OperatingSystem" value="OsWin"}%
-> %<nop>META:FIELD{name="TopicClassification" value="PublicFAQ"}%
-
-### <a name="Specifications"> Specifications </a>
+> <pre>
+> %<nop>META:TOPICINFO{version="1.6" date="976762663" author="PeterThoeny" format="1.0"}%
+> text of the topic
+> %<nop>META:TOPICMOVED{from="Codev.OldName" to="Codev.NewName"
+> by="JohnTalintyre" date="976762680"}%
+> %<nop>META:TOPICPARENT{name="NavigationByTopicContext"}%
+> %<nop>META:FILEATTACHMENT{name="Sample.txt" version="1.3" ... }%
+> %<nop>META:FILEATTACHMENT{name="Smile.gif" version="1.1" ... }%
+> %<nop>META:FORM{name="WebFormTemplate"}%
+> %<nop>META:FIELD{name="OperatingSystem" value="OsWin"}%
+> %<nop>META:FIELD{name="TopicClassification" value="PublicFAQ"}%
+> </nop></nop></nop></nop></nop></nop></nop></nop></pre>
+
+## <a name="Meta_Data_Specifications"> Meta Data Specifications </a>
The current version of Meta Data is 1.0, with support for the following variables.
-#### <a name="TOPICINFO"> </a> TOPICINFO
+### <a name="META_TOPICINFO"> </a> META:TOPICINFO
<table border="1" cellpadding="1" cellspacing="0">
<tr>
@@ -63,11 +63,11 @@ The current version of Meta Data is 1.0, with support for the following variable
</tr>
</table>
-#### <a name="TOPICMOVED"> </a> TOPICMOVED
+### <a name="META_TOPICMOVED"> </a> 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"\}%
+<code>%META:TOPICMOVED\{from="Codev.OldName" to="Codev.NewName" by="talintj" date="976762680"\}%</code>
<table border="1" cellpadding="1" cellspacing="0">
<tr>
@@ -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.
-#### <a name="TOPICPARENT"> </a> TOPICPARENT
+### <a name="META_TOPICPARENT"> </a> META:TOPICPARENT
<table border="1" cellpadding="1" cellspacing="0">
<tr>
@@ -110,7 +110,7 @@ Notes:
</tr>
</table>
-#### <a name="FILEATTACHMENT"> </a> FILEATTACHMENT
+### <a name="META_FILEATTACHMENT"> </a> META:FILEATTACHMENT
<table border="1" cellpadding="1" cellspacing="0">
<tr>
@@ -155,6 +155,10 @@ Extra fields that are added if an attachment is moved:
<table border="1" cellpadding="1" cellspacing="0">
<tr>
+ <th bgcolor="#99CCCC"><strong>Key</strong></th>
+ <th bgcolor="#99CCCC"><strong>Comment</strong></th>
+ </tr>
+ <tr>
<td> movedfrom </td>
<td> full topic name - web.topic </td>
</tr>
@@ -172,7 +176,7 @@ Extra fields that are added if an attachment is moved:
</tr>
</table>
-#### <a name="FORM"> </a> FORM
+### <a name="META_FORM"> </a> META:FORM
<table border="1" cellpadding="1" cellspacing="0">
<tr>
@@ -181,13 +185,13 @@ Extra fields that are added if an attachment is moved:
</tr>
<tr>
<td> name </td>
- <td> A topic name - the topic is a <span style="background:"><font color="">Form Template</font></span><a href="http://LOCATION/TWikiDocumentation">?</a>. Can optionally include the web name i.e. web.topic, but doesn't normally </td>
+ <td> A topic name - the topic represents one of the <span style="background:"><font color="">TWiki Forms</font></span><a href="http://LOCATION/TWikiForms">?</a>. Can optionally include the web name i.e. web.topic, but doesn't normally </td>
</tr>
</table>
-#### <a name="FIELD"> </a> FIELD
+### <a name="META_FIELD"> </a> 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.
<table border="1" cellpadding="1" cellspacing="0">
<tr>
@@ -196,11 +200,11 @@ Should only be present if there is a FORM entry. Note that this data is used whe
</tr>
<tr>
<td> name </td>
- <td> Ties to entry in <span style="background:"><font color="">Form Template</font></span><a href="http://LOCATION/TWikiDocumentation">?</a>, is title with all bar alphanumerics and . removed </td>
+ <td> Ties to entry in <span style="background:"><font color="">TWiki Forms</font></span><a href="http://LOCATION/TWikiForms">?</a> template, is title with all bar alphanumerics and . removed </td>
</tr>
<tr>
<td> title </td>
- <td> Full text from <span style="background:"><font color="">Form Template</font></span><a href="http://LOCATION/TWikiDocumentation">?</a></td>
+ <td> Full text from <span style="background:"><font color="">TWiki Forms</font></span><a href="http://LOCATION/TWikiForms">?</a> template </td>
</tr>
<tr>
<td> value </td>
@@ -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)
## <a name="Viewing_Meta_Data_in_Page_Source"> Viewing Meta Data in Page Source </a>
@@ -244,7 +248,7 @@ Current support covers:
</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>
+ <td> Show form data, see <span style="background:"><font color="">TWiki Forms</font></span><a href="http://LOCATION/TWikiForms">?</a></td>
</tr>
<tr>
<td> %<nop>META{"attachments"}% </nop></td>
@@ -283,15 +287,11 @@ Current support covers:
<td> Suffix, only appears if there are parents; default "" </td>
</tr>
<tr>
- <td> seperator="..." </td>
+ <td> separator="..." </td>
<td> Separator between parents, default is " &amp;gt; " </td>
</tr>
</table>
-* **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.
-
## <a name="Known_Issues"> Known Issues </a>
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.