Метаданные файлов

В начале любого исходного файла может быть расположен блок с метаданными — свойствами, влияющими на обработку файла Собиракой. Такой блок должен быть заключён между двумя строками из трёх или более дефисов.

Метаданные также можно указывать в файлах навигации.

Пример #

Ниже показан пример исходного текста страницы с блоком метаданных.

Благодаря свойству permalink адрес страницы при сборке в HTML будет выглядеть как /setup.html вне зависимости от реального расположения исходного файла.

Благодаря свойству toc_title ссылка на эту страницу из оглавления будет выглядеть как «Установка», несмотря на полный заголовок «Установка программы».

----------------------
permalink: /setup.html
toc_title: Установка
----------------------

# Установка программы

В этом разделе мы расскажем, как установить программу.

Общие свойства #

permalink: /setup/

Адрес, по которому страница будет доступна при сборке в HTML. Этот адрес заменяет собой адрес по умолчанию, который Собирака формирует на основе расположения и имени исходного файла (см. Управление именами выходных файлов). Этот адрес не влияет на иерархические связи между разделами и подразделами для оглавления.

В начале адреса обязательно должен быть слеш.

Если в конце адреса также стоит слеш, то страница будет сохранена в индексный файл внутри соответствующей директории (например: /setup/ → /setup/index.html), в противном случае к адресу просто будет добавлено расширение (например: /setup → /setup.html).

title #

toc_title: Установка программы

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

Это же название будет отображаться в оглавлении при отсутствии свойства toc_title.

Свойства для оглавлений #

Эти свойства влияют на отображение страницы в оглавлениях, генерируемых Собиракой.

toc_collapse #

toc_collapse: true

Если true, то при сборке в HTML список подразделов будет скрыт, пока пользователь не перейдёт в этот раздел.

Например, в документации Собираки это свойство включено для Справочника.

toc_title #

toc_title: Установка

Название страницы для отображения в оглавлении. Если не указано, то используется тот же заголовок, что и в title.

Например, в документации Собираки страница Поддержка HTML в Собираке отображается в оглавлении как просто «HTML».

Свойства для мультиязычных проектов #

Эти свойства предназначены только для мультиязычных проектов.

version #

version: 12.3

Версия страницы в формате ⟨MAJOR⟩.⟨MINOR⟩, где ⟨MAJOR⟩ и ⟨MINOR⟩ — целые числа. Используется для отслеживания актуальности переводов в мультиязычных проектах, см. Версионирование текста.

Обновление version должно происходить синхронно с обновлением содержимого страницы. Поэтому, чтобы минимизировать возможные ошибки, Собирака позволяет указывать version только в самом исходном файле, а не в файле навигации.