Содержание toc.xml

Формат файла с описанием содержания:

<root>
    <toc-root topic="topicId">
        <toc topic="topicId|mask" title="TitleToc" type="auto|files|plain">
            <toc topic="topicId|mask" title="TitleToc" type="auto|files|plain">
                ...
            </toc>
            ...
            <include toc="path/to/toc.xml"/>
            ...
        </toc>
    </toc-root>
</root>

На верхнем уровне указывается узел toc-root, определяющий корень содержания. Его атрибут topic должен указывать на статью с главной страницей документации.

Дочерний узел toc определяет элемент содержания и может содержать свои дочерние узлы toc.

Атрибуты узла toc:

• topic - id статьи (или файл статьи). Может быть относительным (начинатся с '.'), тогда рассматривается относительно папки с родительским элементом содержания, если он есть. иначе - относительно расположения файла toc.xml Может отсутствовать, тогда элемент содержания указывает на виртуальную статью без текста. Может содержать *, тогда рассматривается как маска, указывающая какие статьи должны попасть в это место содержания.
• title - заголовок статьи. Если указан, то заменяет заголовок статьи при генерации содержания. Если элемент содержания без статьи, то обязательно нужно указать title
• type - для элементов содержания с масками. Описывает алгоритм формирования элементов содержания:
  • auto - автоматическое содержание: каждая статья, попавшая под маску - элемент содержания. Если имя файла со статьей имеет имя index, то статья попадает в содержание с именем папки, в которой она находится. Заголовком элемента содержания становится заголовок статьи.
  • file - автоматическое содержание по файлам. Каждая статья, попавшая под маску - элемент содержания. Имя элемента содержания - имя файла статьи без расширения. Учитывается иерархия файлов. Используется для отладочных целей.
  • plain - как auto, только игнорируется иерархия.

Дочерний узел include предназначен для вставки другого файла toc.xml.

Атрибуты узла include:

• toc - виртуальный путь файла toc.xml относительно корня документации.