doctoc_lang_cmdref
ИМЯ
doctoc_lang_cmdref - справочник команд языка doctoc
Содержание
СВОДКА
comment plaintext
division_end
division_start text ?symfile?
include filename
item file text desc
lb
rb
toc_begin text title
toc_end
vset varname value
vset varname
ОПИСАНИЕ
В этом документе указаны имена и синтаксис всех команд, которые вместе образуют язык разметки doctoc версии 1. Поскольку этот документ предназначен для использования в качестве справочника, команды перечислены в алфавитном порядке, а их описания довольно кратки. Начинающим следует сначала прочитать гораздо менее формальное введение в язык doctoc.
Команды
-
comment plaintext
Разметка содержания. Текст аргумента помечается как комментарий, находящийся вне основного текста документа. В основном используется в произвольном тексте.
-
division_end
Структура содержания. Эта команда закрывает раздел, открытый предшествующей командой division_begin и ещё не закрытый.
-
division_start text ?symfile?
Структура содержания. Эта команда открывает раздел в содержании. Ей соответствует команда division_end. Вместе они позволяют пользователю задать дополнительную структуру содержания.
Название нового раздела задаётся аргументом text.
Если указан символический файл symfile, заголовок раздела должен содержать ссылку на указанный документ, если выходной формат поддерживает ссылки.
-
include filename
Шаблонизация. Содержимое указанного файла интерпретируется как текст на языке разметки doctoc и обрабатывается на месте команды включения. Разметка в файле должна быть самодостаточной. Команда разметки не может пересекать границы файлов.
-
item file text desc
Структура содержания. Эта команда добавляет в содержание отдельный элемент. Каждый такой элемент ссылается на документ. Документ указывается с помощью символического имени file. Аргумент text используется в качестве подписи ссылки, а аргумент desc содержит краткое описание документа.
Символические имена используются для сохранения возможности преобразования этого формата в любой выходной формат. Фактическое имя файла будет подставлено выбранным средством форматирования при преобразовании исходного документа. Для этого используется заданное средству форматирования соответствие символических имён фактическим.
-
lb
Текст. Команда заменяется левой квадратной скобкой. Используется в произвольном тексте. Нужна, чтобы левая квадратная скобка не интерпретировалась как начало команды разметки. Её можно использовать только в аргументах других команд разметки.
-
rb
Текст. Команда заменяется правой квадратной скобкой. Используется в произвольном тексте. Нужна, чтобы правая квадратная скобка не интерпретировалась как конец команды разметки. Её можно использовать только в аргументах других команд.
-
toc_begin text title
Структура документа. Команда для начала содержания. Аргументы — это метка для всей группы документов, на которые ссылается указатель (text), и общий заголовок указателя (title), без разметки.
Метка часто представляет собой название пакета (или расширения), к которому относятся документы.
-
toc_end
Структура документа. Команда для завершения содержания. Любое содержимое документа после этой команды считается ошибкой.
-
vset varname value
Шаблонизация. В этой форме команда задаёт указанной переменной документа значение value. Она не создаёт выходных данных, то есть заменяется пустой строкой.
-
vset varname
Шаблонизация. В этой форме команда заменяется значением указанной переменной документа.
Ошибки, идеи, отзывы
В этом документе и описываемом в нём пакете неизбежно могут содержаться ошибки и другие проблемы. Сообщайте о них в категории doctools в системе отслеживания ошибок Tcllib. Также сообщайте о любых идеях по улучшению пакета и/или документации.
Предлагая изменения кода, предоставляйте унифицированные различия, то есть результат выполнения diff -u.
Обратите также внимание: настоятельно рекомендуется прикладывать вложения, а не вставлять исправления непосредственно в текст. Вложения можно добавить, открыв форму Редактировать заявки сразу после её создания, а затем нажав крайнюю левую кнопку на панели дополнительной навигации.
СМ. ТАКЖЕ
doctoc_intro, doctoc_lang_faq, doctoc_lang_intro, doctoc_lang_syntax
КАТЕГОРИЯ
Инструменты документации
АВТОРСКИЕ ПРАВА
Авторское право © 2007 Andreas Kupries
