Difference between revisions of "DevFeature"
(Expand with explanation of the parametric form's implications, reformat some text, mention Lua too) |
(Add usage instructions) |
||
Line 1: | Line 1: | ||
− | + | == Explanation == | |
Items marked with the text {{DevFeature1.11}} are WML or Lua features only available in a development version of the game. | Items marked with the text {{DevFeature1.11}} are WML or Lua features only available in a development version of the game. | ||
Line 9: | Line 9: | ||
If a specific version is specified (e.g. '''1.11.5'''), that means the feature is known to be specifically available in that and later versions. For features recently implemented in the master branch of the repository, the version number may refer to a release that has not been published yet. | If a specific version is specified (e.g. '''1.11.5'''), that means the feature is known to be specifically available in that and later versions. For features recently implemented in the master branch of the repository, the version number may refer to a release that has not been published yet. | ||
− | === Previous | + | == Using DevFeature in documentation == |
+ | |||
+ | The [[Template:DevFeature1.11]] template may be used in either of the following forms: | ||
+ | |||
+ | '''Preferred (version) form:''' | ||
+ | <nowiki>{{DevFeature1.11|5}}</nowiki> | ||
+ | |||
+ | {{DevFeature1.11|5}} | ||
+ | |||
+ | '''Alternative (version-less) form:''' | ||
+ | <nowiki>{{DevFeature1.11}}</nowiki> | ||
+ | |||
+ | {{DevFeature1.11}} | ||
+ | |||
+ | == Previous DevFeature templates == | ||
Some items are marked with {{DevFeature}} or {{DevFeature1.9}}. These features were created in the 1.7/1.9 series and are now in the stable 1.10 branch and all later versions. | Some items are marked with {{DevFeature}} or {{DevFeature1.9}}. These features were created in the 1.7/1.9 series and are now in the stable 1.10 branch and all later versions. |
Revision as of 23:55, 2 January 2014
Explanation
Items marked with the text Template:DevFeature1.11 are WML or Lua features only available in a development version of the game.
This WML reference contains the current WML syntax and Lua API for the stable branch. However, the development version of the game is rapidly growing with new and exciting capabilities.
As new features are added, it is very important to track which ones pertain to the stable and development versions. Sometimes a feature is only available in the master branch of the Git repository (i.e. it hasn't been released yet), or sometimes it is a relatively mature addition.
If a specific version is specified (e.g. 1.11.5), that means the feature is known to be specifically available in that and later versions. For features recently implemented in the master branch of the repository, the version number may refer to a release that has not been published yet.
Using DevFeature in documentation
The Template:DevFeature1.11 template may be used in either of the following forms:
Preferred (version) form:
{{DevFeature1.11|5}} Template:DevFeature1.11
Alternative (version-less) form:
{{DevFeature1.11}} Template:DevFeature1.11
Previous DevFeature templates
Some items are marked with Template:DevFeature or Template:DevFeature1.9. These features were created in the 1.7/1.9 series and are now in the stable 1.10 branch and all later versions.
This template indicates the history of the features and can be safely removed. Its uses are mainly leftover {{DevFeature}}
and {{DevFeature1.9}}
tags that haven't been removed yet.