Texinfo

Пример печатного вывода Texinfo; страница 25 официального руководства GNU Texinfo.
Оригинальный автор(ы)	Ричард Столлман Роберт Чассел
Разработчик(и)	Брайан Фокс [1] Карл Берри
Первоначальный выпуск	Февраль 1986 г. [2]
Стабильный релиз	7.2 [3]  / 28 декабря 2024 г.
Репозиторий	git.savannah.gnu.org/cgit/texinfo.git
Написано в	C , Perl
Операционная система	GNU/Linux , BSD
Тип	Документация
Лицензия	GPL-3.0 или более поздняя версия
Веб-сайт	www.gnu.org/s/texinfo

Texinfo — это наборный синтаксис, используемый для создания документации как в онлайн-, так и в печатной форме (создание типов файлов, таких как dvi , html , pdf и т. д., а также определенного гипертекстового формата Info ) с одним исходным файлом. Он реализован компьютерной программой, выпущенной как свободное программное обеспечение с тем же названием, созданной и предоставленной проектом GNU из Free Software Foundation . ^[4]

Основная цель Texinfo — предоставить способ легкого набора руководств по программному обеспечению. Подобно синтаксису LaTeX , все обычные функции книги, такие как главы, разделы, перекрестные ссылки, таблицы и индексы, доступны для использования в документах. Используя различные генераторы вывода, доступные для Texinfo, можно поддерживать несколько типов документации в актуальном состоянии (например, онлайн-документацию, предоставляемую через веб-сайт, и печатную документацию, созданную с помощью системы набора TeX ), используя только один исходный файл.

В официальной документации Texinfo указано, что первый слог «Texinfo» произносится так, чтобы рифмоваться с «speck», а не с «hex»; это произношение происходит от произношения TeX , в котором X представляет греческую букву chi, а не английскую букву x . Разработчики утверждают, что «Texinfo» следует писать только с заглавной «T», а все остальные буквы — строчными.

Чтобы сделать возможным одновременное обновление нескольких форматов выходной документации при изменении исходного файла Texinfo (.texi), доступно несколько конвертеров синтаксиса, которые можно использовать для генерации переводов файла Texinfo в другие форматы. Большинство из них создаются с помощью программы texi2any , также известной как makeinfo , которая является частью дистрибутива GNU Texinfo.

HTML

(Сгенерировано с помощью texi2any --html.) Поскольку HTML является стандартным языком для документов, представленных во Всемирной паутине, этот формат вывода может эффективно использоваться для создания страниц онлайн-документации. В руководстве отмечается, что вывод texi2any намеренно довольно прост для максимальной портативности и доступности. Вывод HTML texi2any является в высшей степени настраиваемым.

DVI

(Создается с помощью .) Формат файла, не зависящий от устройства , выводится системой набора текста TeX и может использоваться для создания команд, специфичных для устройства, которые можно просматривать или печатать; например, перевод в PostScript ( файлы ps ).texi2dvi

PDF

(Сгенерировано с помощью или .) Основанный на языке PostScript, этот формат был разработан Adobe Systems для переносимого обмена документами. Он может отображать точный вид документа и поддерживает произвольное масштабирование. Он предназначен для независимости от платформы и может просматриваться с помощью большого количества программного обеспечения. По умолчанию Texinfo использует программу pdftex , вариант TeX, для вывода PDF.texi2dvi --pdftexi2pdf

Латекс

(Сгенерировано через .) Это система набора текста, построенная на основе TeX. Вывод LaTeX может быть далее преобразован в DVI, PostScript или PDF.texi2any --latex

Докбук

(Сгенерировано через .) Это язык разметки на основе XML для технической документации, который в общих чертах напоминает Texinfo. Также возможно конвертировать файлы Docbook в Texinfo с помощью программы docbook2X .texi2any --docbook

EPUB

(Сгенерировано с помощью .) EPUB — формат, предназначенный для чтения электронных книг на портативных устройствах. Является производным от HTML.texi2any --epub3

XML

(Сгенерировано через .) В отличие от всех других выходных форматов, является транслитерацией исходного Texinfo, а не готовым выводом. Целью вывода Texinfo XML является возможность дальнейшей обработки инструментами XML.texi2any --xml

Информация

(Сгенерировано с помощью .) Это особый формат, который по сути является простой текстовой транслитерацией исходного источника Texinfo с добавлением нескольких управляющих символов для разделения узлов и предоставления навигационных элементов для меню, перекрестных ссылок, индексов и т. д. Файлы в формате Info можно просматривать с помощью программы info , которая распространяется вместе с Texinfo, а также с помощью нескольких сторонних просмотрщиков info .texi2any

Обычный текст

(Сгенерировано с помощью .) Это почти то же самое, что и вывод Info, за исключением символов управления навигацией.texi2any --plaintext

Примечательно, что man недоступен в качестве выходного формата из стандартных инструментов Texinfo. Хотя Texinfo используется для написания документации программного обеспечения GNU , которое обычно используется в Unix-подобных средах, таких как Linux , где man-страницы являются традиционным форматом для документации, обоснованием этого является то, что man-страницы имеют строгий общепринятый формат, традиционно используемый в качестве кратких справочных руководств, тогда как типичные приложения Texinfo предназначены как для учебных пособий, так и для справочных руководств. Таким образом, не видно никакой выгоды в выражении содержимого Texinfo в формате man-страницы. Более того, многие проекты GNU почти полностью избегают man-страниц, отсылая читателя предоставленной man-страницы (которая часто описывает себя как редко поддерживаемую) к документу Info.

Texinfo позволяет структурировать документ как книгу с главами, разделами, перекрестными ссылками и индексами. Исходный текст — это почти обычный текст , но технически это форматированный текст, размеченный командами, начинающимися с " @". Пример части исходного файла:

@node Топ@top Короткий пример@node Первая глава@nodescription Первая глава — единственная в этом образце.@chapter Первая глава@cindex глава, перваяЭто первая глава.

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

Texinfo используется как официальная система документации для проекта GNU . Дистрибутив GNU Texinfo распространяется под лицензией GNU General Public License .

Формат Texinfo был создан Ричардом М. Столлманом , объединившим другую систему для вывода на печать, используемую в Массачусетском технологическом институте под названием BoTeX, с онлайн- системой гиперссылочной документации Info , также созданной Столлманом поверх реализации Emacs TECO . ^{[5] [6]} Сам BoTeX был основан на более ранней системе под названием Bolio (связанной с Дэвидом А. Муном и использовавшейся для документирования Lisp Machine ^[7] ), преобразованной для использования TeX для вывода. Роберт Чассел помог Столлману создать первый транслятор для создания Info в Emacs Lisp . Texinfo «в некоторой степени основан на Scribe Брайана Рида и других языках форматирования того времени». ^[8]

Разработкой дистрибутива программного обеспечения Texinfo руководили Брайан Фокс (до версии 3.8), Карл Берри (до версии 5.2) и Гэвин Смит (с декабря 2014 г.).

• ТеХ
• Список расширений TeX

• Официальный сайт