Сравнивайте с английским: нажмите на абзац — оригинал откроется в окне. Кнопка EN под абзацем показывает его прямо в тексте.
Содержание
Введение
Язык разметки для документации
Markup language for documentation
Texinfo — это синтаксис для подготовки текста, используемый для создания документации как в онлайн, так и в печатном виде (создание типов файлов , , и т. д., и конкретного формата гипертекста, ) из одного исходного файла. Он реализован в виде компьютерной программы, распространяемой как свободное программное обеспечение с тем же названием, разработанной и предоставленной проектом GNU Фонда свободного программного обеспечения. Основное назначение Texinfo — обеспечить удобный способ подготовки документации к программному обеспечению. Подобно синтаксису LaTeX, в документах Texinfo доступны все стандартные элементы книги, такие как главы, разделы, перекрёстные ссылки, таблицы и указатели. С помощью различных генераторов выходных данных, доступных для Texinfo, можно поддерживать актуальность нескольких типов документации (например, онлайн-документации, предоставляемой через веб-сайт, и печатной документации, создаваемой с помощью системы набора текста TeX), используя только один исходный файл. В официальной документации Texinfo указано, что первый слог слова "Texinfo" произносится так, чтобы рифмоваться со словом "speck", а не "hex"; такое произношение происходит от произношения TeX, где X обозначает греческую букву хи, а не английскую букву x. Разработчики Texinfo утверждают, что "Texinfo" следует писать с заглавной буквы "T" и остальными буквами строчными.
Texinfo is a typesetting syntax used for generating documentation in both on line and printed form (creating filetypes as , , , etc., and a specific hypertext format, ) with a single source file. It is implemented by a computer program released as free software of the same name, created and made available by the GNU Project from the Free Software Foundation. The main purpose of Texinfo is to provide a way to easily typeset software manuals. Similar to the LaTeX syntax, all the normal features of a book, such as chapters, sections, cross references, tables and indices are available for use in documents. Using the various output generators that are available for Texinfo, it is possible to keep several documentation types up to date (such as on line documentation provided via a Web site, and printed documentation, as generated using the TeX typesetting system) using only a single source file. The official Texinfo documentation states that the first syllable of "Texinfo" is pronounced so as to rhyme with "speck", not "hex"; this pronunciation is derived from the pronunciation of TeX, in which the X represents the Greek letter chi rather than the English letter x. The maintainers state that "Texinfo" should be written with only a capital "T" and the rest of the letters in lower case.
Выход человека
Примечательно, что формат man недоступен в качестве выходного из стандартных инструментов Texinfo. Хотя Texinfo используется для написания документации программного обеспечения GNU, которое обычно применяется в Unix-подобных средах, таких как Linux, где man-страницы являются традиционным форматом документации, это объясняется тем, что man-страницы имеют строгий, устоявшийся формат, традиционно используемый как быстрые справочники, в то время как типичные приложения Texinfo предназначены как для учебных пособий, так и для справочных руководств. Поэтому не считается полезным представлять содержимое Texinfo в формате man-страниц. Более того, многие проекты GNU практически полностью отказываются от man-страниц, направляя читателя предоставленной man-страницы (которая часто указывает на свою редкую поддержку) к документу Info.
Notably, man is not available as an output format from the standard Texinfo tools. While Texinfo is used for writing the documentation of GNU software, which typically is used in Unix like environments such as Linux, where man pages are the traditional format for documentation, the rationale for this is that man pages have a strict conventional format, used traditionally as quick reference guides, whereas typical Texinfo applications are for tutorials as well as reference manuals. As such, no benefit is seen in expressing Texinfo content in man page format. Moreover, many GNU projects eschew man pages almost completely, referring the reader of the provided man page (which often describes itself as seldom maintained) to the Info document.
История и статус
Texinfo используется как официальная система документации проекта GNU. Дистрибутив GNU Texinfo распространяется под лицензией GNU General Public License. Формат Texinfo был создан Ричардом М. Столлманом, объединившим другую систему для подготовки печатных версий, использовавшуюся в MIT и называвшуюся BoTeX, с онлайн-системой документации Info с гиперссылками, также созданной Столлманом на основе реализации TECO в Emacs. BoTeX, в свою очередь, был основан на более ранней системе под названием Bolio (разработанной Дэвидом А. Муном и использовавшейся для документации Lisp Machine), которая была переработана для использования TeX для вывода. Роберт Часселл помог Столлману создать первый транслятор для генерации Info на Emacs Lisp. Texinfo «в значительной степени основан на Brian Reid's Scribe и других языках форматирования того времени». Разработка программного обеспечения Texinfo велась под руководством Брайана Фокса (до версии 3.8), Карла Берри (до версии 5.2) и Гэвина Смита (с декабря 2014 года).
Texinfo is used as the official documentation system for the GNU Project. The GNU Texinfo distribution is licensed under the GNU General Public License. The Texinfo format was created by Richard M. Stallman, combining another system for print output in use at MIT called BoTeX, with the online Info hyperlinked documentation system, also created by Stallman on top of the TECO implementation of Emacs. BoTeX itself was based on an earlier system called Bolio (associated with David A. Moon, and used for documentation of the Lisp Machine), converted to use TeX for its output. Robert Chassell helped Stallman to create the first translator to create Info in Emacs Lisp. Texinfo is "loosely based on Brian Reid's Scribe and other formatting languages of the time". The Texinfo software distribution development was led by Brian Fox (up to version 3.8), Karl Berry (through version 5.2), and by Gavin Smith (since Dec. 2014).