HelpWML

Материал из Wesnoth Life Wiki
Перейти к: навигация, поиск

< Данная статья еще недопереведена! Английский оригинал можно прочесть тут. >

Тег верхнего уровня [help]

Тег служит для описания справочной системы "Веснота". 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). Разделы, указанные в данным теге, считываются рекурсивно.
    • sections: Список разделов верхнего уровня (по id).
    • topics: Список статей верхнего уровня.
  • [section]: Описывает раздел справочника. Каждый раздел может содержать статьи и подразделы.
    • id: Уникальный идентификатор раздела.
    • title: Заголовок раздела, отображаемый в списке. Поддерживает локализацию.
    • sections: Список подразделов.
    • sections_generator
    • sort_sections
    • topics: Список статей, относящихся к данному разделу.
    • 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: Определяет, должны ли статьи упорядочиваться по алфавиту, или в порядке, указанном в topics.
      • yes: Фиксированные и генерируемые статьи сортируются вместе в алфавитном порядке.
      • 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.
  • [topic]: Описывает статью справочника (справочную страницу).
    • id: Уникальный идентификатор статьи.
    • title: Отображаемое название статьи. Поддерживает локализацию. Используется как для списка, так и заглавия текстовой области.
    • text: Содержимое статьи. Поддерживает локализацию и форматирование, которое описано ниже.


Разметка статей

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 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:

  • <ref>: Создает перекрестную ссылку на другую статью, a cross reference will not show up if the topic it refers to is not visible.
    • dst: Идентификатор целевой статьи.
    • text: Текст ссылки на dst; т.е. при клике на text открывается страница dst.
    • force: Указывает, что ссылка должна отображаться даже если целевая страница скрыта или отсутствует.
  • <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.
    • amount: the number of pixels to jump forward
  • <img>: Вставляет изображение.
    • src: Путь к файлу рисунка относительно папки images/.
    • align: Расположение рисунка на странице. Допустимые значения: here, left, middle, и right.
    • float: whether the image should float(have text filled in around it) or not (be seen as included in a line).
  • <format>: Вставляет текст в указанном формате.
    • bold: Жирный шрифт.
    • italic: Курсивный шрифт.
    • color: Цвет текста. В настоящее время поддерживаются только слежующие цвета: white (по умолчанию), green, red, yellow, и black.
    • font_size: Высота шрифта в пикселах (по умолчанию: 9?).
    • text: Текст, отображаемый с использованием данного форматирования.
  • <italic>: Ярлык на <format> с параметром italic=yes. Принимает только атрибут text.
  • <bold>: То же самое, но с параметром bold=yes вместо курсива.
  • <header>: То же самое, но с двумя параметрами — bold=yes и font_size=13(?)


Пример

[help]
  [toplevel]
    sections=introduction,gameplay
    topics=about
  [/toplevel]
  [section]
    id=gameplay
    sections=combat
    topics=income_and_upkeep,time_of_day,terrain,victory_and_defeat
  [/section]
  [topic]
    id=terrain
    title=Terrain
    text="<ref>dst=income_and_upkeep text='Link to Income and Upkeep topic'</ref>"
  [/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]


Смотрите также