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

ПРОГРАММА:

ИМЯ

a2x - менеджер цепочки инструментов для AsciiDoc (конвертирует текстовые файлы Asciidoc в другие файлы
форматы)

СИНТАКСИС

a2x [ДОПОЛНИТЕЛЬНЫЕ УСЛУГИ, НЕ ВКЛЮЧЕННЫЕ В ПАКЕТ] ИСХОДНЫЙ ФАЙЛ

ОПИСАНИЕ

Менеджер набора инструментов DocBook, который переводит текстовый файл AsciiDoc ИСХОДНЫЙ ФАЙЛ в PDF,
EPUB, DVI, PS, LaTeX, XHTML (одностраничный или по частям), справочная страница, справка HTML или простой текст
форматы с использованием аскиидок(1) и другие приложения (см. раздел РЕКВИЗИТЫ). ИСХОДНЫЙ ФАЙЛ
также быть файлом DocBook с расширением .xml.

ДОПОЛНИТЕЛЬНЫЕ УСЛУГИ, НЕ ВКЛЮЧЕННЫЕ В ПАКЕТ

-a --атрибут=АТРИБУТ
Поставьте аскиидок(1) значение атрибута (ярлык для --asciidoc-opts="-a АТРИБУТ" опция).
Эта опция может быть указана более одного раза.

--asciidoc-opts=ASCIIDOC_OPTS
дополнительный аскиидок(1) параметры. Эта опция может быть указана более одного раза.

--conf-файл=КОНФ_ФАЙЛ
Загрузите файл конфигурации. См. Раздел CONF FILES.

-Д, --destination-dir=DESTINATION_DIR
Выходной каталог. По умолчанию ИСХОДНЫЙ ФАЙЛ каталог. Эта опция применима только к
Форматы вывода на основе HTML (разбитый, EPUB, htmlhelp, xhtml).

-д, --doctype=DOCTYPE
Тип документа DocBook: гайд, справочная страница or книга. Тип документа по умолчанию: гайд
если формат не справочная страница (в этом случае по умолчанию справочная страница).

-б, - бэкэнд=НАЗАД
НАЗАД это имя установленного внутреннего плагина. Когда указана эта опция a2x
пытается загрузить имя файла a2x-backend.py из НАЗАД каталог плагинов Затем
преобразует ИСХОДНЫЙ ФАЙЛ к НАЗАД форматированный выходной файл с использованием глобальной функции
определяется в a2x-backend.py под названием to_BACKEND.

-ф, --формат=ФОРМАТ
Выходные форматы: разбитый, документация, дви, EPUB, htmlhelp, справочная страница, PDF (По умолчанию), ps,
текс, текст, xhtml. AsciiDoc a2x-формат значение атрибута установлено на ФОРМАТ.

-час, --Помогите
Вывести синтаксис командной строки и параметры программы на стандартный вывод.

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

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

-к, --хранилище-артефакты
Не удаляйте временные файлы сборки.

--рысь
Используйте рысь(1) для создания вывода в текстовом формате. По умолчанию используется w3m(1).

-Л, --no-xmlint
Не проверяйте вывод asciidoc с помощью xmlint(1).

--- epubcheck
Проверьте вывод EPUB с помощью epubcheck(1).

-н, --прогон, репетиция
Ничего не делайте, просто распечатайте то, что было бы сделано.

-р, --ресурс=RESOURCE_SPEC
Укажите ресурс. Эта опция может быть указана более одного раза. Увидеть РЕСУРСЫ
раздел для более подробной информации.

-м, --ресурс-манифест=ФАЙЛОВ
ФАЙЛОВ содержит список ресурсов (по одному в каждой строке). Манифест ФАЙЛОВ записи отформатированы
как --ресурс аргументы опции. Переменные среды и тильда домой
каталоги разрешены.

--таблица стилей=СТИЛЬ
Разделенный пробелами список имен одного или нескольких файлов таблицы стилей CSS, которые используются для стилизации
Вывод HTML, созданный таблицами стилей DocBook XSL. По умолчанию документ-xsl.css,
таблицы стилей обрабатываются в порядке списка. Таблицы стилей должны находиться в допустимом
расположение файла ресурсов. Применимо к форматам HTML: xhtml, EPUB, разбитый, htmlhelp
форматов.

-в, --подробный
Распечатайте рабочие данные на stderr. Второй -v опция применяет подробный вариант к
команды инструментальной цепочки.

--версия
Распечатать версию программы на стандартный вывод.

--xsltproc-opts=XSLTPROC_OPTS
дополнительный xsltproc(1) параметры. Эта опция может быть указана более одного раза.

--xsl-файл=XSL_ФАЙЛ
Заменить встроенную таблицу стилей XSL пользовательской таблицей стилей XSL XSL_ФАЙЛ.

--фоп
Используйте FOP для создания PDF-файлов. По умолчанию используется dblatex(1), --фоп вариант
неявно, если используется эта опция.

--fop-opts=ФОП_ОПТС
дополнительный фат(1) параметры. Если указана эта опция, FOP используется для создания PDF-файлов.
Эта опция может быть указана более одного раза.

--dblatex-opts=DBLATEX_OPTS
дополнительный dblatex(1) параметры. Эта опция может быть указана более одного раза.

- backend-opts=НАЗАДEND_OPTS
Параметры для внутреннего плагина, указанные в - бэкэнд вариант. Этот вариант может быть
указывалось более одного раза.

Параметры также можно установить в исходном файле AsciiDoc. Если ИСХОДНЫЙ ФАЙЛ содержит комментарий
строка, начинающаяся с // а2х: тогда остаток строки будет рассматриваться как a2x
параметры командной строки. Например:

// Параметры по умолчанию a2x.
// a2x: -dbook --epubcheck
// Подавить историю изменений в выводах dblatex.
// a2x: --dblatex-opts "-P latex.output.revhistory = 0"

· Параметры, охватывающие несколько таких строк комментариев, будут объединены.

· Между ведущими символами может быть ноль или более пробелов. // , так и а2х:.

· Параметры командной строки имеют приоритет над параметрами, установленными в исходном файле.

ВЫВОД FILES

Выходные файлы записываются в каталог, указанный в --destination-dir вариант. Если нет
--destination-dir опция установлена, выходные файлы записываются в ИСХОДНЫЙ ФАЙЛ каталог.

Выходные файлы имеют то же имя, что и ИСХОДНЫЙ ФАЙЛ но с соответствующим именем файла
расширение: .html для xhtml; .epub для EPUB; .hhp для htmlhelp; .pdf для PDF; .text для
текст, .xml для документация. По соглашению страницы руководства не имеют расширения .man (раздел страницы руководства
только номер). Имена каталогов HTML с фрагментами имеют расширение .chunked; фрагментированная HTML-справка
имена каталогов имеют расширение .htmlhelp.

Существующие файлы с такими же именами перезаписываются.

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

РЕСУРСЫ

Ресурсы - это файлы (обычно CSS и изображения), которые требуются для вывода на основе HTML.
(xhtml, EPUB, разбитый, htmlhelp форматы). a2x сканирует сгенерированные файлы HTML и строит
список необходимых файлов CSS и изображений. Могут быть указаны дополнительные файлы ресурсов
явно используя --ресурс опцию.

a2x выполняет поиск файлов ресурсов в следующих местах в следующем порядке:

1. ИСХОДНЫЙ ФАЙЛ каталог.

2. Каталоги ресурсов, указанные в --ресурс вариант (поиск выполняется рекурсивно).

3. Каталоги ресурсов, указанные в --ресурс-манифест вариант (поиск выполняется рекурсивно
в порядке их появления в файле манифеста).

4. Каталоги стоковых изображений и таблиц стилей в аскиидок(1) конфигурационные файлы
каталоги (поиск выполняется рекурсивно).

5. Каталог назначения.

Когда файл ресурсов найден, он копируется в правильный относительный каталог назначения.
Отсутствующие подкаталоги назначения создаются автоматически.

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

1. Каталог ресурсов, в котором будет выполняться рекурсивный поиск отсутствующих файлов ресурсов.

2. Файл ресурсов, который будет скопирован в выходной каталог назначения.

Ресурсы указаны с --ресурс значения параметров, которые могут быть одним из следующих
форматы:


знак равно ]
. знак равно

Где:


Задает каталог (абсолютный или относительно ИСХОДНЫЙ ФАЙЛ), который ищется
рекурсивно для отсутствующих файлов ресурсов. Чтобы устранить двусмысленность имя
должен заканчиваться символом-разделителем каталогов.


Задает файл ресурсов (абсолютный или относительно ИСХОДНЫЙ ФАЙЛ) которые будут
скопировано в . Если не указано, то это
так же, как .


Задает место назначения для скопированного исходного файла. В путь
относительно целевого каталога (абсолютные пути не допускаются). Местоположение
каталога назначения зависит от вывода ФОРМАТ (См ВЫВОД FILES
раздел для деталей):

фрагментировано, htmlhelp
Разделенный выходной каталог.

EPUB
Архивный каталог OEBPS.

xhtml
Выход DESTINATION_DIR.

. знак равно
При добавлении ресурсов в файлы EPUB тип mimetype определяется из
file> extension, если невозможно угадать mimetype, возникает ошибка. В
. знак равно синтаксис ресурсов может использоваться для явной установки mimetypes. является
расширение имени файла, соответствующий тип MIME.

Примеры вариантов ресурса:

--ресурс ../изображения/
--resource doc / README.txt = README.txt
--ресурс ~ / images / tiger.png= images / tiger.png
--resource .ttf = приложение / x-font-ttf

ПРИМЕРЫ

a2x -f PDF-документ / исходный-выделенный-фильтр.txt
Создает файл doc / source-highlight-filter.pdf.

a2x -f xhtml -D ../doc --icons -r ../images/team.txt
Создает HTML-файл ../doc/team.html, использует значки предупреждений и рекурсивно выполняет поиск
../images/ каталог для любых недостающих ресурсов.

a2x -f справочная страница doc / asciidoc.1.txt
Создайте справочную страницу doc / asciidoc.1.

РЕКВИЗИТЫ

a2x использует следующие программы:

· Аскид: http://asciidoc.org/

· xsltproc: (все форматы кроме текста): http://xmlsoft.org/XSLT/

· DocBook XSL Таблицы стилей (все форматы кроме текста):
http://docbook.sourceforge.net/projects/xsl/

· dblatex (форматы pdf, dvi, ps, tex): http://dblatex.sourceforge.net/

· ФОП (формат pdf - альтернативный генератор файлов PDF): http://xmlgraphics.apache.org/fop/

· w3m (текстовый формат): http://w3m.sourceforge.net/index.en.html

· рысь (текстовый формат - генератор альтернативного текстового файла): http://lynx.isc.org/

· epubcheck (формат epub - валидатор файлов EPUB): http://code.google.com/p/epubcheck/

См. Также последний файл README.

CONF FILES

Файл конфигурации содержит исполняемый код Python, который переопределяет глобальный
параметры конфигурации в a2x.py. Дополнительные файлы конфигурации загружаются в
в следующем порядке:

1. a2x.conf из каталога, содержащего a2x.py исполняемый файл.

2. a2x.conf из глобального каталога конфигурации AsciiDoc. Пропустите этот шаг, если мы
выполнение локально установленной (не общесистемной) копии.

3. a2x.conf из каталога конфигурации AsciiDoc $ HOME / .asciidoc.

4. КОНФ_ФАЙЛ указано в --conf-файл опцию.

Вот значения параметров файла конфигурации по умолчанию:

# Необязательный словарь переменных среды передается в
# выполнение программ. Если установлено значение Нет, существующие
# используется среда.
ENV = Нет

# Внешние исполняемые файлы.
ASCIIDOC = 'asciidoc'
XSLTPROC = 'xsltproc'
DBLATEX = 'dblatex' # создание pdf.
FOP = 'fop' # генерация pdf (опция --fop).
W3M = 'w3m' # генерация текста.
LYNX = 'lynx' # генерация текста (если нет w3m).
XMLLINT = 'xmllint' # Установите значение '', чтобы отключить.
EPUBCHECK = 'epubcheck' # Установите значение '', чтобы отключить.
# Параметры по умолчанию для внешнего исполняемого файла.
ASCIIDOC_OPTS = ''
DBLATEX_OPTS = ''
FOP_OPTS = ''
XSLTPROC_OPTS = ''

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