| |
| META TOPICPARENT | name="WebHome" |
|---|
|
|
<
< |
<-- template: messages.nat.tmpl -->
Warning: Can't find topic TWiki.UtilTempDocNote
|
| |
|
| | Overview |
|
<
< | 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 |
|
<
< |
- 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).
|
| |
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" |
>
> | %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:FORM{name="WebFormTemplate"}%
%META:FIELD{name="OperatingSystem" value="OsWin"}%
%META:FIELD{name="TopicClassification" value="PublicFAQ"}% |
|
<
< | |
>
> | |
| | |
|
<
< | Specifications |
>
> | Meta Data Specifications |
| | The current version of Meta Data is 1.0, with support for the following variables. |
|
<
< | TOPICINFO |
>
> | META:TOPICINFO |
| |
|
| |
| author | last to change topic, is the REMOTE_USER |
| format | Format of this topic, will be used for automatic format conversion |
|
|
<
< | TOPICMOVED |
>
> | META: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. |
>
> | 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. |
| | |
|
<
< | %META:TOPICMOVED{from="Codev.OldName" to="CoDev.NewName" by="talintj" date="976762680"}% |
>
> | %META:TOPICMOVED{from="Codev.OldName" to="Codev.NewName" by="talintj" date="976762680"}% |
| |
|
| |
- 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 |
>
> | 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. |
|
|
<
< | FILEATTACHMENT |
>
> | META:FILEATTACHMENT |
| |
| Key | Comment |
|---|
| name | Name of file, no path. Must be unique within topic |
|
| | Extra fields 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 |
>
> | META:FORM |
| |
|
|
<
< |
| 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 |
|
| | |
|
<
< | FIELD |
>
> | META: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. |
>
> | 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. |
| |
|
|
<
< |
|
>
> |
| 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 |
| | The recommended sequence is: |
|
<
< | |
>
> | |
| | |
|
<
< |
- 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 |
| | Current support covers:
|
|
<
< |
|
>
> |
|
| |
| %META{"attachments"}% | Show attachments, exclude hidden |
| Options for Attachments: | |
| all="on" | Show ALL attachments (including hidden) |
|
| |
| 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 "" |
|
|
<
< |
| 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 |