Go to the first, previous, next, last section, table of contents.


Начало Texinfo-файла

В начале Texinfo-файла должна предоставляться определенная информация, вроде имени файла и названия документа.

Обычно начальная информация Texinfo-файла состоит из четырех частей:

  1. Заголовок, отделенный специальными строками комментария, который включает в себя команды для определения названия Texinfo-файла и сообщение для TeX, в котором указывается какой файл определений нужно использовать при обработке Texinfo-файла.
  2. Краткое сообщение о том, какую информацию можно найти в этом файле, авторские права и разрешения. Это заключено между командами @ifinfo и @end ifinfo, чтобы программа форматирования поместила это сообщение в Info-файл.
  3. Титульный лист и страница с информацией об авторских правах, с сообщением об авторских правах и разрешениями на распространение. Эта часть заключается между командами @titlepage и @end titlepage. Титульный лист и страница с информацией об авторских правах появляется только при печати руководства.
  4. Первая нода, в которой содержится меню для всего Info-файла. Содержимое этой части появляется только в Info-файле.

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

Так как текст сообщения об авторских правах и условий распространения для документа Texinfo (в отличие от условий распространения для программы) находится в частях, которые появляется либо только в Info-файле, либо только в печатном руководстве, эту информацию следует дублировать.

Образец начала Texinfo-файла

В следующем примере показано что следует вставить в начало Texinfo-файла.

\input texinfo   @c -*-texinfo-*-
@c %**start of header
@setfilename имя-texinfo-файла
@settitle название-руководства
@setchapternewpage odd
@c %**end of header

@ifinfo
Этот файл описывает ...

(C) обладатель авторских прав, год

Предоставляется разрешение ...
@end ifinfo

@c Этот пример иллюстрирует только один из
@c двух методов формирования титульного листа.

@titlepage
@title название-печатного-руководства
@subtitle подзаголовок-если-нужен
@subtitle второй-подзаголовок
@author автор

@c Со следующих двух команд начинается страница
@c с информацией об авторских правах.
@page
@vskip 0pt plus 1filll @copyright{} год
обладатель авторских прав

Опубликовано ...

Предоставляется разрешение ...
@end titlepage

@node Top, Обзор, , (dir)

@ifinfo
В этом документе описывается ...

Этот документ соответствует версии ...
программы ...
@end ifinfo

@menu
* Авторские права::           Ваши права и возможности.
* Первая глава::              Начало ...
* Вторая глава::              ...
...
...
@end menu

@node   Первая глава, Вторая глава, top,      top
@comment node-name,     next,           previous, up
@chapter Первая глава
@cindex Вхождения именных указателей для первой главы

Заголовок Texinfo-файла

Texinfo-файл начинается по крайней мере с трех строк, которые предоставляют необходимую информацию для Info и TeX. Это строка \input texinfo, строка @settitle и строка @setfilename. Если вы хотите, чтобы TeX отформатировал только часть Texinfo-файла, вы должны вставить строки @settitle и @setfilename между строк start-of-header и end-of-header.

Таким образом, начало Texinfo-файла выглядит так:

\input texinfo   @c -*- texinfo -*-
@setfilename пример.info
@settitle Пример оформления документа

или так:

\input texinfo   @c -*- texinfo -*-
@c %**start of header
@setfilename Пример.info
@settitle Пример оформления документа
@c %**end of header

Первая строка Texinfo-файла

Каждый Texinfo-файл, если его предполагается обрабатывать с помощью низкоуровневых процедур форматирования TeX, должен начинаться со строки подобной этой:

\input texinfo   @c -*- texinfo -*-

Эта строка служит для двух целей:

  1. Когда файл обрабатывается TeX, команда `\input texinfo', сообщает TeX о том, что следует загружать макросы, необходимые для обработки Texinfo-файла. Эти макросы находятся в файле, называемом `texinfo.tex', который обычно располагается в каталоге `/usr/lib/tex/macros'. TeX использует обратную косую черту, `\', как отметку начала команды, так же, как Texinfo использует `@'. В файле `texinfo.tex' сигнальный символ `\' переопределяется на `@'; до этого переключения TeX требует `\', поэтому эта строка должна находится в самом начале файла.
  2. Когда файл редактируется в GNU Emacs, строка `-*- texinfo -*-' сообщает Emacs, что следует использовать режим Texinfo.

Начало заголовка

Вставьте строку start-of-header второй строкой в Texinfo-файле. За строкой start-of-header следуют строки, начинающиеся с команд @setfilename и @settitle, а иногда с команд @smallbook или @footnotestyle. Заголовок замыкается строкой end-of-header (see section Окончание заголовка).

С помощью этих строк вы можете форматировать часть Texinfo-файла для Info или для выдачи на печать.

Строка start-of-header выглядит следующим образом:

@c %**start of header

Странная последовательность знаков `%**' должна гарантировать, что никакой другой комментарий не будет случайно перепутан с первой строкой заголовка.

@setfilename

Чтобы Texinfo-файл можно было отформатировать с помощью @command{makeinfo} или TeX, он должен содержать следующую строку:

@setfilename имя-info-файла

Команду @setfilename следует вставлять в начале строки, затем нужно вставить имя Info-файла. Не следует писать на этой строке что-либо еще; все, что следует после этой команды, рассматривается как имя Info-файла, даже то, что в ином другом случае воспринималось бы как комментарий.

Строка @setfilename определяет имя создаваемого при форматировании выходного файла. Это имя должно отличаться от имени Texinfo-файла. Существуют два соглашения для выбора имени файла, вы можете или удалить из имени файла расширение (такое как `.texi'), или заменять расширение на `.info'. При создании HTML-файлов @command{makeinfo} заменяет любое расширение на `html' или добавляет `.html', если у заданного файла нет расширения.

Некоторые операционные системы не поддерживают длинные имена файлов. У вас могут возникнуть проблемы даже тогда, когда имя файла достаточно коротко. Это происходит, потому что программа форматирования Info-файлов разбивает длинный файл на более короткие и дает им имена путем добавления в конец префиксов `-1', `-2', ..., `-10', `-11' и так далее. (See section Создание тегов и разбиение файлов.) Таким образом получаются имена файлов вроде `texinfo.info-10', которые для некоторых систем являются слишком длинными; так что подобные файлы лучше назвать `texinfo', а не `texinfo.info'. Когда программа @command{makeinfo} выполняется на операционных системах вроде MS-DOS, которые налагают серьезные ограничения на длину имен файла, то она иногда будет укорачивать первоначальное имя файла, чтобы обеспечить для суффиксов достаточно места, производя таким образом файлы с названиями вроде `texin-10', `gcc.i12' и так далее.

Команды форматирования для Info игнорируются, если они находятся перед строкой @setfilename, именно поэтому самая первая строка в файле (строка \input) не появляется при выводе.

Строка @setfilename не производит никакого вывода при форматировании руководства с помощью TeX, но несмотря на это она необходима: она открывает вспомогательные файлы для именных указателей, перекрестных ссылок и другие вспомогательные файлы, используемые Texinfo, а также считывает файл `texinfo.cnf', если он присутствует в системе (see section Подготовка к применению TeX).

@settitle

Чтобы из Texinfo-файла можно было создать печатное руководство, он должен содержать следующую строку:

@settitle Заголовок

Команда @settitle вставляется в начале строки, а за ней на этой же строке следует заголовок. Она сообщает TeX заголовок, который следует печатать вверху и внизу страницы. Больше в этой строке ничего писать не следует; все что находится в этой строке, даже комментарий, становится заголовком.

По традиции, когда TeX форматирует Texinfo-файл для двусторонней печати, заголовок печатается вверху на левых (четных) страницах, а название текущей главы -- вверху на правых (нечетных) страницах. (TeX получает название каждой главы из команды @chapter). Внизу страницы ничего не печатается.

Даже если вы печатаете в одностраничном стиле, TeX ищет строку с командой @settitle, если вы включаете название документа в заголовок.

Команда @settitle должна предшествовать всему, что производит действительный вывод в TeX.

Хотя заголовок в команде @settitle обычно тот же самый, что и заголовок на титульном листе, это никак не влияет на то, что печатается на титульном листе. Таким образом, эти два заголовка не обязаны совпадать; заголовок в команде @settitle может быть сокращенной или расширенной версией названия, печатаемого на титульном листе. (See section @titlepage.)

TeX печатает заголовки страниц только для того текста, который следует в Texinfo-файле после команды @end titlepage или находится после команды @headings, которая включает печать заголовков. See section Команда @headings, для более детальной информации.

Вы также можете, если желаете, создать ваши собственные заголовки страниц. Для более детальной информации смотрите section Заголовки страниц.

@setchapternewpage

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

Вы можете использовать команду @setchapternewpage с различными аргументами, чтобы определить, как TeX должен начинать главы и должен ли он форматировать текст для печати на одной или на обеих сторонах бумаги (односторонняя или двусторонняя печать).

Пишите команду @setchapternewpage в начале строки, далее добавьте соответствующий аргумент.

Например, вы хотите, чтобы все главы начинались с новой нечетной страницы:

@setchapternewpage odd

С помощью команды @setchapternewpage вы можете выбрать одну из трех альтернатив:

@setchapternewpage off
Заставляет TeX начинать новую главу на той же самой странице, где кончается предыдущая глава после некоторого вертикального пропуска. Также, заставляет TeX форматировать заголовки страниц для односторонней печати. (Вы можете переопределить формат заголовков с помощью команды @headings double. Для дополнительной информации смотрите section Команда @headings.)
@setchapternewpage on
Заставляет TeX начинать новые главы с новых страниц и форматировать заголовки страниц для односторонней печати. Эта форма наиболее часто используется для коротких докладов или личных распечаток. Эта альтернатива осуществляется по умолчанию.
@setchapternewpage odd
Заставляет TeX начинать новые главы с новых нечетных (правых) страниц и форматировать текст для двусторонней печати. Это форма наиболее часто используется для книг и руководств.

В Texinfo нет команды @setchapternewpage even.

Вы можете переопределить или изменить действие команды @setchapternewpage на заголовки с помощью команды @headings. See section Команда @headings.)

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

Так как Info-файл не имеет страниц, то команда @setchapternewpage не влияет на него.

Мы рекомендуем вообще не включать команду @setchapternewpage в исходный текст вашего руководства, так как желаемый вывод не определяется внутренне документом. Вместо этого, если вам не нравится вариант по умолчанию (нет пустых строк, на всех страницах одинаковые заголовки), используйте ключ @option{--texinfo} для команды @command{texi2dvi}, чтобы указать, какой вывод вы хотите.

Отступ в начале абзаца

Texinfo-процессоры могут вставить несколько пробелов перед началом абзаца в первой его строке, выделяя таким образом этот абзац. Вы можете использовать команду @paragraphindent, чтобы определить величину отступа. Пишите команду @paragraphindent в начале строки, сопровождая ее параметром `asis' или числом, как здесь:

@paragraphindent отступ

Отступ делается в соответствии со значением числа отступ:

asis
Не изменять существующий отступ (не реализовано в TeX).
0
Не делать отступ.
n
Создавать отступ размером в n пробелов при выводе в Info и в n единиц em в TeX.

Значение переменной отступ по умолчанию равно `asis'. @paragraphindent игнорируется при выводе в формате HTML.

Вставляйте команду @paragraphindent перед или вскоре после строки end-of-header в начале Texinfo-файла. (Если вы вставите команду между строк start-of-header и end-of-header, то команды форматирования области будут делать для абзацев указанный отступ.)

Особенность команд texinfo-format-buffer и texinfo-format-region в том, что они не делают отступ (и не заполняют текст) в тех абзацах, которые содержат команды @w или @*. See section Перезаполнение абзацев, для получения дальнейшей информации.

@exampleindent: отступы в блоках

Texinfo-процессоры делают отступ в каждой строке блоков @example и подобных ему. Для задания этого отступа вы можете использовать команду @exampleindent. Пишите команду @exampleindent на отдельной строке, а после нее указывайте число или `asis':

@exampleindent отступ

Отступ делается в соответствии со значением параметра отступ:

asis
Не изменять существующие отступы (не реализовано в TeX).
0
Опустить отступы.
n
Создавать отступ из n пробелов в Info-выводе или из n единиц em в TeX.

Значение отступа по умолчанию равно пяти. @exampleindent игнорируется при выводе в HTML.

Пишите команду @exampleindent перед или немного после строки, end-of-header, завершающей заголовок Texinfo-файла. (Если вы напишете эту команду между строк start-of-header и end-of-header, команды форматирования области будут делать в примерах указанный отступ.)

Окончание заголовка

Заканчивайте заголовок строкой end-of-header. Эта строка выглядит следующим образом:

@c %**end of header

Если в заголовке файла, между строк start-of-header и end-of-header, вы вставляете команду @setchapternewpage, TeX будет форматировать область в соответствии с этой командой. Точно так же, если вы включаете между строк start-of-header и end-of-header команду @smallbook, TeX будет форматировать область в формате "маленькая книга".

See section Начало заголовка.

Обзор и разрешения на копирование для Info

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

Уведомление об авторских правах должно выглядеть так:

(C) обладатель-авторских-прав, год

и находиться на отдельной строке.

Стандартный текст уведомления содержится в приложении к этому руководству; смотрите section Разрешения на копирование для Info, для получения полной версии текста.

Текст условий распространения появляется в Info-файле перед первой нодой. Это означает, что читатель не видит этот текст при чтении файла с использованием Info, если только он не использует продвинутую команду Info g*.

Титульный лист и страница с информацией об авторских правах

Название руководства и имя автора обычно печатаются на титульном листе.

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

Вы можете захотеть включить информацию вида титульного листа в вывод в простом текстовом формате. Просто поместите любой такой начальный материал между @ifinfo и @end ifinfo; @command{makeinfo} включит его в простой текстовый вывод. Этого не будет видно в программах чтения Info.

See section Разрешение на копирование на титульном листе, стандартный текст условий распространения.

@titlepage

Начинайте материал для титульного листа и последующей страницы с информацией об авторских правах с команды @titlepage, занимающей всю первую строку, и заканчивайте строкой с командой @end titlepage.

Команда @end titlepage, начинает новую страницу и включает нумерацию страниц. (See section Заголовки страниц, для дополнительной информации). Весь материал, который вы хотите разместить на ненумерованных страницах, должен быть помещен между командами @titlepage и @end titlepage. Вы можете создать в этом месте содержание с помощью команды @setcontentsaftertitlepage (see section Создание содержания).

Используйте команду @page, чтобы вставить в пределах области, очерченной командами @titlepage и @end titlepage, разрыв страницы и создать таким образом больше одной ненумерованной страницы. Так как создается страница с информацией об авторских правах. (Вероятно команду @titlepage лучше было бы назвать @titleandadditionalpages, но это слишком длинно!)

Когда вы пишете руководство по компьютерной программе, вы должны указать на титульном листе версию программы, к которой применимо данное руководство. Если руководство изменяется чаще, чем программа, или независимо от нее, вы должны также включить номер редакции(5). Это помогает читателям понимать, которое руководство для какой версии программы. (Первая нода также должна содержать эту информацию; смотрите section @top.)

Texinfo предоставляет два основных метода для создания титульного листа. Один метод использует команды @titlefont, @sp и @center, чтобы создать титульный лист, в котором слова на странице центрируется.

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

Вы можете использовать один из методов или комбинировать их; смотрите последующие разделы.

Для чрезвычайно простых случаев в Texinfo есть команда @shorttitlepage, которая принимает единственный аргумент, название. Аргумент набирается на отдельной странице, а затем следует чистая страница.

@titlefont, @center и @sp

Чтобы создать титульный лист для печатного документа, вы можете использовать команды @titlefont, @sp и @center. (Это первый из двух методов для создания титульного листа в Texinfo.)

Используйте команду @titlefont, чтобы выбрать больший шрифт, подходящий для названия. Вы можете использовать @titlefont больше одного раза, если у вас особенно длинное название.

Например:

@titlefont{Texinfo}

Используйте команду @center в начале строки, чтобы отцентрировать текст в этой строке. Например:

@center @titlefont{Texinfo}

центрирует название, которым в этом примере является "Texinfo", напечатанное шрифтом для названий.

Используйте команду @sp, чтобы вставить вертикальный пробел. Например:

@sp 2

Это вставляет две незаполненные строки на напечатанной странице. (See section @sp n: Вставка пустых строк, более подробную информацию о команде @sp.)

Шаблон для этого способа выглядит так:

@titlepage
@sp 10
@center @titlefont{имя-руководства-при-печати}
@sp 2
@center подзаголовок-если-есть
@sp 2
@center автор
...
@end titlepage

Промежутки в примере такие, что текст вмещается на странице формата 8.5 на 11 дюймов.

@title, @subtitle и @author

Вы можете использовать команды @title, @subtitle и @author для создания титульного листа, в котором вертикальный и горизонтальный интервал делаются для вас автоматически. Это отличается от метода, описанного выше, в котором команда @sp является необходимой для настройки вертикальных пропусков.

Пишите команды @title, @subtitle и @author в начале строки, далее за ними в этих же строках должны следовать заголовок, подзаголовок и автор, соответственно.

Команда @title создает строку, в которой название прижимается к левому краю страницы и печатается более крупным, чем обычно, шрифтом. Название подчеркивается черной линейкой. Допустима только одинарная строка; нельзя использовать команду @*, чтобы разбить название на две строки. Чтобы иметь возможность работать с длинными названиями, вам может показаться полезным использовать обе команды @title и @titlefont; смотрите заключительный пример в этом разделе.

Команда @subtitle набирает подзаголовок шрифтом обычного размера и прижимает его к правому краю страницы.

Команда @author печатает шрифтом среднего размера имя автора или авторов в левой части страницы недалеко от нижнего края титульного листа. Имена подчеркиваются черной линейкой, которая тоньше, чем та, что подчеркивает заголовок. (Черная линейка появляется только в том случае, если вслед за строкой команды @author следует строка команды @page.)

Есть два способа применения команды @author: вы можете ввести имя или имена на остающейся части строки, которая начинается с @author:

@author Джейн Смит и Джон До

или вы можете ввести имена одно над другим, используя две (или больше) команды @author:

@author Джейн Смит
@author Джон До

(Только нижнее имя подчеркивается черной линейкой.)

Шаблон для этого метода выглядит так:

@titlepage
@title имя-руководства-при-печати
@subtitle подзаголовок-если-есть
@subtitle второй-подзаголовок
@author автор
@page
...
@end titlepage

Вы можете также комбинировать метод @titlefont, описанный в предыдущем разделе и метод @title, описанный в этом. Это может быть полезно, если у вас есть очень длинное название. Вот пример из реальной жизни:

@titlepage
@titlefont{GNU Software}
@sp 1
@title for MS-Windows and MS-DOS
@subtitle Edition @value{edition} for Release @value{cd-edition}
@author by Daniel Hagerty, Melissa Weisshaus
@author and Eli Zaretskii

(Такое использование @value объясняется в section Пример применения @value.)

Страница с информацией об авторских правах и разрешения

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

Когда текст авторского права печатается на обратной стороне титульного листа, эта страница обычно не нумеруется. Значит, текст уведомления об авторских правах должен писаться в Texinfo между команд @titlepage и @end titlepage.

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

@vskip 0pt plus 1filll

Это команда TeX, которая не поддерживается командами форматирования для Info. Команда @vskip вставляет вертикальный пропуск. Команда `0pt plus 1filll' заставляет TeX создать такой вертикальный пропуск, чтобы сместить последующий текст к нижнему краю страницы. Обратите внимание на использование трех `l' в слове `filll', это правильно в TeX.

В печатном руководстве команда @copyright{} создает знак охраны авторских прав -- `c' внутри круга. (В Info этот знак воспроизводится как `(C)'.) Уведомление об авторских правах имеет официально утвержденную форму записи:

(C) обладатель-авторских-прав, год

Принято помещать информацию о том, как получить руководство, сразу после уведомления об авторских правах перед разрешением на распространение руководства.

Разрешение на распространение должно быть записано здесь, а так же в сегменте обзора между @ifinfo и @end ifinfo сразу после заголовка, так как этот текст появляется только в печатном руководстве, а текст из блока `ifinfo' появляется только в Info-файле.

See section Пример разрешений, стандартный текст разрешений.

Создание заголовков

Команда @end titlepage, занимающая целую строку, не только отмечает конец титульного листа и страницы с информацией об авторских правах, но и заставляет TeX создавать заголовки и номера страниц.

Как уже было сказано, Texinfo имеет два стандартных формата заголовков страниц, один для документов, которые печатаются на одной стороне каждого листа бумаги (односторонняя печать), и другой для документов, которые печатаются с обеих сторон каждого листа (двусторонняя печать). (See section @setchapternewpage.) Вы можете задать эти форматы различными способами:

Большинство документов форматируются в стандартном одностороннем или двустороннем формате. Для печати в двустороннем формате используется команда @setchapternewpage odd, а односторонняя печать производится, если команда @setchapternewpage не задана.

Команда @headings

Команда @headings используется редко. Она задает вид верхних и нижних заголовков страниц. Обычно этим управляет команда @setchapternewpage. Команда @headings нужна вам только в том случае, если команда @setchapternewpage делает не то, что вам нужно, или если вы хотите выключить предопределенные заголовки страниц до определения ваших собственных. Пишите команду @headings сразу после команды @end titlepage.

Вы можете использовать @headings так:

@headings off
Выключает печать заголовков страниц.
@headings single
Включает заголовки страниц, подходящие для односторонней печати.
@headings double
@headings on
Включает заголовки страниц, подходящие для двусторонней печати. Команды @headings on и @headings double являются синонимами.
@headings singleafter
@headings doubleafter
Включает заголовки single или double, соответственно, после текущей выводимой страницы.
@headings on
Включает заголовки страниц: single, если `@setchapternewpage on', и double в противном случае.

Например, предположим, что вы вставили команду @setchapternewpage off перед командой @titlepage, чтобы заставить TeX начинать новую главу на той же самой странице, где закончилась предыдущая. Эта команда также заставляет TeX набирать заголовки страниц для односторонней печати. Чтобы TeX форматировал для двусторонней печати, напишите после @end titlepage команду @headings double.

Вы можете совсем запретить формирование заголовков страниц путем вставки команды @headings off на отдельной строке сразу после строки с командой @end titlepage, как показано:

@end titlepage
@headings off

Команда @headings off перекрывает действие команды @end titlepage, которая в противном случае заставила бы TeX печатать заголовки страниц.

Также, вы можете задать собственный стиль верхних и нижних заголовков. See section Заголовки страниц, для более подробной информации.

Нода Top и главное меню

Нода `Top' -- это нода, с которой вы входите в Info-файл.

Нода `Top' должна содержать краткое описание Info-файла и большое главное меню для доступа ко всему Info-файлу. Это помогает читателю понять, какая информация содержится в данном Info-файле. Кроме того, вы должны указать версию программы, к которой применим этот Info-файл, или по меньшей мере номер редакции Info-файла.

Содержимое ноды `Top' должно появляться только в Info-файле и не должно печататься, поэтому заключайте его между команд @ifinfo и @end ifinfo. (TeX не печатает ни строки @node, ни меню; они появляются только в Info-файле. То есть, строго говоря, вам не нужно заключать эти части их между команд @ifinfo и @end ifinfo, но проще всего все же сделать это. See section Условно видимый текст.)

Заголовок в ноде Top

Иногда вам нужно будет вставить команду структурирования @top, содержащую название документа, сразу после строки @node Top (See section @top, для более детальной информации).

Например, нода `Top' данного руководства содержит в начале команду описания структуры глав @top, краткое описание, номер редакции документа и версию программы. И все это выглядит следующим образом:

...
@end titlepage

@ifnottex
@node Top, Копирование, , (dir)
@top Texinfo
Texinfo --- это система документации...
Это версия ...
...
@end ifnottex

@menu
* Копирование::                 Ваши права.
* Обзор::                       Коротко о Texinfo.
...
@end menu

Указатели `Previous' и `Up' в ноде `Top' обычно ссылаются на каталог верхнего уровня всей системы Info, который называется `(dir)'. Нода `Next' ссылается на первую ноду, которая следует сразу за главным меню; обычно это разрешение на копирование, введение или первая глава.

Части главного меню

Главное меню -- это подробное меню, содержащее ссылки на все ноды в файле.

Главное меню заключается между команд @menu и @end menu и не появляется в печатном руководстве.

Как правило, главное меню делится на части.

Каждая часть меню может быть представлена строкой описания. Если строка не начинается со звездочки, она не будет восприниматься как пункт меню. (See section Написание меню, для более детальной информации.)

Например, главное меню этого руководства выглядит следующим образом (но в нем гораздо больше пунктов):

@menu
* Копирование::                 Ваши права.
* Обзор::                       Коротко о Texinfo.
* Режим Texinfo::               Как использовать режим Texinfo.
...
...
* Указатель команд и переменных::
* Указатель понятий::           Меню, охватывающее все темы.

@detailmenu
 --- Полный список нод ---

Обзор Texinfo

* Описание ошибок::             Посылка эффективных сообщений об
                                ошибках.
* Использование Texinfo::       Создание обычной печатной книги или
                                Info-файла.
...
...

Использование режима Texinfo
* Обзор режима Texinfo::        Как режим Texinfo может вам помочь.
...
...
@end detailmenu
@end menu

Разрешение на копирование программы

Если Texinfo-файл имеет раздел, содержащий "Универсальную Общественную Лицензию", разрешение на распространение и отказ от предоставления гарантий для документируемого программного обеспечения, этот раздел обычно следует после ноды `Top'. Универсальная Общественная Лицензия --- это юридический документ, который очень важен для программного обеспечения Проекта GNU. Он дает вам и другим людям уверенность в том, что право на использование и распространение данного программного обеспечения у вас не отнимут.

После информации о копировании и распространении и отказа от предоставления гарантий следует введение или первая глава руководства.

Хотя введение не является обязательной частью Texinfo-файла, присутствие его в документе очень полезно. В идеальном случае во введении должно быть кратко и ясно изложено, о чем рассказывается в данном Texinfo-файле и кому он может быть интересен. Вообще говоря, введение следует после информации о разрешениях на распространение, хотя иногда некоторые люди помещают эту часть в документе раньше. Обычно введение помещается в ненумерованном разделе (созданном командой @unnumbered). (See section @unnumbered и @appendix.)


Go to the first, previous, next, last section, table of contents.