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

ПРОГРАММА:

ИМЯ

docbook2x-texi - конвертировать DocBook в Texinfo

СИНТАКСИС

docbook2x-texi [кредита] xml-документ

ОПИСАНИЕ

docbook2x-texi преобразует данный документ XML DocBook в один или несколько документов Texinfo.
По умолчанию эти документы Texinfo будут выведены в текущий каталог.

Команда docbook2x-texi Команда представляет собой сценарий-оболочку для двухэтапного процесса преобразования. Увидеть
подробности в разделе «ПРОЦЕСС ПРЕОБРАЗОВАНИЯ» ниже.

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

Доступные варианты - это, по сути, объединение вариантов для db2x_xsltproc(1) и
db2x_texixml(1).

Некоторые часто используемые параметры перечислены ниже:

--encoding =кодирование
Устанавливает кодировку символов вывода.

--строка-параметр параметр=ценностное
Устанавливает параметр таблицы стилей (параметры, которые влияют на внешний вид вывода). Видеть
«Параметры таблицы стилей» ниже для параметров, которые могут быть установлены.

--sgml Примите исходный документ SGML в качестве входных данных вместо XML.

СТИЛЬ ПАРАМЕТРЫ
заголовки-отображать-как-заголовки
Слип/Классические. Использовать разметку заголовков для второстепенных субтитров?

По умолчанию установка. 0 (логическое ложь)

Если true, содержимое заголовка в некоторых (формальных) объектах отображается с помощью Texinfo.
@Заголовок команды.

Если false, заголовки отображаются как выделенный абзац.

ссылки-использование-pxref
Слип/Классические. Перевести ссылку с помощью @pxref

По умолчанию установка. 1 (логическое истина)

Если true, ссылка переводится с гипертекстом, за которым следует перекрестная ссылка в
круглые скобки.

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

явные имена узлов
Слип/Классические. Настаивайте на созданных вручную именах узлов Texinfo

По умолчанию установка. 0 (логическое ложь)

Элементы в исходном документе могут влиять на генерацию имени узла Texinfo.
указав либо xreflabel, либо для элементов секционирования заголовок с
role = 'texinfo-node' в *информационный контейнер.

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

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

По умолчанию этот параметр не установлен (т.е. false).
Внимание

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

шоу-комментарии
Слип/Классические. Отображать элементы комментария?

По умолчанию установка. 1 (логическое истина)

Если true, комментарии будут отображаться, в противном случае они подавляются. Комментарии здесь
относится к элементу комментария, который будет переименован в комментарий в DocBook V4.0, а не
Комментарии XML (<- как это ->), которые недоступны.

Функсинопсис-украшение
Слип/Классические. Украшать элементы FuncSynopsis?

По умолчанию установка. 1 (логическое истина)

Если true, элементы FuncSynopsis будут украшены (например, жирным шрифтом или курсивом). В
оформление контролируется функциями, которые можно переопределить в настройке
слой.

функции-пары
Слип/Классические. Создавать круглые скобки после функции?

По умолчанию установка. 0 (логическое ложь)

Если это правда, форматирование элемент будет включать сгенерированные круглые скобки.

reentry-display-name
Слип/Классические. Вывести заголовок NAME перед RefName?

По умолчанию установка. 1 (логическое истина)

Если true, заголовок раздела «NAME» выводится перед списком RefName.

manvolnum-в-xref
Слип/Классические. Вывести manvolnum как часть перекрестной ссылки refentry?

По умолчанию установка. 1 (логическое истина)

если true, manvolnum используется при перекрестных ссылках на рефентри, либо с помощью xref
или citerefentry.

предпочитаю текстобъекты
Слип/Классические. Предпочитаете текстобъект изображению?

По умолчанию установка. 1 (логическое истина)

Если это правда, текстовый объект в медиаобъекте предпочтительнее любого изображения.

(Конечно, для выходных форматов, отличных от Texinfo, вы обычно предпочитаете
imageobject, но Info - это только текстовый формат.)

Помимо значений true и false, этот параметр может иметь значение 2, чтобы
указывают, что должны быть выведены и текст, и изображения. Вы можете захотеть сделать
это потому, что некоторые программы просмотра Texinfo могут читать изображения. Обратите внимание, что Texinfo @image
у команды есть собственный механизм переключения между выводом текста и изображения - но мы
не используйте это здесь.

По умолчанию это правда.

смысловые украшения
Слип/Классические. Использовать встроенную семантическую разметку Texinfo?

По умолчанию установка. 1 (логическое истина)

Если true, семантическая встроенная разметка DocBook переводится в (ближайший)
Эквивалент Texinfo. Это значение по умолчанию.

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

файл нестандартной локализации
Слип/Классические. URI XML-документа, содержащего пользовательские данные локализации

По умолчанию установка. (пустой)

Этот параметр указывает URI XML-документа, описывающего переводы текста.
(и другая информация, зависящая от локали), которая необходима таблице стилей для обработки
документ DocBook.

Перевод текста, на который указывает этот параметр, всегда имеет приоритет над текстом по умолчанию.
переводы (из файла локализации внутреннего параметра). Если конкретный
перевода здесь нет, соответствующий перевод по умолчанию используется как
отступать.

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

Чтобы не использовать переводы настраиваемого текста, оставьте этот параметр как пустую строку.

пользовательские данные l10n
Слип/Классические. XML-документ, содержащий пользовательские данные локализации

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

Этот параметр указывает XML-документ, описывающий переводы текста (и
другую информацию, зависящую от локали), которая необходима таблице стилей для обработки
Документ DocBook.

Этот параметр является внутренним по отношению к таблице стилей. Чтобы указать на внешний XML-документ
с URI или именем файла следует использовать параметр custom-localization-file
.

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

автор-другое имя-посередине
Слип/Классические. Другое имя в авторе - это отчество?

По умолчанию установка. 1

Если это так, другое имя автора появляется между именем и фамилией.
В противном случае othername подавляется.

выходной файл
Слип/Классические. Имя информационного файла

По умолчанию установка. (пустой)

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

Do включите в название расширение .info.

(Обратите внимание, что этот параметр не имеет ничего общего с названием Текси-XML выходной не провела обыск
XSLT-процессор, из которого вы запускаете эту таблицу стилей.)

каталог-категория
Слип/Классические. Категоризация документа в справочнике Info.

По умолчанию установка. (пустой)

Задается категория, в которую документ должен входить в каталоге Info.
установленных файлов Info. Например, Общие команды.
Внимание

Категории также могут быть установлены непосредственно в исходном документе. Но если этот параметр
не является пустым, то он всегда отменяет настройку в исходном документе.

каталог-описание
Слип/Классические. Описание документа в справочнике Info

По умолчанию установка. (пустой)

Это краткое описание документа, отображаемого в каталоге Info
установленные информационные файлы. Например, программа интерактивного построения графиков.
Внимание

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

Индекс-категории
Слип/Классические. Индекс Texinfo для использования

По умолчанию установка. ср

Индекс Texinfo для indexterm и index указывается с помощью атрибута role. Если
указанные выше элементы не имеют роли, то значение по умолчанию, заданное этим параметром
используется.

Предварительно определенные индексы:

c, cp Указатель концепций

f, fn Индекс функции

v, vr Переменный индекс

k, ky Индекс нажатия клавиш

p, pg Указатель программы

d, tp Индекс типа данных

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

qanda-метка по умолчанию
Слип/Классические. Устанавливает значение по умолчанию для метки по умолчанию в QandASet.

По умолчанию установка.

Если в QandASet не указан атрибут defaultlabel, используется это значение. Это
должно быть одним из допустимых значений атрибута defaultlabel.

qandaset-генерировать-toc
Слип/Классические. Создано ли оглавление для QandASets?

По умолчанию установка.

Если true, ToC создается для QandASets.

ПРИМЕРЫ

$ docbook2x-texi tdg.xml
$ docbook2x-texi --encoding = utf-8 // ПЕРЕВЕСТИ tdg.xml
$ docbook2x-texi --string-param semantic-decoration = 0 tdg.xml
.fi

Конверсия ПРОЦЕСС ПРОЕКТИРОВАНИЯ

преобразование в Тексинфо
Документы DocBook преобразуются в Texinfo в два этапа:

1. Исходный код DocBook преобразуется таблицей стилей XSLT в промежуточный формат XML,
Текси-XML.

Texi-XML проще, чем DocBook, и ближе к формату Texinfo; это предназначено для
облегчить работу с таблицами стилей.

Таблица стилей для этой цели находится в xslt / texi / docbook.xsl. Для портативности это
всегда следует ссылаться на следующий URI:

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

Запустите эту таблицу стилей с помощью db2x_xsltproc(1).

Модификация оборудования. Вы также можете настроить вывод, создав свою собственную таблицу стилей XSLT -
изменение параметров или добавление новых шаблонов - и импорт xslt / texi / docbook.xsl.

2. Texi-XML преобразуется в фактические файлы Texinfo с помощью db2x_texixml(1).

Команда docbook2x-texi команда выполняет оба шага автоматически, но если возникнут какие-либо проблемы, вы
Вы сможете более четко увидеть ошибки, если будете выполнять каждый шаг отдельно:

$ db2x_xsltproc -s текст мой док.xml -о мой док.txml
$ db2x_texixml мой док.txml
.fi

Описываются параметры таблицы стилей преобразования.
в таблицах стилей Texinfo
Справка.

Характер набор Преобразование
При переводе XML в устаревшие форматы на основе ASCII с плохой поддержкой Unicode, такие как
man-страницы и Texinfo, всегда существует проблема, что символы Unicode в исходном тексте
документ тоже нужно как-то переводить.

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

Таким образом, проблему символов Юникода можно решить в два этапа:

1. utf8trans(1), программа, включенная в docbook2X, отображает символы Unicode на уровне разметки.
экранирования или транслитерации.

Поскольку не обязательно существует фиксированное официальное сопоставление символов Юникода,
utf8trans может читать изменяемые пользователем сопоставления символов, выраженные в текстовых файлах и
применить их. (В отличие от большинства конвертеров набора символов.)

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

2. Остальной текст Unicode преобразуется в какой-либо другой набор символов (кодировку). Для
Например, французский документ с диакритическими знаками (например, é) может быть преобразован в
ИСО латиница 1.

Этот шаг применяется после utf8trans отображение символов, используя Iconv(1) кодирование
инструмент преобразования. Оба db2x_manxml(1) и db2x_texixml(1) могу позвонить Iconv(1)
автоматически при производстве своей продукции.

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