Difference: TWikiMetaData (17 vs. 18)
Revision 182005-03-27 - TWikiContributor
TWiki Meta DataAdditional topic data, program-generated or from TWikiForms, is stored inMETA variable name/value pairs
OverviewTWikiMetaData usesMETA 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 | |||||||||
| Changed: | |||||||||
| < < |
| ||||||||
| > > |
| ||||||||
| Changed: | |||||||||
| < < |
| ||||||||
| > > |
| ||||||||
| Changed: | |||||||||
| < < |
| ||||||||
| > > |
| ||||||||
| Changed: | |||||||||
| < < |
| ||||||||
| > > |
| ||||||||
Example of Format
| |||||||||
| Changed: | |||||||||
| < < | text of the topic | ||||||||
| > > | text of the topic | ||||||||
| %META:TOPICMOVED{from="Codev.OldName" to="Codev.NewName" | |||||||||
| Changed: | |||||||||
| < < | by="TopicMoverWikiName" date="976762680"}% | ||||||||
| > > | by="TopicMoverWikiName" 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 SpecificationsThe current version of Meta Data is 1.0, with support for the following variables.META:TOPICINFO | |||||||||
| Changed: | |||||||||
| < < |
| ||||||||
| > > |
| ||||||||
| |||||||||
| Changed: | |||||||||
| < < |
| ||||||||
| > > |
| ||||||||
META:TOPICMOVEDThis 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"}% | |||||||||
| Changed: | |||||||||
| < < |
| ||||||||
| > > |
| ||||||||
| |||||||||
| Changed: | |||||||||
| < < |
| ||||||||
| > > |
| ||||||||
| |||||||||
| Changed: | |||||||||
| < < |
| ||||||||
| > > |
| ||||||||
META:TOPICPARENT | |||||||||
| Changed: | |||||||||
| < < |
| ||||||||
| > > |
| ||||||||
META:FILEATTACHMENT | |||||||||
| Changed: | |||||||||
| < < |
| ||||||||
| > > |
| ||||||||
| |||||||||
| Changed: | |||||||||
| < < |
| ||||||||
| > > |
| ||||||||
| |||||||||
| Changed: | |||||||||
| < < |
| ||||||||
| > > |
| ||||||||
| Extra fields that are added if an attachment is moved: | |||||||||
| Changed: | |||||||||
| < < |
| ||||||||
| > > |
| ||||||||
| |||||||||
| Changed: | |||||||||
| < < |
| ||||||||
| > > |
| ||||||||
META:FORM | |||||||||
| Changed: | |||||||||
| < < |
| ||||||||
| > > |
| ||||||||
META:FIELDShould 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: | |||||||||
| < < |
| ||||||||
| > > |
| ||||||||
| The recommended sequence is: | |||||||||
| Changed: | |||||||||
| < < |
| ||||||||
| > > |
| ||||||||
Viewing Meta Data in Page SourceWhen viewing a topic theRaw Text link can be clicked to show the text of a topic (i.e., 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.
You can render form fields in topic text by using the FORMFIELD variable. Example:%FORMFIELD{"TopicClassification"}% | |||||||||
| Changed: | |||||||||
| < < | For details, see TWikiVariables#VarFORMFIELD. | ||||||||
| > > | For details, see VarFORMFIELD. | ||||||||
| Current support covers: | |||||||||
| Changed: | |||||||||
| < < |
| ||||||||
| > > |
| ||||||||
%META{"attachments"}% | Show attachments, except for hidden ones. Options: | |||||||||
| Changed: | |||||||||
| < < | all="on": Show all attachments, including hidden ones. | | ||||||||
| > > | all="on": Show all attachments, including hidden ones. | | ||||||||
%META{"parent"}% | Show topic parent. Options: | |||||||||
| Changed: | |||||||||
| < < | dontrecurse="on": By default recurses up tree, at some cost. nowebhome="on": Suppress WebHome. prefix="...": Prefix for parents, only if there are parents, default "". suffix="...": Suffix, only appears if there are parents, default "". separator="...": Separator between parents, default is " > ". | | ||||||||
| > > | dontrecurse="on": By default recurses up tree, at some cost. nowebhome="on": Suppress WebHome. prefix="...": Prefix for parents, only if there are parents, default "". suffix="...": Suffix, only appears if there are parents, default "". separator="...": Separator between parents, default is " > ". | | ||||||||
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.
Related Topics: DeveloperDocumentationCategory, UserDocumentationCategory
| |||||||||
View topic | History: r19 < r18 < r17 < r16 | More topic actions...
Copyright © by the contributing authors. All material on this collaboration platform is the property of the contributing authors. Ideas, requests, problems regarding KoreaCmsWiki? Send feedback
Note: Please contribute updates to this topic on TWiki.org at TWiki:TWiki.TWikiMetaData