Difference between revisions of "DevFeature"

From The Battle for Wesnoth Wiki
(Add usage instructions)
(Update for 1.15)
 
(4 intermediate revisions by 2 users not shown)
Line 1: Line 1:
 
== Explanation ==
 
== 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.15|0}} 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.
 
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.
Line 7: Line 7:
 
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.
 
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.
+
If a specific version is specified (e.g. '''1.15.3'''), 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 ==
 
== Using DevFeature in documentation ==
  
The [[Template:DevFeature1.11]] template may be used in either of the following forms:
+
The [[Template:DevFeature1.15]] template may be used as follows:
  
'''Preferred (version) form:'''
+
  <nowiki>{{DevFeature1.15|3}}</nowiki>
  <nowiki>{{DevFeature1.11|5}}</nowiki>
 
 
   
 
   
  {{DevFeature1.11|5}}
+
  {{DevFeature1.15|3}}
 
 
'''Alternative (version-less) form:'''
 
<nowiki>{{DevFeature1.11}}</nowiki>
 
 
{{DevFeature1.11}}
 
  
 
== Previous DevFeature templates ==
 
== 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 <code><nowiki>{{DevFeature1.13}}</nowiki></code>. These features were created in the 1.13 series and are now in the stable 1.14 branch and all later versions.
  
This template indicates the history of the features and can be safely removed. Its uses are mainly leftover <code><nowiki>{{DevFeature}}</nowiki></code> and <code><nowiki>{{DevFeature1.9}}</nowiki></code> tags that haven't been removed yet.
+
<!-- Uncomment when we're ready to remove the pre-1.14 tags:
 +
This template indicates the history of the features and can be safely removed. Its uses are mainly leftover <code><nowiki>{{DevFeature1.13}}</nowiki></code> tags that haven't been removed yet:
 +
http://wiki.wesnoth.org/index.php?title=Special:WhatLinksHere/Template:DevFeature1.13
 +
-->
  
 
[[Category:Wesnoth Wiki]]
 
[[Category:Wesnoth Wiki]]

Latest revision as of 04:55, 2 August 2019

Explanation

Items marked with the text (Version 1.15.0 and later only) 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.15.3), 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.15 template may be used as follows:

{{DevFeature1.15|3}}

(Version 1.15.3 and later only)

Previous DevFeature templates

Some items are marked with {{DevFeature1.13}}. These features were created in the 1.13 series and are now in the stable 1.14 branch and all later versions.

This page was last edited on 2 August 2019, at 04:55.