| |||||||||||||||||||
Deleted: | |||||||||||||||||||
< < | Warning: Can't find topic TWiki.UtilTempDocNote | ||||||||||||||||||
On this page:
TWiki Meta DataTopic data not editable from main freeform text box, stored in name/valueMETA variable 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 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: | |||||||||||||||||||
< < |
| ||||||||||||||||||
> > |
| ||||||||||||||||||
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" ... }% %META:FILEATTACHMENT{name="Smile.gif" version="1.1" ... }% %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 | ||||||||||||||||||
Changed: | |||||||||||||||||||
< < |
| ||||||||||||||||||
> > |
| ||||||||||||||||||
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"}% | ||||||||||||||||||
Changed: | |||||||||||||||||||
< < |
| ||||||||||||||||||
> > |
| ||||||||||||||||||
Notes:
| |||||||||||||||||||
Changed: | |||||||||||||||||||
< < | TOPICPARENT | ||||||||||||||||||
> > | META:TOPICPARENT | ||||||||||||||||||
Changed: | |||||||||||||||||||
< < |
| ||||||||||||||||||
> > |
| ||||||||||||||||||
| |||||||||||||||||||
Changed: | |||||||||||||||||||
< < | FILEATTACHMENT | ||||||||||||||||||
> > | META:FILEATTACHMENT | ||||||||||||||||||
Changed: | |||||||||||||||||||
< < |
| ||||||||||||||||||
> > |
| ||||||||||||||||||
| |||||||||||||||||||
Added: | |||||||||||||||||||
> > |
| ||||||||||||||||||
| |||||||||||||||||||
Changed: | |||||||||||||||||||
< < | FORM | ||||||||||||||||||
> > | META:FORM | ||||||||||||||||||
Changed: | |||||||||||||||||||
< < |
| ||||||||||||||||||
> > |
| ||||||||||||||||||
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. | ||||||||||||||||||
| |||||||||||||||||||
Changed: | |||||||||||||||||||
< < |
| ||||||||||||||||||
> > |
| ||||||||||||||||||
Recommended SequenceThere is no absolute need for Meta Data variables to be listed in a specific order within a topic, but it makes sense to do so a couple of good reasons:
| |||||||||||||||||||
Changed: | |||||||||||||||||||
< < |
| ||||||||||||||||||
> > |
| ||||||||||||||||||
| |||||||||||||||||||
Changed: | |||||||||||||||||||
< < |
| ||||||||||||||||||
> > |
| ||||||||||||||||||
Viewing Meta Data in Page SourceWhen viewing a topic theRaw 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
Rendering Meta DataMeta Data is rendered with the %META% variable. This is mostly used in theview , preview and edit scripts.
Current support covers:
| |||||||||||||||||||
Changed: | |||||||||||||||||||
< < |
| ||||||||||||||||||
> > |
| ||||||||||||||||||
| |||||||||||||||||||
Changed: | |||||||||||||||||||
< < |
| ||||||||||||||||||
> > |
| ||||||||||||||||||
Deleted: | |||||||||||||||||||
< < |
| ||||||||||||||||||
Known IssuesAt present, there is no Meta Data support for Plugins. However, the format is readily extendable and theMeta.pm code that supports the format needs only minor alteration.
-- JohnTalintyre - 29 Aug 2001 |