From 7eedd93979a5dd6296c404897dfb286345a79fe0 Mon Sep 17 00:00:00 2001 From: John Talintyre Date: Thu, 16 Aug 2001 17:09:21 +0000 Subject: none --- TWiki/MetaDataDefinition.mdwn | 233 ++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 233 insertions(+) create mode 100644 TWiki/MetaDataDefinition.mdwn (limited to 'TWiki/MetaDataDefinition.mdwn') diff --git a/TWiki/MetaDataDefinition.mdwn b/TWiki/MetaDataDefinition.mdwn new file mode 100644 index 00000000..7aab24a0 --- /dev/null +++ b/TWiki/MetaDataDefinition.mdwn @@ -0,0 +1,233 @@ +## Meta Data Definition + +See [[MetaDataRendering]] for display of meta data + +Current version: **1\.0** + +Table of contents: %TOC% + +### 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"}%
+
+ +### General notes + +* Format is as for %TWIKIWEB%.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) +* Each meta variable is on one line +* '\\n' is represented in values by **%\_N\_** and '"' by **%\_Q\_%** + +### Logical order + +There no absolute need for meta data to be in a specific order, however, it does for the following reasons: + +* Keep (form) fields in the order they are defined +* Allow diff command to give output in a logically sensible 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: + +* TOPICINFO +* text of topic +* TOPICMOVED - optional +* TOPICPARENT - optional +* FILEATTACHMENT - 0 or more entries +* FORM - optional +* FIELD - 0 or more entries (FORM required) + +### Specification + +#### TOPICINFO + + + + + + + + + + + + + + + + + + + + + + +
KeyComment
version Same as RCS version
date integer, unx time, seconds since start 1970
author last to change topic, is the REMOTE_USER
format Format of this topic, will be used for automatic format conversion
+ +#### 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. + +%META:TOPICMOVED\{from="Codev.OldName" to="CoDev.NewName" by="talintj" date="976762680"\}% + + + + + + + + + + + + + + + + + + + + + + +
KeyComment
from Full name i.e. web.topic
to Full name i.e. web.topic
by Who did it, is the REMOTE_USER, not WikiName
date integer, unx time, seconds since start 1970
+ +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 + + + + + + + + + + +
KeyComment
name The topic from which this was created, Web Home? if done from Go, othewise topic where ? or form used. Normally just topic, but is full web.topic format if parent is in a different Web. Renaming a Web will then only break a few of these references or they can be scanned and fixed.
+ +#### FILEATTACHMENT + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
KeyComment
name Name of file, no path. Must be unique within topic
version Same as RCS revision
path Full path file was loaded from
size In bytes
date integer, unx time, seconds since start 1970
user the REMOTE_USER, not WikiName
comment As supplied when file uploaded
attr h if hidden, optional
+ +Extra field that are added if an attachment is moved: + + + + + + + + + + + + + + + + + + +
movedfrom full topic name - web.topic
movedby the REMOTE_USER, not WikiName
movedto full topic name - web.topic
moveddate integer, unx time, seconds since start 1970
+ +#### FORM + + + + + + + + + + +
KeyComment
name A topic name - the topic is a TWiki Form Template?. Can optionally include the web name i.e. web.topic, but doesn't normally
+ +#### 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. + + + + + + + + + + + + + + + + + + +
KeyName
name Ties to entry in TWiki Form Template?, is title with all bar alphanumerics and . removed
title Full text from TWiki Form Template?
value Value user has supplied via form
+ +### Viewing meta data + +When viewing a topic the `Raw Text` link can be clicked to show the text of a topic (i.e. as is seen when editing). This is done by adding `raw=on` to URL. `raw=debug` shows the meta data as well as the topic data e.g. [for this topic](%SCRIPTURLPATH%/view%SCRIPTSUFFIX%/%WEB%/%TOPIC%?raw=debug) + +### Other + +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 only needs minor alteration. + +-- [[Main/JohnTalintyre]] - 16 Aug 2001
-- cgit v1.2.3