Как создать Информационную документацию?

Для создания информационной документации вам сначала нужен файл Texi.

. TEXI - [112979291] - TEXINFO - это наборной синтаксис, используемый для генерации документации как в режиме онлайн, так и на печатном виде (создавая файлы в виде DVI, HTML, PDF и т. Д., И его собственный формат гипертекста , информация) с одним исходным файлом. Он реализуется компьютерной программой, выпущенной в виде бесплатного программного обеспечения того же имени, созданного и сделанного проектом GNU из фонда бесплатного программного обеспечения.

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

Makeinfo - это утилита, которая преобразует файл Texinfo в файл информации; Это часть пакета Texinfo . Texinfo-формат-регион и Texinfo-формат-буфер - функции GNU Emacs, которые делают то же самое.

Вот образец TEXI для использования в качестве шаблона :

\input texinfo   @c -*-texinfo-*-
@comment $Id@w{$}
@comment %**start of header
@setfilename sample.info
@include version.texi
@settitle GNU Sample @value{VERSION}
@syncodeindex pg cp
@comment %**end of header
@copying
This manual is for GNU Sample (version @value{VERSION}, @value{UPDATED}),
which is an example in the Texinfo documentation.

Copyright @copyright{} 2013 Free Software Foundation, Inc.

@quotation
Permission is granted to copy, distribute and/or modify this document
under the terms of the GNU Free Documentation License, Version 1.3 or
any later version published by the Free Software Foundation; with no
Invariant Sections, with no Front-Cover Texts, and with no Back-Cover
Texts.  A copy of the license is included in the section entitled
``GNU Free Documentation License''.
@end quotation
@end copying

@dircategory Texinfo documentation system
@direntry
* sample: (sample)Invoking sample.
@end direntry

@titlepage
@title GNU Sample
@subtitle for version @value{VERSION}, @value{UPDATED}
@author A.U. Thor (@email{bug-sample@@gnu.org})
@page
@vskip 0pt plus 1filll
@insertcopying
@end titlepage

@contents

@ifnottex
@node Top
@top GNU Sample

This manual is for GNU Sample (version @value{VERSION}, @value{UPDATED}).
@end ifnottex

@menu
* Invoking sample::
* GNU Free Documentation License::
* Index::
@end menu


@node Invoking sample
@chapter Invoking sample

@pindex sample
@cindex invoking @command{sample}

This is a sample manual.  There is no sample program to
invoke, but if there were, you could see its basic usage
and command line options here.


@node GNU Free Documentation License
@appendix GNU Free Documentation License

@include fdl.texi


@node Index
@unnumbered Index

@printindex cp

@bye

Преобразуйте, что в информационную документацию с:

makeinfo mytool.texi

Перечисление нового файла информации

, чтобы добавить новый файл информации В вашу систему написать запись меню для него в меню в файле в каталоге ( / usr / share / info / на ubuntu) Отказ Кроме того, переместите новый файл информации в каталог . Например, если вы добавили документацию для GDB, вы бы записали следующую новую запись:

* GDB: (gdb).           The source-level C debugger.

Первая часть ввода меню - это имя входа меню, за которым следует джойл. Вторая часть - это имя информационного файла в скобках, а затем период. Третья часть - это описание.

Обычно название информационного файла имеет .info . Таким образом, вы можете перечислить название файла, такого как это:

* GDB: (gdb.info).           The source-level C debugger.

Тем не менее, информация будет искать файл с расширением .info . Если он не найдет файл под именем, указанным в меню. Это означает, что вы можете обратиться к файлу GDB.INFO как GDB , как показано в первом примере. Это выглядит лучше.