Welcome, Registration, and other StartingPoints; TWiki history & Wiki style; All the docs...
View   r9  >  r8  >  r7  >  r6  >  r5  >  r4  ...
TWikiMetaData 9 - 03 Dec 2001 - Main.MikeMannix
Line: 1 to 1
 
META TOPICPARENT name="WebHome"

Changed:
<
<

Appendix B: TWiki Meta Data

>
>

TWiki Meta Data

 
Changed:
<
<
Additional topic data, not editable from main freeform text box, stored in META variable name/value pairs
>
>
Additional topic data, program-generated or from TWikiForms, is stored in META variable name/value pairs
 

Overview

Changed:
<
<
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.
>
>
TWikiMetaData uses META variables to store topic data that's separate from the main free-form content. This includes program-generated info like FileAttachment and topic movement data, and user-defined TWikiForms info. Use META variables to format and display Meta Data.
 

Meta Data Syntax

Line: 151 to 151
 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

Changed:
<
<
-- MikeMannix? - 02 Oct 2001
>
>
-- MikeMannix? - 03 Dec 2001

TWikiMetaData 8 - 02 Oct 2001 - Main.MikeMannix
Line: 1 to 1
 
META TOPICPARENT name="WebHome"

Changed:
<
<

TWiki Meta Data

>
>

Appendix B: TWiki Meta Data

 Additional topic data, not editable from main freeform text box, stored in META variable name/value pairs
Line: 151 to 151
 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

Added:
>
>
-- MikeMannix? - 02 Oct 2001

TWikiMetaData 7 - 16 Sep 2001 - Main.MikeMannix
Line: 1 to 1
 
META TOPICPARENT name="WebHome"

TWiki Meta Data

Changed:
<
<
Topic data not editable from main freeform text box, stored in name/value META variable pairs
>
>
Additional topic data, not editable from main freeform text box, stored in META variable name/value pairs
 

Overview


TWikiMetaData 6 - 14 Sep 2001 - Main.PeterThoeny
Line: 1 to 1
 
META TOPICPARENT name="WebHome"
Deleted:
<
<

<-- template: messages.nat.tmpl -->
Warning: Can't find topic TWiki.UtilTempDocNote
 

Line: 11 to 9
 

Overview

Changed:
<
<
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 Form Template 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

Changed:
<
<
  • Format is the same as in TWikiVariables, 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).
Line: 26 to 24
 
Example of Format
Changed:
<
<
>
>

 %META:TOPICINFO{version="1.6" date="976762663" author="PeterThoeny" format="1.0"}% text of the topic
Changed:
<
<
%META:TOPICMOVED{from="Codev.OldName" to="CoDev.NewName"
>
>
%META:TOPICMOVED{from="Codev.OldName" to="Codev.NewName"
  by="JohnTalintyre" date="976762680"}% %META:TOPICPARENT{name="NavigationByTopicContext"}% %META:FILEATTACHMENT{name="Sample.txt" version="1.3" ... }%
Line: 37 to 35
 %META:FORM{name="WebFormTemplate"}% %META:FIELD{name="OperatingSystem" value="OsWin"}% %META:FIELD{name="TopicClassification" value="PublicFAQ"}%
Changed:
<
<
>
>
 
Changed:
<
<

Specifications

>
>

Meta Data Specifications

 The current version of Meta Data is 1.0, with support for the following variables.
Changed:
<
<

TOPICINFO

>
>

META:TOPICINFO

 
Key Comment
version Same as RCS version
Line: 52 to 50
 
author last to change topic, is the REMOTE_USER
format Format of this topic, will be used for automatic format conversion
Changed:
<
<

TOPICMOVED

>
>

META:TOPICMOVED

 
Changed:
<
<
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.
 
Changed:
<
<
%META:TOPICMOVED{from="Codev.OldName" to="CoDev.NewName" by="talintj" date="976762680"}%
>
>
%META:TOPICMOVED{from="Codev.OldName" to="Codev.NewName" by="talintj" date="976762680"}%
 
Key Comment
from Full name i.e. web.topic
Line: 68 to 66
 
  • 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.

Changed:
<
<

TOPICPARENT

>
>

META:TOPICPARENT

 
Key Comment
name The topic from which this was created, WebHome 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.
Changed:
<
<

FILEATTACHMENT

>
>

META:FILEATTACHMENT

 
Key Comment
name Name of file, no path. Must be unique within topic
Line: 87 to 85
 Extra fields that are added if an attachment is moved:
Added:
>
>
Key Comment
 
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
Changed:
<
<

FORM

>
>

META:FORM

 
Key Comment
Changed:
<
<
name A topic name - the topic is a Form Template. Can optionally include the web name i.e. web.topic, but doesn't normally
>
>
name A topic name - the topic represents one of the TWikiForms. Can optionally include the web name i.e. web.topic, but doesn't normally
 
Changed:
<
<

FIELD

>
>

META:FIELD

 
Changed:
<
<
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.
 
Key Name
Changed:
<
<
name Ties to entry in Form Template, is title with all bar alphanumerics and . removed
title Full text from Form Template
>
>
name Ties to entry in TWikiForms template, is title with all bar alphanumerics and . removed
title Full text from TWikiForms template
 
value Value user has supplied via form

Recommended Sequence

Line: 115 to 114
 The recommended sequence is:
Changed:
<
<
  • TOPICINFO
>
>
  • META:TOPICINFO
 
  • text of topic
Changed:
<
<
  • 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

Line: 135 to 134
 Current support covers:

Variable usage: Comment:
Changed:
<
<
%META{"form"}% Show form data, see Form Templates
>
>
%META{"form"}% Show form data, see TWikiForms
 
%META{"attachments"}% Show attachments, exclude hidden
Options for Attachments:  
all="on" Show ALL attachments (including hidden)
Line: 145 to 144
 
dontrecurse="on" By default recurses up tree, at some cost
prefix="..." Prefix for parents, only if there are parents; default ""
suffix="..." Suffix, only appears if there are parents; default ""
Changed:
<
<
seperator="..." Separator between parents, default is " > "

  • 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.
>
>
separator="..." Separator between parents, default is " > "
 

Known Issues


TWikiMetaData 5 - 12 Sep 2001 - Main.MikeMannix
Line: 1 to 1
 
META TOPICPARENT name="WebHome"
Added:
>
>

<-- template: messages.nat.tmpl -->
Warning: Can't find topic TWiki.UtilTempDocNote
 


Revision 9r9 - 03 Dec 2001 - 12:53:00 - MikeMannix?
Revision 8r8 - 02 Oct 2001 - 07:38:10 - MikeMannix?
Revision 7r7 - 16 Sep 2001 - 05:57:08 - MikeMannix?
Revision 6r6 - 14 Sep 2001 - 09:11:10 - PeterThoeny?
Revision 5r5 - 12 Sep 2001 - 06:56:27 - MikeMannix?
Revision 4r4 - 08 Sep 2001 - 14:30:25 - MikeMannix?
This site is powered by the TWiki collaboration platform.
All material on this collaboration platform is the property of the contributing authors.
All material marked as authored by Eben Moglen is available under the license terms CC-BY-SA version 4.
Syndicate this site RSSATOM