docbook2x-man – онлайн у хмарі

ПРОГРАМА:

ІМ'Я

docbook2x-man - Перетворення DocBook на сторінки керівництва

СИНТАКСИС

docbook2x-man [опції] xml-документ

ОПИС

docbook2x-man перетворює наданий документ DocBook XML у сторінки керівництва. За замовчуванням чоловік
сторінки будуть виведені в поточний каталог.

Конвертується лише вміст refentry в документі DocBook. (Щоб конвертувати вміст
за межами refentry потрібне налаштування таблиці стилів. Перегляньте пакет docbook2X
деталі.)

Команда docbook2x-man Команда — це скрипт-обгортка для двоетапного процесу перетворення. Див
Розділ «ПРОЦЕС ПЕРЕВІРТУВАННЯ» нижче для детальної інформації.

ВАРІАНТИ

Доступні варіанти, по суті, є об’єднанням варіантів з db2x_xsltproc(1) і
db2x_manxml(1).

Нижче наведено деякі часто використовувані параметри:

--кодування=кодування
Встановлює кодування символів виводу.

--string-param параметр=значення
Встановлює параметр таблиці стилів (параметри, які впливають на вигляд результату). Побачити
«Параметри таблиці стилів» нижче для параметрів, які можна встановити.

--sgml Прийміть вихідний документ SGML як вхід замість XML.

--solinks
Створіть сторінки-заглушки для альтернативних імен для вихідної сторінки керівництва.

ТАБЛИЦЯ СТИЛІВ ПАРАМЕТРИ
заголовки у верхньому регістрі
Brief. Зробити заголовки великими літерами?

дефолт установка. 1 (логічне значення істина)

Заголовки у вмісті сторінки керівництва мають бути або не повинні бути великими.

manvolnum-cite-numer-only
Brief. Посилання на розділ сторінки керівництва має використовувати лише число

дефолт установка. 1 (логічне значення істина)

Під час цитування інших сторінок керівництва розділ man-сторінки надається як є, або має
літери, вилучені з нього, вказуючи лише номер розділу (наприклад, розділ 3x
стає 3). Цей параметр визначає стиль.

цитати на літерах
Brief. Відображати лапки на літерних елементах?

дефолт установка. 0 (логічний хибний)

Якщо вірно, відтворіть літерні елементи з лапками навколо них.

шоу-коментарі
Brief. Показати елементи коментарів?

дефолт установка. 1 (логічне значення істина)

Якщо вірно, коментарі відображатимуться, інакше вони приховуються. Коментарі тут
посилається на елемент коментаря, який буде перейменовано на remark в DocBook V4.0, не
Коментарі XML (<-- як це -->), які недоступні.

функції парень
Brief. Створити дужки після функції?

дефолт установка. 0 (логічний хибний)

Якщо вірно, форматування a елемент міститиме згенеровані дужки.

xref-on-link
Brief. Чи повинно посилання генерувати перехресне посилання?

дефолт установка. 1 (логічне значення істина)

Сторінки Man не можуть відображати гіпертекстові посилання, створені посиланням. Якщо цей параметр встановлено,
тоді таблиця стилів відображає перехресне посилання на ціль посилання. (Це може
зменшити безлад). В іншому випадку відображатиметься лише вміст посилання та фактичний
саме посилання ігнорується.

заголовок-3
Brief. Текст третього заголовка

дефолт установка. (пусто)

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

заголовок-4
Brief. Четвертий текст заголовка

дефолт установка. (пусто)

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

заголовок-5
Brief. П'ятий текст заголовка

дефолт установка. (пусто)

Визначає текст п’ятого заголовка сторінки довідки. Якщо порожній, "ім'я вручну",
тобто використовується назва книги або довідкового контейнера.

розділ сторінки керування за замовчуванням
Brief. Розділ сторінки керівництва за замовчуванням

дефолт установка, 1

У вихідному документі зазвичай вказуються розділи, до яких має належати кожна сторінка керівництва
до (з manvolnum в refmeta). Якщо у вихідному документі не вказано людину-
розділів сторінок, цей параметр визначає значення за замовчуванням.

налаштований файл локалізації
Brief. URI XML-документа, що містить користувацькі дані локалізації

дефолт установка. (пусто)

Цей параметр визначає URI XML-документа, який описує переклади тексту
(та іншу інформацію про місцеві стандарти), необхідну для обробки таблиці стилів
документ DocBook.

Переклади тексту, на які вказує цей параметр, завжди замінюють текст за замовчуванням
перекладів (з внутрішнього файлу локалізації параметрів). Якщо окремий
перекладу тут немає, відповідний переклад за замовчуванням використовується як a
відступати.

Цей параметр в першу чергу призначений для зміни певних знаків пунктуації, які використовуються в
форматування вихідного документа. Налаштування знаків пунктуації часто
специфічні для вихідного документа, але також можуть залежати від локалі.

Щоб не використовувати власні переклади тексту, залиште цей параметр порожнім рядком.

custom-l10n-data
Brief. XML-документ, що містить спеціальні дані локалізації

дефолт установка. документ ($custom-localization-file)

Цей параметр визначає XML-документ, який описує переклади тексту (і
інша інформація, специфічна для локалі), яка потрібна таблиці стилів для обробки
Документ DocBook.

Цей параметр є внутрішнім для таблиці стилів. Щоб вказати на зовнішній XML-документ
з URI або іменем файлу, ви повинні використовувати параметр custom-localization-file
замість цього.

Однак всередині спеціальної таблиці стилів (НЕ on командного рядка) цей параметр може бути
встановити значення для документа виразу XPath(''), що спричинить користувацькі переклади
безпосередньо вбудований у власну таблицю стилів для читання.

автор-інше ім'я-посередині
Brief. Чи є інше ім'я автора по батькові?

дефолт установка, 1

Якщо вірно, між ім’ям та прізвищем з’являється інше ім’я автора.
В іншому випадку, othername приховується.

ПРИКЛАДИ

$ docbook2x-man --solinks manpages.xml
$ docbook2x-man --solinks --encoding=utf-8//TRANSLIT manpages.xml
$ docbook2x-man --string-param header-4="Безкоштовне перекодування 3.6" document.xml
.fi

КОНВЕРСІЯ ПРОЦЕС

Перетворення до людина сторінок
Документи DocBook перетворюються на сторінки керівництва за два кроки:

1. Джерело DocBook перетворюється за допомогою таблиці стилів XSLT у проміжний формат XML,
Людина-XML.

Man-XML простіший, ніж DocBook, і ближчий до формату сторінки man; це призначено
полегшити роботу таблиць стилів.

Таблиця стилів для цієї мети знаходиться в xslt/man/docbook.xsl. Для портативності це
завжди має посилатися на такий URI:

http://docbook2x.sourceforge.net/latest/xslt/man/docbook.xsl

Запустіть цю таблицю стилів за допомогою db2x_xsltproc(1).

Налаштування. Ви також можете налаштувати вихід, створивши власну таблицю стилів XSLT —
змінювати параметри або додавати нові шаблони — та імпортувати xslt/man/docbook.xsl.

2. Man-XML перетворюється на фактичні сторінки man db2x_manxml(1).

Команда docbook2x-man команда виконує обидва кроки автоматично, але якщо виникають якісь проблеми, ви
Ви зможете чіткіше побачити помилки, якщо виконаєте кожен крок окремо:

$ db2x_xsltproc -s людина mydoc.xml -o mydoc.mxml
$ db2x_manxml mydoc.mxml
.fi

Параметри таблиці стилів перетворення описані в
таблиці стилів man-сторінок
довідник.

Чистий XSLT Перетворення.
Альтернатива до db2x_manxml Сценарій Perl - це XSLT
таблиця стилів у
xslt/backend/db2x_manxml.xsl.
Ця таблиця стилів виконує подібну функцію
перетворення Man-XML у реальні сторінки керівництва.
Це корисно, якщо вам потрібен чистий XSLT
рішення для перетворення man-сторінки.
Звичайно, якість перетворення за допомогою цієї таблиці стилів
ніколи не буде таким хорошим, як Perl db2x_manxml,
і він працює повільніше.
Зокрема, чиста версія XSLT
наразі не підтримує таблиці на сторінках керівництва,
але його аналог Perl робить.

Характер комплект Перетворення
При перекладі XML у застарілі формати на основі ASCII із поганою підтримкою Unicode, наприклад
man-сторінок і Texinfo, завжди існує проблема з символами Unicode у вихідному коді
документ теж треба якось перекласти.

Простого перетворення набору символів з Unicode недостатньо, оскільки
цільовий набір символів, зазвичай US-ASCII або ISO Latin-1, не містить загальних символів
такі як тире та напрямні лапки, які широко використовуються в документах XML. Але
Форматники документів (man і Texinfo) дозволяють вводити такі символи за допомогою розмітки
escape: наприклад, \(lq для лівої спрямованої цитати ". І якщо вихід на рівні розмітки
недоступний, може використовуватися транслітерація ASCII: наприклад, за допомогою ASCII
Знак менше < для кутової лапки ⟨.

Отже, проблему символів Unicode можна вирішити у два кроки:

1. utf8trans(1), програма, включена в docbook2X, відображає символи Unicode на рівні розмітки
втечі або транслітерації.

Оскільки не обов’язково існує фіксоване, офіційне відображення символів Unicode,
utf8trans може читати змінені користувачем відображення символів, виражені в текстових файлах і
застосовувати їх. (На відміну від більшості конвертерів набору символів.)

In charmaps/man/roff.charmap та charmaps/man/texi.charmap є карти символів, які можуть
використовуватися для перетворення сторінки вручну та Texinfo. Програми db2x_manxml(1) і
db2x_texixml(1) застосуватиме ці карти символів або іншу карту символів, визначену
користувача автоматично.

2. Решта тексту Unicode перетворюється на інший набір символів (кодування). Для
наприклад, французький документ з наголошеними символами (наприклад, é) може бути перетворений у
ISO Latin 1.

Цей крок застосовується після utf8trans відображення символів, використовуючи iconv(1) кодування
інструмент перетворення. Обидва db2x_manxml(1) і db2x_texixml(1) може зателефонувати iconv(1)
автоматично при виготовленні їх виходу.

Використовуйте docbook2x-man онлайн за допомогою служб onworks.net