Из Википедии, бесплатной энциклопедии
Перейти к навигации Перейти к поиску
Texinfo
Пример texinfo.png
Пример напечатанного вывода Texinfo; страница 25 официального руководства GNU Texinfo.
Автор (ы) оригиналаРичард Столмен
Боб Часселл
Разработчики)Брайан Фокс [1]
Карл Берри
изначальный выпускФевраль 1986 [2]
Стабильный выпуск6.7 (23 сентября 2019 г . ; 17 месяцев назад [3] ) [±] ( 2019-09-23 )
Репозиторий
Отредактируйте это в Викиданных
Написано вC , Perl
Операционная системаGNU
ТипДокументация
ЛицензияСтандартная общественная лицензия GNU
Интернет сайтwww .gnu .org / s / texinfo

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

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

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

Форматы вывода [ править ]

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

HTML
(Генерируется с помощью makeinfo --html.) Поскольку HTML является стандартным языком для документов, представленных во всемирной паутине, этот выходной формат можно эффективно использовать для создания страниц онлайн-документации. В руководстве отмечается, что программа makeinfo пытается ограничить свои выходные файлы определенным подмножеством разметки HTML, которое может быть прочитано как можно большим количеством браузеров.
DVI
(Генерируется с помощью texi2dvi.) Независимый от устройства формат файла выводится системой набора TeX и может использоваться для генерации специфичных для устройства команд, которые можно просматривать или распечатывать; например, перевод в PostScript ( файлы ps ).
PDF
(Создан с помощью texi2dvi --pdfили texi2pdf.) Этот формат, основанный на языке PostScript, был разработан Adobe Systems для портативного обмена документами. Как и формат PostScript, он может точно отражать внешний вид документа и поддерживает произвольное масштабирование. Он предназначен для независимости от платформы и может быть просмотрен с помощью большого разнообразия программного обеспечения. Texinfo использует программу pdftex , вариант TeX, для вывода PDF.
Docbook
(Создано с помощью makeinfo --docbook.) Это основанный на XML язык разметки для технической документации, который в общих чертах имеет некоторое сходство с Texinfo. Также возможно преобразовать файлы Docbook в Texinfo с помощью программы docbook2X .
XML
(Создано через makeinfo --xml.) Для общих целей.
Информация
(Генерируется с помощью makeinfo.) Это особый формат, который по сути представляет собой текстовую версию исходного синтаксиса Texinfo в сочетании с несколькими управляющими символами для разделения узлов и предоставления навигационных элементов для меню, перекрестных ссылок, разделов и так далее. Информационный формат можно просмотреть с помощью информационной программы.

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

Исходный файл Texinfo [ править ]

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

@ifnottex@node Top@top Короткий образец@insertcopying@end ifnottex@меню* Первая глава :: Первая глава - это только глава в этом примере.* Индекс :: Полный индекс.@end меню

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

История и статус [ править ]

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

Формат Texinfo был создан Ричардом М. Столлманом , сочетая другую систему вывода на печать, используемую в Массачусетском технологическом институте, под названием BoTeX, с интерактивной системой документации с гиперссылками Info , также созданной Столлманом поверх реализации Emacs TECO . [5] [6] Сам BoTeX был основан на более ранней системе под названием Bolio (связанной с Дэвидом А. Муном и использовавшейся для документации Lisp Machine [7] ), преобразованной для использования TeX для вывода. Роберт Чассел помог Столлману создать первый переводчик для создания Info в Emacs Lisp.. Разработкой распространения программного обеспечения Texinfo руководили Брайан Фокс (до версии 3.8), Карл Берри (до версии 5.2) и Гэвин Смит (с декабря 2014 г.).

Texinfo является « по мотивам Брайан Рид «s Скриба и других языков форматирования времени». [8]

См. Также [ править ]

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

Примечания и ссылки [ править ]

  1. ^ Кто проект GNU , ГНУ Team выросла больше в последние несколько месяцев: Брайан Фокс и Opus Goldstein присоединились Джей Fenlason , как только сотрудники Фонда. Совсем недавно Брайан создал автономное средство форматирования и браузер texinfo ... , февраль 1988 г., Бюллетень GNU, т. 1 шт. 4
  2. ^ Статус Gnu , Ричард М. Столмен. 5. Система документации. Теперь у меня есть действительно совместимая пара программ, которые могут преобразовывать файл документации формата texinfo либо в печатное руководство, либо в файл Info. Файлы документации необходимы для многих утилит., Февраль 1986, GNU 'SBULLETIN, Volume 1 No.1
  3. ↑ Смит, Гэвин (23 сентября 2019 г.). «Выпущен Texinfo 6.7» . info-gnu (Список рассылки) . Проверено 24 сентября 2019 года .
  4. ^ Что такое GNU: Texinfo , выпуск 6, 01 октября 1994 г., Арнольд Роббинс, Linux Journal
  5. ^ Руководство по GNU Texinfo , раздел 1.14 История
  6. ^ Ричард Столлман, 8 января 2012 г., сообщение в списке рассылки emacs-devel : «... Информация существует примерно с 1976 года в исходном Emacs. В то время файлы Info писались вручную, и каждый мог редактировать систему. файлы на ЕГО. "
  7. ^ Daniel Вайнреб и David A. Moon (январь 1979), Lisp Machine Manual, Вторая предварительная версия
  8. ^ Texinfo

Внешние ссылки [ править ]

  • Официальный веб-сайт