doc/include/texinfo.tex

1 % texinfo.tex -- TeX macros to handle Texinfo files.
12 % This texinfo.tex file is free software: you can redistribute it and/or
17 % This texinfo.tex file is distributed in the hope that it will be
29 % Please try the latest version of texinfo.tex before submitting bug
31 %   http://ftp.gnu.org/gnu/texinfo/ (the Texinfo release area), or
32 %   http://ftpmirror.gnu.org/texinfo/ (same, via a mirror), or
33 %   http://www.gnu.org/software/texinfo/ (the Texinfo home page)
34 % The texinfo.tex in any given distribution could well be out
37 % Send bug reports to bug-texinfo@gnu.org.  Please include including a
53 % It is possible to adapt texinfo.tex for other languages, to some
57 % The GNU Texinfo home page is http://www.gnu.org/software/texinfo.
60 \message{Loading texinfo [version \texinfoversion]:}
516 % Define the framework for environments in texinfo.tex.  It's used like this:
635 % max (\topskip - \ht (first item), 0).  If that height is large,
854     \wlog{texinfo.tex: doing @include of #1^^J}%
1040 % @setfilename is done at the beginning of every texinfo file.
1042 % This makes it possible to make a .fmt file for texinfo.
1044    \fixbackslash  % Turn off hack to swallow `\input texinfo'.
1053    % If texinfo.cnf is present on the system, read it.
1055    \openin 1 texinfo.cnf
1056    \ifeof 1 \else \input texinfo.cnf \fi
1782 % before you read in texinfo.tex.
2091 % texinfo doesn't allow for producing subscripts and superscripts except
2179 % Fonts for short table of contents.
2795 % @asis just yields its argument.  Used with @table, for example.
2824   % make the texinfo accent commands work in math mode
2840 % to a command which sets the catcodes (such as @item or @section).
3468 % Tables -- @table, @ftable, @vtable, @item(x).
3470 % default indentation of table text
3474 % margin between end of table item and start of table text.
3480 % Note @table, @ftable, and @vtable define @item, @itemx, etc., with
3483 % to index the item name in whatever manner is desired (perhaps none).
3499   % If the item text does not fit in the space we have, put it on a line
3516     % \parskip glue -- logically it's part of the @item we just started.
3522     % cause the example and the item to crash together.  So we use this
3530     % The item text fits into the space.  Start a paragraph, so that the
3534     % the item text, it can migrate to the main vertical list and
3545 \def\item{\errmessage{@item while not in a list environment}}
3548 % @table, @ftable, @vtable.
3549 \envdef\table{%
3551   \tablecheck{table}%
3595   \let\item = \internalBitem
3620   % Try typesetting the item mark that if the document erroneously says
3621   % something like @itemize @samp (intending @table), there's an error
3623   % world, but it's better than leaving it to the @item.  This means if
3631   \let\item=\itemizeitem
3634 % Definition of @item while inside @itemize and @enumerate.
3643    % parskip, or the item text will crash with the heading.  On the
3644    % other hand, when there is normal text preceding the item (as there
3652    \vadjust{\penalty 1200}}% not good to break after first line of item.
3739 % \itemno, since @item increments \itemno.
3769 %   @item ...
3778 %   @item ...
3781 % Each new table line starts with @item, each subsequent new column
3786 % @item, @tab do not need to be on their own lines, but it will not hurt
3792 %   @item first col stuff @tab second col stuff @tab third col
3793 %   @item
3799 %   @item first col stuff @tab second col stuff
3803 %   @item@tab@tab This will be in third column.
3807 % @multitableparskip is vertical space between paragraphs in table.
3808 % @multitableparindent is paragraph indent in table.
3810 % @multitablelinespace is space to leave between table items, baseline
3880   \the\everytab % for the first item
3897   % @item within a multitable starts a normal row.
3899   % contains an @itemize, we don't choke on the \item (seen as \crcr aka
3901   \def\item{\crcr}%
3917       % Keeps underfull box messages off when table breaks over pages.
3920 	% table breaks over pages. Wouldn't \vfil be better?  Wait until the
3928   % To parse everything between @multitable and @item:
3973       % @item @code{#}
3992   % See bug-texinfo report from Werner Lemberg, 31 Oct 2004 12:52:20 +0100.
3998 % table. If not, do nothing.
4003                                       % than skip between lines in the table.
4008                                       % than skip between lines in the table.
4069 { \catcode`_=11 % We want to use \_STOP_ which cannot appear in texinfo source.
4343   % help-texinfo, 22may06):
4769   % If \lastskip is nonzero, that means the last item was a
4772   % non-discardable item, therefore it is not a potential
4782     % If \lastskip was zero, perhaps the last item was a penalty, and
4785     % signals); since we just inserted a non-discardable item, any
4795     % this make-up glue would be preceded by a non-discardable item
4911 % and table of contents entries.  The paragraph is indented by \leftskip.
5902   % discardable item.)  However, when a paragraph is not started next
5908   % This is so the last item on the main vertical list is a known
5931 % table of contents chapter openings themselves.
5954   % writing pdf.  These are used in the table of contents.  We can't
6093 % These macros generate individual entries in the table of contents.
6670 % because texinfo's \verbatim doesn't stop at '\end{verbatim}':
6701     \wlog{texinfo.tex: doing @verbatiminclude of #1^^J}%
7222 % (as in normal texinfo). It is necessary to change the definition of \
8292 % text to a box and make the \insert when a row of the table is finished.
8653 % @listoffloats FLOATTYPE - print a list of floats like a table of contents.
9732   % your texinfo source file like this:
9819 \message{and turning on texinfo input format.}
9911 % In texinfo, backslash is an active character; it prints the backslash
9957 % If a .fmt file is being used, we don't want the `\input texinfo' to show up.
9961 @gdef@eatinput input texinfo{@fixbackslash}
9964 % On the other hand, perhaps the file did not have a `\input texinfo'. Then