home
***
CD-ROM
|
disk
|
FTP
|
other
***
search
/
Fresh Fish 1
/
FFMCD01.bin
/
useful
/
info
/
texi.info-4
(
.txt
)
< prev
next >
Wrap
GNU Info File
|
1993-09-27
|
50KB
|
944 lines
This is Info file texi.info, produced by Makeinfo-1.55 from the input
file texi.texi.
This file documents Texinfo, a documentation system that uses a
single source file to produce both on-line information and a printed
manual.
Copyright (C) 1988, 1990, 1991, 1992, 1993 Free Software Foundation,
This is the second edition of the Texinfo documentation,
and is consistent with version 2 of `texinfo.tex'.
Permission is granted to make and distribute verbatim copies of this
manual provided the copyright notice and this permission notice are
preserved on all copies.
Permission is granted to copy and distribute modified versions of
this manual under the conditions for verbatim copying, provided that
the entire resulting derived work is distributed under the terms of a
permission notice identical to this one.
Permission is granted to copy and distribute translations of this
manual into another language, under the above conditions for modified
versions, except that this permission notice may be stated in a
translation approved by the Free Software Foundation.
File: texi.info, Node: Node Line Requirements, Next: First Node, Prev: Node Line Tips, Up: node
`@node' Line Requirements
-------------------------
Here are several requirements for `@node' lines:
* All the node names for a single Info file must be unique.
Duplicates confuse the Info movement commands. This means, for
example, that if you end every chapter with a summary, you must
name each summary node differently. You cannot just call each one
"Summary". You may, however, duplicate the titles of chapters,
sections, and the like. Thus you can end each chapter in a book
with a section called "Summary", so long as the node names for
those sections are all different.
* A pointer name must be the name of a node.
The node to which a pointer points may come before or after the
node containing the pointer.
* You cannot use any of the Texinfo @-commands in a node name;
@-commands confuse Info.
Thus, the beginning of the section called `@chapter' looks like
this:
@node chapter, unnumbered & appendix, makeinfo top, Structuring
@comment node-name, next, previous, up
@section @code{@@chapter}
@findex chapter
* You cannot use commas, colons, or apostrophes within a node name;
these confuse TeX or the Info formatters.
For example, the following is a section title:
@code{@@unnumberedsec}, @code{@@appendixsec}, @code{@@heading}
The corresponding node name is:
unnumberedsec appendixsec heading
* Case is significant.
File: texi.info, Node: First Node, Next: makeinfo top command, Prev: Node Line Requirements, Up: node
The First Node
--------------
The first node of a Texinfo file is the `Top' node, except in an
included file (*note Include Files::.).
The `Top' node (which must be named `top' or `Top') should have as
its `Up' and `Previous' nodes the name of a node in another file, where
there is a menu that leads to this file. Specify the file name in
parentheses. If the file is to be installed directly in the Info
directory file, use `(dir)' as the parent of the `Top' node; this is
short for `(dir)top', and specifies the `Top' node in the `dir' file,
which contains the main menu for Info. For example, the `@node Top'
line of this manual looks like this:
@node Top, Overview, (dir), (dir)
(You may use the Texinfo updating commands or the `makeinfo' utility to
insert these `Next' and `(dir)' pointers automatically.)
*Note Install an Info File::, for more information about installing
an Info file in the `info' directory.
The `Top' node contains the main or master menu for the document.
File: texi.info, Node: makeinfo top command, Next: Top Node Summary, Prev: First Node, Up: node
The `@top' Sectioning Command
-----------------------------
A special sectioning command, `@top', has been created for use with
the `@node Top' line. The `@top' sectioning command tells `makeinfo'
that it marks the `Top' node in the file. It provides the information
that `makeinfo' needs to insert node pointers automatically. Write the
`@top' command at the beginning of the line immediately following the
`@node Top' line. Write the title on the remaining part of the same
line as the `@top' command.
In Info, the `@top' sectioning command causes the title to appear on
a line by itself, with a line of asterisks inserted underneath.
In TeX and `texinfo-format-buffer', the `@top' sectioning command is
merely a synonym for `@unnumbered'. Neither of these formatters
require an `@top' command, and do nothing special with it. You can use
`@chapter' or `@unnumbered' after the `@node Top' line when you use
these formatters. Also, you can use `@chapter' or `@unnumbered' when
you use the Texinfo updating commands to create or update pointers and
menus.
Whatever sectioning command follows an `@node Top' line, whether it
be `@top' or `@chapter', the `@node Top' line and the immediately
following line and any additional text must be enclosed between
`@ifinfo' and `@end ifinfo' commands. (*Note Conditionals::.) This
prevents the title and the accompanying text from appearing in printed
output. Write the `@ifinfo' command before the `@node' line and write
the `@end ifinfo' command after the `@top' or other sectioning command
and after any additional text. (You can write the `@end ifinfo'
command after the `@end menu' command if you like.)
File: texi.info, Node: Top Node Summary, Prev: makeinfo top command, Up: node
The `Top' Node Summary
----------------------
You can help readers by writing a summary in the `Top' node, after
the `@top' line, before the main or master menu. The summary should
briefly describe the Info file. You should also write the version
number of the program to which the manual applies in this section. This
helps the reader keep track of which manual is for which version of the
program. If the manual changes more frequently than the program or is
independent of it, you should also include an edition number for the
manual. (The title page should also contain this information: see
*Note `@titlepage': titlepage.)
Put the whole of the `Top' node, including the `@top' sectioning
command line if you have one, between `@ifinfo' and `@end ifinfo' so
none of the text appears in the printed output (*note Conditionally
Visible Text: Conditionals.). (You may want to repeat the brief
description from the `Top' node within `@iftex' ... `@end iftex' at the
beginning of the first chapter, for those who read the printed manual.)
File: texi.info, Node: makeinfo Pointer Creation, Prev: node, Up: Nodes
Creating Pointers with `makeinfo'
=================================
The `makeinfo' program has a feature for automatically creating node
pointers for a hierarchically organized file that lacks them.
When you take advantage of this feature, you do not need to write the
`Next', `Previous', and `Up' pointers after the name of a node.
However, you must write a sectioning command, such as `@chapter' or
`@section', on the line immediately following each truncated `@node'
line. You cannot write a comment line after a node line; the section
line must follow it immediately.
In addition, you must follow the `Top' `@node' line with a line
beginning with `@top' to mark the `Top' node in the file. *Note `@top':
makeinfo top.
Finally, you must write the name of each node (except for the `Top'
node) in a menu that is one or more hierarchical levels above the
node's hierarchical level.
This node pointer insertion feature in `makeinfo' is an alternative
to the menu and pointer creation and update commands in Texinfo mode.
(*Note Updating Nodes and Menus::.) It is especially helpful to people
who do not use GNU Emacs for writing Texinfo documents.
File: texi.info, Node: Menus, Next: Cross References, Prev: Nodes, Up: Top
Menus
*****
"Menus" contain pointers to subordinate nodes.(1) In Info, you use
menus to go to such nodes. Menus have no effect in printed manuals and
do not appear in them.
By con