a2x - онлайн у хмарі

ПРОГРАМА:

ІМ'Я

a2x - Менеджер ланцюга інструментів для AsciiDoc (перетворює текстові файли Asciidoc в інший файл
формати)

СИНТАКСИС

a2x [ВАРІАНТИ] ВИХІДНИЙ ФАЙЛ

ОПИС

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

ВАРІАНТИ

-а, --атрибут=АТРИБУТ
Установка asciodoc(1) значення атрибута (ярлик для --asciidoc-opts="-а АТРИБУТ" варіант).
Цей параметр можна вказати більше одного разу.

--asciidoc-opts=ASCIIDOC_OPTS
Додатковий asciodoc(1) варіанти. Цей параметр можна вказати більше одного разу.

--conf-файл=CONF_FILE
Завантажте файл конфігурації. Дивіться розділ КОНФ-ФАЙЛИ.

-Д, --пункт призначення-реж=DESTINATION_DIR
Вихідний каталог. За замовчуванням ВИХІДНИЙ ФАЙЛ каталог. Цей параметр застосовний лише до
Формати виведення на основі HTML (шматок, EPUB, htmlдовідка, xhtml).

-d, --doctype=DOCTYPE
Тип документа DocBook: стаття, man-сторінка or книга. Тип документа за замовчуванням стаття
хіба що формат man-сторінка (у цьому випадку за замовчуванням man-сторінка).

-б, --бекенд=НАЗАД
НАЗАД - це назва встановленого внутрішнього плагіна. Коли вказано цю опцію a2x
спроби завантажити ім’я файлу a2x-backend.py від НАЗАД тоді каталог плагінів
перетворює ВИХІДНИЙ ФАЙЛ до НАЗАД відформатований вихідний файл за допомогою глобальної функції
визначено в a2x-backend.py званий до_BACKEND.

-f, --формат=ФОРМАТ
Вихідні формати: шматок, книга документів, Двійки, EPUB, htmlдовідка, man-сторінка, PDF (За замовчуванням), ps,
tex, текст, xhtml. AsciiDoc формат a2x значення атрибута встановлено на ФОРМАТ.

-h, --допомога
Надрукуйте синтаксис командного рядка та параметри програми на стандартний вивід.

--значки
Використовуйте зображення значків попереджень або навігації у вихідних документах. Поведінка за замовчуванням
використовувати текст замість піктограм.

--icons-dir=PATH
Шлях (відносно вихідних файлів), що містить значки сповіщень та навігації. Значення за замовчуванням
до зображень/значків. The --значки Опція є неявною, якщо ця опція використовується.

-к, --keep-артефакти
Не видаляйте тимчасові файли збірки.

-- рись
Скористайтесь рись(1) для створення текстового форматованого виходу. Поведінка за замовчуванням – використовувати w3m(1).

-Л, --no-xmllint
Не перевіряйте вихід asciidoc за допомогою xmllint(1).

---перевірка epub
Перевірте вихід EPUB за допомогою epubcheck(1).

-n, --сушить
Не робіть нічого, просто роздрукуйте те, що було б зроблено.

-р, --ресурс=RESOURCE_SPEC
Вкажіть ресурс. Цей параметр можна вказати більше одного разу. Див РЕСУРСИ
розділ, щоб дізнатися більше.

-м, --маніфест ресурсу=Фото
Фото містить список ресурсів (по одному на рядок). Маніфест Фото записи відформатовані
так як --ресурс аргументи варіантів. Змінні середовища і будинок з тильди
каталоги дозволені.

--таблиця стилів=ТАБЛИЦЯ СТИЛІВ
Розмежований пробілом список одного або кількох імен файлів таблиць стилів CSS, які використовуються для стилізації
Вихід HTML, згенерований таблицями стилів DocBook XSL. За замовчуванням docbook-xsl.css,
таблиці стилів обробляються в порядку списку. Таблиці стилів повинні знаходитися в дійсному файлі
розташування файлу ресурсу. Застосовується до форматів HTML: xhtml, EPUB, шматок, htmlдовідка
форматах.

-v, -багатослівний
Надрукуйте оперативні відомості в stderr. Секунда -v параметр застосовує опцію багатослівного до
команди інструментарій.

-- версія
Роздрукувати версію програми на стандартний вивід.

--xsltproc-opts=XSLTPROC_OPTS
Додатковий xsltproc(1) варіанти. Цей параметр можна вказати більше одного разу.

--xsl-файл=XSL_FILE
Замінити вбудовану таблицю стилів XSL за допомогою спеціальної таблиці стилів XSL XSL_FILE.

--fop
Використовуйте FOP для створення PDF-файлів. Поведінка за замовчуванням – використовувати dblatex(1), --fop варіант
є неявним, якщо використовується ця опція.

--fop-opts=FOP_OPTS
Додатковий FOP(1) варіанти. Якщо вказано цей параметр, FOP використовується для створення PDF-файлів.
Цей параметр можна вказати більше одного разу.

--dblatex-opts=DBLATEX_OPTS
Додатковий dblatex(1) варіанти. Цей параметр можна вказати більше одного разу.

--backend-opts=НАЗАДEND_OPTS
Параметри для внутрішнього плагіна, зазначені в --бекенд варіант. Цей варіант може бути
вказано більше одного разу.

Параметри також можна встановити у вихідному файлі AsciiDoc. Якщо ВИХІДНИЙ ФАЙЛ містить коментар
рядок, що починається з // a2x: тоді залишок рядка буде розглядатися як a2x
параметри командного рядка. Наприклад:

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

· Опції, що охоплюють декілька таких рядків коментарів, будуть об'єднані.

· Між провідними символами може бути нуль або більше пробілів // та a2x:.

· Параметри командного рядка мають пріоритет над параметрами, заданими у вихідному файлі.

ВИХІД ФАЙЛИ

Вихідні файли записуються в каталог, визначений файлом --пункт призначення-реж варіант. Якщо ні
--пункт призначення-реж Встановлено опцію вихідні файли записуються в ВИХІДНИЙ ФАЙЛ каталог.

Вихідні файли мають те саме ім'я, що і файл ВИХІДНИЙ ФАЙЛ але з відповідною назвою файлу
розширення: .html для xhtml; .epub для EPUB; .hhp для htmlдовідка; .pdf для PDF; .текст для
текст, .xml для книга документів. За домовленістю, сторінки man не мають розширення .man (розділ сторінки man
тільки номер). Назви каталогів HTML із фрагментами мають розширення .chunked; розділена довідка HTML
імена каталогів мають розширення .htmlhelp.

Існуючі файли з однаковими назвами перезаписуються.

На додаток до створення файлів HTML xhtml, EPUB, шматок та htmlдовідка формати забезпечують
файли ресурсів копіюються в правильні місця розташування в каталозі призначення.

РЕСУРСИ

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

a2x шукає файли ресурсів у таких місцях у такому порядку:

1. ВИХІДНИЙ ФАЙЛ каталог.

2. Каталоги ресурсів, зазначені в --ресурс параметр (шукається рекурсивно).

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

4. Каталоги запасних зображень і таблиць стилів у asciodoc(1) файли конфігурації
каталоги (рекурсивний пошук).

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

Коли файл ресурсу знайдено, він копіюється в правильний відносний каталог призначення.
Відсутні цільові підкаталоги створюються автоматично.

Існують два різні механізми для визначення додаткових ресурсів:

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

2. Файл ресурсу, який буде скопійовано до вихідного цільового каталогу.

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


[= ]
. =

де:


Вказує каталог (абсолютний або відносний до ВИХІДНИЙ ФАЙЛ), який обшукується
рекурсивно для відсутніх файлів ресурсів. Щоб усунути двозначність ім'я
має закінчуватися символом роздільника каталогу.


Вказує файл ресурсу (абсолютний або відносний до ВИХІДНИЙ ФАЙЛ) який буде
скопійовано до . Якщо не вказано, то це
те саме, що .


Вказує місце призначення скопійованого вихідного файлу. The шлях є
відносно каталогу призначення (абсолютні шляхи не дозволені). Розташування
каталогу призначення залежить від виводу ФОРМАТ (Див ВИХІД ФАЙЛИ
розділ для деталей):

chunked, htmlhelp
Розбитий вихідний каталог.

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

xhtml
Вихідні дані DESTINATION_DIR.

. =
Під час додавання ресурсів до файлів EPUB тип mime виводиться з файлу
file>, якщо не вдається вгадати тип mime, виникає помилка. The
. = Синтаксис ресурсу можна використовувати для явного встановлення типів mime. є
розширення імені файлу, є відповідним типом MIME.

Приклади варіантів ресурсу:

--ресурс ../images/
--resource doc/README.txt=README.txt
--ресурс ~/images/tiger.png=images/tiger.png
--resource .ttf=програма/x-font-ttf

ПРИКЛАДИ

a2x -f pdf doc/source-highlight-filter.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

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

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

Дивіться також останній файл README.

КОНФ ФАЙЛИ

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

1. a2x.conf з каталогу, що містить файл a2x.py виконуваний файл

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

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

4. CONF_FILE зазначені в --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