Difference between revisions of "DevFeature"

From The Battle for Wesnoth Wiki
 
m (Explanation)
 
(17 intermediate revisions by 9 users not shown)
Line 1: Line 1:
=== Explanation ===
+
== Explanation ==
  
Items marked with the text {{DevFeature}} refer to WML features only available in the development version of the game.
+
Items marked with the text {{DevFeature1.15|0}} are features only available since version 1.15.0 of the game.
  
This wiki WML reference contains the current syntax for the 1.0 stable branch. However, the development version of the game is rapidly growing with new and exciting WML 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.
  
As they are added it is very important to mark which WML code pertains to 1.0 and which WML code pertains to the latest development feature.  Any item marked with this text should be considered to be valid for the latest development version. Sometimes the WML feature is only available in SVN trunk (i.e. it hasn't been released yet).  The only distinction we care about is whether it refers to 1.0 WML or >1.0 WML.
+
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:
 +
 
 +
<nowiki>{{DevFeature1.15|3}}</nowiki>
 +
   
 +
{{DevFeature1.15|3}}
 +
 
 +
== Previous DevFeature templates ==
 +
 
 +
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.
 +
 
 +
<!-- 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]]

Latest revision as of 08:45, 27 June 2024

Explanation

Items marked with the text (Version 1.15.0 and later only) are features only available since version 1.15.0 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 27 June 2024, at 08:45.