dtplite - Интернет в облаке

ПРОГРАММА:

ИМЯ

dtplite - облегченный процессор разметки DocTools

СИНТАКСИС

дтплит -o выходной ?параметры? формат входной_файл

дтплит подтверждать входной_файл

дтплит -o выходной ?параметры? формат входной каталог

дтплит -слияние -o выходной ?параметры? формат входной каталог

_________________________________________________________________________________________________

ОПИСАНИЕ

Приложение, описанное в этом документе, дтплит, является преемником чрезвычайно
декриминализовано mpрасширить. На его функциональность повлияли DTP doctools процессор много
более мощный, чем mpрасширить, но по-прежнему проста в использовании; определенно легче чем DTP с его
множество подкоманд и опций.

дтплит основан на пакете докторантуры, как и два других процессора.

ИСПОЛЬЗОВАНИЕ КЕЙСЫ
дтплит был написан с учетом следующих трех вариантов использования.

[1] Проверка отдельного документа, т. Е. Проверка того, что он был написан на действительной
формат doctools. Этот режим также можно использовать для получения предварительной версии
форматированный вывод для одного документа для отображения в браузере, nroff и т. д.,
позволяет корректировать форматирование.

[2] Генерация форматированной документации для одного пакета, т.е. всех
manpages, а также оглавление и указатель ключевых слов.

[3] Расширение предыдущего режима работы, метод для простого создания
одно дерево документации для нескольких пакетов, а особенно единой таблицы
содержание и индекс ключевых слов.

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

Мы позволяем вызывающей стороне указывать строку заголовка, строку нижнего колонтитула, таблицу стилей и данные для
панель навигационных ссылок вверху сгенерированного документа. Хотя все можно установить как
пока механизм форматирования предоставляет соответствующий параметр механизма (см. раздел
ДОПОЛНИТЕЛЬНЫЕ ОПЦИИ) последние два имеют внутреннюю обработку, которая делает их специфичными для HTML.

КОМАНДА ЛИНИЯ
дтплит -o выходной ?параметры? формат входной_файл
Это форма для варианта использования [1]. В кредита будет объяснено позже, в разделе
ДОПОЛНИТЕЛЬНЫЕ ОПЦИИ.

путь выходной (в)
Этот аргумент указывает, куда записывать сгенерированный документ. Это может быть
путь к файлу или каталогу, или -. Последнее значение заставляет приложение
записать сгенерированный документированный в стандартный вывод.

Если же линия индикатора выходной не существует, то [имя_файла $ output] должно существовать и
должен быть доступным для записи каталогом. Сгенерированный документ будет записан в
файл в этом каталоге, и имя этого файла будет производным от
входной_файл, формат, а значение параметра -доб. (если имеется).

(путь | дескриптор) формат (в)
Этот аргумент указывает механизм форматирования, который будет использоваться при обработке
input, а значит, и формат сгенерированного документа. См. Раздел ФОРМАТЫ
для возможностей, распознаваемых приложением.

путь входной_файл (в)
Этот аргумент указывает путь к файлу для обработки. Он должен существовать,
должен быть читабельным и написан на докторантуры формат.

дтплит подтверждать входной_файл
Это более простая форма для варианта использования [1]. Формат «проверить» не дает никаких результатов.
вообще, выполняется только проверка синтаксиса. Как таковая спецификация вывода
файл или другие параметры не являются обязательными и не учитываются.

дтплит -o выходной ?параметры? формат входной каталог
Это форма для варианта использования [2]. Он отличается от формы для варианта использования [1] тем, что
наличие входных документов, указанных в каталоге, а не в файле. В
остальные аргументы идентичны, за исключением выходной, который теперь должен быть путем к
существующий и доступный для записи каталог.

Входные документы - это все файлы в входной каталог или любой из его подкаталогов
которые были признаны fileutil :: fileType как содержащий текст в докторантуры формат.

дтплит -слияние -o выходной ?параметры? формат входной каталог
Это форма для варианта использования [3]. Единственное отличие от формы для варианта использования [2]
это дополнительная опция -слияние.

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

ДОПОЛНИТЕЛЬНЫЕ ОПЦИИ
В этом разделе описаны все параметры, доступные пользователю приложения, с
исключение из вариантов -o и -слияние. Эти двое уже были описаны в разделе
КОМАНДА ЛИНИЯ.

-исключать string
Эта опция определяет шаблон исключения (glob). Любые файлы, идентифицированные как страницы руководства
для обработки, соответствующие шаблону исключения, игнорируются. Опция может быть предоставлена
несколько раз, при каждом использовании добавляется дополнительный шаблон в список исключений.

-доб. string
Если имя выходного файла должно быть производным от имени входного файла, оно
будет использовать имя формат как расширение по умолчанию. Этот вариант здесь будет
однако переопределить это, заставив его использовать string как расширение файла. Этот вариант
игнорируется, если имя выходного файла полностью указано с помощью опции -o.

При многократном использовании актуально только последнее определение.

-заголовок файл
Эта опция может быть использована тогда и только тогда, когда выбранный формат обеспечивает двигатель
параметр с именем «заголовок». Он берет содержимое указанного файла и назначает
их к этому параметру для любого использования движком. HTML-движок вставит
текст сразу после тега . Если кнопки навигации присутствуют (см. Опцию
-нав ниже), то сгенерированный для них HTML добавляется к данным заголовка.
происходит здесь до окончательного присвоения параметру.

При многократном использовании актуально только последнее определение.

-нижний колонтитул файл
Подобно -заголовок, за исключением: Любые кнопки навигации игнорируются, соответствующие
обязательный параметр движка называется "нижний колонтитул", и данные вставляются непосредственно перед
тег .

При многократном использовании актуально только последнее определение.

Стиль файл
Эта опция может быть использована тогда и только тогда, когда выбранный формат обеспечивает двигатель
параметр с именем «мета». Если указано, он будет генерировать фрагмент HTML-кода.
объявив файл в качестве таблицы стилей для сгенерированного документа и назначьте его
параметр. Механизм HTML вставит это в документ сразу после
день .

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

При многократном использовании актуально только последнее определение.

-ток путь
Этот параметр указывает файл документа, который будет использоваться для оглавления вместо
создание наших собственных.

При многократном использовании актуально только последнее определение.

-pre + toc путь метки | текст

-post + toc путь метки | текст
Этот параметр указывает дополнительные файлы (или тексты) документа для использования в навигации.
.

Позиционирование и обработка нескольких вариантов использования аналогичны параметрам -пренав и -постнав,
Смотри ниже.

-нав ярлык url

-пренав ярлык url
Используйте этот параметр, чтобы указать кнопку навигации с этикетка отображать и URL в
ссылка на. Эта опция может быть использована тогда и только тогда, когда выбранный формат обеспечивает
параметр двигателя с именем "заголовок". HTML-код, созданный для этого, добавляется к
какие данные мы получили от варианта -заголовок прежде, чем он будет вставлен в сгенерированный
документов.

При многократном использовании собираются все определения и отображается панель навигации.
создан, с первым определением, показанным на левом краю, и последним определением
направо.

URL-адрес может быть относительным. В этом случае предполагается, что он относится к основному
файлы (оглавление и индекс ключевых слов) и будут преобразованы, чтобы все остальные по-прежнему ссылались
должным образом.

-постнав ярлык url
Используйте этот параметр, чтобы указать кнопку навигации с этикетка отображать и URL в
ссылка на. Эта опция может быть использована тогда и только тогда, когда выбранный формат обеспечивает
параметр двигателя с именем "заголовок". HTML-код, созданный для этого, добавляется к
какие данные мы получили от варианта -заголовок прежде, чем он будет вставлен в сгенерированный
документов.

При многократном использовании собираются все определения и отображается панель навигации.
создан, с последним определением, показанным на правом краю, и первым определением
влево.

URL-адрес может быть относительным. В этом случае предполагается, что он относится к основному
файлы (оглавление и индекс ключевых слов) и будут преобразованы, чтобы все остальные по-прежнему ссылались
должным образом.

ФОРМАТЫ
Сначала формат аргумент будет рассматриваться как путь к tcl файлу, содержащему код
для запрошенного механизма форматирования. Аргумент будет рассматриваться как имя одного из
предварительно определенные форматы, перечисленные ниже, тогда и только тогда, когда путь не существует.

Внимание a ограничение: Если рассматривать формат как путь к сценарию tcl, реализующему
движок был успешным, то этот скрипт должен реализовывать не только API движка для
докторские, т.е. doctools_api, но для docto_api и docidx_api также. В противном случае
создание оглавления и индекса ключевых слов завершится ошибкой.

Список предопределенных форматов, т.е. предусмотренных пакетом докторантуры:

Nroff Процессор генерирует вывод * roff, стандартный формат для man-страниц unix.

HTML Процессор генерирует вывод HTML для использования и отображения в веб-браузерах. Этот
двигатель в настоящее время является единственным, обеспечивающим различные требуемые параметры двигателя
для дополнительной настройки вывода.

тммл Процессор генерирует вывод TMML, язык разметки Tcl Manpage, производный
XML.

латекс Процессор генерирует вывод LaTeX.

Вики Процессор создает разметку Wiki в понимании викит.

список Процессор извлекает информацию, предоставленную manpage_begin. Этот формат
используются внутри для извлечения метаданных, из которых оглавление и
индекс ключевого слова получены из.

нуль Процессор не генерирует никаких выходных данных. Это эквивалентно подтверждать.

СПРАВОЧНИК КОНСТРУКЦИИ
В этом разделе мы описываем структуры каталогов, сгенерированные приложением в
выходной при оформлении всех документов в входной каталог. Другими словами, это всего лишь
относится к вариантам использования [2] и [3].

[2] Следующая структура каталогов создается при обработке одного набора входных данных.
документы. Используемое расширение файла предназначено для вывода в HTML, но это не имеет значения.
к структуре и использовался только для правильных имен файлов.

выход/
toc.html
index.html
файлы /
путь / к / FOO.html

Последняя строка в примере показывает документ, созданный для файла FOO, расположенного в

входной каталог / путь / к / FOO

[3] При объединении множества пакетов в единый набор документов сгенерированный каталог
структура немного глубже:

выходной
.toc
.idx
.tocdoc
.idxdoc
.xrf
toc.html
index.html
FOO1 /
...
FOO2 /
toc.html
файлы /
путь / к / BAR.html

Каждый из каталогов FOO1, ... содержит документы, созданные для пакета.
FOO1, ... и следует структуре, показанной для варианта использования [2]. Единственное исключение -
что нет индекса для каждого пакета.

Файлы ".toc,.idxи.xrf"содержат внутренний статус целого
вывод и будет прочитан и обновлен при следующем вызове. Их содержание не будет
быть задокументированным. Удалите эти файлы, когда все пакеты, необходимые для вывода, будут
обрабатывается, т.е. когда вывод завершен.

Файлы ".tocdocи.idxdoc", являются промежуточными файлами в doctoc и docidx.
разметка, соответственно, содержащая основное оглавление и индекс ключевых слов для
набор документов перед их преобразованием в выбранный выходной формат. Они есть
оставлено на месте, то есть не удалено, чтобы служить демонстрацией doctoc и docidx
разметки.

Используйте dtplite онлайн с помощью сервисов onworks.net