Go to the previous, next section.
Texinfo has several ways of making lists and two-column tables. Lists can be bulleted or numbered, while two-column tables can highlight the items in the first column.
Texinfo automatically indents the text in lists or tables, and numbers an enumerated list. This last feature is useful if you modify the list, since you do not need to renumber it yourself.
Numbered lists and tables begin with the appropriate @-command at the
beginning of a line, and end with the corresponding @end
command on a line by itself. The table and itemized-list commands
also require that you write formatting information on the same line as
the beginning @-command.
Begin an enumerated list, for example, with an @enumerate
command and end the list with an @end enumerate command.
Begin an itemized list with an @itemize command, followed on
the same line by a formatting command such as @bullet, and end
the list with an @end itemize command.
Precede each element of a list with an @item or @itemx
command.
Here is an itemized list of the different kinds of table and lists:
Here is an enumerated list with the same items:
And here is a two-column table with the same items and their @-commands:
@itemize
@enumerate
@table
@ftable
@vtable
The @itemize command produces sequences of indented
paragraphs, with a bullet or other mark inside the left margin
at the beginning of each paragraph for which such a mark is desired.
Begin an itemized list by writing @itemize at the beginning of
a line. Follow the command, on the same line, with a character or a
Texinfo command that generates a mark. Usually, you will write
@bullet after @itemize, but you can use
@minus, or any character or any special symbol that results in
a single character in the Info file. (When you write @bullet
or @minus after an @itemize command, you may omit the
`{}'.)
Write the text of the indented paragraphs themselves after the
@itemize, up to another line that says @end
itemize.
Before each paragraph for which a mark in the margin is desired, write
a line that says just @item. Do not write any other text on this
line.
Usually, you should put a blank line before an @item. This
puts a blank line in the Info file. (TeX inserts the proper
interline whitespace in either case.) Except when the entries are
very brief, these blank lines make the list look better.
Here is an example of the use of @itemize, followed by the
output it produces. Note that @bullet produces an `*' in
Info and a round dot in TeX.
@itemize @bullet @item Some text for foo. @item Some text for bar. @end itemize
This produces:
- Some text for foo.
- Some text for bar.
Itemized lists may be embedded within other itemized lists. Here is a list marked with dashes embedded in a list marked with bullets:
@itemize @bullet @item First item. @itemize @minus @item Inner item. @item Second inner item. @end itemize @item Second outer item. @end itemize
This produces:
- First item.
- Inner item.
- Second inner item.
- Second outer item.
@enumerate is like @itemize except that the marks in
the left margin contain successive integers or letters.
(See section Making an Itemized List.)
Write the @enumerate command at the beginning of a line.
The command does not require an argument, but accepts either a number or
a letter as an option.
Without an argument, @enumerate starts the list
with the number 1. With a numeric argument, such as 3,
the command starts the list with that number.
With an upper or lower case letter, such as a or A,
the command starts the list with that letter.
Write the text of the enumerated list in the same way you write an
itemized list: put @item on a line of its own before the start of
each paragraph that you want enumerated. Do not write any other text on
the line beginning with @item.
You should put a blank line between entries in the list. This generally makes it easier to read the Info file.
Here is an example of @enumerate without an argument:
@enumerate @item Underlying causes. @item Proximate causes. @end enumerate
This produces:
Here is an example with an argument of 3:
@enumerate 3 @item Predisposing causes. @item Precipitating causes. @item Perpetuating causes. @end enumerate
This produces:
Here is a brief summary of the alternatives. The summary is constructed
using @enumerate with an argument of a.
@enumerate
Without an argument, produce a numbered list, starting with the number 1.
@enumerate positive-integer
With a (positive) numeric argument, start a numbered list with that number. You can use this to continue a list that you interrupted with other text.
@enumerate upper-case-letter
With an upper case letter as argument, start a list in which each item is marked by a letter, beginning with that upper case letter.
@enumerate lower-case-letter
With a lower case letter as argument, start a list in which each item is marked by a letter, beginning with that lower case letter.
You can also nest enumerated lists, as in an outline.
@table is similar to @itemize, but the command allows
you to specify a name or heading line for each item. (See section Making an Itemized List}.) The @table command is used to produce
two-column tables, and is especially useful for glossaries and
explanatory exhibits.
Write the @table command at the beginning of a line and follow
it on the same line with an argument that is a Texinfo command such as
@code, @samp, @var, or @kbd.
Although these commands are usually followed by arguments in braces,
in this case you use the command name without an argument because
@item will supply the argument. This command will be applied
to the text that goes into the first column of each item and
determines how it will be highlighted. For example, @samp
will cause the text in the first column to be highlighted with an
@samp command.
You may also choose to use the @asis command as an argument to
@table. @asis is a command that does nothing; if you use this
command after @table, TeX and the Info formatting commands
output the first column entries without added highlighting (`as
is').
(The @table command may work with other commands besides those
listed here. However, you can only use commands
that normally take arguments in braces.)
Begin each table entry with an @item command at the beginning
of a line. Write the first column text on the same line as the
@item command. Write the second column text on the line
following the @item line and on subsequent lines. (You do not
need to type anything for an empty second column entry.) You may
write as many lines of supporting text as you wish, even several
paragraphs. But only text on the same line as the @item will
be placed in the first column.
Normally, you should put a blank line before an @item line.
This puts a blank like in the Info file. Except when the entries are
very brief, a blank line looks better.
The following table, for example, highlights the text in the first
column with an @samp command:
@table @samp
@item foo
This is the text for
@samp{foo}.
@item bar
Text for @samp{bar}.
@end table
This produces:
If you want to list two or more named items with a single block of
text, use the @itemx command. (See section @itemx}.)
@ftable and @vtable
The @ftable and @vtable commands are the same as the
@table command except that @ftable automatically enters
each of the items in the first column of the table into the index of
functions and @vtable automatically enters each of the items in
the first column of the table into the index of variables. This
simplifies the task of creating indices. Only the items on the same
line as the @item commands are indexed, and they are indexed in
exactly the form that they appear on that line. See section Creating Indices, for more information about indices.
Begin a two-column table using @ftable or @vtable by
writing the @-command at the beginning of a line, followed on the same
line by an argument that is a Texinfo command such as @code,
exactly as you would for an @table command; and end the table
with an @end ftable or @end vtable command on a line by
itself.
@itemx
Use the @itemx command inside a table when you have two or
more first column entries for the same item, each of which should
appear on a line of its own. Use @itemx for all but the first
entry. The @itemx command works exactly like @item
except that it does not generate extra vertical space above the first
column text.
For example,
@table @code @item upcase @itemx downcase These two functions accept a character or a string as argument, and return the corresponding upper case (lower case) character or string. @end table
This produces:
upcase
downcase
(Note also that this example illustrates multi-line supporting text in a two-column table.)
Go to the previous, next section.