Difference between revisions of "DescriptionWML"

From The Battle for Wesnoth Wiki
 
(updated formatting, and clarified the meaning of =)
Line 1: Line 1:
 +
== Description texts ==
 +
 
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 is used to represent a single option in the menu
+
It is used to represent a single option in the menu which consists of an image(called the ''icon'') followed by text.
which consists of an image(called the ''icon'') followed by text.
 
  
 
A description has the format
 
A description has the format
  
== ";"+ == if another description precedes it
+
* ''';''' if another description precedes it
  
== "*"+ == if it should be the default selection
+
* '''*''' if it should be the default selection
  
== "&"+"''image//"+"="+//texts''''' main description; different texts separated by '''+ ==
+
* '''&''image''=''text''''' image with text description
  
for example:
+
* '''&''image''=''text''=''text2''''' image with two text descriptions
  
difficulty_descriptions="&" + "elvish-fighter.png" + "=" + _"Fighter" + _"(easiest)" +
+
Single text items are always enclosed in '''"''', and concatenated with '''+'''. This is useful so the text can contain translateable items (the '''_''' before a text), and so it can span multiple lines.
";*" + "&" + "elvish-hero.png" + "=" + _"Hero" + ";" +
 
"&" + "elvish-champion.png" + _"Champion" + _"(hardest)"
 
  
The utility macros(see [[UtilWML]])
+
for example:
  
== {MENU_IMG_TXT ''icon'' ''text''} ==
+
difficulty_descriptions="&" + "elvish-fighter.png" + "=" + _"Fighter" + "=" + _"(easiest)" +
 
+
";*" + "&" + "elvish-hero.png" + "=" + _"Hero" +
== {MENU_IMG_TXT2 ''icon'' ''text'' ''text-2''} ==
+
";" + "&" + "elvish-champion.png" + "=" + _"Champion" + "=" + _"(hardest)"
  
 +
The utility macros (see [[UtilWML]]) '''{MENU_IMG_TXT ''icon'' ''text''}'''
 +
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:
  
Line 34: Line 35:
 
* [[EraWML]]
 
* [[EraWML]]
 
* [[ReferenceWML]]
 
* [[ReferenceWML]]
 

Revision as of 10:39, 29 August 2005

Description texts

A description is a part of the value of a menu attribute. It is used to represent a single option in the menu which consists of an image(called the icon) followed by text.

A description has the format

  • ; if another description precedes it
  • * if it should be the default selection
  • &image=text image with text description
  • &image=text=text2 image with two text descriptions

Single text items are always enclosed in ", and concatenated with +. This is useful so the text can contain translateable items (the _ before a text), and so it can span multiple lines.

for example:

difficulty_descriptions="&" + "elvish-fighter.png" + "=" + _"Fighter" + "=" + _"(easiest)" +
	";*" + "&" + "elvish-hero.png" + "=" + _"Hero" +
	";" + "&" + "elvish-champion.png" + "=" + _"Champion" + "=" + _"(hardest)"

The utility macros (see UtilWML) {MENU_IMG_TXT icon text} and {MENU_IMG_TXT2 icon text text-2} can be used to create descriptions more easily. The above example would become:

difficulty_descriptions={MENU_IMG_TXT2 "elvish-fighter.png" _"Fighter" _"(easiest)"} +
	";*" + {MENU_IMG_TXT "elvish-hero.png" _"Hero"} + ";" +
	{MENU_IMG_TXT2 "elvish-champion.png" _"Champion" _"(hardest)"}

See Also