ConventionsWML - Revision history

Shadowm: Update links to macro-reference.html

2021-08-24T08:16:20Z

Update links to macro-reference.html

← Older revision		Revision as of 08:16, 24 August 2021
Line 10:		Line 10:
	Using macros is useful for decreasing the size of a file,		Using macros is useful for decreasing the size of a file,
	and for making it clear that you are doing the same thing several times.		and for making it clear that you are doing the same thing several times.
	It is economical to use '''[~~http~~://www.wesnoth.org/macro-reference.~~xhtml~~ macros from the standard library]''' rather than writing your own whenever you can, but don't hesitate to write your own when the standard library does not do what you need.		It is economical to use '''[https://www.wesnoth.org/macro-reference.html macros from the standard library]''' rather than writing your own whenever you can, but don't hesitate to write your own when the standard library does not do what you need.

	A good rule for when to write a macro is to use them whenever information or code is being duplicated and all the duplications might have to be changed in the same way later. For information on how to create and use macros, see [[PreprocessorRef]].		A good rule for when to write a macro is to use them whenever information or code is being duplicated and all the duplications might have to be changed in the same way later. For information on how to create and use macros, see [[PreprocessorRef]].

Kernigh: /* WML variables */ Wesnoth does not accept 1 or 0 as boolean values.

2012-06-06T18:25:56Z

WML variables: Wesnoth does not accept 1 or 0 as boolean values.

← Older revision		Revision as of 18:25, 6 June 2012
Line 57:		Line 57:
	clear meaningless variables using [clear_variable].		clear meaningless variables using [clear_variable].

	For variable values, use 'yes' and 'no' for boolean values		For variable values, use 'yes' and 'no' for boolean values. (Wesnoth does not accept 1 or 0 as boolean values; see [[ConditionalActionsWML#Boolean Values]].
	~~rather than~~ 1 ~~and~~ 0.
	~~It's clearer to people who don't know programming~~.

	== See Also ==		== See Also ==

ShikadiQueen: /* Indentation */ Include #undef and #ifndef in the rules

2009-02-05T02:37:20Z

Indentation: Include #undef and #ifndef in the rules

← Older revision		Revision as of 02:37, 5 February 2009
Line 25:		Line 25:
	# Indent each level with '''4 spaces'''.		# Indent each level with '''4 spaces'''.
	# Indent attributes a level deeper than their parent tag.		# Indent attributes a level deeper than their parent tag.
	# Indent macros as though the <tt>#define/#enddef</tt> are an outermost level; that is, the macro body starts with one level of indenting.		# Indent macros as though the <tt>#define/#enddef</tt> are an outermost level; that is, the macro body starts with one level of indenting. Same applies to <tt>#undef</tt>.
	# Don't indent <tt>#ifdef</tt>/<tt>#else</tt>/<tt>#endif</tt> at all		# Don't indent <tt>#ifdef</tt>/<tt>#ifndef</tt>/<tt>#else</tt>/<tt>#endif</tt> at all
	# Indent comments at the same level as the text they go with.		# Indent comments at the same level as the text they go with.

Sapient: /* Naming files */

2008-12-07T07:06:16Z

Naming files

← Older revision		Revision as of 07:06, 7 December 2008
Line 42:		Line 42:
	name the files after the IDs, not the names.		name the files after the IDs, not the names.
	That way it is easier to tell which scenario is next.		That way it is easier to tell which scenario is next.

			On some systems, filenames are case-sensitive. This means that if the ID has capital or lowercase letters, then the files must have identical capital or lowercase letters.

	Use the scenario number and an underscore as a name prefix of your scenario files, and if you have more than 9 of these put 0 at the beginning of single-digit numbers. This will make them list in order, which is convenient for people trying to read your campaign.		Use the scenario number and an underscore as a name prefix of your scenario files, and if you have more than 9 of these put 0 at the beginning of single-digit numbers. This will make them list in order, which is convenient for people trying to read your campaign.

Sapient: /* Indentation */

2008-12-07T07:01:49Z

Indentation

← Older revision		Revision as of 07:01, 7 December 2008
Line 31:		Line 31:
	When in doubt, run <tt>wmlindent</tt> on your code. See [[Maintenance tools]] for more description of this program.		When in doubt, run <tt>wmlindent</tt> on your code. See [[Maintenance tools]] for more description of this program.

	Note: Although 4 spaces is the mainline style, there's absolutely ''nothing'' wrong with tabs either. Those of you who prefer a ~~simple~~ Notepad program should not feel compelled to use spacebar and/or delete key four times the necessary amount when you can simply use tabs. In any case, it is very easy to convert these ~~things~~, so don't be scared to use your preferred method of indentation when working with WML. The important thing is that your code is uniformly indented, nested to the proper level, and using a form of whitespace that is easy for you to read, work with, and debug.		:'''Note:''' Although 4 spaces is the mainline style, there's absolutely ''nothing'' wrong with tabs either. Those of you who prefer a simpler Notepad program should not feel compelled to use spacebar and/or delete key four times the necessary amount when you can simply use tabs. In any case, it is very easy to convert these to the standard convention using <tt>wmlindent</tt>, so don't be scared to use your preferred method of indentation when working with WML. The most important thing to keep in mind is that your code should be uniformly indented, nested to the proper level, and using a form of whitespace that is easy for you to read, work with, and debug.

	== Naming files ==		== Naming files ==

Sapient: /* Indentation */

2008-12-07T06:57:25Z

Indentation

← Older revision		Revision as of 06:57, 7 December 2008
Line 30:		Line 30:

	When in doubt, run <tt>wmlindent</tt> on your code. See [[Maintenance tools]] for more description of this program.		When in doubt, run <tt>wmlindent</tt> on your code. See [[Maintenance tools]] for more description of this program.

			Note: Although 4 spaces is the mainline style, there's absolutely ''nothing'' wrong with tabs either. Those of you who prefer a simple Notepad program should not feel compelled to use spacebar and/or delete key four times the necessary amount when you can simply use tabs. In any case, it is very easy to convert these things, so don't be scared to use your preferred method of indentation when working with WML. The important thing is that your code is uniformly indented, nested to the proper level, and using a form of whitespace that is easy for you to read, work with, and debug.

	== Naming files ==		== Naming files ==

Sapient: remove false information

2008-12-07T06:46:23Z

remove false information

← Older revision		Revision as of 06:46, 7 December 2008
Line 30:		Line 30:

	When in doubt, run <tt>wmlindent</tt> on your code. See [[Maintenance tools]] for more description of this program.		When in doubt, run <tt>wmlindent</tt> on your code. See [[Maintenance tools]] for more description of this program.

	Note: Please do '''not''' insert tabs in WML code! Editor and viewer programs do not handle tabs in a uniform way; it has been found by experience, especially in the land of Python, that this leads to all manner of annoyances for maintainers further down the road.

	== Naming files ==		== Naming files ==

Xonev: /* Naming files */

2008-03-25T17:48:15Z

Naming files

← Older revision		Revision as of 17:48, 25 March 2008
Line 45:		Line 45:
	Use the scenario number and an underscore as a name prefix of your scenario files, and if you have more than 9 of these put 0 at the beginning of single-digit numbers. This will make them list in order, which is convenient for people trying to read your campaign.		Use the scenario number and an underscore as a name prefix of your scenario files, and if you have more than 9 of these put 0 at the beginning of single-digit numbers. This will make them list in order, which is convenient for people trying to read your campaign.

	While many campaigns use the same sort of number prefixing for their map files, it's better not to if (as ~~somethimes~~ happens) your campaign needs to use the same map twice.		While many campaigns use the same sort of number prefixing for their map files, it's better not to if (as sometimes happens) your campaign needs to use the same map twice.

	== WML variables ==		== WML variables ==

Xonev: /* Use wmlscope, wmllint, and wmlindent */

2008-03-25T17:00:23Z

Use wmlscope, wmllint, and wmlindent

← Older revision		Revision as of 17:00, 25 March 2008
Line 4:		Line 4:
	== Use wmlscope, wmllint, and wmlindent ==		== Use wmlscope, wmllint, and wmlindent ==

	The WML [[Maintenance_tools\|~~maintainance~~ tools]] will help you ensure that your WML is clean, up-to-date, and correct. Use them early and often; they will save you a lot of trouble later by catching entire classes of WML bugs before a user can ever see them.		The WML [[Maintenance_tools\|maintenance tools]] will help you ensure that your WML is clean, up-to-date, and correct. Use them early and often; they will save you a lot of trouble later by catching entire classes of WML bugs before a user can ever see them.

	== Macros ==		== Macros ==

Aethaeryn: /* Macros */ bolding link because it is important

2008-03-09T19:10:22Z

Macros: bolding link because it is important

← Older revision		Revision as of 19:10, 9 March 2008
Line 10:		Line 10:
	Using macros is useful for decreasing the size of a file,		Using macros is useful for decreasing the size of a file,
	and for making it clear that you are doing the same thing several times.		and for making it clear that you are doing the same thing several times.
	It is economical to use [http://www.wesnoth.org/macro-reference.xhtml macros from the standard library] rather than writing your own whenever you can, but don't hesitate to write your own when the standard library does not do what you need.		It is economical to use '''[http://www.wesnoth.org/macro-reference.xhtml macros from the standard library]''' rather than writing your own whenever you can, but don't hesitate to write your own when the standard library does not do what you need.

	A good rule for when to write a macro is to use them whenever information or code is being duplicated and all the duplications might have to be changed in the same way later. For information on how to create and use macros, see [[PreprocessorRef]].		A good rule for when to write a macro is to use them whenever information or code is being duplicated and all the duplications might have to be changed in the same way later. For information on how to create and use macros, see [[PreprocessorRef]].