Difference between revisions of "ReferenceWMLSyntax"

From The Battle for Wesnoth Wiki
(I hope this falls under wiki syntax - added notes for WML version control)
(Reorganized page, added category)
Line 1: Line 1:
 
== Wiki Syntax ==
 
== Wiki Syntax ==
 +
 +
==== Formatting ====
  
 
This page is an example of how these wikis should be formatted:
 
This page is an example of how these wikis should be formatted:
Line 17: Line 19:
 
  key2=value
 
  key2=value
  
== Reminders ==
+
==== Version Control ====
  
 
For WML features not present in the 1.0 branch, please precede the reference text with the template <nowiki>{{DevFeature}}</nowiki>.  Doing this will use the standardized "development version only WML" flag.
 
For WML features not present in the 1.0 branch, please precede the reference text with the template <nowiki>{{DevFeature}}</nowiki>.  Doing this will use the standardized "development version only WML" flag.
Line 24: Line 26:
  
 
The <nowiki>{{DevFeature}}</nowiki> code turns into this: {{DevFeature}} (dynamically updated from the template page [[Template:DevFeature]])
 
The <nowiki>{{DevFeature}}</nowiki> code turns into this: {{DevFeature}} (dynamically updated from the template page [[Template:DevFeature]])
 +
 +
==== Categorization ====
 +
 +
WML reference pages should be placed into the category "WML reference."  This allows someone to easily bring up all the WML-related pages at once.
 +
 +
To do this, add the text <nowiki>[[Category: WML Reference]]</nowiki> at the bottom of the page under the "See Also" section.
  
 
== See Also ==
 
== See Also ==
  
 
* [[ReferenceWML]]
 
* [[ReferenceWML]]
 +
 +
[[Category: WML Reference]]

Revision as of 05:02, 29 January 2006

Wiki Syntax

Formatting

This page is an example of how these wikis should be formatted:

Description of the page

  • [tag] description of [tag]
    • key description of key.

"key" can refer either to the key key or the value of key

  • key2 description of key2
    • 'value' what happens when the attribute key2=value is set

Example:

[tag]
key=0
[/tag]
key2=value

Version Control

For WML features not present in the 1.0 branch, please precede the reference text with the template {{DevFeature}}. Doing this will use the standardized "development version only WML" flag.

Please do not delete WML reference text that is valid for version 1.0 if a new feature obsoletes, deprecates, or replaces it. Just put the new reference text beneath it and mark it with {{DevFeature}}.

The {{DevFeature}} code turns into this: Template:DevFeature (dynamically updated from the template page Template:DevFeature)

Categorization

WML reference pages should be placed into the category "WML reference." This allows someone to easily bring up all the WML-related pages at once.

To do this, add the text [[Category: WML Reference]] at the bottom of the page under the "See Also" section.

See Also