DescriptionWML - Revision history

Celtic Minstrel: Swap the order so the new format is documented first

2023-07-25T00:01:20Z

Swap the order so the new format is documented first

@@ Line 1: / Line 1: @@
 {{WML Tags}}
 == Description texts ==
-{{DevFeature1.15|1}} '''Support for the image-icon plus text format in this section has been removed.  See the WML Format section further down on this page for the supported format.'''
+{{DevFeature1.15|1}} '''Support for the image-icon plus text format in this section has been removed. It is documented here only for the benefit of people who wish to port old add-ons to the new format, documented above.'''
 A description is a part of the value of a menu attribute.
@@ Line 74: / Line 86: @@
 [[User:Simons Mith|Simons Mith]] 20:16, 18 November 2011 (UTC)
 == See Also ==

Shadowm: Update links to macro-reference.html

2021-08-24T08:23:57Z

Update links to macro-reference.html

← Older revision		Revision as of 08:23, 24 August 2021
Line 25:		Line 25:
	";" + "&" + "units/elves-wood/elvish-champion.png~TC(1,magenta)" + "=" + _"Champion" + "=" + _"(hardest)"		";" + "&" + "units/elves-wood/elvish-champion.png~TC(1,magenta)" + "=" + _"Champion" + "=" + _"(hardest)"

	The utility macros (see the [~~http~~://www.wesnoth.org/macro-reference.~~xhtml~~#file:utils.cfg Macro Reference]) '''{MENU_IMG_TXT ''icon'' ''text''}'''		The utility macros (see the [https://www.wesnoth.org/macro-reference.html#file:utils.cfg Macro Reference]) '''{MENU_IMG_TXT ''icon'' ''text''}'''
	and '''{MENU_IMG_TXT2 ''icon'' ''text'' ''text-2''}'''		and '''{MENU_IMG_TXT2 ''icon'' ''text'' ''text-2''}'''
	can be used to create descriptions more easily. The above example would become:		can be used to create descriptions more easily. The above example would become:

Pentarctagon: /* Description texts */

2019-08-30T20:12:45Z

Description texts

← Older revision		Revision as of 20:12, 30 August 2019
Line 1:		Line 1:
	{{WML Tags}}		{{WML Tags}}
	== Description texts ==		== Description texts ==

			{{DevFeature1.15\|1}} '''Support for the image-icon plus text format in this section has been removed. See the WML Format section further down on this page for the supported format.'''

	A description is a part of the value of a menu attribute.		A description is a part of the value of a menu attribute.

Celtic Minstrel: Update links to bypass redirect

2019-03-10T14:56:33Z

Update links to bypass redirect

← Older revision		Revision as of 14:56, 10 March 2019
Line 3:		Line 3:

	A description is a part of the value of a menu attribute.		A description is a part of the value of a menu attribute.
	It represents a single option in the difficulty selection menu for a campaign, which consists of an image (called the ''icon'') followed by text. When appropriate, the icon should use [[~~ImagePathFunctionWML~~]] to replace any magenta with a team color.		It represents a single option in the difficulty selection menu for a campaign, which consists of an image (called the ''icon'') followed by text. When appropriate, the icon should use [[ImagePathFunctions]] to replace any magenta with a team color.

	The description tag uses a special format:		The description tag uses a special format:

Celtic Minstrel: Add new format

2015-10-01T18:34:31Z

Add new format

← Older revision		Revision as of 18:34, 1 October 2015
Line 72:		Line 72:

	[[User:Simons Mith\|Simons Mith]] 20:16, 18 November 2011 (UTC)		[[User:Simons Mith\|Simons Mith]] 20:16, 18 November 2011 (UTC)

			== WML Format ==

			{{DevFeature1.13\|2}}

			As of 1.13.2, the DescriptionWML format has changed to use WML tags. It goes in either a '''[difficulty]''' tag within '''[campaign]''' or an '''[option]''' tag within '''[message]''' and comprises the following attributes:

			* '''default''': If yes, this item is the default selection (assuming no other items also have default=yes).
			* '''image''': Optional path to an image file to display.
			* '''label''': Text to display in the first text column.
			* '''description''': Text to display in the second text column.

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

Vultraz: /* Description texts */

2014-03-16T05:42:59Z

Description texts

← Older revision		Revision as of 05:42, 16 March 2014
Line 23:		Line 23:
	";" + "&" + "units/elves-wood/elvish-champion.png~TC(1,magenta)" + "=" + _"Champion" + "=" + _"(hardest)"		";" + "&" + "units/elves-wood/elvish-champion.png~TC(1,magenta)" + "=" + _"Champion" + "=" + _"(hardest)"

	The utility macros (see [~~[UtilWML]~~]) '''{MENU_IMG_TXT ''icon'' ''text''}'''		The utility macros (see the [http://www.wesnoth.org/macro-reference.xhtml#file:utils.cfg Macro Reference]) '''{MENU_IMG_TXT ''icon'' ''text''}'''
	and '''{MENU_IMG_TXT2 ''icon'' ''text'' ''text-2''}'''		and '''{MENU_IMG_TXT2 ''icon'' ''text'' ''text-2''}'''
	can be used to create descriptions more easily. The above example would become:		can be used to create descriptions more easily. The above example would become:

Simons Mith: /* Alternative Description Implementation */

2011-11-18T21:39:20Z

Alternative Description Implementation

← Older revision		Revision as of 21:39, 18 November 2011
Line 63:		Line 63:
	#enddef		#enddef

	'''Note:''' The above example assumes three difficulty levels, which gives six difficulty entries - three for the pictures and three for the text. If you have more or fewer than three difficulty levels, make sure that the last entry does ''not'' have a trailing plus sign and that all the others do. Note also that the first image description ''doesn't'' start with a semicolon, whereas the second and subsequent ones do. Finally, only the default difficulty entry is marked with a * character.		'''Note:''' The above example assumes three difficulty levels, which gives six difficulty entries – three for the pictures and three for the text. If you have more or fewer than three difficulty levels, make sure that the last entry does ''not'' have a trailing plus sign and that all the others do. Note also that the first image description ''doesn't'' start with a semicolon, whereas the second and subsequent ones do. Finally, only the default difficulty entry is marked with a * character.

	If you set up your difficulty strings in this way you can then use a standard difficulty_descriptions tag that you will rarely need to alter. Note that this string does ''not'' contain any plus signs. You have to have them in the difficulty ratings strings instead to avoid upsetting the Wesnoth preprocessor:		If you set up your difficulty strings in this way you can then use a standard difficulty_descriptions tag that you will rarely need to alter. Note that this string does ''not'' contain any plus signs. You have to have them in the difficulty ratings strings instead to avoid upsetting the Wesnoth preprocessor:

Simons Mith: /* Alternative Description Implementation */

2011-11-18T21:38:32Z

Alternative Description Implementation

← Older revision		Revision as of 21:38, 18 November 2011
Line 63:		Line 63:
	#enddef		#enddef

	~~You~~ can then use a standard difficulty_descriptions tag that you will rarely need to alter. Note that this string does ''not'' contain any plus signs. You have to have them in the difficulty ratings ~~trings~~ instead to avoid upsetting the Wesnoth preprocessor:		'''Note:''' The above example assumes three difficulty levels, which gives six difficulty entries - three for the pictures and three for the text. If you have more or fewer than three difficulty levels, make sure that the last entry does ''not'' have a trailing plus sign and that all the others do. Note also that the first image description ''doesn't'' start with a semicolon, whereas the second and subsequent ones do. Finally, only the default difficulty entry is marked with a * character.

			If you set up your difficulty strings in this way you can then use a standard difficulty_descriptions tag that you will rarely need to alter. Note that this string does ''not'' contain any plus signs. You have to have them in the difficulty ratings strings instead to avoid upsetting the Wesnoth preprocessor:

	difficulty_descriptions={EASY_IMAGE}{EASY_TEXT}{NORMAL_IMAGE}{NORMAL_TEXT}{HARD_IMAGE}{HARD_TEXT}		difficulty_descriptions={EASY_IMAGE}{EASY_TEXT}{NORMAL_IMAGE}{NORMAL_TEXT}{HARD_IMAGE}{HARD_TEXT}

	~~'''Note:'''~~ The ~~above example assumes three difficulty levels, which gives six difficulty entries - three for the pictures and three for the text. If~~ you have more or fewer than three difficulty levels~~, make sure that the last entry does ''not'' have a trailing plus sign and that all the others do~~.		The only time you would need to alter this string is if you have more or fewer than three difficulty levels for your campaign.

	[[User:Simons Mith\|Simons Mith]] 20:16, 18 November 2011 (UTC)		[[User:Simons Mith\|Simons Mith]] 20:16, 18 November 2011 (UTC)

Simons Mith: /* Description texts */

2011-11-18T20:25:15Z

Description texts

← Older revision		Revision as of 20:25, 18 November 2011
Line 31:		Line 31:
	{MENU_IMG_TXT2 "units/elves-wood/elvish-champion.png~TC(1,magenta)" _"Champion" _"(hardest)"}		{MENU_IMG_TXT2 "units/elves-wood/elvish-champion.png~TC(1,magenta)" _"Champion" _"(hardest)"}

	~~----~~		====Alternative Description Implementation====

	For still greater clarity, I have the following suggestion:		For still greater clarity, I have the following suggestion:
Line 63:		Line 63:
	#enddef		#enddef

	You can then use a standard difficulty_descriptions tag that you will rarely need to alter:		You can then use a standard difficulty_descriptions tag that you will rarely need to alter. Note that this string does ''not'' contain any plus signs. You have to have them in the difficulty ratings trings instead to avoid upsetting the Wesnoth preprocessor:

	difficulty_descriptions={EASY_IMAGE}{EASY_TEXT}{NORMAL_IMAGE}{NORMAL_TEXT}{HARD_IMAGE}{HARD_TEXT}		difficulty_descriptions={EASY_IMAGE}{EASY_TEXT}{NORMAL_IMAGE}{NORMAL_TEXT}{HARD_IMAGE}{HARD_TEXT}

Simons Mith: /* Description texts */ A user was caught by a gotcha, so re-stressing a key point

2011-11-18T20:16:30Z

Description texts: A user was caught by a gotcha, so re-stressing a key point

← Older revision		Revision as of 20:16, 18 November 2011
Line 30:		Line 30:
	";*" + {MENU_IMG_TXT "units/elves-wood/elvish-hero.png~TC(1,magenta)" _"Hero"} + ";" +		";*" + {MENU_IMG_TXT "units/elves-wood/elvish-hero.png~TC(1,magenta)" _"Hero"} + ";" +
	{MENU_IMG_TXT2 "units/elves-wood/elvish-champion.png~TC(1,magenta)" _"Champion" _"(hardest)"}		{MENU_IMG_TXT2 "units/elves-wood/elvish-champion.png~TC(1,magenta)" _"Champion" _"(hardest)"}

	----		----

	For still greater clarity, I have the following suggestion:		For still greater clarity, I have the following suggestion:
	Before the start of the [campaign] tag, create a set of #define commands as follows:		Before the start of the [campaign] tag, create a set of #define commands as follows:
	# Image definitions		# Image definitions
	# NB Don't forget the trailing + symbols for all but the last entry		# NB Don't forget the trailing + symbols for all but the last entry.
	#define EASY_IMAGE		#define EASY_IMAGE
	"&units/elves-wood/elvish-fighter.png~TC(1,magenta)"+		"&units/elves-wood/elvish-fighter.png~TC(1,magenta)"+
Line 48:		Line 50:

	# Difficulty ratings		# Difficulty ratings
	#po: NB be sure to retain the = signs in the translated text		#po: NB be sure to retain the = signs in the translated text.
	#define EASY_TEXT		#define EASY_TEXT
	_"=Fighter=(easiest)"+		_"=Fighter=(easiest)"+
Line 65:		Line 67:
	difficulty_descriptions={EASY_IMAGE}{EASY_TEXT}{NORMAL_IMAGE}{NORMAL_TEXT}{HARD_IMAGE}{HARD_TEXT}		difficulty_descriptions={EASY_IMAGE}{EASY_TEXT}{NORMAL_IMAGE}{NORMAL_TEXT}{HARD_IMAGE}{HARD_TEXT}

	[[User:Simons Mith\|Simons Mith]] 04:08, 7 November 2011 (UTC)		'''Note:''' The above example assumes three difficulty levels, which gives six difficulty entries - three for the pictures and three for the text. If you have more or fewer than three difficulty levels, make sure that the last entry does ''not'' have a trailing plus sign and that all the others do.

			[[User:Simons Mith\|Simons Mith]] 20:16, 18 November 2011 (UTC)

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