Texinfo - это синтаксис набора текста, используемый для создания документации как в онлайновой, так и в печатной форме (создание типов файлов, таких как dvi , html , pdf и т. д ., и собственного гипертекстового формата, info ) с одним исходным файлом. Он реализован с помощью компьютерной программы, выпущенной как бесплатное программное обеспечение с тем же именем, созданное и предоставленное проектом GNU от Free Software Foundation . [4]
Основная цель Texinfo — предоставить возможность легко набирать руководства по программному обеспечению. Подобно синтаксису LaTeX , все обычные функции книги, такие как главы, разделы, перекрестные ссылки, таблицы и индексы, доступны для использования в документах. Используя различные генераторы вывода, доступные для Texinfo, можно поддерживать несколько типов документации в актуальном состоянии (например, онлайновую документацию, предоставляемую через веб-сайт, и печатную документацию, сгенерированную с помощью системы набора текста TeX ), используя только один исходный файл.
В официальной документации Texinfo говорится, что первый слог слова «Texinfo» произносится так, чтобы рифмоваться с «пятнышком», а не с «шестнадцатеричным»; это произношение происходит от произношения TeX , в котором X представляет собой греческую букву chi , а не английскую букву x . Разработчики заявляют, что «Texinfo» следует писать только с заглавной буквы «T», а остальные буквы в нижнем регистре.
Чтобы сделать возможным обновление сразу нескольких выходных форматов документации при изменении исходного файла Texinfo (.texi), доступно несколько преобразователей синтаксиса, которые можно использовать для создания переводов файла Texinfo в другие форматы. Большинство из них создаются с помощью программы makeinfo , которая является частью дистрибутива GNU Texinfo.
Примечательно, что man недоступен в качестве выходного формата для стандартных инструментов Texinfo. В то время как Texinfo используется для написания документации к программному обеспечению GNU , которое обычно используется в Unix-подобных средах, таких как Linux , где справочные страницы являются традиционным форматом документации, обоснованиеэто связано с тем, что справочные страницы имеют строгий общепринятый формат и традиционно используются в качестве кратких справочных руководств, тогда как типичные приложения Texinfo предназначены для учебных пособий, а также справочных руководств. Таким образом, не видно никаких преимуществ в представлении содержания Texinfo в формате справочной страницы. Более того, многие проекты GNU почти полностью избегают справочных страниц, отсылая читателя предоставленной справочной страницы (которая часто описывает себя как редко поддерживаемую) к документу Info.
Texinfo позволяет структурировать документ как книгу с главами, разделами, перекрестными ссылками и указателями. Исходный текст представляет собой почти обычный текст , но технически это форматированный текст , размеченный командами, начинающимися с « @». Образец части исходного файла: