<<O>>  Difference Topic MetaDataDefinition (r1.6 - 07 Sep 2001 - MikeMannix)

META TOPICPARENT WebHome
TOC: No TOC in "TWiki.MetaDataDefinition"

Changed:
<
<

TWiki Meta Data

>
>

TWiki Meta Data


Changed:
<
<

What is Meta Data in TWiki?

>
>

What is Meta Data in TWiki?


What, indeed!

Line: 15 to 15

Current version: 1.0

Changed:
<
<

Syntax

>
>

Syntax


  • Format is as for [[TWikiDocumentation#TWiki_Variables, except all fields have a key.
    • %META:<type>{key1="value1" [key2="value2" [...]]}%
Line: 39 to 39

Changed:
<
<

Specifications

>
>

Specifications


Changed:
<
<
TOPICINFO
>
>

TOPICINFO


Key Comment
version Same as RCS version
Line: 49 to 49

author last to change topic, is the REMOTE_USER
format Format of this topic, will be used for automatic format conversion
Changed:
<
<
TOPICMOVED
>
>

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.

Line: 65 to 65

  • 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
>
>

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
>
>

FILEATTACHMENT


Key Comment
name Name of file, no path. Must be unique within topic
Line: 89 to 89

movedto full topic name - web.topic
moveddate integer, unx time, seconds since start 1970
Changed:
<
<
FORM
>
>

FORM


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

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.

Line: 103 to 103

title Full text from Form Template
value Value user has supplied via form
Changed:
<
<

Recommended Sequence

>
>

Recommended Sequence


There no absolute need for meta data variables to be in a specific order, however, it does for the following reasons:

  • Keep (form) fields in the order they are defined
Line: 122 to 122

  • FORM - optional
  • FIELD - 0 or more entries (FORM required)
Changed:
<
<

Viewing Meta Data in Page Source

>
>

Viewing Meta Data in Page Source


When viewing a topic the Raw 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

Changed:
<
<

Future Support for Plugins

>
>

Future Support for Plugins


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 needs only minor alteration.

Changed:
<
<

Rendering Meta Data

>
>

Rendering Meta Data


Various types of meta data can be stored in topics. The data is rendered using the %META% variable. This is mostly used in the view, preview and edit scripts.

View topic | Diffs | r1.7 | > | r1.6 | > | r1.5 | More
Revision r1.5 - 31 Aug 2001 - 19:10 - MikeMannix
Revision r1.6 - 07 Sep 2001 - 06:09 - MikeMannix