Техинфо

Пример распечатанного вывода Texinfo; страница 25 официального руководства GNU Texinfo.
Оригинальный автор(ы)	Ричард Столлман Роберт Чассел
Разработчик(и)	Брайан Фокс Карл Берри
Первоначальный выпуск	февраль 1986 г.
Стабильная версия	7.1   / 18 октября 2023 г.
Репозиторий	мерзавец .саванна .gnu .org /cgit /texinfo .git
Написано в	С , Перл
Операционная система	ГНУ/Линукс , БСД
Тип	Документация
Лицензия	GPL-3.0 или новее
Веб-сайт	www .gnu .org /с /texinfo

Texinfo — это синтаксис набора текста, используемый для создания документации как в онлайновой, так и в печатной форме (создание типов файлов как два , html , pdf и т. д., а также определенный формат гипертекста, Info ) с одним исходным файлом. Он реализован с помощью компьютерной программы, выпущенной в виде бесплатного программного обеспечения одноименного , созданного и предоставленного в рамках проекта GNU Project Фонда свободного программного обеспечения .

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

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

Выходные форматы

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

HTML

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

Два

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

PDF

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

Латекс

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

документация

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

EPUB

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

XML

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

Информация

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

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

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

Выход человека

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

Исходный файл Texinfo

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

@node Top
@top Short Sample

@node First Chapter
@nodedescription The first chapter is the only chapter in this sample.
@chapter First Chapter

@cindex chapter, first
This is the first chapter.

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

История и статус

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

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

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

См. также

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

Внешние ссылки

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