diff options
| -rw-r--r-- | TWiki/MetaDataDefinition.mdwn | 28 |
1 files changed, 14 insertions, 14 deletions
diff --git a/TWiki/MetaDataDefinition.mdwn b/TWiki/MetaDataDefinition.mdwn index 0bd6dcd9..6c22e00d 100644 --- a/TWiki/MetaDataDefinition.mdwn +++ b/TWiki/MetaDataDefinition.mdwn @@ -1,8 +1,8 @@ %TOC% %STARTINCLUDE% <a name="MetaDataDefinition"></a> -## <a name="TWiki_Meta_Data"> TWiki Meta Data </a> +# <a name="TWiki_Meta_Data"> TWiki Meta Data </a> -### <a name="What_is_Meta_Data_in_TWiki_"> What is Meta Data in TWiki? </a> +## <a name="What_is_Meta_Data_in_TWiki_"> What is Meta Data in TWiki? </a> **_What, indeed!_** @@ -12,7 +12,7 @@ See Meta Data Rendering for variables used to display meta data. Current version: **1\.0** -#### <a name="Syntax"> Syntax </a> +### <a name="Syntax"> Syntax </a> * Format is as for \[[TWikiDocumentation#TWiki\_Variables, except all fields have a key. * %META:<type>\{key1="value1" [key2="value2" [...]]\}% @@ -33,9 +33,9 @@ Current version: **1\.0** > %<nop>META:FIELD{name="OperatingSystem" value="OsWin"}% > %<nop>META:FIELD{name="TopicClassification" value="PublicFAQ"}% -#### <a name="Specifications"> Specifications </a> +### <a name="Specifications"> Specifications </a> -##### <a name="TOPICINFO"> </a> TOPICINFO +#### <a name="TOPICINFO"> </a> TOPICINFO <table border="1" cellpadding="1" cellspacing="0"> <tr> @@ -60,7 +60,7 @@ Current version: **1\.0** </tr> </table> -##### <a name="TOPICMOVED"> </a> TOPICMOVED +#### <a name="TOPICMOVED"> </a> 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. @@ -94,7 +94,7 @@ Notes: * 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. -##### <a name="TOPICPARENT"> </a> TOPICPARENT +#### <a name="TOPICPARENT"> </a> TOPICPARENT <table border="1" cellpadding="1" cellspacing="0"> <tr> @@ -107,7 +107,7 @@ Notes: </tr> </table> -##### <a name="FILEATTACHMENT"> </a> FILEATTACHMENT +#### <a name="FILEATTACHMENT"> </a> FILEATTACHMENT <table border="1" cellpadding="1" cellspacing="0"> <tr> @@ -169,7 +169,7 @@ Extra field that are added if an attachment is moved: </tr> </table> -##### <a name="FORM"> </a> FORM +#### <a name="FORM"> </a> FORM <table border="1" cellpadding="1" cellspacing="0"> <tr> @@ -182,7 +182,7 @@ Extra field that are added if an attachment is moved: </tr> </table> -##### <a name="FIELD"> </a> FIELD +#### <a name="FIELD"> </a> 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. @@ -205,7 +205,7 @@ Should only be present if there is a FORM entry. Note that this data is used whe </tr> </table> -#### <a name="Recommended_Sequence"> Recommended Sequence </a> +### <a name="Recommended_Sequence"> Recommended Sequence </a> There no absolute need for meta data variables to be in a specific order, however, it does for the following reasons: @@ -227,17 +227,17 @@ So the order is: * FORM - optional * FIELD - 0 or more entries (FORM required) -#### <a name="Viewing_Meta_Data_in_Page_Source"> Viewing Meta Data in Page Source </a> +### <a name="Viewing_Meta_Data_in_Page_Source"> Viewing Meta Data in Page Source </a> When viewing a topic the <code>**Raw Text**</code> 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](%SCRIPTURLPATH%/view%SCRIPTSUFFIX%/%WEB%/%TOPIC%?raw=debug) -#### <a name="Future_Support_for_Plugins"> Future Support for Plugins </a> +### <a name="Future_Support_for_Plugins"> Future Support for Plugins </a> 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. <a name="MetaDataRendering"></a> -### <a name="Rendering_Meta_Data"> Rendering Meta Data </a> +## <a name="Rendering_Meta_Data"> Rendering Meta Data </a> Various types of meta data can be stored in topics. The data is rendered using the %META% variable. This is mostly used in the <code>**view**</code>, <code>**preview**</code> and <code>**edit**</code> scripts. |