HelpWML - Revision history

Bssarkar: Info about help special symbols

2025-08-07T09:16:59Z

Info about help special symbols

← Older revision		Revision as of 09:16, 7 August 2025
Line 19:		Line 19:
	** '''title''': (translatable) is the title of the topic. It is displayed in the left menu and as a header in the text area.		** '''title''': (translatable) is the title of the topic. It is displayed in the left menu and as a header in the text area.
	** '''text''': (translatable) is the contents of the topics. May contain markup described below.		** '''text''': (translatable) is the contents of the topics. May contain markup described below.

			== Topic Symbols ==
			Internally, the Help subsystem identifies certain topics/section by the following symbols:

			* <code>.</code> Hidden topics are prefixed by a dot (.)
			* <code>..</code> Sections (help topics that contain other topics) are prefixed by two dots (..)
			* <code>+</code> Collapsed sections
			* <code>-</code> Expanded sections

			Some of these can be seen by turning on the help logdomain: <code>--log-debug=help</code>.

	== Help System Topic Markup ==		== Help System Topic Markup ==

	For the markup used in the Help topics themselves, see [[Help_markup~~#Help_Markup_.28Pre_1.19.29~~\|Help Markup ~~(Pre-1.19)~~]].		For the markup used in the Help topics themselves, see [[Help_markup\|Help Markup]].

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

Bssarkar: /* Help System Topic Markup */ Move into to Help Markup main page + link

2025-08-07T09:06:04Z

Help System Topic Markup: Move into to Help Markup main page + link

@@ Line 22: / Line 22: @@
 == Help System Topic Markup ==
-The markup that is allowed in the text key within a topic tag is in a WML-like markup language with angle brackets.
+For the markup used in the Help topics themselves, see [[Help_markup#Help_Markup_.28Pre_1.19.29|Help Markup (Pre-1.19)]].
 == See Also ==

Shiki: /* See Also */ link to help markup

2025-04-25T21:52:52Z

Celtic Minstrel: /* Help System Topic Markup */ Add more anchors that can be linked to

2024-02-27T05:57:51Z

Help System Topic Markup: Add more anchors that can be linked to

Celtic Minstrel: /* The toplevel [help] tag */ Add anchors that can be linked to

2024-02-27T05:56:13Z

The toplevel [help] tag: Add anchors that can be linked to

Josteph: /* Help System Topic Markup */

2019-08-31T01:51:39Z

Help System Topic Markup

← Older revision		Revision as of 01:51, 31 August 2019
Line 26:		Line 26:
	It consists of plain text, interrupted with markup tags. Between paired start and end tags (like '''<jump> ... </jump>''') you can give keys and values like in WML, separated by spaces instead of newlines. For values containing spaces, surround them with single quotes. The "text content" of a tag, if any, is usually given by a ''text'' key. You can't nest tags within another tag.		It consists of plain text, interrupted with markup tags. Between paired start and end tags (like '''<jump> ... </jump>''') you can give keys and values like in WML, separated by spaces instead of newlines. For values containing spaces, surround them with single quotes. The "text content" of a tag, if any, is usually given by a ''text'' key. You can't nest tags within another tag.

	The following key/tags are accepted inside '''text''':		The following key/tags are accepted inside '''text''' ([https://github.com/wesnoth/wesnoth/blob/c09c58a8c8892d5f8392de48520a4f1b0ae1f35f/src/help/help_text_area.cpp#L126-L139 source]):
	* '''<ref>''': creates a cross reference to another topic, a cross reference will not show up if the topic it refers to is not visible.		* '''<ref>''': creates a cross reference to another topic, a cross reference will not show up if the topic it refers to is not visible.
	** '''dst''': the ID of the topic to reference.		** '''dst''': the ID of the topic to reference.

Josteph: /* Help System Topic Markup */ Fix mediawiki syntax error

2019-08-31T01:50:48Z

Help System Topic Markup: Fix mediawiki syntax error

← Older revision		Revision as of 01:50, 31 August 2019
Line 27:		Line 27:

	The following key/tags are accepted inside '''text''':		The following key/tags are accepted inside '''text''':
	* '''<ref>''': creates a cross reference to another topic, a cross reference will not show up if the topic it refers to is not visible.		* '''<ref>''': creates a cross reference to another topic, a cross reference will not show up if the topic it refers to is not visible.
	** '''dst''': the ID of the topic to reference.		** '''dst''': the ID of the topic to reference.
	** '''text''': the text to display as a link to '''dst'''; i.e. when '''text''' is clicked on the page '''dst''' will be linked to.		** '''text''': the text to display as a link to '''dst'''; i.e. when '''text''' is clicked on the page '''dst''' will be linked to.

Celtic Minstrel: /* Help System Topic Markup */ Syntax hiliting

2018-02-27T06:47:19Z

Help System Topic Markup: Syntax hiliting

← Older revision		Revision as of 06:47, 27 February 2018
Line 49:		Line 49:

	Example:		Example:
	[help]		<syntaxhighlight lang=wml>
	[toplevel]		[help]
	sections=introduction,gameplay		[toplevel]
	topics=about		sections=introduction,gameplay
	[/toplevel]		topics=about
	[section]		[/toplevel]
	id=gameplay		[section]
	sections=combat		id=gameplay
	topics=income_and_upkeep,time_of_day,terrain,victory_and_defeat		sections=combat
	[/section]		topics=income_and_upkeep,time_of_day,terrain,victory_and_defeat
	[topic]		[/section]
	id=terrain		[topic]
	title=Terrain		id=terrain
	text="<ref>dst=income_and_upkeep text='Link to Income and Upkeep topic'</ref>"		title=Terrain
	[/topic]		text="<ref>dst=income_and_upkeep text='Link to Income and Upkeep topic'</ref>"
	[topic]		[/topic]
	id=victory_and_defeat		[topic]
	title= _ "Victory and Defeat"		id=victory_and_defeat
	text= _ "Pay careful attention to the <bold>text='Objectives'</bold> pop-up		title= _ "Victory and Defeat"
	box at the beginning of each scenario. Usually you will achieve		text= _ "Pay careful attention to the <bold>text='Objectives'</bold> pop-up
	victory by killing all enemy leaders, and only be defeated by having		box at the beginning of each scenario. Usually you will achieve
	your leader killed. But scenarios may have other victory objectives		victory by killing all enemy leaders, and only be defeated by having
	— getting your leader to a designated point, say, or rescuing someone,		your leader killed. But scenarios may have other victory objectives
	or solving a puzzle, or holding out against a siege until a certain		— getting your leader to a designated point, say, or rescuing someone,
	number of turns have elapsed." + _"		or solving a puzzle, or holding out against a siege until a certain
			number of turns have elapsed." + _"
	When you win a scenario, the map grays over and the
	<bold>text='End Turn'</bold> button changes to		When you win a scenario, the map grays over and the
	<bold>text='End Scenario'</bold>. You can now do things like changing		<bold>text='End Turn'</bold> button changes to
	your save options or (if you are in a multiplayer game) chatting with		<bold>text='End Scenario'</bold>. You can now do things like changing
	other players before pressing that button to advance."		your save options or (if you are in a multiplayer game) chatting with
			other players before pressing that button to advance."
	[/topic]
	[/help]		[/topic]
			[/help]
			</syntaxhighlight>

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

Paŭlo: /* Help System Topic Markup */ clarified a bit more.

2011-01-15T22:25:54Z

Help System Topic Markup: clarified a bit more.

← Older revision		Revision as of 22:25, 15 January 2011
Line 24:		Line 24:
	The markup that is allowed in the text key within a topic tag is in a WML-like markup language with angle brackets.		The markup that is allowed in the text key within a topic tag is in a WML-like markup language with angle brackets.

	It consists of plain text, interrupted with markup tags. Between ~~the~~ tags you can give keys and values like in WML, separated by spaces instead of newlines. For values containing spaces, surround them with single quotes.		It consists of plain text, interrupted with markup tags. Between paired start and end tags (like '''<jump> ... </jump>''') you can give keys and values like in WML, separated by spaces instead of newlines. For values containing spaces, surround them with single quotes. The "text content" of a tag, if any, is usually given by a ''text'' key. You can't nest tags within another tag.

	The following key/tags are accepted inside '''text''':		The following key/tags are accepted inside '''text''':

Paŭlo: /* Help System Topic Markup */ better description (I hope), one more topic example (from current trunk help.cfg)

2011-01-15T22:10:52Z

Help System Topic Markup: better description (I hope), one more topic example (from current trunk help.cfg)

← Older revision		Revision as of 22:10, 15 January 2011
Line 22:		Line 22:
	== Help System Topic Markup ==		== Help System Topic Markup ==

	The markup that is allowed in the text key within a topic tag is in ~~XML,~~ a ~~markup language similar to~~ WML~~. Note that this is the only time that~~ markup language ~~is used as a value~~. ~~To convert WML into XML, you need to make some changes:~~		The markup that is allowed in the text key within a topic tag is in a WML-like markup language with angle brackets.

	~~- change brackets ('''['''~~, ~~''']''') into angle brackets('''<'''~~, ~~'''>''')~~		It consists of plain text, interrupted with markup tags. Between the tags you can give keys and values like in WML, separated by spaces instead of newlines. For values containing spaces, surround them with single quotes.

	~~- change '''newline''' into space(''' ''')~~		The following key/tags are accepted inside '''text''':
			* '''<ref>''': creates a cross reference to another topic, a cross reference will not show up if the topic it refers to is not visible.
	~~- all values with spaces must be in quotes. This is because spaces are actually newlines.~~

	~~Due to limitations of the wiki (it is coded using XML), the WML for the topic markup will be described rather than~~
	~~the XML. However, you still need to use XML to code the topic.~~

	The following key/tags are accepted ~~for~~ '''text''':
	* '''[ref]''': creates a cross reference to another topic, a cross reference will not show up if the topic it refers to is not visible.
	** '''dst''': the ID of the topic to reference.		** '''dst''': the ID of the topic to reference.
	** '''text''': the text to display as a link to '''dst'''; i.e. when '''text''' is clicked on the page '''dst''' will be linked to.		** '''text''': the text to display as a link to '''dst'''; i.e. when '''text''' is clicked on the page '''dst''' will be linked to.
	** '''force''': shows the cross reference even though the referred topic is not shown.		** '''force''': shows the cross reference even though the referred topic is not shown.
	* '''[jump]''': when this text is selected, the input position along the X axis is moved. Can be used for example to create columns of things. A jump is ignored if it would bring the input position to an invalid position.		* '''<jump>''': when this text is selected, the input position along the X axis is moved. Can be used for example to create columns of things. A jump is ignored if it would bring the input position to an invalid position.
	** '''to''': the X coordinate of the text area to jump to. If it can't be done on the current row, the input position is moved down one line.		** '''to''': the X coordinate of the text area to jump to. If it can't be done on the current row, the input position is moved down one line.
	** '''amount''': the number of pixels to jump forward		** '''amount''': the number of pixels to jump forward
	* '''[img]''': insert an image in the topic		* '''<img>''': insert an image in the topic
	** '''src''': the path to the image relative to the '''images/''' directory.		** '''src''': the path to the image relative to the '''images/''' directory.
	** '''align''': the position of the image with respect to the page. Values are '''here''', '''left''', '''middle''', and '''right'''.		** '''align''': the position of the image with respect to the page. Values are '''here''', '''left''', '''middle''', and '''right'''.
	** '''float''': whether the image should float(have text filled in around it) or not (be seen as included in a line).		** '''float''': whether the image should float(have text filled in around it) or not (be seen as included in a line).
	* '''[format]''': describes a group of text in a different format. Can be used to describe different colors and font sizes.		* '''<format>''': describes a group of text in a different format. Can be used to describe different colors and font sizes.
	** '''bold''': whether the text should be displayed in bold('''bold''').		** '''bold''': whether the text should be displayed in bold('''bold''').
	** '''italic''': whether the text should be displayed in italics(''italics'').		** '''italic''': whether the text should be displayed in italics(''italics'').
Line 51:		Line 44:
	** '''font_size''': the height of the text in pixels. Default 9(?)		** '''font_size''': the height of the text in pixels. Default 9(?)
	** '''text''': the text to be displayed using this format.		** '''text''': the text to be displayed using this format.
	* '''[italic]''': a shortcut to '''[format]''' which inputs only the '''text''' key. Uses the attribute '''italic=yes'''		* '''<italic>''': a shortcut to '''<format>''' which inputs only the '''text''' key. Uses the attribute '''italic=yes'''
	* '''[bold]''': like [italic], but uses '''bold=yes'''		* '''<bold>''': like <italic>, but uses '''bold=yes'''
	* '''[header]''': like [italic], but uses both the attributes '''bold=yes''' and '''font_size=13'''(?)		* '''<header>''': like <italic>, but uses both the attributes '''bold=yes''' and '''font_size=13'''(?)

	Example:		Example:
	[help]		[help]
	[toplevel]		[toplevel]
	sections=introduction,gameplay		sections=introduction,gameplay
	topics=about		topics=about
	[/toplevel]		[/toplevel]
	[section]		[section]
	id=gameplay		id=gameplay
	sections=combat		sections=combat
	topics=income_and_upkeep,time_of_day,terrain		topics=income_and_upkeep,time_of_day,terrain,victory_and_defeat
	[/section]		[/section]
	[topic]		[topic]
	id=terrain		id=terrain
	title=Terrain		title=Terrain
	text="<ref>dst=income_and_upkeep text='Link to Income and Upkeep topic'</ref>"		text="<ref>dst=income_and_upkeep text='Link to Income and Upkeep topic'</ref>"
	[/topic]		[/topic]
			[topic]
			id=victory_and_defeat
			title= _ "Victory and Defeat"
			text= _ "Pay careful attention to the <bold>text='Objectives'</bold> pop-up
			box at the beginning of each scenario. Usually you will achieve
			victory by killing all enemy leaders, and only be defeated by having
			your leader killed. But scenarios may have other victory objectives
			— getting your leader to a designated point, say, or rescuing someone,
			or solving a puzzle, or holding out against a siege until a certain
			number of turns have elapsed." + _"

			When you win a scenario, the map grays over and the
			<bold>text='End Turn'</bold> button changes to
			<bold>text='End Scenario'</bold>. You can now do things like changing
			your save options or (if you are in a multiplayer game) chatting with
			other players before pressing that button to advance."

			[/topic]
	[/help]		[/help]

← Older revision		Revision as of 21:52, 25 April 2025
Line 89:		Line 89:

	* [[ReferenceWML]]		* [[ReferenceWML]]
			* [[Help_Markup\|Help Markup]]

	[[Category: WML Reference]]		[[Category: WML Reference]]

← Older revision		Revision as of 05:57, 27 February 2024
Line 27:		Line 27:

	The following key/tags are accepted inside '''text''' ([https://github.com/wesnoth/wesnoth/blob/c09c58a8c8892d5f8392de48520a4f1b0ae1f35f/src/help/help_text_area.cpp#L126-L139 source]):		The following key/tags are accepted inside '''text''' ([https://github.com/wesnoth/wesnoth/blob/c09c58a8c8892d5f8392de48520a4f1b0ae1f35f/src/help/help_text_area.cpp#L126-L139 source]):
	* '''<ref>''': creates a cross reference to another topic, a cross reference will not show up if the topic it refers to is not visible.		* {{anchor\|ref\|'''<ref>'''}}: creates a cross reference to another topic, a cross reference will not show up if the topic it refers to is not visible.
	** '''dst''': the ID of the topic to reference.		** '''dst''': the ID of the topic to reference.
	** '''text''': the text to display as a link to '''dst'''; i.e. when '''text''' is clicked on the page '''dst''' will be linked to.		** '''text''': the text to display as a link to '''dst'''; i.e. when '''text''' is clicked on the page '''dst''' will be linked to.
	** '''force''': shows the cross reference even though the referred topic is not shown.		** '''force''': shows the cross reference even though the referred topic is not shown.
	* '''<jump>''': when this text is selected, the input position along the X axis is moved. Can be used for example to create columns of things. A jump is ignored if it would bring the input position to an invalid position.		* {{anchor\|jump\|'''<jump>'''}}: when this text is selected, the input position along the X axis is moved. Can be used for example to create columns of things. A jump is ignored if it would bring the input position to an invalid position.
	** '''to''': the X coordinate of the text area to jump to. If it can't be done on the current row, the input position is moved down one line.		** '''to''': the X coordinate of the text area to jump to. If it can't be done on the current row, the input position is moved down one line.
	** '''amount''': the number of pixels to jump forward		** '''amount''': the number of pixels to jump forward
	* '''<img>''': insert an image in the topic		* {{anchor\|img\|'''<img>'''}}: insert an image in the topic
	** '''src''': the path to the image relative to the '''images/''' directory.		** '''src''': the path to the image relative to the '''images/''' directory.
	** '''align''': the position of the image with respect to the page. Values are '''here''', '''left''', '''middle''', and '''right'''.		** '''align''': the position of the image with respect to the page. Values are '''here''', '''left''', '''middle''', and '''right'''.
	** '''float''': whether the image should float(have text filled in around it) or not (be seen as included in a line).		** '''float''': whether the image should float(have text filled in around it) or not (be seen as included in a line).
	* '''<format>''': describes a group of text in a different format. Can be used to describe different colors and font sizes.		* {{anchor\|format\|'''<format>'''}}: describes a group of text in a different format. Can be used to describe different colors and font sizes.
	** '''bold''': whether the text should be displayed in bold('''bold''').		** '''bold''': whether the text should be displayed in bold('''bold''').
	** '''italic''': whether the text should be displayed in italics(''italics'').		** '''italic''': whether the text should be displayed in italics(''italics'').
Line 44:		Line 44:
	** '''font_size''': the height of the text in pixels. Default 9(?)		** '''font_size''': the height of the text in pixels. Default 9(?)
	** '''text''': the text to be displayed using this format.		** '''text''': the text to be displayed using this format.
	* '''<italic>''': a shortcut to '''<format>''' which inputs only the '''text''' key. Uses the attribute '''italic=yes'''		* {{anchor\|italic\|'''<italic>'''}}: a shortcut to '''<format>''' which inputs only the '''text''' key. Uses the attribute '''italic=yes'''
	* '''<bold>''': like <italic>, but uses '''bold=yes'''		* {{anchor\|bold\|'''<bold>'''}}: like <italic>, but uses '''bold=yes'''
	* '''<header>''': like <italic>, but uses both the attributes '''bold=yes''' and '''font_size=13'''(?)		* {{anchor\|header\|'''<header>'''}}: like <italic>, but uses both the attributes '''bold=yes''' and '''font_size=13'''(?)

	Example:		Example:

← Older revision		Revision as of 05:56, 27 February 2024
Line 5:		Line 5:
	Each of the three subtags [toplevel], [section] and [topic] describe an element of the help system.		Each of the three subtags [toplevel], [section] and [topic] describe an element of the help system.

	* '''[toplevel]''': The toplevel tag denotes sections and topics that should be shown immediately when the "Help" button is clicked on (see the "help" action, [[ThemeWML]]). The sections referenced within this tag are read recursively, including all subsections.		* {{anchor\|toplevel\|'''[toplevel]'''}}: The toplevel tag denotes sections and topics that should be shown immediately when the "Help" button is clicked on (see the "help" action, [[ThemeWML]]). The sections referenced within this tag are read recursively, including all subsections.
	** '''sections''': a list of IDs of the sections to include recursively.		** '''sections''': a list of IDs of the sections to include recursively.
	** '''topics''': a list of IDs of the topics to show as not being included in a section; i.e. top-level topics.		** '''topics''': a list of IDs of the topics to show as not being included in a section; i.e. top-level topics.
	* '''[section]''': The section tag describes a section in the help browser. A section contains subsections and/or topics.		* {{anchor\|section\|'''[section]'''}}: The section tag describes a section in the help browser. A section contains subsections and/or topics.
	** '''id''': is the unique ID for this section.		** '''id''': is the unique ID for this section.
	** '''title''': (translatable) is the title of the section. It is displayed in the left menu.		** '''title''': (translatable) is the title of the section. It is displayed in the left menu.
Line 15:		Line 15:
	** '''generator''': provides the name of a function that will generate a list of topics and include them in this section. These topics will be included after topics listed on the '''topics''' key unless ''sort_topics'' is ''yes''.		** '''generator''': provides the name of a function that will generate a list of topics and include them in this section. These topics will be included after topics listed on the '''topics''' key unless ''sort_topics'' is ''yes''.
	** '''sort_topics''': specifies whether or not to list the topics sorted by title or in the order listed on the '''topics''' key. '''yes''' indicates fixed and generated topics should be sorted together by title. '''no''' indicates that topics should appear in the order listed with fixed topics appearing before generated topics. '''generated''' indicates that fixed topics should not be sorted and will be followed by generated topics sorted by the generator. The default is '''generated'''.		** '''sort_topics''': specifies whether or not to list the topics sorted by title or in the order listed on the '''topics''' key. '''yes''' indicates fixed and generated topics should be sorted together by title. '''no''' indicates that topics should appear in the order listed with fixed topics appearing before generated topics. '''generated''' indicates that fixed topics should not be sorted and will be followed by generated topics sorted by the generator. The default is '''generated'''.
	* '''[topic]''': The topic tag describes one topic, i.e, one help page. The keys that are meaningful in the topic tag:		* {{anchor\|topic\|'''[topic]'''}}: The topic tag describes one topic, i.e, one help page. The keys that are meaningful in the topic tag:
	** '''id''': is the unique ID for this topic.		** '''id''': is the unique ID for this topic.
	** '''title''': (translatable) is the title of the topic. It is displayed in the left menu and as a header in the text area.		** '''title''': (translatable) is the title of the topic. It is displayed in the left menu and as a header in the text area.