HelpWML
From The Battle for Wesnoth Wiki
The toplevel [help] tag
The [help] tag describes the Wesnoth 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.
- 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.
- [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.
- title: (translatable) is the title of the section. It is displayed in the left menu.
- sections: is a list of IDs of the sections that should be this section's subsections.
- topics: is a list of IDs of the topics that should be included in this section. Topics will be included in the order listed unless sorting is requested.
- 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.
- [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.
- 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.
Topic Symbols
Internally, the Help subsystem identifies certain topics/section by the following symbols:
.
Hidden topics are prefixed by a dot (.)..
Sections (help topics that contain other topics) are prefixed by two dots (..)+
Collapsed sections-
Expanded sections
Some of these can be seen by turning on the help logdomain: --log-debug=help
.
Help System Topic Markup
For the markup used in the Help topics themselves, see Help Markup.
See Also
This page was last edited on 7 August 2025, at 09:16.