comparison man/texinfo.tex @ 5492:e82f5b7010fe

Merge some stuff in man, fix up Makefile -------------------- ChangeLog entries follow: -------------------- man/ChangeLog addition: 2010-02-19 Ben Wing <ben@xemacs.org> * widget.texi: * widget.texi (Top): * widget.texi (Introduction): * widget.texi (User Interface): * widget.texi (Programming Example): * widget.texi (Setting Up the Buffer): * widget.texi (Basic Types): * widget.texi (link): * widget.texi (url-link): * widget.texi (info-link): * widget.texi (push-button): * widget.texi (editable-field): * widget.texi (text): * widget.texi (menu-choice): * widget.texi (radio-button-choice): * widget.texi (item): * widget.texi (choice-item): * widget.texi (toggle): * widget.texi (checkbox): * widget.texi (checklist): * widget.texi (editable-list): * widget.texi (group): * widget.texi (Sexp Types): * widget.texi (constants): * widget.texi (generic): * widget.texi (atoms): * widget.texi (composite): * widget.texi (Widget Properties): * widget.texi (Defining New Widgets): * widget.texi (Widget Browser): * widget.texi (Widget Minor Mode): * widget.texi (Utilities): * widget.texi (Widget Wishlist): * widget.texi (Widget Internals): * widget.texi (GNU Free Documentation License): * widget.texi (Index): Sync with FSF 23.1.92. 2010-02-19 Ben Wing <ben@xemacs.org> * texinfo/fdl.texi: New file. * texinfo/texinfo.texi: * texinfo/texinfo.texi (Top): * texinfo/texinfo.texi (Copying Conditions): * texinfo/texinfo.texi (Overview): * texinfo/texinfo.texi (Reporting Bugs): * texinfo/texinfo.texi (Using Texinfo): * texinfo/texinfo.texi (Output Formats): * texinfo/texinfo.texi (Info Files): * texinfo/texinfo.texi (Printed Books): * texinfo/texinfo.texi (Formatting Commands): * texinfo/texinfo.texi (Conventions): * texinfo/texinfo.texi (Comments): * texinfo/texinfo.texi (Minimum): * texinfo/texinfo.texi (Six Parts): * texinfo/texinfo.texi (Short Sample): * texinfo/texinfo.texi (History): * texinfo/texinfo.texi (Texinfo Mode): * texinfo/texinfo.texi (Texinfo Mode Overview): * texinfo/texinfo.texi (XEmacs Editing): * texinfo/texinfo.texi (Inserting): * texinfo/texinfo.texi (Showing the Structure): * texinfo/texinfo.texi (Updating Nodes and Menus): * texinfo/texinfo.texi (Updating Commands): * texinfo/texinfo.texi (Updating Requirements): * texinfo/texinfo.texi (Other Updating Commands): * texinfo/texinfo.texi (Info Formatting): * texinfo/texinfo.texi (Printing): * texinfo/texinfo.texi (Texinfo Mode Summary): * texinfo/texinfo.texi (Beginning a File): * texinfo/texinfo.texi (Sample Beginning): * texinfo/texinfo.texi (Texinfo File Header): * texinfo/texinfo.texi (First Line): * texinfo/texinfo.texi (Start of Header): * texinfo/texinfo.texi (setfilename): * texinfo/texinfo.texi (settitle): * texinfo/texinfo.texi (End of Header): * texinfo/texinfo.texi (Document Permissions): * texinfo/texinfo.texi (copying): * texinfo/texinfo.texi (insertcopying): * texinfo/texinfo.texi (Titlepage & Copyright Page): * texinfo/texinfo.texi (titlepage): * texinfo/texinfo.texi (titlefont center sp): * texinfo/texinfo.texi (title subtitle author): * texinfo/texinfo.texi (Copyright): * texinfo/texinfo.texi (end titlepage): * texinfo/texinfo.texi (headings on off): * texinfo/texinfo.texi (Contents): * texinfo/texinfo.texi (The Top Node): * texinfo/texinfo.texi (Top Node Example): * texinfo/texinfo.texi (Master Menu Parts): * texinfo/texinfo.texi (Global Document Commands): * texinfo/texinfo.texi (documentdescription): * texinfo/texinfo.texi (setchapternewpage): * texinfo/texinfo.texi (paragraphindent): * texinfo/texinfo.texi (firstparagraphindent): * texinfo/texinfo.texi (exampleindent): * texinfo/texinfo.texi (Software Copying Permissions): * texinfo/texinfo.texi (Ending a File): * texinfo/texinfo.texi (Printing Indices & Menus): * texinfo/texinfo.texi (File End): * texinfo/texinfo.texi (Structuring): * texinfo/texinfo.texi (Tree Structuring): * texinfo/texinfo.texi (Structuring Command Types): * texinfo/texinfo.texi (makeinfo top): * texinfo/texinfo.texi (chapter): * texinfo/texinfo.texi (unnumbered & appendix): * texinfo/texinfo.texi (majorheading & chapheading): * texinfo/texinfo.texi (section): * texinfo/texinfo.texi (unnumberedsec appendixsec heading): * texinfo/texinfo.texi (subsection): * texinfo/texinfo.texi (unnumberedsubsec appendixsubsec subheading): * texinfo/texinfo.texi (subsubsection): * texinfo/texinfo.texi (Raise/lower sections): * texinfo/texinfo.texi (Nodes): * texinfo/texinfo.texi (Two Paths): * texinfo/texinfo.texi (Node Menu Illustration): * texinfo/texinfo.texi (node): * texinfo/texinfo.texi (Node Names): * texinfo/texinfo.texi (Writing a Node): * texinfo/texinfo.texi (Node Line Tips): * texinfo/texinfo.texi (Node Line Requirements): * texinfo/texinfo.texi (First Node): * texinfo/texinfo.texi (makeinfo top command): * texinfo/texinfo.texi (makeinfo Pointer Creation): * texinfo/texinfo.texi (anchor): * texinfo/texinfo.texi (Menus): * texinfo/texinfo.texi (Menu Location): * texinfo/texinfo.texi (Writing a Menu): * texinfo/texinfo.texi (Menu Parts): * texinfo/texinfo.texi (Less Cluttered Menu Entry): * texinfo/texinfo.texi (Menu Example): * texinfo/texinfo.texi (Other Info Files): * texinfo/texinfo.texi (Cross References): * texinfo/texinfo.texi (References): * texinfo/texinfo.texi (Cross Reference Commands): * texinfo/texinfo.texi (Cross Reference Parts): * texinfo/texinfo.texi (xref): * texinfo/texinfo.texi (Reference Syntax): * texinfo/texinfo.texi (One Argument): * texinfo/texinfo.texi (Two Arguments): * texinfo/texinfo.texi (Three Arguments): * texinfo/texinfo.texi (Four and Five Arguments): * texinfo/texinfo.texi (Top Node Naming): * texinfo/texinfo.texi (ref): * texinfo/texinfo.texi (pxref): * texinfo/texinfo.texi (inforef): * texinfo/texinfo.texi (uref): * texinfo/texinfo.texi (cite): * texinfo/texinfo.texi (Marking Text): * texinfo/texinfo.texi (Indicating): * texinfo/texinfo.texi (Useful Highlighting): * texinfo/texinfo.texi (code): * texinfo/texinfo.texi (kbd): * texinfo/texinfo.texi (key): * texinfo/texinfo.texi (samp): * texinfo/texinfo.texi (verb): * texinfo/texinfo.texi (var): * texinfo/texinfo.texi (env): * texinfo/texinfo.texi (file): * texinfo/texinfo.texi (command): * texinfo/texinfo.texi (option): * texinfo/texinfo.texi (dfn): * texinfo/texinfo.texi (abbr): * texinfo/texinfo.texi (acronym): * texinfo/texinfo.texi (indicateurl): * texinfo/texinfo.texi (email): * texinfo/texinfo.texi (Emphasis): * texinfo/texinfo.texi (emph & strong): * texinfo/texinfo.texi (Smallcaps): * texinfo/texinfo.texi (Fonts): * texinfo/texinfo.texi (Quotations and Examples): * texinfo/texinfo.texi (Block Enclosing Commands): * texinfo/texinfo.texi (quotation): * texinfo/texinfo.texi (example): * texinfo/texinfo.texi (verbatim): * texinfo/texinfo.texi (verbatiminclude): * texinfo/texinfo.texi (lisp): * texinfo/texinfo.texi (small): * texinfo/texinfo.texi (display): * texinfo/texinfo.texi (format): * texinfo/texinfo.texi (exdent): * texinfo/texinfo.texi (flushleft & flushright): * texinfo/texinfo.texi (noindent): * texinfo/texinfo.texi (indent): * texinfo/texinfo.texi (cartouche): * texinfo/texinfo.texi (Lists and Tables): * texinfo/texinfo.texi (Introducing Lists): * texinfo/texinfo.texi (itemize): * texinfo/texinfo.texi (enumerate): * texinfo/texinfo.texi (Two-column Tables): * texinfo/texinfo.texi (table): * texinfo/texinfo.texi (ftable vtable): * texinfo/texinfo.texi (itemx): * texinfo/texinfo.texi (Multi-column Tables): * texinfo/texinfo.texi (Multitable Column Widths): * texinfo/texinfo.texi (Multitable Rows): * texinfo/texinfo.texi (Special Displays): * texinfo/texinfo.texi (Floats): * texinfo/texinfo.texi (float): * texinfo/texinfo.texi (caption shortcaption): * texinfo/texinfo.texi (listoffloats): * texinfo/texinfo.texi (Images): * texinfo/texinfo.texi (Image Syntax): * texinfo/texinfo.texi (Image Scaling): * texinfo/texinfo.texi (Footnotes): * texinfo/texinfo.texi (Footnote Commands): * texinfo/texinfo.texi (Footnote Styles): * texinfo/texinfo.texi (Indices): * texinfo/texinfo.texi (Index Entries): * texinfo/texinfo.texi (Predefined Indices): * texinfo/texinfo.texi (Indexing Commands): * texinfo/texinfo.texi (Combining Indices): * texinfo/texinfo.texi (syncodeindex): * texinfo/texinfo.texi (synindex): * texinfo/texinfo.texi (New Indices): * texinfo/texinfo.texi (Insertions): * texinfo/texinfo.texi (Atsign Braces Comma): * texinfo/texinfo.texi (Inserting an Atsign): * texinfo/texinfo.texi (Inserting Braces): * texinfo/texinfo.texi (Inserting a Comma): * texinfo/texinfo.texi (Inserting Quote Characters): * texinfo/texinfo.texi (Inserting Space): * texinfo/texinfo.texi (Not Ending a Sentence): * texinfo/texinfo.texi (Ending a Sentence): * texinfo/texinfo.texi (Multiple Spaces): * texinfo/texinfo.texi (frenchspacing): * texinfo/texinfo.texi (dmn): * texinfo/texinfo.texi (Inserting Accents): * texinfo/texinfo.texi (Inserting Quotation Marks): * texinfo/texinfo.texi (Dots Bullets): * texinfo/texinfo.texi (dots): * texinfo/texinfo.texi (bullet): * texinfo/texinfo.texi (TeX and copyright): * texinfo/texinfo.texi (tex): * texinfo/texinfo.texi (copyright symbol): * texinfo/texinfo.texi (registered symbol): * texinfo/texinfo.texi (euro): * texinfo/texinfo.texi (pounds): * texinfo/texinfo.texi (textdegree): * texinfo/texinfo.texi (minus): * texinfo/texinfo.texi (geq leq): * texinfo/texinfo.texi (math): * texinfo/texinfo.texi (Click Sequences): * texinfo/texinfo.texi (Glyphs): * texinfo/texinfo.texi (Glyphs Summary): * texinfo/texinfo.texi (result): * texinfo/texinfo.texi (expansion): * texinfo/texinfo.texi (Print Glyph): * texinfo/texinfo.texi (Error Glyph): * texinfo/texinfo.texi (Equivalence): * texinfo/texinfo.texi (Point Glyph): * texinfo/texinfo.texi (Breaks): * texinfo/texinfo.texi (Break Commands): * texinfo/texinfo.texi (Line Breaks): * texinfo/texinfo.texi (- and hyphenation): * texinfo/texinfo.texi (allowcodebreaks): * texinfo/texinfo.texi (w): * texinfo/texinfo.texi (tie): * texinfo/texinfo.texi (sp): * texinfo/texinfo.texi (page): * texinfo/texinfo.texi (group): * texinfo/texinfo.texi (need): * texinfo/texinfo.texi (Definition Commands): * texinfo/texinfo.texi (Def Cmd Template): * texinfo/texinfo.texi (Def Cmd Continuation Lines): * texinfo/texinfo.texi (Optional Arguments): * texinfo/texinfo.texi (deffnx): * texinfo/texinfo.texi (Def Cmds in Detail): * texinfo/texinfo.texi (Functions Commands): * texinfo/texinfo.texi (Variables Commands): * texinfo/texinfo.texi (Typed Functions): * texinfo/texinfo.texi (Typed Variables): * texinfo/texinfo.texi (Data Types): * texinfo/texinfo.texi (Abstract Objects): * texinfo/texinfo.texi (Object-Oriented Variables): * texinfo/texinfo.texi (Object-Oriented Methods): * texinfo/texinfo.texi (Defining Macros): * texinfo/texinfo.texi (Invoking Macros): * texinfo/texinfo.texi (Macro Details): * texinfo/texinfo.texi (alias): * texinfo/texinfo.texi (definfoenclose): * texinfo/texinfo.texi (Hardcopy): * texinfo/texinfo.texi (Use TeX): * texinfo/texinfo.texi (Format with tex/texindex): * texinfo/texinfo.texi (Format with texi2dvi): * texinfo/texinfo.texi (Print with lpr): * texinfo/texinfo.texi (Within XEmacs): * texinfo/texinfo.texi (Texinfo Mode Printing): * texinfo/texinfo.texi (Compile-Command): * texinfo/texinfo.texi (Requirements Summary): * texinfo/texinfo.texi (Preparing for TeX): * texinfo/texinfo.texi (Overfull hboxes): * texinfo/texinfo.texi (smallbook): * texinfo/texinfo.texi (A4 Paper): * texinfo/texinfo.texi (pagesizes): * texinfo/texinfo.texi (Cropmarks and Magnification): * texinfo/texinfo.texi (PDF Output): * texinfo/texinfo.texi (Obtaining TeX): * texinfo/texinfo.texi (Creating and Installing Info Files): * texinfo/texinfo.texi (Creating an Info File): * texinfo/texinfo.texi (makeinfo advantages): * texinfo/texinfo.texi (Invoking makeinfo): * texinfo/texinfo.texi (makeinfo options): * texinfo/texinfo.texi (Pointer Validation): * texinfo/texinfo.texi (makeinfo in XEmacs): * texinfo/texinfo.texi (texinfo-format commands): * texinfo/texinfo.texi (Batch Formatting): * texinfo/texinfo.texi (Tag and Split Files): * texinfo/texinfo.texi (Installing an Info File): * texinfo/texinfo.texi (Directory File): * texinfo/texinfo.texi (New Info File): * texinfo/texinfo.texi (Other Info Directories): * texinfo/texinfo.texi (Installing Dir Entries): * texinfo/texinfo.texi (Invoking install-info): * texinfo/texinfo.texi (Generating HTML): * texinfo/texinfo.texi (HTML Translation): * texinfo/texinfo.texi (HTML Splitting): * texinfo/texinfo.texi (HTML CSS): * texinfo/texinfo.texi (HTML Xref): * texinfo/texinfo.texi (HTML Xref Link Basics): * texinfo/texinfo.texi (HTML Xref Node Name Expansion): * texinfo/texinfo.texi (HTML Xref Command Expansion): * texinfo/texinfo.texi (HTML Xref 8-bit Character Expansion): * texinfo/texinfo.texi (HTML Xref Mismatch): * texinfo/texinfo.texi (Command List): * texinfo/texinfo.texi (Command Syntax): * texinfo/texinfo.texi (Tips): * texinfo/texinfo.texi (Sample Texinfo Files): * texinfo/texinfo.texi (Short Sample Texinfo File): * texinfo/texinfo.texi (GNU Sample Texts): * texinfo/texinfo.texi (Invoking sample): * texinfo/texinfo.texi (GNU Free Documentation License): * texinfo/texinfo.texi (Index): * texinfo/texinfo.texi (Verbatim Copying License): * texinfo/texinfo.texi (All-permissive Copying License): * texinfo/texinfo.texi (Include Files): * texinfo/texinfo.texi (Using Include Files): * texinfo/texinfo.texi (texinfo-multiple-files-update): * texinfo/texinfo.texi (Include Files Requirements): * texinfo/texinfo.texi (Sample Include File): * texinfo/texinfo.texi (Include Files Evolution): * texinfo/texinfo.texi (Headings): * texinfo/texinfo.texi (Headings Introduced): * texinfo/texinfo.texi (Heading Format): * texinfo/texinfo.texi (Heading Choice): * texinfo/texinfo.texi (Custom Headings): * texinfo/texinfo.texi (Catching Mistakes): * texinfo/texinfo.texi (makeinfo Preferred): * texinfo/texinfo.texi (Debugging with Info): * texinfo/texinfo.texi (Debugging with TeX): * texinfo/texinfo.texi (Using texinfo-show-structure): * texinfo/texinfo.texi (Using occur): * texinfo/texinfo.texi (Running Info-Validate): * texinfo/texinfo.texi (Using Info-validate): * texinfo/texinfo.texi (Unsplit): * texinfo/texinfo.texi (Tagifying): * texinfo/texinfo.texi (Splitting): * texinfo/texinfo.texi (Refilling Paragraphs): * texinfo/texinfo.texi (Command and Variable Index): * texinfo/texinfo.texi (General Index): * texinfo/version.texi: New file. Sync with FSF 23.1.92. Make new directory to hold the files needed to generate texinfo.info, since there are three such files now. 2010-02-19 Ben Wing <ben@xemacs.org> * Makefile: * Makefile (src_files1): * Makefile (DIR): * Makefile (texinfo-srcs): * Makefile ($(INFODIR)/widget.info): * Makefile ($(INFODIR)/texinfo.info): * Makefile (.PHONY): * Makefile (texinfo.dvi): * Makefile (texinfo.pdf): * Makefile ($(HTMLDIR)/widget.html): * Makefile ($(HTMLDIR)/texinfo.html): Incorporate texinfo.texi moving to a subdirectory texinfo/. Do some tricks to reduce the amount of duplication while still maintaining compatible with non-GNU make (at least, with Solaris make). * doclicense.texi: New file. * info.texi: * info.texi (Top): * info.texi (Getting Started): * info.texi (Help-Small-Screen): * info.texi (Help): * info.texi (Help-P): * info.texi (Help-^L): * info.texi (Help-Inv): * info.texi (Help-]): * info.texi (Help-M): * info.texi (Help-FOO): * info.texi (Help-Xref): * info.texi (Help-Int): * info.texi (Help-Q): * info.texi (Advanced): * info.texi (Search Text): * info.texi (Search Index): * info.texi (Go to node): * info.texi (Choose menu subtopic): * info.texi (Create Info buffer): * info.texi (XEmacs Info Variables): * info.texi (Expert Info): * info.texi (Add): * info.texi (Menus): * info.texi (Cross-refs): * info.texi (Help-Cross): * info.texi (Tags): * info.texi (Checking): * info.texi (Index): * texinfo.tex: * texinfo.tex (paragraphindent{%): * texinfo.tex (sectionheading will have): * texinfo.tex (chapterzzz{#3}%): * texinfo.tex (subsubsection = \numberedsubsubsec): * texinfo.tex (subsubsection = \appendixsubsubsec): * texinfo.tex (subsubsection = \unnumberedsubsubsec): * texinfo.tex (sectionheading{#1}{sec}{Ynumbered}{\the\chapno.\the\secno}%): * texinfo.tex (sectionheading{#1}{sec}{Yappendix}{\appendixletter.\the\secno}%): * texinfo.tex (sectionheading{#1}{sec}{Ynothing}{\the\unnumberedno.\the\secno}%): * texinfo.tex (sectionheading{#1}{subsec}{Ynumbered}{\the\chapno.\the\secno.\the\subsecno}%): * texinfo.tex (sectionheading{#1}{subsec}{Yappendix}%): * texinfo.tex (sectionheading{#1}{subsec}{Ynothing}%): * texinfo.tex (sectionheading{#1}{subsubsec}{Ynumbered}%): * texinfo.tex (sectionheading{#1}{subsubsec}{Yappendix}%): * texinfo.tex (sectionheading{#1}{subsubsec}{Ynothing}%): * texinfo.tex (sectionheading{#1}{subsubsec}{Yomitfromtoc}{}): * texinfo.tex (sectionheading to do the printing.): * texinfo.tex (sectionlevel}{#1}{#4}%): * texinfo.tex (sectionheading, q.v.): Sync with FSF 23.1.92.
author Ben Wing <ben@xemacs.org>
date Fri, 19 Feb 2010 22:39:19 -0600
parents 3ecd8885ac67
children 1f0b15040456 a7da359711ce
comparison
equal deleted inserted replaced
5491:06dd936cde16 5492:e82f5b7010fe
1 % texinfo.tex -- TeX macros to handle Texinfo files. 1 % texinfo.tex -- TeX macros to handle Texinfo files.
2 % 2 %
3 % Load plain if necessary, i.e., if running under initex. 3 % Load plain if necessary, i.e., if running under initex.
4 \expandafter\ifx\csname fmtname\endcsname\relax\input plain\fi 4 \expandafter\ifx\csname fmtname\endcsname\relax\input plain\fi
5 % 5 %
6 \def\texinfoversion{1999-09-25.10} 6 \def\texinfoversion{2008-04-18.10}
7 % 7 %
8 % Copyright (C) 1985, 86, 88, 90, 91, 92, 93, 94, 95, 96, 97, 98, 99 8 % Copyright (C) 1985, 1986, 1988, 1990, 1991, 1992, 1993, 1994, 1995,
9 % Free Software Foundation, Inc. 9 % 1996, 1997, 1998, 1999, 2000, 2001, 2002, 2003, 2004, 2005, 2006,
10 % 10 % 2007, 2008 Free Software Foundation, Inc.
11 % This texinfo.tex file is free software; you can redistribute it and/or 11 %
12 % This texinfo.tex file is free software: you can redistribute it and/or
12 % modify it under the terms of the GNU General Public License as 13 % modify it under the terms of the GNU General Public License as
13 % published by the Free Software Foundation; either version 2, or (at 14 % published by the Free Software Foundation, either version 3 of the
14 % your option) any later version. 15 % License, or (at your option) any later version.
15 % 16 %
16 % This texinfo.tex file is distributed in the hope that it will be 17 % This texinfo.tex file is distributed in the hope that it will be
17 % useful, but WITHOUT ANY WARRANTY; without even the implied warranty 18 % useful, but WITHOUT ANY WARRANTY; without even the implied warranty
18 % of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU 19 % of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
19 % General Public License for more details. 20 % General Public License for more details.
20 % 21 %
21 % You should have received a copy of the GNU General Public License 22 % You should have received a copy of the GNU General Public License
22 % along with this texinfo.tex file; see the file COPYING. If not, write 23 % along with this program. If not, see <http://www.gnu.org/licenses/>.
23 % to the Free Software Foundation, Inc., 59 Temple Place - Suite 330, 24 %
24 % Boston, MA 02111-1307, USA. 25 % As a special exception, when this file is read by TeX when processing
25 % 26 % a Texinfo source document, you may use the result without
26 % In other words, you are welcome to use, share and improve this program. 27 % restriction. (This has been our intent since Texinfo was invented.)
27 % You are forbidden to forbid anyone else to use, share and improve
28 % what you give them. Help stamp out software-hoarding!
29 % 28 %
30 % Please try the latest version of texinfo.tex before submitting bug 29 % Please try the latest version of texinfo.tex before submitting bug
31 % reports; you can get the latest version from: 30 % reports; you can get the latest version from:
32 % ftp://ftp.gnu.org/gnu/texinfo.tex 31 % http://www.gnu.org/software/texinfo/ (the Texinfo home page), or
33 % (and all GNU mirrors, see http://www.gnu.org/order/ftp.html) 32 % ftp://tug.org/tex/texinfo.tex
34 % ftp://texinfo.org/tex/texinfo.tex 33 % (and all CTAN mirrors, see http://www.ctan.org).
35 % ftp://us.ctan.org/macros/texinfo/texinfo.tex 34 % The texinfo.tex in any given distribution could well be out
36 % (and all CTAN mirrors, finger ctan@us.ctan.org for a list).
37 % /home/gd/gnu/doc/texinfo.tex on the GNU machines.
38 % The texinfo.tex in any given Texinfo distribution could well be out
39 % of date, so if that's what you're using, please check. 35 % of date, so if that's what you're using, please check.
40 % Texinfo has a small home page at http://texinfo.org/.
41 % 36 %
42 % Send bug reports to bug-texinfo@gnu.org. Please include including a 37 % Send bug reports to bug-texinfo@gnu.org. Please include including a
43 % complete document in each bug report with which we can reproduce the 38 % complete document in each bug report with which we can reproduce the
44 % problem. Patches are, of course, greatly appreciated. 39 % problem. Patches are, of course, greatly appreciated.
45 % 40 %
48 % manual foo.texi, however, you can get away with this: 43 % manual foo.texi, however, you can get away with this:
49 % tex foo.texi 44 % tex foo.texi
50 % texindex foo.?? 45 % texindex foo.??
51 % tex foo.texi 46 % tex foo.texi
52 % tex foo.texi 47 % tex foo.texi
53 % dvips foo.dvi -o # or whatever, to process the dvi file; this makes foo.ps. 48 % dvips foo.dvi -o # or whatever; this makes foo.ps.
54 % The extra runs of TeX get the cross-reference information correct. 49 % The extra TeX runs get the cross-reference information correct.
55 % Sometimes one run after texindex suffices, and sometimes you need more 50 % Sometimes one run after texindex suffices, and sometimes you need more
56 % than two; texi2dvi does it as many times as necessary. 51 % than two; texi2dvi does it as many times as necessary.
57 % 52 %
58 % It is possible to adapt texinfo.tex for other languages. You can get 53 % It is possible to adapt texinfo.tex for other languages, to some
59 % the existing language-specific files from ftp://ftp.gnu.org/gnu/texinfo/. 54 % extent. You can get the existing language-specific files from the
55 % full Texinfo distribution.
56 %
57 % The GNU Texinfo home page is http://www.gnu.org/software/texinfo.
58
60 59
61 \message{Loading texinfo [version \texinfoversion]:} 60 \message{Loading texinfo [version \texinfoversion]:}
62 61
63 % If in a .fmt file, print the version number 62 % If in a .fmt file, print the version number
64 % and turn on active characters that we couldn't do earlier because 63 % and turn on active characters that we couldn't do earlier because
65 % they might have appeared in the input file name. 64 % they might have appeared in the input file name.
66 \everyjob{\message{[Texinfo version \texinfoversion]}% 65 \everyjob{\message{[Texinfo version \texinfoversion]}%
67 \catcode`+=\active \catcode`\_=\active} 66 \catcode`+=\active \catcode`\_=\active}
68 67
69 % Save some parts of plain tex whose names we will redefine. 68
69 \chardef\other=12
70
71 % We never want plain's \outer definition of \+ in Texinfo.
72 % For @tex, we can use \tabalign.
73 \let\+ = \relax
74
75 % Save some plain tex macros whose names we will redefine.
70 \let\ptexb=\b 76 \let\ptexb=\b
71 \let\ptexbullet=\bullet 77 \let\ptexbullet=\bullet
72 \let\ptexc=\c 78 \let\ptexc=\c
73 \let\ptexcomma=\, 79 \let\ptexcomma=\,
74 \let\ptexdot=\. 80 \let\ptexdot=\.
75 \let\ptexdots=\dots 81 \let\ptexdots=\dots
76 \let\ptexend=\end 82 \let\ptexend=\end
77 \let\ptexequiv=\equiv 83 \let\ptexequiv=\equiv
78 \let\ptexexclam=\! 84 \let\ptexexclam=\!
85 \let\ptexfootnote=\footnote
86 \let\ptexgtr=>
87 \let\ptexhat=^
79 \let\ptexi=\i 88 \let\ptexi=\i
89 \let\ptexindent=\indent
90 \let\ptexinsert=\insert
80 \let\ptexlbrace=\{ 91 \let\ptexlbrace=\{
92 \let\ptexless=<
93 \let\ptexnewwrite\newwrite
94 \let\ptexnoindent=\noindent
95 \let\ptexplus=+
81 \let\ptexrbrace=\} 96 \let\ptexrbrace=\}
97 \let\ptexslash=\/
82 \let\ptexstar=\* 98 \let\ptexstar=\*
83 \let\ptext=\t 99 \let\ptext=\t
84 100 \let\ptextop=\top
85 % We never want plain's outer \+ definition in Texinfo.
86 % For @tex, we can use \tabalign.
87 \let\+ = \relax
88
89 \message{Basics,}
90 \chardef\other=12
91 101
92 % If this character appears in an error message or help string, it 102 % If this character appears in an error message or help string, it
93 % starts a new line in the output. 103 % starts a new line in the output.
94 \newlinechar = `^^J 104 \newlinechar = `^^J
105
106 % Use TeX 3.0's \inputlineno to get the line number, for better error
107 % messages, but if we're using an old version of TeX, don't do anything.
108 %
109 \ifx\inputlineno\thisisundefined
110 \let\linenumber = \empty % Pre-3.0.
111 \else
112 \def\linenumber{l.\the\inputlineno:\space}
113 \fi
95 114
96 % Set up fixed words for English if not already set. 115 % Set up fixed words for English if not already set.
97 \ifx\putwordAppendix\undefined \gdef\putwordAppendix{Appendix}\fi 116 \ifx\putwordAppendix\undefined \gdef\putwordAppendix{Appendix}\fi
98 \ifx\putwordChapter\undefined \gdef\putwordChapter{Chapter}\fi 117 \ifx\putwordChapter\undefined \gdef\putwordChapter{Chapter}\fi
99 \ifx\putwordfile\undefined \gdef\putwordfile{file}\fi 118 \ifx\putwordfile\undefined \gdef\putwordfile{file}\fi
129 % 148 %
130 \ifx\putwordDefmac\undefined \gdef\putwordDefmac{Macro}\fi 149 \ifx\putwordDefmac\undefined \gdef\putwordDefmac{Macro}\fi
131 \ifx\putwordDefspec\undefined \gdef\putwordDefspec{Special Form}\fi 150 \ifx\putwordDefspec\undefined \gdef\putwordDefspec{Special Form}\fi
132 \ifx\putwordDefvar\undefined \gdef\putwordDefvar{Variable}\fi 151 \ifx\putwordDefvar\undefined \gdef\putwordDefvar{Variable}\fi
133 \ifx\putwordDefopt\undefined \gdef\putwordDefopt{User Option}\fi 152 \ifx\putwordDefopt\undefined \gdef\putwordDefopt{User Option}\fi
134 \ifx\putwordDeftypevar\undefined\gdef\putwordDeftypevar{Variable}\fi
135 \ifx\putwordDeffunc\undefined \gdef\putwordDeffunc{Function}\fi 153 \ifx\putwordDeffunc\undefined \gdef\putwordDeffunc{Function}\fi
136 \ifx\putwordDeftypefun\undefined\gdef\putwordDeftypefun{Function}\fi 154
155 % Since the category of space is not known, we have to be careful.
156 \chardef\spacecat = 10
157 \def\spaceisspace{\catcode`\ =\spacecat}
158
159 % sometimes characters are active, so we need control sequences.
160 \chardef\colonChar = `\:
161 \chardef\commaChar = `\,
162 \chardef\dashChar = `\-
163 \chardef\dotChar = `\.
164 \chardef\exclamChar= `\!
165 \chardef\lquoteChar= `\`
166 \chardef\questChar = `\?
167 \chardef\rquoteChar= `\'
168 \chardef\semiChar = `\;
169 \chardef\underChar = `\_
137 170
138 % Ignore a token. 171 % Ignore a token.
139 % 172 %
140 \def\gobble#1{} 173 \def\gobble#1{}
141 174
142 \hyphenation{ap-pen-dix} 175 % The following is used inside several \edef's.
143 \hyphenation{mini-buf-fer mini-buf-fers} 176 \def\makecsname#1{\expandafter\noexpand\csname#1\endcsname}
144 \hyphenation{eshell} 177
145 \hyphenation{white-space} 178 % Hyphenation fixes.
179 \hyphenation{
180 Flor-i-da Ghost-script Ghost-view Mac-OS Post-Script
181 ap-pen-dix bit-map bit-maps
182 data-base data-bases eshell fall-ing half-way long-est man-u-script
183 man-u-scripts mini-buf-fer mini-buf-fers over-view par-a-digm
184 par-a-digms rath-er rec-tan-gu-lar ro-bot-ics se-vere-ly set-up spa-ces
185 spell-ing spell-ings
186 stand-alone strong-est time-stamp time-stamps which-ever white-space
187 wide-spread wrap-around
188 }
146 189
147 % Margin to add to right of even pages, to left of odd pages. 190 % Margin to add to right of even pages, to left of odd pages.
148 \newdimen \bindingoffset 191 \newdimen\bindingoffset
149 \newdimen \normaloffset 192 \newdimen\normaloffset
150 \newdimen\pagewidth \newdimen\pageheight 193 \newdimen\pagewidth \newdimen\pageheight
194
195 % For a final copy, take out the rectangles
196 % that mark overfull boxes (in case you have decided
197 % that the text looks ok even though it passes the margin).
198 %
199 \def\finalout{\overfullrule=0pt}
200
201 % @| inserts a changebar to the left of the current line. It should
202 % surround any changed text. This approach does *not* work if the
203 % change spans more than two lines of output. To handle that, we would
204 % have adopt a much more difficult approach (putting marks into the main
205 % vertical list for the beginning and end of each change).
206 %
207 \def\|{%
208 % \vadjust can only be used in horizontal mode.
209 \leavevmode
210 %
211 % Append this vertical mode material after the current line in the output.
212 \vadjust{%
213 % We want to insert a rule with the height and depth of the current
214 % leading; that is exactly what \strutbox is supposed to record.
215 \vskip-\baselineskip
216 %
217 % \vadjust-items are inserted at the left edge of the type. So
218 % the \llap here moves out into the left-hand margin.
219 \llap{%
220 %
221 % For a thicker or thinner bar, change the `1pt'.
222 \vrule height\baselineskip width1pt
223 %
224 % This is the space between the bar and the text.
225 \hskip 12pt
226 }%
227 }%
228 }
151 229
152 % Sometimes it is convenient to have everything in the transcript file 230 % Sometimes it is convenient to have everything in the transcript file
153 % and nothing on the terminal. We don't just call \tracingall here, 231 % and nothing on the terminal. We don't just call \tracingall here,
154 % since that produces some useless output on the terminal. 232 % since that produces some useless output on the terminal. We also make
233 % some effort to order the tracing commands to reduce output in the log
234 % file; cf. trace.sty in LaTeX.
155 % 235 %
156 \def\gloggingall{\begingroup \globaldefs = 1 \loggingall \endgroup}% 236 \def\gloggingall{\begingroup \globaldefs = 1 \loggingall \endgroup}%
157 \ifx\eTeXversion\undefined 237 \def\loggingall{%
158 \def\loggingall{\tracingcommands2 \tracingstats2 238 \tracingstats2
159 \tracingpages1 \tracingoutput1 \tracinglostchars1 239 \tracingpages1
160 \tracingmacros2 \tracingparagraphs1 \tracingrestores1 240 \tracinglostchars2 % 2 gives us more in etex
161 \showboxbreadth\maxdimen\showboxdepth\maxdimen 241 \tracingparagraphs1
242 \tracingoutput1
243 \tracingmacros2
244 \tracingrestores1
245 \showboxbreadth\maxdimen \showboxdepth\maxdimen
246 \ifx\eTeXversion\undefined\else % etex gives us more logging
247 \tracingscantokens1
248 \tracingifs1
249 \tracinggroups1
250 \tracingnesting2
251 \tracingassigns1
252 \fi
253 \tracingcommands3 % 3 gives us more in etex
254 \errorcontextlines16
162 }% 255 }%
163 \else 256
164 \def\loggingall{\tracingcommands3 \tracingstats2 257 % add check for \lastpenalty to plain's definitions. If the last thing
165 \tracingpages1 \tracingoutput1 \tracinglostchars1 258 % we did was a \nobreak, we don't want to insert more space.
166 \tracingmacros2 \tracingparagraphs1 \tracingrestores1 259 %
167 \tracingscantokens1 \tracingassigns1 \tracingifs1 260 \def\smallbreak{\ifnum\lastpenalty<10000\par\ifdim\lastskip<\smallskipamount
168 \tracinggroups1 \tracingnesting2 261 \removelastskip\penalty-50\smallskip\fi\fi}
169 \showboxbreadth\maxdimen\showboxdepth\maxdimen 262 \def\medbreak{\ifnum\lastpenalty<10000\par\ifdim\lastskip<\medskipamount
170 }% 263 \removelastskip\penalty-100\medskip\fi\fi}
171 \fi 264 \def\bigbreak{\ifnum\lastpenalty<10000\par\ifdim\lastskip<\bigskipamount
265 \removelastskip\penalty-200\bigskip\fi\fi}
172 266
173 % For @cropmarks command. 267 % For @cropmarks command.
174 % Do @cropmarks to get crop marks. 268 % Do @cropmarks to get crop marks.
175 % 269 %
176 \newif\ifcropmarks 270 \newif\ifcropmarks
182 \newdimen\outerhsize \newdimen\outervsize % set by the paper size routines 276 \newdimen\outerhsize \newdimen\outervsize % set by the paper size routines
183 \newdimen\cornerlong \cornerlong=1pc 277 \newdimen\cornerlong \cornerlong=1pc
184 \newdimen\cornerthick \cornerthick=.3pt 278 \newdimen\cornerthick \cornerthick=.3pt
185 \newdimen\topandbottommargin \topandbottommargin=.75in 279 \newdimen\topandbottommargin \topandbottommargin=.75in
186 280
281 % Output a mark which sets \thischapter, \thissection and \thiscolor.
282 % We dump everything together because we only have one kind of mark.
283 % This works because we only use \botmark / \topmark, not \firstmark.
284 %
285 % A mark contains a subexpression of the \ifcase ... \fi construct.
286 % \get*marks macros below extract the needed part using \ifcase.
287 %
288 % Another complication is to let the user choose whether \thischapter
289 % (\thissection) refers to the chapter (section) in effect at the top
290 % of a page, or that at the bottom of a page. The solution is
291 % described on page 260 of The TeXbook. It involves outputting two
292 % marks for the sectioning macros, one before the section break, and
293 % one after. I won't pretend I can describe this better than DEK...
294 \def\domark{%
295 \toks0=\expandafter{\lastchapterdefs}%
296 \toks2=\expandafter{\lastsectiondefs}%
297 \toks4=\expandafter{\prevchapterdefs}%
298 \toks6=\expandafter{\prevsectiondefs}%
299 \toks8=\expandafter{\lastcolordefs}%
300 \mark{%
301 \the\toks0 \the\toks2
302 \noexpand\or \the\toks4 \the\toks6
303 \noexpand\else \the\toks8
304 }%
305 }
306 % \topmark doesn't work for the very first chapter (after the title
307 % page or the contents), so we use \firstmark there -- this gets us
308 % the mark with the chapter defs, unless the user sneaks in, e.g.,
309 % @setcolor (or @url, or @link, etc.) between @contents and the very
310 % first @chapter.
311 \def\gettopheadingmarks{%
312 \ifcase0\topmark\fi
313 \ifx\thischapter\empty \ifcase0\firstmark\fi \fi
314 }
315 \def\getbottomheadingmarks{\ifcase1\botmark\fi}
316 \def\getcolormarks{\ifcase2\topmark\fi}
317
318 % Avoid "undefined control sequence" errors.
319 \def\lastchapterdefs{}
320 \def\lastsectiondefs{}
321 \def\prevchapterdefs{}
322 \def\prevsectiondefs{}
323 \def\lastcolordefs{}
324
187 % Main output routine. 325 % Main output routine.
188 \chardef\PAGE = 255 326 \chardef\PAGE = 255
189 \output = {\onepageout{\pagecontents\PAGE}} 327 \output = {\onepageout{\pagecontents\PAGE}}
190 328
191 \newbox\headlinebox 329 \newbox\headlinebox
199 \ifodd\pageno \advance\hoffset by \bindingoffset 337 \ifodd\pageno \advance\hoffset by \bindingoffset
200 \else \advance\hoffset by -\bindingoffset\fi 338 \else \advance\hoffset by -\bindingoffset\fi
201 % 339 %
202 % Do this outside of the \shipout so @code etc. will be expanded in 340 % Do this outside of the \shipout so @code etc. will be expanded in
203 % the headline as they should be, not taken literally (outputting ''code). 341 % the headline as they should be, not taken literally (outputting ''code).
342 \ifodd\pageno \getoddheadingmarks \else \getevenheadingmarks \fi
204 \setbox\headlinebox = \vbox{\let\hsize=\pagewidth \makeheadline}% 343 \setbox\headlinebox = \vbox{\let\hsize=\pagewidth \makeheadline}%
344 \ifodd\pageno \getoddfootingmarks \else \getevenfootingmarks \fi
205 \setbox\footlinebox = \vbox{\let\hsize=\pagewidth \makefootline}% 345 \setbox\footlinebox = \vbox{\let\hsize=\pagewidth \makefootline}%
206 % 346 %
207 {% 347 {%
208 % Have to do this stuff outside the \shipout because we want it to 348 % Have to do this stuff outside the \shipout because we want it to
209 % take effect in \write's, yet the group defined by the \vbox ends 349 % take effect in \write's, yet the group defined by the \vbox ends
210 % before the \shipout runs. 350 % before the \shipout runs.
211 % 351 %
212 \escapechar = `\\ % use backslash in output files.
213 \indexdummies % don't expand commands in the output. 352 \indexdummies % don't expand commands in the output.
214 \normalturnoffactive % \ in index entries must not stay \, e.g., if 353 \normalturnoffactive % \ in index entries must not stay \, e.g., if
215 % the page break happens to be in the middle of an example. 354 % the page break happens to be in the middle of an example.
355 % We don't want .vr (or whatever) entries like this:
356 % \entry{{\tt \indexbackslash }acronym}{32}{\code {\acronym}}
357 % "\acronym" won't work when it's read back in;
358 % it needs to be
359 % {\code {{\tt \backslashcurfont }acronym}
216 \shipout\vbox{% 360 \shipout\vbox{%
361 % Do this early so pdf references go to the beginning of the page.
362 \ifpdfmakepagedest \pdfdest name{\the\pageno} xyz\fi
363 %
217 \ifcropmarks \vbox to \outervsize\bgroup 364 \ifcropmarks \vbox to \outervsize\bgroup
218 \hsize = \outerhsize 365 \hsize = \outerhsize
219 \vskip-\topandbottommargin 366 \vskip-\topandbottommargin
220 \vtop to0pt{% 367 \vtop to0pt{%
221 \line{\ewtop\hfil\ewtop}% 368 \line{\ewtop\hfil\ewtop}%
235 % 382 %
236 \unvbox\headlinebox 383 \unvbox\headlinebox
237 \pagebody{#1}% 384 \pagebody{#1}%
238 \ifdim\ht\footlinebox > 0pt 385 \ifdim\ht\footlinebox > 0pt
239 % Only leave this space if the footline is nonempty. 386 % Only leave this space if the footline is nonempty.
240 % (We lessened \vsize for it in \oddfootingxxx.) 387 % (We lessened \vsize for it in \oddfootingyyy.)
241 % The \baselineskip=24pt in plain's \makefootline has no effect. 388 % The \baselineskip=24pt in plain's \makefootline has no effect.
242 \vskip 2\baselineskip 389 \vskip 24pt
243 \unvbox\footlinebox 390 \unvbox\footlinebox
244 \fi 391 \fi
245 %
246 \ifpdfmakepagedest \pdfmkdest{\the\pageno} \fi
247 % 392 %
248 \ifcropmarks 393 \ifcropmarks
249 \egroup % end of \vbox\bgroup 394 \egroup % end of \vbox\bgroup
250 \hfil\egroup % end of (centering) \line\bgroup 395 \hfil\egroup % end of (centering) \line\bgroup
251 \vskip\topandbottommargin plus1fill minus1fill 396 \vskip\topandbottommargin plus1fill minus1fill
260 \line{\ewbot\hfil\ewbot}% 405 \line{\ewbot\hfil\ewbot}%
261 }% 406 }%
262 \egroup % \vbox from first cropmarks clause 407 \egroup % \vbox from first cropmarks clause
263 \fi 408 \fi
264 }% end of \shipout\vbox 409 }% end of \shipout\vbox
265 }% end of group with \turnoffactive 410 }% end of group with \indexdummies
266 \advancepageno 411 \advancepageno
267 \ifnum\outputpenalty>-20000 \else\dosupereject\fi 412 \ifnum\outputpenalty>-20000 \else\dosupereject\fi
268 } 413 }
269 414
270 \newinsert\margin \dimen\margin=\maxdimen 415 \newinsert\margin \dimen\margin=\maxdimen
273 {\catcode`\@ =11 418 {\catcode`\@ =11
274 \gdef\pagecontents#1{\ifvoid\topins\else\unvbox\topins\fi 419 \gdef\pagecontents#1{\ifvoid\topins\else\unvbox\topins\fi
275 % marginal hacks, juha@viisa.uucp (Juha Takala) 420 % marginal hacks, juha@viisa.uucp (Juha Takala)
276 \ifvoid\margin\else % marginal info is present 421 \ifvoid\margin\else % marginal info is present
277 \rlap{\kern\hsize\vbox to\z@{\kern1pt\box\margin \vss}}\fi 422 \rlap{\kern\hsize\vbox to\z@{\kern1pt\box\margin \vss}}\fi
278 \dimen@=\dp#1 \unvbox#1 423 \dimen@=\dp#1\relax \unvbox#1\relax
279 \ifvoid\footins\else\vskip\skip\footins\footnoterule \unvbox\footins\fi 424 \ifvoid\footins\else\vskip\skip\footins\footnoterule \unvbox\footins\fi
280 \ifr@ggedbottom \kern-\dimen@ \vfil \fi} 425 \ifr@ggedbottom \kern-\dimen@ \vfil \fi}
281 } 426 }
282 427
283 % Here are the rules for the cropmarks. Note that they are 428 % Here are the rules for the cropmarks. Note that they are
293 438
294 % Parse an argument, then pass it to #1. The argument is the rest of 439 % Parse an argument, then pass it to #1. The argument is the rest of
295 % the input line (except we remove a trailing comment). #1 should be a 440 % the input line (except we remove a trailing comment). #1 should be a
296 % macro which expects an ordinary undelimited TeX argument. 441 % macro which expects an ordinary undelimited TeX argument.
297 % 442 %
298 \def\parsearg#1{% 443 \def\parsearg{\parseargusing{}}
299 \let\next = #1% 444 \def\parseargusing#1#2{%
445 \def\argtorun{#2}%
300 \begingroup 446 \begingroup
301 \obeylines 447 \obeylines
302 \futurelet\temp\parseargx 448 \spaceisspace
303 } 449 #1%
304 450 \parseargline\empty% Insert the \empty token, see \finishparsearg below.
305 % If the next token is an obeyed space (from an @example environment or 451 }
306 % the like), remove it and recurse. Otherwise, we're done.
307 \def\parseargx{%
308 % \obeyedspace is defined far below, after the definition of \sepspaces.
309 \ifx\obeyedspace\temp
310 \expandafter\parseargdiscardspace
311 \else
312 \expandafter\parseargline
313 \fi
314 }
315
316 % Remove a single space (as the delimiter token to the macro call).
317 {\obeyspaces %
318 \gdef\parseargdiscardspace {\futurelet\temp\parseargx}}
319 452
320 {\obeylines % 453 {\obeylines %
321 \gdef\parseargline#1^^M{% 454 \gdef\parseargline#1^^M{%
322 \endgroup % End of the group started in \parsearg. 455 \endgroup % End of the group started in \parsearg.
323 % 456 \argremovecomment #1\comment\ArgTerm%
324 % First remove any @c comment, then any @comment.
325 % Result of each macro is put in \toks0.
326 \argremovec #1\c\relax %
327 \expandafter\argremovecomment \the\toks0 \comment\relax %
328 %
329 % Call the caller's macro, saved as \next in \parsearg.
330 \expandafter\next\expandafter{\the\toks0}%
331 }% 457 }%
332 } 458 }
333 459
334 % Since all \c{,omment} does is throw away the argument, we can let TeX 460 % First remove any @comment, then any @c comment.
335 % do that for us. The \relax here is matched by the \relax in the call 461 \def\argremovecomment#1\comment#2\ArgTerm{\argremovec #1\c\ArgTerm}
336 % in \parseargline; it could be more or less anything, its purpose is 462 \def\argremovec#1\c#2\ArgTerm{\argcheckspaces#1\^^M\ArgTerm}
337 % just to delimit the argument to the \c. 463
338 \def\argremovec#1\c#2\relax{\toks0 = {#1}} 464 % Each occurrence of `\^^M' or `<space>\^^M' is replaced by a single space.
339 \def\argremovecomment#1\comment#2\relax{\toks0 = {#1}} 465 %
340 466 % \argremovec might leave us with trailing space, e.g.,
341 % \argremovec{,omment} might leave us with trailing spaces, though; e.g.,
342 % @end itemize @c foo 467 % @end itemize @c foo
343 % will have two active spaces as part of the argument with the 468 % This space token undergoes the same procedure and is eventually removed
344 % `itemize'. Here we remove all active spaces from #1, and assign the 469 % by \finishparsearg.
345 % result to \toks0. 470 %
346 % 471 \def\argcheckspaces#1\^^M{\argcheckspacesX#1\^^M \^^M}
347 % This loses if there are any *other* active characters besides spaces 472 \def\argcheckspacesX#1 \^^M{\argcheckspacesY#1\^^M}
348 % in the argument -- _ ^ +, for example -- since they get expanded. 473 \def\argcheckspacesY#1\^^M#2\^^M#3\ArgTerm{%
349 % Fortunately, Texinfo does not define any such commands. (If it ever 474 \def\temp{#3}%
350 % does, the catcode of the characters in questionwill have to be changed 475 \ifx\temp\empty
351 % here.) But this means we cannot call \removeactivespaces as part of 476 % Do not use \next, perhaps the caller of \parsearg uses it; reuse \temp:
352 % \argremovec{,omment}, since @c uses \parsearg, and thus the argument 477 \let\temp\finishparsearg
353 % that \parsearg gets might well have any character at all in it. 478 \else
354 % 479 \let\temp\argcheckspaces
355 \def\removeactivespaces#1{% 480 \fi
356 \begingroup 481 % Put the space token in:
357 \ignoreactivespaces 482 \temp#1 #3\ArgTerm
358 \edef\temp{#1}% 483 }
359 \global\toks0 = \expandafter{\temp}% 484
360 \endgroup 485 % If a _delimited_ argument is enclosed in braces, they get stripped; so
361 } 486 % to get _exactly_ the rest of the line, we had to prevent such situation.
362 487 % We prepended an \empty token at the very beginning and we expand it now,
363 % Change the active space to expand to nothing. 488 % just before passing the control to \argtorun.
364 % 489 % (Similarly, we have to think about #3 of \argcheckspacesY above: it is
365 \begingroup 490 % either the null string, or it ends with \^^M---thus there is no danger
491 % that a pair of braces would be stripped.
492 %
493 % But first, we have to remove the trailing space token.
494 %
495 \def\finishparsearg#1 \ArgTerm{\expandafter\argtorun\expandafter{#1}}
496
497 % \parseargdef\foo{...}
498 % is roughly equivalent to
499 % \def\foo{\parsearg\Xfoo}
500 % \def\Xfoo#1{...}
501 %
502 % Actually, I use \csname\string\foo\endcsname, ie. \\foo, as it is my
503 % favourite TeX trick. --kasal, 16nov03
504
505 \def\parseargdef#1{%
506 \expandafter \doparseargdef \csname\string#1\endcsname #1%
507 }
508 \def\doparseargdef#1#2{%
509 \def#2{\parsearg#1}%
510 \def#1##1%
511 }
512
513 % Several utility definitions with active space:
514 {
366 \obeyspaces 515 \obeyspaces
367 \gdef\ignoreactivespaces{\obeyspaces\let =\empty} 516 \gdef\obeyedspace{ }
368 \endgroup 517
518 % Make each space character in the input produce a normal interword
519 % space in the output. Don't allow a line break at this space, as this
520 % is used only in environments like @example, where each line of input
521 % should produce a line of output anyway.
522 %
523 \gdef\sepspaces{\obeyspaces\let =\tie}
524
525 % If an index command is used in an @example environment, any spaces
526 % therein should become regular spaces in the raw index file, not the
527 % expansion of \tie (\leavevmode \penalty \@M \ ).
528 \gdef\unsepspaces{\let =\space}
529 }
369 530
370 531
371 \def\flushcr{\ifx\par\lisppar \def\next##1{}\else \let\next=\relax \fi \next} 532 \def\flushcr{\ifx\par\lisppar \def\next##1{}\else \let\next=\relax \fi \next}
372 533
373 %% These are used to keep @begin/@end levels from running away 534 % Define the framework for environments in texinfo.tex. It's used like this:
374 %% Call \inENV within environments (after a \begingroup) 535 %
375 \newif\ifENV \ENVfalse \def\inENV{\ifENV\relax\else\ENVtrue\fi} 536 % \envdef\foo{...}
376 \def\ENVcheck{% 537 % \def\Efoo{...}
377 \ifENV\errmessage{Still within an environment; press RETURN to continue} 538 %
378 \endgroup\fi} % This is not perfect, but it should reduce lossage 539 % It's the responsibility of \envdef to insert \begingroup before the
379 540 % actual body; @end closes the group after calling \Efoo. \envdef also
380 % @begin foo is the same as @foo, for now. 541 % defines \thisenv, so the current environment is known; @end checks
542 % whether the environment name matches. The \checkenv macro can also be
543 % used to check whether the current environment is the one expected.
544 %
545 % Non-false conditionals (@iftex, @ifset) don't fit into this, so they
546 % are not treated as environments; they don't open a group. (The
547 % implementation of @end takes care not to call \endgroup in this
548 % special case.)
549
550
551 % At run-time, environments start with this:
552 \def\startenvironment#1{\begingroup\def\thisenv{#1}}
553 % initialize
554 \let\thisenv\empty
555
556 % ... but they get defined via ``\envdef\foo{...}'':
557 \long\def\envdef#1#2{\def#1{\startenvironment#1#2}}
558 \def\envparseargdef#1#2{\parseargdef#1{\startenvironment#1#2}}
559
560 % Check whether we're in the right environment:
561 \def\checkenv#1{%
562 \def\temp{#1}%
563 \ifx\thisenv\temp
564 \else
565 \badenverr
566 \fi
567 }
568
569 % Environment mismatch, #1 expected:
570 \def\badenverr{%
571 \errhelp = \EMsimple
572 \errmessage{This command can appear only \inenvironment\temp,
573 not \inenvironment\thisenv}%
574 }
575 \def\inenvironment#1{%
576 \ifx#1\empty
577 out of any environment%
578 \else
579 in environment \expandafter\string#1%
580 \fi
581 }
582
583 % @end foo executes the definition of \Efoo.
584 % But first, it executes a specialized version of \checkenv
585 %
586 \parseargdef\end{%
587 \if 1\csname iscond.#1\endcsname
588 \else
589 % The general wording of \badenverr may not be ideal, but... --kasal, 06nov03
590 \expandafter\checkenv\csname#1\endcsname
591 \csname E#1\endcsname
592 \endgroup
593 \fi
594 }
595
381 \newhelp\EMsimple{Press RETURN to continue.} 596 \newhelp\EMsimple{Press RETURN to continue.}
382 597
383 \outer\def\begin{\parsearg\beginxxx}
384
385 \def\beginxxx #1{%
386 \expandafter\ifx\csname #1\endcsname\relax
387 {\errhelp=\EMsimple \errmessage{Undefined command @begin #1}}\else
388 \csname #1\endcsname\fi}
389
390 % @end foo executes the definition of \Efoo.
391 %
392 \def\end{\parsearg\endxxx}
393 \def\endxxx #1{%
394 \removeactivespaces{#1}%
395 \edef\endthing{\the\toks0}%
396 %
397 \expandafter\ifx\csname E\endthing\endcsname\relax
398 \expandafter\ifx\csname \endthing\endcsname\relax
399 % There's no \foo, i.e., no ``environment'' foo.
400 \errhelp = \EMsimple
401 \errmessage{Undefined command `@end \endthing'}%
402 \else
403 \unmatchedenderror\endthing
404 \fi
405 \else
406 % Everything's ok; the right environment has been started.
407 \csname E\endthing\endcsname
408 \fi
409 }
410
411 % There is an environment #1, but it hasn't been started. Give an error.
412 %
413 \def\unmatchedenderror#1{%
414 \errhelp = \EMsimple
415 \errmessage{This `@end #1' doesn't have a matching `@#1'}%
416 }
417
418 % Define the control sequence \E#1 to give an unmatched @end error.
419 %
420 \def\defineunmatchedend#1{%
421 \expandafter\def\csname E#1\endcsname{\unmatchedenderror{#1}}%
422 }
423
424
425 % Single-spacing is done by various environments (specifically, in
426 % \nonfillstart and \quotations).
427 \newskip\singlespaceskip \singlespaceskip = 12.5pt
428 \def\singlespace{%
429 % Why was this kern here? It messes up equalizing space above and below
430 % environments. --karl, 6may93
431 %{\advance \baselineskip by -\singlespaceskip
432 %\kern \baselineskip}%
433 \setleading \singlespaceskip
434 }
435 598
436 %% Simple single-character @ commands 599 %% Simple single-character @ commands
437 600
438 % @@ prints an @ 601 % @@ prints an @
439 % Kludge this until the fonts are right (grr). 602 % Kludge this until the fonts are right (grr).
450 \def\mylbrace {{\tt\char123}} 613 \def\mylbrace {{\tt\char123}}
451 \def\myrbrace {{\tt\char125}} 614 \def\myrbrace {{\tt\char125}}
452 \let\{=\mylbrace 615 \let\{=\mylbrace
453 \let\}=\myrbrace 616 \let\}=\myrbrace
454 \begingroup 617 \begingroup
455 % Definitions to produce actual \{ & \} command in an index. 618 % Definitions to produce \{ and \} commands for indices,
456 \catcode`\{ = 12 \catcode`\} = 12 619 % and @{ and @} for the aux/toc files.
620 \catcode`\{ = \other \catcode`\} = \other
457 \catcode`\[ = 1 \catcode`\] = 2 621 \catcode`\[ = 1 \catcode`\] = 2
458 \catcode`\@ = 0 \catcode`\\ = 12 622 \catcode`\! = 0 \catcode`\\ = \other
459 @gdef@lbracecmd[\{]% 623 !gdef!lbracecmd[\{]%
460 @gdef@rbracecmd[\}]% 624 !gdef!rbracecmd[\}]%
461 @endgroup 625 !gdef!lbraceatcmd[@{]%
626 !gdef!rbraceatcmd[@}]%
627 !endgroup
628
629 % @comma{} to avoid , parsing problems.
630 \let\comma = ,
462 631
463 % Accents: @, @dotaccent @ringaccent @ubaraccent @udotaccent 632 % Accents: @, @dotaccent @ringaccent @ubaraccent @udotaccent
464 % Others are defined by plain TeX: @` @' @" @^ @~ @= @v @H. 633 % Others are defined by plain TeX: @` @' @" @^ @~ @= @u @v @H.
465 \let\, = \c 634 \let\, = \c
466 \let\dotaccent = \. 635 \let\dotaccent = \.
467 \def\ringaccent#1{{\accent23 #1}} 636 \def\ringaccent#1{{\accent23 #1}}
468 \let\tieaccent = \t 637 \let\tieaccent = \t
469 \let\ubaraccent = \b 638 \let\ubaraccent = \b
470 \let\udotaccent = \d 639 \let\udotaccent = \d
471 640
472 % Other special characters: @questiondown @exclamdown 641 % Other special characters: @questiondown @exclamdown @ordf @ordm
473 % Plain TeX defines: @AA @AE @O @OE @L (and lowercase versions) @ss. 642 % Plain TeX defines: @AA @AE @O @OE @L (plus lowercase versions) @ss.
474 \def\questiondown{?`} 643 \def\questiondown{?`}
475 \def\exclamdown{!`} 644 \def\exclamdown{!`}
645 \def\ordf{\leavevmode\raise1ex\hbox{\selectfonts\lllsize \underbar{a}}}
646 \def\ordm{\leavevmode\raise1ex\hbox{\selectfonts\lllsize \underbar{o}}}
476 647
477 % Dotless i and dotless j, used for accents. 648 % Dotless i and dotless j, used for accents.
478 \def\imacro{i} 649 \def\imacro{i}
479 \def\jmacro{j} 650 \def\jmacro{j}
480 \def\dotless#1{% 651 \def\dotless#1{%
481 \def\temp{#1}% 652 \def\temp{#1}%
482 \ifx\temp\imacro \ptexi 653 \ifx\temp\imacro \ifmmode\imath \else\ptexi \fi
483 \else\ifx\temp\jmacro \j 654 \else\ifx\temp\jmacro \ifmmode\jmath \else\j \fi
484 \else \errmessage{@dotless can be used only with i or j}% 655 \else \errmessage{@dotless can be used only with i or j}%
485 \fi\fi 656 \fi\fi
657 }
658
659 % The \TeX{} logo, as in plain, but resetting the spacing so that a
660 % period following counts as ending a sentence. (Idea found in latex.)
661 %
662 \edef\TeX{\TeX \spacefactor=1000 }
663
664 % @LaTeX{} logo. Not quite the same results as the definition in
665 % latex.ltx, since we use a different font for the raised A; it's most
666 % convenient for us to use an explicitly smaller font, rather than using
667 % the \scriptstyle font (since we don't reset \scriptstyle and
668 % \scriptscriptstyle).
669 %
670 \def\LaTeX{%
671 L\kern-.36em
672 {\setbox0=\hbox{T}%
673 \vbox to \ht0{\hbox{\selectfonts\lllsize A}\vss}}%
674 \kern-.15em
675 \TeX
486 } 676 }
487 677
488 % Be sure we're in horizontal mode when doing a tie, since we make space 678 % Be sure we're in horizontal mode when doing a tie, since we make space
489 % equivalent to this in @example-like environments. Otherwise, a space 679 % equivalent to this in @example-like environments. Otherwise, a space
490 % at the beginning of a line will start with \penalty -- and 680 % at the beginning of a line will start with \penalty -- and
501 \def\:{\spacefactor=1000 } 691 \def\:{\spacefactor=1000 }
502 692
503 % @* forces a line break. 693 % @* forces a line break.
504 \def\*{\hfil\break\hbox{}\ignorespaces} 694 \def\*{\hfil\break\hbox{}\ignorespaces}
505 695
696 % @/ allows a line break.
697 \let\/=\allowbreak
698
506 % @. is an end-of-sentence period. 699 % @. is an end-of-sentence period.
507 \def\.{.\spacefactor=3000 } 700 \def\.{.\spacefactor=\endofsentencespacefactor\space}
508 701
509 % @! is an end-of-sentence bang. 702 % @! is an end-of-sentence bang.
510 \def\!{!\spacefactor=3000 } 703 \def\!{!\spacefactor=\endofsentencespacefactor\space}
511 704
512 % @? is an end-of-sentence query. 705 % @? is an end-of-sentence query.
513 \def\?{?\spacefactor=3000 } 706 \def\?{?\spacefactor=\endofsentencespacefactor\space}
707
708 % @frenchspacing on|off says whether to put extra space after punctuation.
709 %
710 \def\onword{on}
711 \def\offword{off}
712 %
713 \parseargdef\frenchspacing{%
714 \def\temp{#1}%
715 \ifx\temp\onword \plainfrenchspacing
716 \else\ifx\temp\offword \plainnonfrenchspacing
717 \else
718 \errhelp = \EMsimple
719 \errmessage{Unknown @frenchspacing option `\temp', must be on/off}%
720 \fi\fi
721 }
514 722
515 % @w prevents a word break. Without the \leavevmode, @w at the 723 % @w prevents a word break. Without the \leavevmode, @w at the
516 % beginning of a paragraph, when TeX is still in vertical mode, would 724 % beginning of a paragraph, when TeX is still in vertical mode, would
517 % produce a whole line of output instead of starting the paragraph. 725 % produce a whole line of output instead of starting the paragraph.
518 \def\w#1{\leavevmode\hbox{#1}} 726 \def\w#1{\leavevmode\hbox{#1}}
523 % \topskip (p.114 of the TeXbook), the glue inserted is 731 % \topskip (p.114 of the TeXbook), the glue inserted is
524 % max (\topskip - \ht (first item), 0). If that height is large, 732 % max (\topskip - \ht (first item), 0). If that height is large,
525 % therefore, no glue is inserted, and the space between the headline and 733 % therefore, no glue is inserted, and the space between the headline and
526 % the text is small, which looks bad. 734 % the text is small, which looks bad.
527 % 735 %
528 \def\group{\begingroup 736 % Another complication is that the group might be very large. This can
529 \ifnum\catcode13=\active \else 737 % cause the glue on the previous page to be unduly stretched, because it
738 % does not have much material. In this case, it's better to add an
739 % explicit \vfill so that the extra space is at the bottom. The
740 % threshold for doing this is if the group is more than \vfilllimit
741 % percent of a page (\vfilllimit can be changed inside of @tex).
742 %
743 \newbox\groupbox
744 \def\vfilllimit{0.7}
745 %
746 \envdef\group{%
747 \ifnum\catcode`\^^M=\active \else
530 \errhelp = \groupinvalidhelp 748 \errhelp = \groupinvalidhelp
531 \errmessage{@group invalid in context where filling is enabled}% 749 \errmessage{@group invalid in context where filling is enabled}%
532 \fi 750 \fi
533 % 751 \startsavinginserts
534 % The \vtop we start below produces a box with normal height and large 752 %
535 % depth; thus, TeX puts \baselineskip glue before it, and (when the 753 \setbox\groupbox = \vtop\bgroup
536 % next line of text is done) \lineskip glue after it. (See p.82 of
537 % the TeXbook.) Thus, space below is not quite equal to space
538 % above. But it's pretty close.
539 \def\Egroup{%
540 \egroup % End the \vtop.
541 \endgroup % End the \group.
542 }%
543 %
544 \vtop\bgroup
545 % We have to put a strut on the last line in case the @group is in
546 % the midst of an example, rather than completely enclosing it.
547 % Otherwise, the interline space between the last line of the group
548 % and the first line afterwards is too small. But we can't put the
549 % strut in \Egroup, since there it would be on a line by itself.
550 % Hence this just inserts a strut at the beginning of each line.
551 \everypar = {\strut}%
552 %
553 % Since we have a strut on every line, we don't need any of TeX's
554 % normal interline spacing.
555 \offinterlineskip
556 %
557 % OK, but now we have to do something about blank
558 % lines in the input in @example-like environments, which normally
559 % just turn into \lisppar, which will insert no space now that we've
560 % turned off the interline space. Simplest is to make them be an
561 % empty paragraph.
562 \ifx\par\lisppar
563 \edef\par{\leavevmode \par}%
564 %
565 % Reset ^^M's definition to new definition of \par.
566 \obeylines
567 \fi
568 %
569 % Do @comment since we are called inside an environment such as 754 % Do @comment since we are called inside an environment such as
570 % @example, where each end-of-line in the input causes an 755 % @example, where each end-of-line in the input causes an
571 % end-of-line in the output. We don't want the end-of-line after 756 % end-of-line in the output. We don't want the end-of-line after
572 % the `@group' to put extra space in the output. Since @group 757 % the `@group' to put extra space in the output. Since @group
573 % should appear on a line by itself (according to the Texinfo 758 % should appear on a line by itself (according to the Texinfo
574 % manual), we don't worry about eating any user text. 759 % manual), we don't worry about eating any user text.
575 \comment 760 \comment
576 } 761 }
577 % 762 %
763 % The \vtop produces a box with normal height and large depth; thus, TeX puts
764 % \baselineskip glue before it, and (when the next line of text is done)
765 % \lineskip glue after it. Thus, space below is not quite equal to space
766 % above. But it's pretty close.
767 \def\Egroup{%
768 % To get correct interline space between the last line of the group
769 % and the first line afterwards, we have to propagate \prevdepth.
770 \endgraf % Not \par, as it may have been set to \lisppar.
771 \global\dimen1 = \prevdepth
772 \egroup % End the \vtop.
773 % \dimen0 is the vertical size of the group's box.
774 \dimen0 = \ht\groupbox \advance\dimen0 by \dp\groupbox
775 % \dimen2 is how much space is left on the page (more or less).
776 \dimen2 = \pageheight \advance\dimen2 by -\pagetotal
777 % if the group doesn't fit on the current page, and it's a big big
778 % group, force a page break.
779 \ifdim \dimen0 > \dimen2
780 \ifdim \pagetotal < \vfilllimit\pageheight
781 \page
782 \fi
783 \fi
784 \box\groupbox
785 \prevdepth = \dimen1
786 \checkinserts
787 }
788 %
578 % TeX puts in an \escapechar (i.e., `@') at the beginning of the help 789 % TeX puts in an \escapechar (i.e., `@') at the beginning of the help
579 % message, so this ends up printing `@group can only ...'. 790 % message, so this ends up printing `@group can only ...'.
580 % 791 %
581 \newhelp\groupinvalidhelp{% 792 \newhelp\groupinvalidhelp{%
582 group can only be used in environments such as @example,^^J% 793 group can only be used in environments such as @example,^^J%
585 % @need space-in-mils 796 % @need space-in-mils
586 % forces a page break if there is not space-in-mils remaining. 797 % forces a page break if there is not space-in-mils remaining.
587 798
588 \newdimen\mil \mil=0.001in 799 \newdimen\mil \mil=0.001in
589 800
590 \def\need{\parsearg\needx}
591
592 % Old definition--didn't work. 801 % Old definition--didn't work.
593 %\def\needx #1{\par % 802 %\parseargdef\need{\par %
594 %% This method tries to make TeX break the page naturally 803 %% This method tries to make TeX break the page naturally
595 %% if the depth of the box does not fit. 804 %% if the depth of the box does not fit.
596 %{\baselineskip=0pt% 805 %{\baselineskip=0pt%
597 %\vtop to #1\mil{\vfil}\kern -#1\mil\nobreak 806 %\vtop to #1\mil{\vfil}\kern -#1\mil\nobreak
598 %\prevdepth=-1000pt 807 %\prevdepth=-1000pt
599 %}} 808 %}}
600 809
601 \def\needx#1{% 810 \parseargdef\need{%
602 % Ensure vertical mode, so we don't make a big box in the middle of a 811 % Ensure vertical mode, so we don't make a big box in the middle of a
603 % paragraph. 812 % paragraph.
604 \par 813 \par
605 % 814 %
606 % If the @need value is less than one line space, it's useless. 815 % If the @need value is less than one line space, it's useless.
635 % Do not allow a page break right after this kern. 844 % Do not allow a page break right after this kern.
636 \nobreak 845 \nobreak
637 \fi 846 \fi
638 } 847 }
639 848
640 % @br forces paragraph break 849 % @br forces paragraph break (and is undocumented).
641 850
642 \let\br = \par 851 \let\br = \par
643 852
644 % @dots{} output an ellipsis using the current font. 853 % @page forces the start of a new page.
645 % We do .5em per period so that it has the same spacing in a typewriter
646 % font as three actual period characters.
647 %
648 \def\dots{%
649 \leavevmode
650 \hbox to 1.5em{%
651 \hskip 0pt plus 0.25fil minus 0.25fil
652 .\hss.\hss.%
653 \hskip 0pt plus 0.5fil minus 0.5fil
654 }%
655 }
656
657 % @enddots{} is an end-of-sentence ellipsis.
658 %
659 \def\enddots{%
660 \leavevmode
661 \hbox to 2em{%
662 \hskip 0pt plus 0.25fil minus 0.25fil
663 .\hss.\hss.\hss.%
664 \hskip 0pt plus 0.5fil minus 0.5fil
665 }%
666 \spacefactor=3000
667 }
668
669
670 % @page forces the start of a new page
671 % 854 %
672 \def\page{\par\vfill\supereject} 855 \def\page{\par\vfill\supereject}
673 856
674 % @exdent text.... 857 % @exdent text....
675 % outputs text on separate line in roman font, starting at standard page margin 858 % outputs text on separate line in roman font, starting at standard page margin
677 % This records the amount of indent in the innermost environment. 860 % This records the amount of indent in the innermost environment.
678 % That's how much \exdent should take out. 861 % That's how much \exdent should take out.
679 \newskip\exdentamount 862 \newskip\exdentamount
680 863
681 % This defn is used inside fill environments such as @defun. 864 % This defn is used inside fill environments such as @defun.
682 \def\exdent{\parsearg\exdentyyy} 865 \parseargdef\exdent{\hfil\break\hbox{\kern -\exdentamount{\rm#1}}\hfil\break}
683 \def\exdentyyy #1{{\hfil\break\hbox{\kern -\exdentamount{\rm#1}}\hfil\break}}
684 866
685 % This defn is used inside nofill environments such as @example. 867 % This defn is used inside nofill environments such as @example.
686 \def\nofillexdent{\parsearg\nofillexdentyyy} 868 \parseargdef\nofillexdent{{\advance \leftskip by -\exdentamount
687 \def\nofillexdentyyy #1{{\advance \leftskip by -\exdentamount 869 \leftline{\hskip\leftskip{\rm#1}}}}
688 \leftline{\hskip\leftskip{\rm#1}}}} 870
689 871 % @inmargin{WHICH}{TEXT} puts TEXT in the WHICH margin next to the current
690 % @inmargin{TEXT} puts TEXT in the margin next to the current paragraph. 872 % paragraph. For more general purposes, use the \margin insertion
691 873 % class. WHICH is `l' or `r'.
692 \def\inmargin#1{% 874 %
693 \strut\vadjust{\nobreak\kern-\strutdepth
694 \vtop to \strutdepth{\baselineskip\strutdepth\vss
695 \llap{\rightskip=\inmarginspacing \vbox{\noindent #1}}\null}}}
696 \newskip\inmarginspacing \inmarginspacing=1cm 875 \newskip\inmarginspacing \inmarginspacing=1cm
697 \def\strutdepth{\dp\strutbox} 876 \def\strutdepth{\dp\strutbox}
698 877 %
699 %\hbox{{\rm#1}}\hfil\break}} 878 \def\doinmargin#1#2{\strut\vadjust{%
700 879 \nobreak
701 % @include file insert text of that file as input. 880 \kern-\strutdepth
702 % Allow normal characters that we make active in the argument (a file name). 881 \vtop to \strutdepth{%
703 \def\include{\begingroup 882 \baselineskip=\strutdepth
704 \catcode`\\=12 883 \vss
705 \catcode`~=12 884 % if you have multiple lines of stuff to put here, you'll need to
706 \catcode`^=12 885 % make the vbox yourself of the appropriate size.
707 \catcode`_=12 886 \ifx#1l%
708 \catcode`|=12 887 \llap{\ignorespaces #2\hskip\inmarginspacing}%
709 \catcode`<=12 888 \else
710 \catcode`>=12 889 \rlap{\hskip\hsize \hskip\inmarginspacing \ignorespaces #2}%
711 \catcode`+=12 890 \fi
712 \parsearg\includezzz} 891 \null
713 % Restore active chars for included file. 892 }%
714 \def\includezzz#1{\endgroup\begingroup 893 }}
715 % Read the included file in a group so nested @include's work. 894 \def\inleftmargin{\doinmargin l}
895 \def\inrightmargin{\doinmargin r}
896 %
897 % @inmargin{TEXT [, RIGHT-TEXT]}
898 % (if RIGHT-TEXT is given, use TEXT for left page, RIGHT-TEXT for right;
899 % else use TEXT for both).
900 %
901 \def\inmargin#1{\parseinmargin #1,,\finish}
902 \def\parseinmargin#1,#2,#3\finish{% not perfect, but better than nothing.
903 \setbox0 = \hbox{\ignorespaces #2}%
904 \ifdim\wd0 > 0pt
905 \def\lefttext{#1}% have both texts
906 \def\righttext{#2}%
907 \else
908 \def\lefttext{#1}% have only one text
909 \def\righttext{#1}%
910 \fi
911 %
912 \ifodd\pageno
913 \def\temp{\inrightmargin\righttext}% odd page -> outside is right margin
914 \else
915 \def\temp{\inleftmargin\lefttext}%
916 \fi
917 \temp
918 }
919
920 % @include FILE -- \input text of FILE.
921 %
922 \def\include{\parseargusing\filenamecatcodes\includezzz}
923 \def\includezzz#1{%
924 \pushthisfilestack
716 \def\thisfile{#1}% 925 \def\thisfile{#1}%
717 \input\thisfile 926 {%
718 \endgroup} 927 \makevalueexpandable % we want to expand any @value in FILE.
928 \turnoffactive % and allow special characters in the expansion
929 \edef\temp{\noexpand\input #1 }%
930 %
931 % This trickery is to read FILE outside of a group, in case it makes
932 % definitions, etc.
933 \expandafter
934 }\temp
935 \popthisfilestack
936 }
937 \def\filenamecatcodes{%
938 \catcode`\\=\other
939 \catcode`~=\other
940 \catcode`^=\other
941 \catcode`_=\other
942 \catcode`|=\other
943 \catcode`<=\other
944 \catcode`>=\other
945 \catcode`+=\other
946 \catcode`-=\other
947 }
948
949 \def\pushthisfilestack{%
950 \expandafter\pushthisfilestackX\popthisfilestack\StackTerm
951 }
952 \def\pushthisfilestackX{%
953 \expandafter\pushthisfilestackY\thisfile\StackTerm
954 }
955 \def\pushthisfilestackY #1\StackTerm #2\StackTerm {%
956 \gdef\popthisfilestack{\gdef\thisfile{#1}\gdef\popthisfilestack{#2}}%
957 }
958
959 \def\popthisfilestack{\errthisfilestackempty}
960 \def\errthisfilestackempty{\errmessage{Internal error:
961 the stack of filenames is empty.}}
719 962
720 \def\thisfile{} 963 \def\thisfile{}
721 964
722 % @center line outputs that line, centered 965 % @center line
723 966 % outputs that line, centered.
724 \def\center{\parsearg\centerzzz} 967 %
725 \def\centerzzz #1{{\advance\hsize by -\leftskip 968 \parseargdef\center{%
726 \advance\hsize by -\rightskip 969 \ifhmode
727 \centerline{#1}}} 970 \let\next\centerH
971 \else
972 \let\next\centerV
973 \fi
974 \next{\hfil \ignorespaces#1\unskip \hfil}%
975 }
976 \def\centerH#1{%
977 {%
978 \hfil\break
979 \advance\hsize by -\leftskip
980 \advance\hsize by -\rightskip
981 \line{#1}%
982 \break
983 }%
984 }
985 \def\centerV#1{\line{\kern\leftskip #1\kern\rightskip}}
728 986
729 % @sp n outputs n lines of vertical space 987 % @sp n outputs n lines of vertical space
730 988
731 \def\sp{\parsearg\spxxx} 989 \parseargdef\sp{\vskip #1\baselineskip}
732 \def\spxxx #1{\vskip #1\baselineskip}
733 990
734 % @comment ...line which is ignored... 991 % @comment ...line which is ignored...
735 % @c is the same as @comment 992 % @c is the same as @comment
736 % @ignore ... @end ignore is another way to write a comment 993 % @ignore ... @end ignore is another way to write a comment
737 994
742 999
743 \let\c=\comment 1000 \let\c=\comment
744 1001
745 % @paragraphindent NCHARS 1002 % @paragraphindent NCHARS
746 % We'll use ems for NCHARS, close enough. 1003 % We'll use ems for NCHARS, close enough.
747 % We cannot implement @paragraphindent asis, though. 1004 % NCHARS can also be the word `asis' or `none'.
748 % 1005 % We cannot feasibly implement @paragraphindent asis, though.
1006 %
749 \def\asisword{asis} % no translation, these are keywords 1007 \def\asisword{asis} % no translation, these are keywords
750 \def\noneword{none} 1008 \def\noneword{none}
751 % 1009 %
752 \def\paragraphindent{\parsearg\doparagraphindent} 1010 \parseargdef\paragraphindent{%
753 \def\doparagraphindent#1{%
754 \def\temp{#1}% 1011 \def\temp{#1}%
755 \ifx\temp\asisword 1012 \ifx\temp\asisword
756 \else 1013 \else
757 \ifx\temp\noneword 1014 \ifx\temp\noneword
758 \defaultparindent = 0pt 1015 \defaultparindent = 0pt
765 1022
766 % @exampleindent NCHARS 1023 % @exampleindent NCHARS
767 % We'll use ems for NCHARS like @paragraphindent. 1024 % We'll use ems for NCHARS like @paragraphindent.
768 % It seems @exampleindent asis isn't necessary, but 1025 % It seems @exampleindent asis isn't necessary, but
769 % I preserve it to make it similar to @paragraphindent. 1026 % I preserve it to make it similar to @paragraphindent.
770 \def\exampleindent{\parsearg\doexampleindent} 1027 \parseargdef\exampleindent{%
771 \def\doexampleindent#1{%
772 \def\temp{#1}% 1028 \def\temp{#1}%
773 \ifx\temp\asisword 1029 \ifx\temp\asisword
774 \else 1030 \else
775 \ifx\temp\noneword 1031 \ifx\temp\noneword
776 \lispnarrowing = 0pt 1032 \lispnarrowing = 0pt
778 \lispnarrowing = #1em 1034 \lispnarrowing = #1em
779 \fi 1035 \fi
780 \fi 1036 \fi
781 } 1037 }
782 1038
1039 % @firstparagraphindent WORD
1040 % If WORD is `none', then suppress indentation of the first paragraph
1041 % after a section heading. If WORD is `insert', then do indent at such
1042 % paragraphs.
1043 %
1044 % The paragraph indentation is suppressed or not by calling
1045 % \suppressfirstparagraphindent, which the sectioning commands do.
1046 % We switch the definition of this back and forth according to WORD.
1047 % By default, we suppress indentation.
1048 %
1049 \def\suppressfirstparagraphindent{\dosuppressfirstparagraphindent}
1050 \def\insertword{insert}
1051 %
1052 \parseargdef\firstparagraphindent{%
1053 \def\temp{#1}%
1054 \ifx\temp\noneword
1055 \let\suppressfirstparagraphindent = \dosuppressfirstparagraphindent
1056 \else\ifx\temp\insertword
1057 \let\suppressfirstparagraphindent = \relax
1058 \else
1059 \errhelp = \EMsimple
1060 \errmessage{Unknown @firstparagraphindent option `\temp'}%
1061 \fi\fi
1062 }
1063
1064 % Here is how we actually suppress indentation. Redefine \everypar to
1065 % \kern backwards by \parindent, and then reset itself to empty.
1066 %
1067 % We also make \indent itself not actually do anything until the next
1068 % paragraph.
1069 %
1070 \gdef\dosuppressfirstparagraphindent{%
1071 \gdef\indent{%
1072 \restorefirstparagraphindent
1073 \indent
1074 }%
1075 \gdef\noindent{%
1076 \restorefirstparagraphindent
1077 \noindent
1078 }%
1079 \global\everypar = {%
1080 \kern -\parindent
1081 \restorefirstparagraphindent
1082 }%
1083 }
1084
1085 \gdef\restorefirstparagraphindent{%
1086 \global \let \indent = \ptexindent
1087 \global \let \noindent = \ptexnoindent
1088 \global \everypar = {}%
1089 }
1090
1091
783 % @asis just yields its argument. Used with @table, for example. 1092 % @asis just yields its argument. Used with @table, for example.
784 % 1093 %
785 \def\asis#1{#1} 1094 \def\asis#1{#1}
786 1095
787 % @math means output in math mode. 1096 % @math outputs its argument in math mode.
788 % We don't use $'s directly in the definition of \math because control 1097 %
789 % sequences like \math are expanded when the toc file is written. Then, 1098 % One complication: _ usually means subscripts, but it could also mean
790 % we read the toc file back, the $'s will be normal characters (as they 1099 % an actual _ character, as in @math{@var{some_variable} + 1}. So make
791 % should be, according to the definition of Texinfo). So we must use a 1100 % _ active, and distinguish by seeing if the current family is \slfam,
792 % control sequence to switch into and out of math mode. 1101 % which is what @var uses.
793 % 1102 {
794 % This isn't quite enough for @math to work properly in indices, but it 1103 \catcode`\_ = \active
795 % seems unlikely it will ever be needed there. 1104 \gdef\mathunderscore{%
796 % 1105 \catcode`\_=\active
797 \let\implicitmath = $ 1106 \def_{\ifnum\fam=\slfam \_\else\sb\fi}%
798 \def\math#1{\implicitmath #1\implicitmath} 1107 }
799 1108 }
800 % @bullet and @minus need the same treatment as @math, just above. 1109 % Another complication: we want \\ (and @\) to output a \ character.
801 \def\bullet{\implicitmath\ptexbullet\implicitmath} 1110 % FYI, plain.tex uses \\ as a temporary control sequence (why?), but
802 \def\minus{\implicitmath-\implicitmath} 1111 % this is not advertised and we don't care. Texinfo does not
1112 % otherwise define @\.
1113 %
1114 % The \mathchar is class=0=ordinary, family=7=ttfam, position=5C=\.
1115 \def\mathbackslash{\ifnum\fam=\ttfam \mathchar"075C \else\backslash \fi}
1116 %
1117 \def\math{%
1118 \tex
1119 \mathunderscore
1120 \let\\ = \mathbackslash
1121 \mathactive
1122 % make the texinfo accent commands work in math mode
1123 \let\"=\ddot
1124 \let\'=\acute
1125 \let\==\bar
1126 \let\^=\hat
1127 \let\`=\grave
1128 \let\u=\breve
1129 \let\v=\check
1130 \let\~=\tilde
1131 \let\dotaccent=\dot
1132 $\finishmath
1133 }
1134 \def\finishmath#1{#1$\endgroup} % Close the group opened by \tex.
1135
1136 % Some active characters (such as <) are spaced differently in math.
1137 % We have to reset their definitions in case the @math was an argument
1138 % to a command which sets the catcodes (such as @item or @section).
1139 %
1140 {
1141 \catcode`^ = \active
1142 \catcode`< = \active
1143 \catcode`> = \active
1144 \catcode`+ = \active
1145 \gdef\mathactive{%
1146 \let^ = \ptexhat
1147 \let< = \ptexless
1148 \let> = \ptexgtr
1149 \let+ = \ptexplus
1150 }
1151 }
1152
1153 % Some math mode symbols.
1154 \def\bullet{$\ptexbullet$}
1155 \def\geq{\ifmmode \ge\else $\ge$\fi}
1156 \def\leq{\ifmmode \le\else $\le$\fi}
1157 \def\minus{\ifmmode -\else $-$\fi}
1158
1159 % @dots{} outputs an ellipsis using the current font.
1160 % We do .5em per period so that it has the same spacing in the cm
1161 % typewriter fonts as three actual period characters; on the other hand,
1162 % in other typewriter fonts three periods are wider than 1.5em. So do
1163 % whichever is larger.
1164 %
1165 \def\dots{%
1166 \leavevmode
1167 \setbox0=\hbox{...}% get width of three periods
1168 \ifdim\wd0 > 1.5em
1169 \dimen0 = \wd0
1170 \else
1171 \dimen0 = 1.5em
1172 \fi
1173 \hbox to \dimen0{%
1174 \hskip 0pt plus.25fil
1175 .\hskip 0pt plus1fil
1176 .\hskip 0pt plus1fil
1177 .\hskip 0pt plus.5fil
1178 }%
1179 }
1180
1181 % @enddots{} is an end-of-sentence ellipsis.
1182 %
1183 \def\enddots{%
1184 \dots
1185 \spacefactor=\endofsentencespacefactor
1186 }
1187
1188 % @comma{} is so commas can be inserted into text without messing up
1189 % Texinfo's parsing.
1190 %
1191 \let\comma = ,
803 1192
804 % @refill is a no-op. 1193 % @refill is a no-op.
805 \let\refill=\relax 1194 \let\refill=\relax
806 1195
807 % If working on a large document in chapters, it is convenient to 1196 % If working on a large document in chapters, it is convenient to
813 1202
814 % @setfilename is done at the beginning of every texinfo file. 1203 % @setfilename is done at the beginning of every texinfo file.
815 % So open here the files we need to have open while reading the input. 1204 % So open here the files we need to have open while reading the input.
816 % This makes it possible to make a .fmt file for texinfo. 1205 % This makes it possible to make a .fmt file for texinfo.
817 \def\setfilename{% 1206 \def\setfilename{%
1207 \fixbackslash % Turn off hack to swallow `\input texinfo'.
818 \iflinks 1208 \iflinks
819 \readauxfile 1209 \tryauxfile
1210 % Open the new aux file. TeX will close it automatically at exit.
1211 \immediate\openout\auxfile=\jobname.aux
820 \fi % \openindices needs to do some work in any case. 1212 \fi % \openindices needs to do some work in any case.
821 \openindices 1213 \openindices
822 \fixbackslash % Turn off hack to swallow `\input texinfo'. 1214 \let\setfilename=\comment % Ignore extra @setfilename cmds.
823 \global\let\setfilename=\comment % Ignore extra @setfilename cmds.
824 % 1215 %
825 % If texinfo.cnf is present on the system, read it. 1216 % If texinfo.cnf is present on the system, read it.
826 % Useful for site-wide @afourpaper, etc. 1217 % Useful for site-wide @afourpaper, etc.
827 % Just to be on the safe side, close the input stream before the \input.
828 \openin 1 texinfo.cnf 1218 \openin 1 texinfo.cnf
829 \ifeof1 \let\temp=\relax \else \def\temp{\input texinfo.cnf }\fi 1219 \ifeof 1 \else \input texinfo.cnf \fi
830 \closein1 1220 \closein 1
831 \temp
832 % 1221 %
833 \comment % Ignore the actual filename. 1222 \comment % Ignore the actual filename.
834 } 1223 }
835 1224
836 % Called from \setfilename. 1225 % Called from \setfilename.
862 \newbox\boxA 1251 \newbox\boxA
863 \newcount\countA 1252 \newcount\countA
864 \newif\ifpdf 1253 \newif\ifpdf
865 \newif\ifpdfmakepagedest 1254 \newif\ifpdfmakepagedest
866 1255
1256 % when pdftex is run in dvi mode, \pdfoutput is defined (so \pdfoutput=1
1257 % can be set). So we test for \relax and 0 as well as \undefined,
1258 % borrowed from ifpdf.sty.
867 \ifx\pdfoutput\undefined 1259 \ifx\pdfoutput\undefined
868 \pdffalse
869 \let\pdfmkdest = \gobble
870 \let\pdfurl = \gobble
871 \let\endlink = \relax
872 \let\linkcolor = \relax
873 \let\pdfmakeoutlines = \relax
874 \else 1260 \else
875 \pdftrue 1261 \ifx\pdfoutput\relax
876 \pdfoutput = 1 1262 \else
877 \input pdfcolor 1263 \ifcase\pdfoutput
1264 \else
1265 \pdftrue
1266 \fi
1267 \fi
1268 \fi
1269
1270 % PDF uses PostScript string constants for the names of xref targets,
1271 % for display in the outlines, and in other places. Thus, we have to
1272 % double any backslashes. Otherwise, a name like "\node" will be
1273 % interpreted as a newline (\n), followed by o, d, e. Not good.
1274 % http://www.ntg.nl/pipermail/ntg-pdftex/2004-July/000654.html
1275 % (and related messages, the final outcome is that it is up to the TeX
1276 % user to double the backslashes and otherwise make the string valid, so
1277 % that's what we do).
1278
1279 % double active backslashes.
1280 %
1281 {\catcode`\@=0 \catcode`\\=\active
1282 @gdef@activebackslashdouble{%
1283 @catcode`@\=@active
1284 @let\=@doublebackslash}
1285 }
1286
1287 % To handle parens, we must adopt a different approach, since parens are
1288 % not active characters. hyperref.dtx (which has the same problem as
1289 % us) handles it with this amazing macro to replace tokens, with minor
1290 % changes for Texinfo. It is included here under the GPL by permission
1291 % from the author, Heiko Oberdiek.
1292 %
1293 % #1 is the tokens to replace.
1294 % #2 is the replacement.
1295 % #3 is the control sequence with the string.
1296 %
1297 \def\HyPsdSubst#1#2#3{%
1298 \def\HyPsdReplace##1#1##2\END{%
1299 ##1%
1300 \ifx\\##2\\%
1301 \else
1302 #2%
1303 \HyReturnAfterFi{%
1304 \HyPsdReplace##2\END
1305 }%
1306 \fi
1307 }%
1308 \xdef#3{\expandafter\HyPsdReplace#3#1\END}%
1309 }
1310 \long\def\HyReturnAfterFi#1\fi{\fi#1}
1311
1312 % #1 is a control sequence in which to do the replacements.
1313 \def\backslashparens#1{%
1314 \xdef#1{#1}% redefine it as its expansion; the definition is simply
1315 % \lastnode when called from \setref -> \pdfmkdest.
1316 \HyPsdSubst{(}{\realbackslash(}{#1}%
1317 \HyPsdSubst{)}{\realbackslash)}{#1}%
1318 }
1319
1320 \newhelp\nopdfimagehelp{Texinfo supports .png, .jpg, .jpeg, and .pdf images
1321 with PDF output, and none of those formats could be found. (.eps cannot
1322 be supported due to the design of the PDF format; use regular TeX (DVI
1323 output) for that.)}
1324
1325 \ifpdf
1326 %
1327 % Color manipulation macros based on pdfcolor.tex.
1328 \def\cmykDarkRed{0.28 1 1 0.35}
1329 \def\cmykBlack{0 0 0 1}
1330 %
1331 \def\pdfsetcolor#1{\pdfliteral{#1 k}}
1332 % Set color, and create a mark which defines \thiscolor accordingly,
1333 % so that \makeheadline knows which color to restore.
1334 \def\setcolor#1{%
1335 \xdef\lastcolordefs{\gdef\noexpand\thiscolor{#1}}%
1336 \domark
1337 \pdfsetcolor{#1}%
1338 }
1339 %
1340 \def\maincolor{\cmykBlack}
1341 \pdfsetcolor{\maincolor}
1342 \edef\thiscolor{\maincolor}
1343 \def\lastcolordefs{}
1344 %
1345 \def\makefootline{%
1346 \baselineskip24pt
1347 \line{\pdfsetcolor{\maincolor}\the\footline}%
1348 }
1349 %
1350 \def\makeheadline{%
1351 \vbox to 0pt{%
1352 \vskip-22.5pt
1353 \line{%
1354 \vbox to8.5pt{}%
1355 % Extract \thiscolor definition from the marks.
1356 \getcolormarks
1357 % Typeset the headline with \maincolor, then restore the color.
1358 \pdfsetcolor{\maincolor}\the\headline\pdfsetcolor{\thiscolor}%
1359 }%
1360 \vss
1361 }%
1362 \nointerlineskip
1363 }
1364 %
1365 %
1366 \pdfcatalog{/PageMode /UseOutlines}
1367 %
1368 % #1 is image name, #2 width (might be empty/whitespace), #3 height (ditto).
878 \def\dopdfimage#1#2#3{% 1369 \def\dopdfimage#1#2#3{%
879 \def\imagewidth{#2}% 1370 \def\imagewidth{#2}\setbox0 = \hbox{\ignorespaces #2}%
880 \def\imageheight{#3}% 1371 \def\imageheight{#3}\setbox2 = \hbox{\ignorespaces #3}%
1372 %
1373 % pdftex (and the PDF format) support .png, .jpg, .pdf (among
1374 % others). Let's try in that order.
1375 \let\pdfimgext=\empty
1376 \begingroup
1377 \openin 1 #1.png \ifeof 1
1378 \openin 1 #1.jpg \ifeof 1
1379 \openin 1 #1.jpeg \ifeof 1
1380 \openin 1 #1.JPG \ifeof 1
1381 \openin 1 #1.pdf \ifeof 1
1382 \openin 1 #1.PDF \ifeof 1
1383 \errhelp = \nopdfimagehelp
1384 \errmessage{Could not find image file #1 for pdf}%
1385 \else \gdef\pdfimgext{PDF}%
1386 \fi
1387 \else \gdef\pdfimgext{pdf}%
1388 \fi
1389 \else \gdef\pdfimgext{JPG}%
1390 \fi
1391 \else \gdef\pdfimgext{jpeg}%
1392 \fi
1393 \else \gdef\pdfimgext{jpg}%
1394 \fi
1395 \else \gdef\pdfimgext{png}%
1396 \fi
1397 \closein 1
1398 \endgroup
1399 %
1400 % without \immediate, ancient pdftex seg faults when the same image is
1401 % included twice. (Version 3.14159-pre-1.0-unofficial-20010704.)
881 \ifnum\pdftexversion < 14 1402 \ifnum\pdftexversion < 14
882 \pdfimage 1403 \immediate\pdfimage
883 \else 1404 \else
884 \pdfximage 1405 \immediate\pdfximage
885 \fi 1406 \fi
886 \ifx\empty\imagewidth\else width \imagewidth \fi 1407 \ifdim \wd0 >0pt width \imagewidth \fi
887 \ifx\empty\imageheight\else height \imageheight \fi 1408 \ifdim \wd2 >0pt height \imageheight \fi
888 {#1.pdf}% 1409 \ifnum\pdftexversion<13
1410 #1.\pdfimgext
1411 \else
1412 {#1.\pdfimgext}%
1413 \fi
889 \ifnum\pdftexversion < 14 \else 1414 \ifnum\pdftexversion < 14 \else
890 \pdfrefximage \pdflastximage 1415 \pdfrefximage \pdflastximage
891 \fi} 1416 \fi}
892 \def\pdfmkdest#1{\pdfdest name{#1@} xyz} 1417 %
893 \def\pdfmkpgn#1{#1@} 1418 \def\pdfmkdest#1{{%
894 \let\linkcolor = \Cyan 1419 % We have to set dummies so commands such as @code, and characters
895 \def\endlink{\Black\pdfendlink} 1420 % such as \, aren't expanded when present in a section title.
1421 \indexnofonts
1422 \turnoffactive
1423 \activebackslashdouble
1424 \makevalueexpandable
1425 \def\pdfdestname{#1}%
1426 \backslashparens\pdfdestname
1427 \safewhatsit{\pdfdest name{\pdfdestname} xyz}%
1428 }}
1429 %
1430 % used to mark target names; must be expandable.
1431 \def\pdfmkpgn#1{#1}
1432 %
1433 % by default, use a color that is dark enough to print on paper as
1434 % nearly black, but still distinguishable for online viewing.
1435 \def\urlcolor{\cmykDarkRed}
1436 \def\linkcolor{\cmykDarkRed}
1437 \def\endlink{\setcolor{\maincolor}\pdfendlink}
1438 %
896 % Adding outlines to PDF; macros for calculating structure of outlines 1439 % Adding outlines to PDF; macros for calculating structure of outlines
897 % come from Petr Olsak 1440 % come from Petr Olsak
898 \def\expnumber#1{\expandafter\ifx\csname#1\endcsname\relax 0% 1441 \def\expnumber#1{\expandafter\ifx\csname#1\endcsname\relax 0%
899 \else \csname#1\endcsname \fi} 1442 \else \csname#1\endcsname \fi}
900 \def\advancenumber#1{\tempnum=\expnumber{#1}\relax 1443 \def\advancenumber#1{\tempnum=\expnumber{#1}\relax
901 \advance\tempnum by1 1444 \advance\tempnum by 1
902 \expandafter\xdef\csname#1\endcsname{\the\tempnum}} 1445 \expandafter\xdef\csname#1\endcsname{\the\tempnum}}
903 \def\pdfmakeoutlines{{% 1446 %
904 \openin 1 \jobname.toc 1447 % #1 is the section text, which is what will be displayed in the
905 \ifeof 1\else\bgroup 1448 % outline by the pdf viewer. #2 is the pdf expression for the number
906 \closein 1 1449 % of subentries (or empty, for subsubsections). #3 is the node text,
907 \indexnofonts 1450 % which might be empty if this toc entry had no corresponding node.
908 \def\tt{} 1451 % #4 is the page number
909 % thanh's hack / proper braces in bookmarks 1452 %
1453 \def\dopdfoutline#1#2#3#4{%
1454 % Generate a link to the node text if that exists; else, use the
1455 % page number. We could generate a destination for the section
1456 % text in the case where a section has no node, but it doesn't
1457 % seem worth the trouble, since most documents are normally structured.
1458 \def\pdfoutlinedest{#3}%
1459 \ifx\pdfoutlinedest\empty
1460 \def\pdfoutlinedest{#4}%
1461 \else
1462 % Doubled backslashes in the name.
1463 {\activebackslashdouble \xdef\pdfoutlinedest{#3}%
1464 \backslashparens\pdfoutlinedest}%
1465 \fi
1466 %
1467 % Also double the backslashes in the display string.
1468 {\activebackslashdouble \xdef\pdfoutlinetext{#1}%
1469 \backslashparens\pdfoutlinetext}%
1470 %
1471 \pdfoutline goto name{\pdfmkpgn{\pdfoutlinedest}}#2{\pdfoutlinetext}%
1472 }
1473 %
1474 \def\pdfmakeoutlines{%
1475 \begingroup
1476 % Thanh's hack / proper braces in bookmarks
910 \edef\mylbrace{\iftrue \string{\else}\fi}\let\{=\mylbrace 1477 \edef\mylbrace{\iftrue \string{\else}\fi}\let\{=\mylbrace
911 \edef\myrbrace{\iffalse{\else\string}\fi}\let\}=\myrbrace 1478 \edef\myrbrace{\iffalse{\else\string}\fi}\let\}=\myrbrace
912 % 1479 %
913 \def\chapentry ##1##2##3{} 1480 % Read toc silently, to get counts of subentries for \pdfoutline.
914 \def\unnumbchapentry ##1##2{} 1481 \def\numchapentry##1##2##3##4{%
915 \def\secentry ##1##2##3##4{\advancenumber{chap##2}} 1482 \def\thischapnum{##2}%
916 \def\unnumbsecentry ##1##2{} 1483 \def\thissecnum{0}%
917 \def\subsecentry ##1##2##3##4##5{\advancenumber{sec##2.##3}} 1484 \def\thissubsecnum{0}%
918 \def\unnumbsubsecentry ##1##2{} 1485 }%
919 \def\subsubsecentry ##1##2##3##4##5##6{\advancenumber{subsec##2.##3.##4}} 1486 \def\numsecentry##1##2##3##4{%
920 \def\unnumbsubsubsecentry ##1##2{} 1487 \advancenumber{chap\thischapnum}%
921 \input \jobname.toc 1488 \def\thissecnum{##2}%
922 \def\chapentry ##1##2##3{% 1489 \def\thissubsecnum{0}%
923 \pdfoutline goto name{\pdfmkpgn{##3}}count-\expnumber{chap##2}{##1}} 1490 }%
924 \def\unnumbchapentry ##1##2{% 1491 \def\numsubsecentry##1##2##3##4{%
925 \pdfoutline goto name{\pdfmkpgn{##2}}{##1}} 1492 \advancenumber{sec\thissecnum}%
926 \def\secentry ##1##2##3##4{% 1493 \def\thissubsecnum{##2}%
927 \pdfoutline goto name{\pdfmkpgn{##4}}count-\expnumber{sec##2.##3}{##1}} 1494 }%
928 \def\unnumbsecentry ##1##2{% 1495 \def\numsubsubsecentry##1##2##3##4{%
929 \pdfoutline goto name{\pdfmkpgn{##2}}{##1}} 1496 \advancenumber{subsec\thissubsecnum}%
930 \def\subsecentry ##1##2##3##4##5{% 1497 }%
931 \pdfoutline goto name{\pdfmkpgn{##5}}count-\expnumber{subsec##2.##3.##4}{##1}} 1498 \def\thischapnum{0}%
932 \def\unnumbsubsecentry ##1##2{% 1499 \def\thissecnum{0}%
933 \pdfoutline goto name{\pdfmkpgn{##2}}{##1}} 1500 \def\thissubsecnum{0}%
934 \def\subsubsecentry ##1##2##3##4##5##6{% 1501 %
935 \pdfoutline goto name{\pdfmkpgn{##6}}{##1}} 1502 % use \def rather than \let here because we redefine \chapentry et
936 \def\unnumbsubsubsecentry ##1##2{% 1503 % al. a second time, below.
937 \pdfoutline goto name{\pdfmkpgn{##2}}{##1}} 1504 \def\appentry{\numchapentry}%
938 \input \jobname.toc 1505 \def\appsecentry{\numsecentry}%
939 \egroup\fi 1506 \def\appsubsecentry{\numsubsecentry}%
940 }} 1507 \def\appsubsubsecentry{\numsubsubsecentry}%
941 \def\makelinks #1,{% 1508 \def\unnchapentry{\numchapentry}%
942 \def\params{#1}\def\E{END}% 1509 \def\unnsecentry{\numsecentry}%
943 \ifx\params\E 1510 \def\unnsubsecentry{\numsubsecentry}%
944 \let\nextmakelinks=\relax 1511 \def\unnsubsubsecentry{\numsubsubsecentry}%
945 \else 1512 \readdatafile{toc}%
946 \let\nextmakelinks=\makelinks 1513 %
947 \ifnum\lnkcount>0,\fi 1514 % Read toc second time, this time actually producing the outlines.
948 \picknum{#1}% 1515 % The `-' means take the \expnumber as the absolute number of
949 \startlink attr{/Border [0 0 0]} 1516 % subentries, which we calculated on our first read of the .toc above.
950 goto name{\pdfmkpgn{\the\pgn}}% 1517 %
951 \linkcolor #1% 1518 % We use the node names as the destinations.
952 \advance\lnkcount by 1% 1519 \def\numchapentry##1##2##3##4{%
953 \endlink 1520 \dopdfoutline{##1}{count-\expnumber{chap##2}}{##3}{##4}}%
954 \fi 1521 \def\numsecentry##1##2##3##4{%
955 \nextmakelinks 1522 \dopdfoutline{##1}{count-\expnumber{sec##2}}{##3}{##4}}%
1523 \def\numsubsecentry##1##2##3##4{%
1524 \dopdfoutline{##1}{count-\expnumber{subsec##2}}{##3}{##4}}%
1525 \def\numsubsubsecentry##1##2##3##4{% count is always zero
1526 \dopdfoutline{##1}{}{##3}{##4}}%
1527 %
1528 % PDF outlines are displayed using system fonts, instead of
1529 % document fonts. Therefore we cannot use special characters,
1530 % since the encoding is unknown. For example, the eogonek from
1531 % Latin 2 (0xea) gets translated to a | character. Info from
1532 % Staszek Wawrykiewicz, 19 Jan 2004 04:09:24 +0100.
1533 %
1534 % xx to do this right, we have to translate 8-bit characters to
1535 % their "best" equivalent, based on the @documentencoding. Right
1536 % now, I guess we'll just let the pdf reader have its way.
1537 \indexnofonts
1538 \setupdatafile
1539 \catcode`\\=\active \otherbackslash
1540 \input \tocreadfilename
1541 \endgroup
956 } 1542 }
957 \def\picknum#1{\expandafter\pn#1} 1543 %
958 \def\pn#1{%
959 \def\p{#1}%
960 \ifx\p\lbrace
961 \let\nextpn=\ppn
962 \else
963 \let\nextpn=\ppnn
964 \def\first{#1}
965 \fi
966 \nextpn
967 }
968 \def\ppn#1{\pgn=#1\gobble}
969 \def\ppnn{\pgn=\first}
970 \def\pdfmklnk#1{\lnkcount=0\makelinks #1,END,}
971 \def\addtokens#1#2{\edef\addtoks{\noexpand#1={\the#1#2}}\addtoks}
972 \def\skipspaces#1{\def\PP{#1}\def\D{|}% 1544 \def\skipspaces#1{\def\PP{#1}\def\D{|}%
973 \ifx\PP\D\let\nextsp\relax 1545 \ifx\PP\D\let\nextsp\relax
974 \else\let\nextsp\skipspaces 1546 \else\let\nextsp\skipspaces
975 \ifx\p\space\else\addtokens{\filename}{\PP}% 1547 \ifx\p\space\else\addtokens{\filename}{\PP}%
976 \advance\filenamelength by 1 1548 \advance\filenamelength by 1
981 \ifnum\pdftexversion < 14 1553 \ifnum\pdftexversion < 14
982 \let \startlink \pdfannotlink 1554 \let \startlink \pdfannotlink
983 \else 1555 \else
984 \let \startlink \pdfstartlink 1556 \let \startlink \pdfstartlink
985 \fi 1557 \fi
1558 % make a live url in pdf output.
986 \def\pdfurl#1{% 1559 \def\pdfurl#1{%
987 \begingroup 1560 \begingroup
988 \normalturnoffactive\def\@{@}% 1561 % it seems we really need yet another set of dummies; have not
989 \leavevmode\Red 1562 % tried to figure out what each command should do in the context
1563 % of @url. for now, just make @/ a no-op, that's the only one
1564 % people have actually reported a problem with.
1565 %
1566 \normalturnoffactive
1567 \def\@{@}%
1568 \let\/=\empty
1569 \makevalueexpandable
1570 \leavevmode\setcolor{\urlcolor}%
990 \startlink attr{/Border [0 0 0]}% 1571 \startlink attr{/Border [0 0 0]}%
991 user{/Subtype /Link /A << /S /URI /URI (#1) >>}% 1572 user{/Subtype /Link /A << /S /URI /URI (#1) >>}%
992 % #1
993 \endgroup} 1573 \endgroup}
994 \def\pdfgettoks#1.{\setbox\boxA=\hbox{\toksA={#1.}\toksB={}\maketoks}} 1574 \def\pdfgettoks#1.{\setbox\boxA=\hbox{\toksA={#1.}\toksB={}\maketoks}}
995 \def\addtokens#1#2{\edef\addtoks{\noexpand#1={\the#1#2}}\addtoks} 1575 \def\addtokens#1#2{\edef\addtoks{\noexpand#1={\the#1#2}}\addtoks}
996 \def\adn#1{\addtokens{\toksC}{#1}\global\countA=1\let\next=\maketoks} 1576 \def\adn#1{\addtokens{\toksC}{#1}\global\countA=1\let\next=\maketoks}
997 \def\poptoks#1#2|ENDTOKS|{\let\first=#1\toksD={#1}\toksA={#2}} 1577 \def\poptoks#1#2|ENDTOKS|{\let\first=#1\toksD={#1}\toksA={#2}}
998 \def\maketoks{% 1578 \def\maketoks{%
999 \expandafter\poptoks\the\toksA|ENDTOKS| 1579 \expandafter\poptoks\the\toksA|ENDTOKS|\relax
1000 \ifx\first0\adn0 1580 \ifx\first0\adn0
1001 \else\ifx\first1\adn1 \else\ifx\first2\adn2 \else\ifx\first3\adn3 1581 \else\ifx\first1\adn1 \else\ifx\first2\adn2 \else\ifx\first3\adn3
1002 \else\ifx\first4\adn4 \else\ifx\first5\adn5 \else\ifx\first6\adn6 1582 \else\ifx\first4\adn4 \else\ifx\first5\adn5 \else\ifx\first6\adn6
1003 \else\ifx\first7\adn7 \else\ifx\first8\adn8 \else\ifx\first9\adn9 1583 \else\ifx\first7\adn7 \else\ifx\first8\adn8 \else\ifx\first9\adn9
1004 \else 1584 \else
1005 \ifnum0=\countA\else\makelink\fi 1585 \ifnum0=\countA\else\makelink\fi
1006 \ifx\first.\let\next=\done\else 1586 \ifx\first.\let\next=\done\else
1007 \let\next=\maketoks 1587 \let\next=\maketoks
1008 \addtokens{\toksB}{\the\toksD} 1588 \addtokens{\toksB}{\the\toksD}
1011 \fi\fi\fi\fi\fi\fi\fi\fi\fi\fi 1591 \fi\fi\fi\fi\fi\fi\fi\fi\fi\fi
1012 \next} 1592 \next}
1013 \def\makelink{\addtokens{\toksB}% 1593 \def\makelink{\addtokens{\toksB}%
1014 {\noexpand\pdflink{\the\toksC}}\toksC={}\global\countA=0} 1594 {\noexpand\pdflink{\the\toksC}}\toksC={}\global\countA=0}
1015 \def\pdflink#1{% 1595 \def\pdflink#1{%
1016 \startlink attr{/Border [0 0 0]} goto name{\mkpgn{#1}} 1596 \startlink attr{/Border [0 0 0]} goto name{\pdfmkpgn{#1}}
1017 \linkcolor #1\endlink} 1597 \setcolor{\linkcolor}#1\endlink}
1018 \def\mkpgn#1{#1@}
1019 \def\done{\edef\st{\global\noexpand\toksA={\the\toksB}}\st} 1598 \def\done{\edef\st{\global\noexpand\toksA={\the\toksB}}\st}
1020 \fi % \ifx\pdfoutput 1599 \else
1600 \let\pdfmkdest = \gobble
1601 \let\pdfurl = \gobble
1602 \let\endlink = \relax
1603 \let\setcolor = \gobble
1604 \let\pdfsetcolor = \gobble
1605 \let\pdfmakeoutlines = \relax
1606 \fi % \ifx\pdfoutput
1021 1607
1022 1608
1023 \message{fonts,} 1609 \message{fonts,}
1024 % Font-change commands. 1610
1611 % Change the current font style to #1, remembering it in \curfontstyle.
1612 % For now, we do not accumulate font styles: @b{@i{foo}} prints foo in
1613 % italics, not bold italics.
1614 %
1615 \def\setfontstyle#1{%
1616 \def\curfontstyle{#1}% not as a control sequence, because we are \edef'd.
1617 \csname ten#1\endcsname % change the current font
1618 }
1619
1620 % Select #1 fonts with the current style.
1621 %
1622 \def\selectfonts#1{\csname #1fonts\endcsname \csname\curfontstyle\endcsname}
1623
1624 \def\rm{\fam=0 \setfontstyle{rm}}
1625 \def\it{\fam=\itfam \setfontstyle{it}}
1626 \def\sl{\fam=\slfam \setfontstyle{sl}}
1627 \def\bf{\fam=\bffam \setfontstyle{bf}}\def\bfstylename{bf}
1628 \def\tt{\fam=\ttfam \setfontstyle{tt}}
1025 1629
1026 % Texinfo sort of supports the sans serif font style, which plain TeX does not. 1630 % Texinfo sort of supports the sans serif font style, which plain TeX does not.
1027 % So we set up a \sf analogous to plain's \rm, etc. 1631 % So we set up a \sf.
1028 \newfam\sffam 1632 \newfam\sffam
1029 \def\sf{\fam=\sffam \tensf} 1633 \def\sf{\fam=\sffam \setfontstyle{sf}}
1030 \let\li = \sf % Sometimes we call it \li, not \sf. 1634 \let\li = \sf % Sometimes we call it \li, not \sf.
1031 1635
1032 % We don't need math for this one. 1636 % We don't need math for this font style.
1033 \def\ttsl{\tenttsl} 1637 \def\ttsl{\setfontstyle{ttsl}}
1034 1638
1035 % Use Computer Modern fonts at \magstephalf (11pt). 1639
1036 \newcount\mainmagstep 1640 % Default leading.
1037 \mainmagstep=\magstephalf 1641 \newdimen\textleading \textleading = 13.2pt
1642
1643 % Set the baselineskip to #1, and the lineskip and strut size
1644 % correspondingly. There is no deep meaning behind these magic numbers
1645 % used as factors; they just match (closely enough) what Knuth defined.
1646 %
1647 \def\lineskipfactor{.08333}
1648 \def\strutheightpercent{.70833}
1649 \def\strutdepthpercent {.29167}
1650 %
1651 % can get a sort of poor man's double spacing by redefining this.
1652 \def\baselinefactor{1}
1653 %
1654 \def\setleading#1{%
1655 \dimen0 = #1\relax
1656 \normalbaselineskip = \baselinefactor\dimen0
1657 \normallineskip = \lineskipfactor\normalbaselineskip
1658 \normalbaselines
1659 \setbox\strutbox =\hbox{%
1660 \vrule width0pt height\strutheightpercent\baselineskip
1661 depth \strutdepthpercent \baselineskip
1662 }%
1663 }
1664
1665 % PDF CMaps. See also LaTeX's t1.cmap.
1666 %
1667 % do nothing with this by default.
1668 \expandafter\let\csname cmapOT1\endcsname\gobble
1669 \expandafter\let\csname cmapOT1IT\endcsname\gobble
1670 \expandafter\let\csname cmapOT1TT\endcsname\gobble
1671
1672 % if we are producing pdf, and we have \pdffontattr, then define cmaps.
1673 % (\pdffontattr was introduced many years ago, but people still run
1674 % older pdftex's; it's easy to conditionalize, so we do.)
1675 \ifpdf \ifx\pdffontattr\undefined \else
1676 \begingroup
1677 \catcode`\^^M=\active \def^^M{^^J}% Output line endings as the ^^J char.
1678 \catcode`\%=12 \immediate\pdfobj stream {%!PS-Adobe-3.0 Resource-CMap
1679 %%DocumentNeededResources: ProcSet (CIDInit)
1680 %%IncludeResource: ProcSet (CIDInit)
1681 %%BeginResource: CMap (TeX-OT1-0)
1682 %%Title: (TeX-OT1-0 TeX OT1 0)
1683 %%Version: 1.000
1684 %%EndComments
1685 /CIDInit /ProcSet findresource begin
1686 12 dict begin
1687 begincmap
1688 /CIDSystemInfo
1689 << /Registry (TeX)
1690 /Ordering (OT1)
1691 /Supplement 0
1692 >> def
1693 /CMapName /TeX-OT1-0 def
1694 /CMapType 2 def
1695 1 begincodespacerange
1696 <00> <7F>
1697 endcodespacerange
1698 8 beginbfrange
1699 <00> <01> <0393>
1700 <09> <0A> <03A8>
1701 <23> <26> <0023>
1702 <28> <3B> <0028>
1703 <3F> <5B> <003F>
1704 <5D> <5E> <005D>
1705 <61> <7A> <0061>
1706 <7B> <7C> <2013>
1707 endbfrange
1708 40 beginbfchar
1709 <02> <0398>
1710 <03> <039B>
1711 <04> <039E>
1712 <05> <03A0>
1713 <06> <03A3>
1714 <07> <03D2>
1715 <08> <03A6>
1716 <0B> <00660066>
1717 <0C> <00660069>
1718 <0D> <0066006C>
1719 <0E> <006600660069>
1720 <0F> <00660066006C>
1721 <10> <0131>
1722 <11> <0237>
1723 <12> <0060>
1724 <13> <00B4>
1725 <14> <02C7>
1726 <15> <02D8>
1727 <16> <00AF>
1728 <17> <02DA>
1729 <18> <00B8>
1730 <19> <00DF>
1731 <1A> <00E6>
1732 <1B> <0153>
1733 <1C> <00F8>
1734 <1D> <00C6>
1735 <1E> <0152>
1736 <1F> <00D8>
1737 <21> <0021>
1738 <22> <201D>
1739 <27> <2019>
1740 <3C> <00A1>
1741 <3D> <003D>
1742 <3E> <00BF>
1743 <5C> <201C>
1744 <5F> <02D9>
1745 <60> <2018>
1746 <7D> <02DD>
1747 <7E> <007E>
1748 <7F> <00A8>
1749 endbfchar
1750 endcmap
1751 CMapName currentdict /CMap defineresource pop
1752 end
1753 end
1754 %%EndResource
1755 %%EOF
1756 }\endgroup
1757 \expandafter\edef\csname cmapOT1\endcsname#1{%
1758 \pdffontattr#1{/ToUnicode \the\pdflastobj\space 0 R}%
1759 }%
1760 %
1761 % \cmapOT1IT
1762 \begingroup
1763 \catcode`\^^M=\active \def^^M{^^J}% Output line endings as the ^^J char.
1764 \catcode`\%=12 \immediate\pdfobj stream {%!PS-Adobe-3.0 Resource-CMap
1765 %%DocumentNeededResources: ProcSet (CIDInit)
1766 %%IncludeResource: ProcSet (CIDInit)
1767 %%BeginResource: CMap (TeX-OT1IT-0)
1768 %%Title: (TeX-OT1IT-0 TeX OT1IT 0)
1769 %%Version: 1.000
1770 %%EndComments
1771 /CIDInit /ProcSet findresource begin
1772 12 dict begin
1773 begincmap
1774 /CIDSystemInfo
1775 << /Registry (TeX)
1776 /Ordering (OT1IT)
1777 /Supplement 0
1778 >> def
1779 /CMapName /TeX-OT1IT-0 def
1780 /CMapType 2 def
1781 1 begincodespacerange
1782 <00> <7F>
1783 endcodespacerange
1784 8 beginbfrange
1785 <00> <01> <0393>
1786 <09> <0A> <03A8>
1787 <25> <26> <0025>
1788 <28> <3B> <0028>
1789 <3F> <5B> <003F>
1790 <5D> <5E> <005D>
1791 <61> <7A> <0061>
1792 <7B> <7C> <2013>
1793 endbfrange
1794 42 beginbfchar
1795 <02> <0398>
1796 <03> <039B>
1797 <04> <039E>
1798 <05> <03A0>
1799 <06> <03A3>
1800 <07> <03D2>
1801 <08> <03A6>
1802 <0B> <00660066>
1803 <0C> <00660069>
1804 <0D> <0066006C>
1805 <0E> <006600660069>
1806 <0F> <00660066006C>
1807 <10> <0131>
1808 <11> <0237>
1809 <12> <0060>
1810 <13> <00B4>
1811 <14> <02C7>
1812 <15> <02D8>
1813 <16> <00AF>
1814 <17> <02DA>
1815 <18> <00B8>
1816 <19> <00DF>
1817 <1A> <00E6>
1818 <1B> <0153>
1819 <1C> <00F8>
1820 <1D> <00C6>
1821 <1E> <0152>
1822 <1F> <00D8>
1823 <21> <0021>
1824 <22> <201D>
1825 <23> <0023>
1826 <24> <00A3>
1827 <27> <2019>
1828 <3C> <00A1>
1829 <3D> <003D>
1830 <3E> <00BF>
1831 <5C> <201C>
1832 <5F> <02D9>
1833 <60> <2018>
1834 <7D> <02DD>
1835 <7E> <007E>
1836 <7F> <00A8>
1837 endbfchar
1838 endcmap
1839 CMapName currentdict /CMap defineresource pop
1840 end
1841 end
1842 %%EndResource
1843 %%EOF
1844 }\endgroup
1845 \expandafter\edef\csname cmapOT1IT\endcsname#1{%
1846 \pdffontattr#1{/ToUnicode \the\pdflastobj\space 0 R}%
1847 }%
1848 %
1849 % \cmapOT1TT
1850 \begingroup
1851 \catcode`\^^M=\active \def^^M{^^J}% Output line endings as the ^^J char.
1852 \catcode`\%=12 \immediate\pdfobj stream {%!PS-Adobe-3.0 Resource-CMap
1853 %%DocumentNeededResources: ProcSet (CIDInit)
1854 %%IncludeResource: ProcSet (CIDInit)
1855 %%BeginResource: CMap (TeX-OT1TT-0)
1856 %%Title: (TeX-OT1TT-0 TeX OT1TT 0)
1857 %%Version: 1.000
1858 %%EndComments
1859 /CIDInit /ProcSet findresource begin
1860 12 dict begin
1861 begincmap
1862 /CIDSystemInfo
1863 << /Registry (TeX)
1864 /Ordering (OT1TT)
1865 /Supplement 0
1866 >> def
1867 /CMapName /TeX-OT1TT-0 def
1868 /CMapType 2 def
1869 1 begincodespacerange
1870 <00> <7F>
1871 endcodespacerange
1872 5 beginbfrange
1873 <00> <01> <0393>
1874 <09> <0A> <03A8>
1875 <21> <26> <0021>
1876 <28> <5F> <0028>
1877 <61> <7E> <0061>
1878 endbfrange
1879 32 beginbfchar
1880 <02> <0398>
1881 <03> <039B>
1882 <04> <039E>
1883 <05> <03A0>
1884 <06> <03A3>
1885 <07> <03D2>
1886 <08> <03A6>
1887 <0B> <2191>
1888 <0C> <2193>
1889 <0D> <0027>
1890 <0E> <00A1>
1891 <0F> <00BF>
1892 <10> <0131>
1893 <11> <0237>
1894 <12> <0060>
1895 <13> <00B4>
1896 <14> <02C7>
1897 <15> <02D8>
1898 <16> <00AF>
1899 <17> <02DA>
1900 <18> <00B8>
1901 <19> <00DF>
1902 <1A> <00E6>
1903 <1B> <0153>
1904 <1C> <00F8>
1905 <1D> <00C6>
1906 <1E> <0152>
1907 <1F> <00D8>
1908 <20> <2423>
1909 <27> <2019>
1910 <60> <2018>
1911 <7F> <00A8>
1912 endbfchar
1913 endcmap
1914 CMapName currentdict /CMap defineresource pop
1915 end
1916 end
1917 %%EndResource
1918 %%EOF
1919 }\endgroup
1920 \expandafter\edef\csname cmapOT1TT\endcsname#1{%
1921 \pdffontattr#1{/ToUnicode \the\pdflastobj\space 0 R}%
1922 }%
1923 \fi\fi
1924
1038 1925
1039 % Set the font macro #1 to the font named #2, adding on the 1926 % Set the font macro #1 to the font named #2, adding on the
1040 % specified font prefix (normally `cm'). 1927 % specified font prefix (normally `cm').
1041 % #3 is the font's design size, #4 is a scale factor 1928 % #3 is the font's design size, #4 is a scale factor, #5 is the CMap
1042 \def\setfont#1#2#3#4{\font#1=\fontprefix#2#3 scaled #4} 1929 % encoding (currently only OT1, OT1IT and OT1TT are allowed, pass
1930 % empty to omit).
1931 \def\setfont#1#2#3#4#5{%
1932 \font#1=\fontprefix#2#3 scaled #4
1933 \csname cmap#5\endcsname#1%
1934 }
1935 % This is what gets called when #5 of \setfont is empty.
1936 \let\cmap\gobble
1937 % emacs-page end of cmaps
1043 1938
1044 % Use cm as the default font prefix. 1939 % Use cm as the default font prefix.
1045 % To specify the font prefix, you must define \fontprefix 1940 % To specify the font prefix, you must define \fontprefix
1046 % before you read in texinfo.tex. 1941 % before you read in texinfo.tex.
1047 \ifx\fontprefix\undefined 1942 \ifx\fontprefix\undefined
1062 \def\sfshape{ss} 1957 \def\sfshape{ss}
1063 \def\sfbshape{ss} 1958 \def\sfbshape{ss}
1064 \def\scshape{csc} 1959 \def\scshape{csc}
1065 \def\scbshape{csc} 1960 \def\scbshape{csc}
1066 1961
1067 \ifx\bigger\relax 1962 % Definitions for a main text size of 11pt. This is the default in
1068 \let\mainmagstep=\magstep1 1963 % Texinfo.
1069 \setfont\textrm\rmshape{12}{1000} 1964 %
1070 \setfont\texttt\ttshape{12}{1000} 1965 \def\definetextfontsizexi{%
1071 \else 1966 % Text fonts (11.2pt, magstep1).
1072 \setfont\textrm\rmshape{10}{\mainmagstep} 1967 \def\textnominalsize{11pt}
1073 \setfont\texttt\ttshape{10}{\mainmagstep} 1968 \edef\mainmagstep{\magstephalf}
1074 \fi 1969 \setfont\textrm\rmshape{10}{\mainmagstep}{OT1}
1075 % Instead of cmb10, you many want to use cmbx10. 1970 \setfont\texttt\ttshape{10}{\mainmagstep}{OT1TT}
1076 % cmbx10 is a prettier font on its own, but cmb10 1971 \setfont\textbf\bfshape{10}{\mainmagstep}{OT1}
1077 % looks better when embedded in a line with cmr10. 1972 \setfont\textit\itshape{10}{\mainmagstep}{OT1IT}
1078 \setfont\textbf\bfshape{10}{\mainmagstep} 1973 \setfont\textsl\slshape{10}{\mainmagstep}{OT1}
1079 \setfont\textit\itshape{10}{\mainmagstep} 1974 \setfont\textsf\sfshape{10}{\mainmagstep}{OT1}
1080 \setfont\textsl\slshape{10}{\mainmagstep} 1975 \setfont\textsc\scshape{10}{\mainmagstep}{OT1}
1081 \setfont\textsf\sfshape{10}{\mainmagstep} 1976 \setfont\textttsl\ttslshape{10}{\mainmagstep}{OT1TT}
1082 \setfont\textsc\scshape{10}{\mainmagstep}
1083 \setfont\textttsl\ttslshape{10}{\mainmagstep}
1084 \font\texti=cmmi10 scaled \mainmagstep 1977 \font\texti=cmmi10 scaled \mainmagstep
1085 \font\textsy=cmsy10 scaled \mainmagstep 1978 \font\textsy=cmsy10 scaled \mainmagstep
1086 1979 \def\textecsize{1095}
1087 % A few fonts for @defun, etc. 1980
1088 \setfont\defbf\bxshape{10}{\magstep1} %was 1314 1981 % A few fonts for @defun names and args.
1089 \setfont\deftt\ttshape{10}{\magstep1} 1982 \setfont\defbf\bfshape{10}{\magstep1}{OT1}
1090 \def\df{\let\tentt=\deftt \let\tenbf = \defbf \bf} 1983 \setfont\deftt\ttshape{10}{\magstep1}{OT1TT}
1984 \setfont\defttsl\ttslshape{10}{\magstep1}{OT1TT}
1985 \def\df{\let\tentt=\deftt \let\tenbf = \defbf \let\tenttsl=\defttsl \bf}
1091 1986
1092 % Fonts for indices, footnotes, small examples (9pt). 1987 % Fonts for indices, footnotes, small examples (9pt).
1093 \setfont\smallrm\rmshape{9}{1000} 1988 \def\smallnominalsize{9pt}
1094 \setfont\smalltt\ttshape{9}{1000} 1989 \setfont\smallrm\rmshape{9}{1000}{OT1}
1095 \setfont\smallbf\bfshape{10}{900} 1990 \setfont\smalltt\ttshape{9}{1000}{OT1TT}
1096 \setfont\smallit\itshape{9}{1000} 1991 \setfont\smallbf\bfshape{10}{900}{OT1}
1097 \setfont\smallsl\slshape{9}{1000} 1992 \setfont\smallit\itshape{9}{1000}{OT1IT}
1098 \setfont\smallsf\sfshape{9}{1000} 1993 \setfont\smallsl\slshape{9}{1000}{OT1}
1099 \setfont\smallsc\scshape{10}{900} 1994 \setfont\smallsf\sfshape{9}{1000}{OT1}
1100 \setfont\smallttsl\ttslshape{10}{900} 1995 \setfont\smallsc\scshape{10}{900}{OT1}
1996 \setfont\smallttsl\ttslshape{10}{900}{OT1TT}
1101 \font\smalli=cmmi9 1997 \font\smalli=cmmi9
1102 \font\smallsy=cmsy9 1998 \font\smallsy=cmsy9
1103 1999 \def\smallecsize{0900}
1104 % Fonts for title page: 2000
1105 \setfont\titlerm\rmbshape{12}{\magstep3} 2001 % Fonts for small examples (8pt).
1106 \setfont\titleit\itbshape{10}{\magstep4} 2002 \def\smallernominalsize{8pt}
1107 \setfont\titlesl\slbshape{10}{\magstep4} 2003 \setfont\smallerrm\rmshape{8}{1000}{OT1}
1108 \setfont\titlett\ttbshape{12}{\magstep3} 2004 \setfont\smallertt\ttshape{8}{1000}{OT1TT}
1109 \setfont\titlettsl\ttslshape{10}{\magstep4} 2005 \setfont\smallerbf\bfshape{10}{800}{OT1}
1110 \setfont\titlesf\sfbshape{17}{\magstep1} 2006 \setfont\smallerit\itshape{8}{1000}{OT1IT}
2007 \setfont\smallersl\slshape{8}{1000}{OT1}
2008 \setfont\smallersf\sfshape{8}{1000}{OT1}
2009 \setfont\smallersc\scshape{10}{800}{OT1}
2010 \setfont\smallerttsl\ttslshape{10}{800}{OT1TT}
2011 \font\smalleri=cmmi8
2012 \font\smallersy=cmsy8
2013 \def\smallerecsize{0800}
2014
2015 % Fonts for title page (20.4pt):
2016 \def\titlenominalsize{20pt}
2017 \setfont\titlerm\rmbshape{12}{\magstep3}{OT1}
2018 \setfont\titleit\itbshape{10}{\magstep4}{OT1IT}
2019 \setfont\titlesl\slbshape{10}{\magstep4}{OT1}
2020 \setfont\titlett\ttbshape{12}{\magstep3}{OT1TT}
2021 \setfont\titlettsl\ttslshape{10}{\magstep4}{OT1TT}
2022 \setfont\titlesf\sfbshape{17}{\magstep1}{OT1}
1111 \let\titlebf=\titlerm 2023 \let\titlebf=\titlerm
1112 \setfont\titlesc\scbshape{10}{\magstep4} 2024 \setfont\titlesc\scbshape{10}{\magstep4}{OT1}
1113 \font\titlei=cmmi12 scaled \magstep3 2025 \font\titlei=cmmi12 scaled \magstep3
1114 \font\titlesy=cmsy10 scaled \magstep4 2026 \font\titlesy=cmsy10 scaled \magstep4
1115 \def\authorrm{\secrm} 2027 \def\authorrm{\secrm}
2028 \def\authortt{\sectt}
2029 \def\titleecsize{2074}
1116 2030
1117 % Chapter (and unnumbered) fonts (17.28pt). 2031 % Chapter (and unnumbered) fonts (17.28pt).
1118 \setfont\chaprm\rmbshape{12}{\magstep2} 2032 \def\chapnominalsize{17pt}
1119 \setfont\chapit\itbshape{10}{\magstep3} 2033 \setfont\chaprm\rmbshape{12}{\magstep2}{OT1}
1120 \setfont\chapsl\slbshape{10}{\magstep3} 2034 \setfont\chapit\itbshape{10}{\magstep3}{OT1IT}
1121 \setfont\chaptt\ttbshape{12}{\magstep2} 2035 \setfont\chapsl\slbshape{10}{\magstep3}{OT1}
1122 \setfont\chapttsl\ttslshape{10}{\magstep3} 2036 \setfont\chaptt\ttbshape{12}{\magstep2}{OT1TT}
1123 \setfont\chapsf\sfbshape{17}{1000} 2037 \setfont\chapttsl\ttslshape{10}{\magstep3}{OT1TT}
2038 \setfont\chapsf\sfbshape{17}{1000}{OT1}
1124 \let\chapbf=\chaprm 2039 \let\chapbf=\chaprm
1125 \setfont\chapsc\scbshape{10}{\magstep3} 2040 \setfont\chapsc\scbshape{10}{\magstep3}{OT1}
1126 \font\chapi=cmmi12 scaled \magstep2 2041 \font\chapi=cmmi12 scaled \magstep2
1127 \font\chapsy=cmsy10 scaled \magstep3 2042 \font\chapsy=cmsy10 scaled \magstep3
2043 \def\chapecsize{1728}
1128 2044
1129 % Section fonts (14.4pt). 2045 % Section fonts (14.4pt).
1130 \setfont\secrm\rmbshape{12}{\magstep1} 2046 \def\secnominalsize{14pt}
1131 \setfont\secit\itbshape{10}{\magstep2} 2047 \setfont\secrm\rmbshape{12}{\magstep1}{OT1}
1132 \setfont\secsl\slbshape{10}{\magstep2} 2048 \setfont\secit\itbshape{10}{\magstep2}{OT1IT}
1133 \setfont\sectt\ttbshape{12}{\magstep1} 2049 \setfont\secsl\slbshape{10}{\magstep2}{OT1}
1134 \setfont\secttsl\ttslshape{10}{\magstep2} 2050 \setfont\sectt\ttbshape{12}{\magstep1}{OT1TT}
1135 \setfont\secsf\sfbshape{12}{\magstep1} 2051 \setfont\secttsl\ttslshape{10}{\magstep2}{OT1TT}
2052 \setfont\secsf\sfbshape{12}{\magstep1}{OT1}
1136 \let\secbf\secrm 2053 \let\secbf\secrm
1137 \setfont\secsc\scbshape{10}{\magstep2} 2054 \setfont\secsc\scbshape{10}{\magstep2}{OT1}
1138 \font\seci=cmmi12 scaled \magstep1 2055 \font\seci=cmmi12 scaled \magstep1
1139 \font\secsy=cmsy10 scaled \magstep2 2056 \font\secsy=cmsy10 scaled \magstep2
1140 2057 \def\sececsize{1440}
1141 % \setfont\ssecrm\bxshape{10}{\magstep1} % This size an font looked bad.
1142 % \setfont\ssecit\itshape{10}{\magstep1} % The letters were too crowded.
1143 % \setfont\ssecsl\slshape{10}{\magstep1}
1144 % \setfont\ssectt\ttshape{10}{\magstep1}
1145 % \setfont\ssecsf\sfshape{10}{\magstep1}
1146
1147 %\setfont\ssecrm\bfshape{10}{1315} % Note the use of cmb rather than cmbx.
1148 %\setfont\ssecit\itshape{10}{1315} % Also, the size is a little larger than
1149 %\setfont\ssecsl\slshape{10}{1315} % being scaled magstep1.
1150 %\setfont\ssectt\ttshape{10}{1315}
1151 %\setfont\ssecsf\sfshape{10}{1315}
1152
1153 %\let\ssecbf=\ssecrm
1154 2058
1155 % Subsection fonts (13.15pt). 2059 % Subsection fonts (13.15pt).
1156 \setfont\ssecrm\rmbshape{12}{\magstephalf} 2060 \def\ssecnominalsize{13pt}
1157 \setfont\ssecit\itbshape{10}{1315} 2061 \setfont\ssecrm\rmbshape{12}{\magstephalf}{OT1}
1158 \setfont\ssecsl\slbshape{10}{1315} 2062 \setfont\ssecit\itbshape{10}{1315}{OT1IT}
1159 \setfont\ssectt\ttbshape{12}{\magstephalf} 2063 \setfont\ssecsl\slbshape{10}{1315}{OT1}
1160 \setfont\ssecttsl\ttslshape{10}{1315} 2064 \setfont\ssectt\ttbshape{12}{\magstephalf}{OT1TT}
1161 \setfont\ssecsf\sfbshape{12}{\magstephalf} 2065 \setfont\ssecttsl\ttslshape{10}{1315}{OT1TT}
2066 \setfont\ssecsf\sfbshape{12}{\magstephalf}{OT1}
1162 \let\ssecbf\ssecrm 2067 \let\ssecbf\ssecrm
1163 \setfont\ssecsc\scbshape{10}{\magstep1} 2068 \setfont\ssecsc\scbshape{10}{1315}{OT1}
1164 \font\sseci=cmmi12 scaled \magstephalf 2069 \font\sseci=cmmi12 scaled \magstephalf
1165 \font\ssecsy=cmsy10 scaled 1315 2070 \font\ssecsy=cmsy10 scaled 1315
1166 % The smallcaps and symbol fonts should actually be scaled \magstep1.5, 2071 \def\ssececsize{1200}
1167 % but that is not a standard magnification. 2072
2073 % Reduced fonts for @acro in text (10pt).
2074 \def\reducednominalsize{10pt}
2075 \setfont\reducedrm\rmshape{10}{1000}{OT1}
2076 \setfont\reducedtt\ttshape{10}{1000}{OT1TT}
2077 \setfont\reducedbf\bfshape{10}{1000}{OT1}
2078 \setfont\reducedit\itshape{10}{1000}{OT1IT}
2079 \setfont\reducedsl\slshape{10}{1000}{OT1}
2080 \setfont\reducedsf\sfshape{10}{1000}{OT1}
2081 \setfont\reducedsc\scshape{10}{1000}{OT1}
2082 \setfont\reducedttsl\ttslshape{10}{1000}{OT1TT}
2083 \font\reducedi=cmmi10
2084 \font\reducedsy=cmsy10
2085 \def\reducedecsize{1000}
2086
2087 % reset the current fonts
2088 \textfonts
2089 \rm
2090 } % end of 11pt text font size definitions
2091
2092
2093 % Definitions to make the main text be 10pt Computer Modern, with
2094 % section, chapter, etc., sizes following suit. This is for the GNU
2095 % Press printing of the Emacs 22 manual. Maybe other manuals in the
2096 % future. Used with @smallbook, which sets the leading to 12pt.
2097 %
2098 \def\definetextfontsizex{%
2099 % Text fonts (10pt).
2100 \def\textnominalsize{10pt}
2101 \edef\mainmagstep{1000}
2102 \setfont\textrm\rmshape{10}{\mainmagstep}{OT1}
2103 \setfont\texttt\ttshape{10}{\mainmagstep}{OT1TT}
2104 \setfont\textbf\bfshape{10}{\mainmagstep}{OT1}
2105 \setfont\textit\itshape{10}{\mainmagstep}{OT1IT}
2106 \setfont\textsl\slshape{10}{\mainmagstep}{OT1}
2107 \setfont\textsf\sfshape{10}{\mainmagstep}{OT1}
2108 \setfont\textsc\scshape{10}{\mainmagstep}{OT1}
2109 \setfont\textttsl\ttslshape{10}{\mainmagstep}{OT1TT}
2110 \font\texti=cmmi10 scaled \mainmagstep
2111 \font\textsy=cmsy10 scaled \mainmagstep
2112 \def\textecsize{1000}
2113
2114 % A few fonts for @defun names and args.
2115 \setfont\defbf\bfshape{10}{\magstephalf}{OT1}
2116 \setfont\deftt\ttshape{10}{\magstephalf}{OT1TT}
2117 \setfont\defttsl\ttslshape{10}{\magstephalf}{OT1TT}
2118 \def\df{\let\tentt=\deftt \let\tenbf = \defbf \let\tenttsl=\defttsl \bf}
2119
2120 % Fonts for indices, footnotes, small examples (9pt).
2121 \def\smallnominalsize{9pt}
2122 \setfont\smallrm\rmshape{9}{1000}{OT1}
2123 \setfont\smalltt\ttshape{9}{1000}{OT1TT}
2124 \setfont\smallbf\bfshape{10}{900}{OT1}
2125 \setfont\smallit\itshape{9}{1000}{OT1IT}
2126 \setfont\smallsl\slshape{9}{1000}{OT1}
2127 \setfont\smallsf\sfshape{9}{1000}{OT1}
2128 \setfont\smallsc\scshape{10}{900}{OT1}
2129 \setfont\smallttsl\ttslshape{10}{900}{OT1TT}
2130 \font\smalli=cmmi9
2131 \font\smallsy=cmsy9
2132 \def\smallecsize{0900}
2133
2134 % Fonts for small examples (8pt).
2135 \def\smallernominalsize{8pt}
2136 \setfont\smallerrm\rmshape{8}{1000}{OT1}
2137 \setfont\smallertt\ttshape{8}{1000}{OT1TT}
2138 \setfont\smallerbf\bfshape{10}{800}{OT1}
2139 \setfont\smallerit\itshape{8}{1000}{OT1IT}
2140 \setfont\smallersl\slshape{8}{1000}{OT1}
2141 \setfont\smallersf\sfshape{8}{1000}{OT1}
2142 \setfont\smallersc\scshape{10}{800}{OT1}
2143 \setfont\smallerttsl\ttslshape{10}{800}{OT1TT}
2144 \font\smalleri=cmmi8
2145 \font\smallersy=cmsy8
2146 \def\smallerecsize{0800}
2147
2148 % Fonts for title page (20.4pt):
2149 \def\titlenominalsize{20pt}
2150 \setfont\titlerm\rmbshape{12}{\magstep3}{OT1}
2151 \setfont\titleit\itbshape{10}{\magstep4}{OT1IT}
2152 \setfont\titlesl\slbshape{10}{\magstep4}{OT1}
2153 \setfont\titlett\ttbshape{12}{\magstep3}{OT1TT}
2154 \setfont\titlettsl\ttslshape{10}{\magstep4}{OT1TT}
2155 \setfont\titlesf\sfbshape{17}{\magstep1}{OT1}
2156 \let\titlebf=\titlerm
2157 \setfont\titlesc\scbshape{10}{\magstep4}{OT1}
2158 \font\titlei=cmmi12 scaled \magstep3
2159 \font\titlesy=cmsy10 scaled \magstep4
2160 \def\authorrm{\secrm}
2161 \def\authortt{\sectt}
2162 \def\titleecsize{2074}
2163
2164 % Chapter fonts (14.4pt).
2165 \def\chapnominalsize{14pt}
2166 \setfont\chaprm\rmbshape{12}{\magstep1}{OT1}
2167 \setfont\chapit\itbshape{10}{\magstep2}{OT1IT}
2168 \setfont\chapsl\slbshape{10}{\magstep2}{OT1}
2169 \setfont\chaptt\ttbshape{12}{\magstep1}{OT1TT}
2170 \setfont\chapttsl\ttslshape{10}{\magstep2}{OT1TT}
2171 \setfont\chapsf\sfbshape{12}{\magstep1}{OT1}
2172 \let\chapbf\chaprm
2173 \setfont\chapsc\scbshape{10}{\magstep2}{OT1}
2174 \font\chapi=cmmi12 scaled \magstep1
2175 \font\chapsy=cmsy10 scaled \magstep2
2176 \def\chapecsize{1440}
2177
2178 % Section fonts (12pt).
2179 \def\secnominalsize{12pt}
2180 \setfont\secrm\rmbshape{12}{1000}{OT1}
2181 \setfont\secit\itbshape{10}{\magstep1}{OT1IT}
2182 \setfont\secsl\slbshape{10}{\magstep1}{OT1}
2183 \setfont\sectt\ttbshape{12}{1000}{OT1TT}
2184 \setfont\secttsl\ttslshape{10}{\magstep1}{OT1TT}
2185 \setfont\secsf\sfbshape{12}{1000}{OT1}
2186 \let\secbf\secrm
2187 \setfont\secsc\scbshape{10}{\magstep1}{OT1}
2188 \font\seci=cmmi12
2189 \font\secsy=cmsy10 scaled \magstep1
2190 \def\sececsize{1200}
2191
2192 % Subsection fonts (10pt).
2193 \def\ssecnominalsize{10pt}
2194 \setfont\ssecrm\rmbshape{10}{1000}{OT1}
2195 \setfont\ssecit\itbshape{10}{1000}{OT1IT}
2196 \setfont\ssecsl\slbshape{10}{1000}{OT1}
2197 \setfont\ssectt\ttbshape{10}{1000}{OT1TT}
2198 \setfont\ssecttsl\ttslshape{10}{1000}{OT1TT}
2199 \setfont\ssecsf\sfbshape{10}{1000}{OT1}
2200 \let\ssecbf\ssecrm
2201 \setfont\ssecsc\scbshape{10}{1000}{OT1}
2202 \font\sseci=cmmi10
2203 \font\ssecsy=cmsy10
2204 \def\ssececsize{1000}
2205
2206 % Reduced fonts for @acro in text (9pt).
2207 \def\reducednominalsize{9pt}
2208 \setfont\reducedrm\rmshape{9}{1000}{OT1}
2209 \setfont\reducedtt\ttshape{9}{1000}{OT1TT}
2210 \setfont\reducedbf\bfshape{10}{900}{OT1}
2211 \setfont\reducedit\itshape{9}{1000}{OT1IT}
2212 \setfont\reducedsl\slshape{9}{1000}{OT1}
2213 \setfont\reducedsf\sfshape{9}{1000}{OT1}
2214 \setfont\reducedsc\scshape{10}{900}{OT1}
2215 \setfont\reducedttsl\ttslshape{10}{900}{OT1TT}
2216 \font\reducedi=cmmi9
2217 \font\reducedsy=cmsy9
2218 \def\reducedecsize{0900}
2219
2220 % reduce space between paragraphs
2221 \divide\parskip by 2
2222
2223 % reset the current fonts
2224 \textfonts
2225 \rm
2226 } % end of 10pt text font size definitions
2227
2228
2229 % We provide the user-level command
2230 % @fonttextsize 10
2231 % (or 11) to redefine the text font size. pt is assumed.
2232 %
2233 \def\xword{10}
2234 \def\xiword{11}
2235 %
2236 \parseargdef\fonttextsize{%
2237 \def\textsizearg{#1}%
2238 \wlog{doing @fonttextsize \textsizearg}%
2239 %
2240 % Set \globaldefs so that documents can use this inside @tex, since
2241 % makeinfo 4.8 does not support it, but we need it nonetheless.
2242 %
2243 \begingroup \globaldefs=1
2244 \ifx\textsizearg\xword \definetextfontsizex
2245 \else \ifx\textsizearg\xiword \definetextfontsizexi
2246 \else
2247 \errhelp=\EMsimple
2248 \errmessage{@fonttextsize only supports `10' or `11', not `\textsizearg'}
2249 \fi\fi
2250 \endgroup
2251 }
2252
1168 2253
1169 % In order for the font changes to affect most math symbols and letters, 2254 % In order for the font changes to affect most math symbols and letters,
1170 % we have to define the \textfont of the standard families. Since 2255 % we have to define the \textfont of the standard families. Since
1171 % texinfo doesn't allow for producing subscripts and superscripts, we 2256 % texinfo doesn't allow for producing subscripts and superscripts except
1172 % don't bother to reset \scriptfont and \scriptscriptfont (which would 2257 % in the main text, we don't bother to reset \scriptfont and
1173 % also require loading a lot more fonts). 2258 % \scriptscriptfont (which would also require loading a lot more fonts).
1174 % 2259 %
1175 \def\resetmathfonts{% 2260 \def\resetmathfonts{%
1176 \textfont0 = \tenrm \textfont1 = \teni \textfont2 = \tensy 2261 \textfont0=\tenrm \textfont1=\teni \textfont2=\tensy
1177 \textfont\itfam = \tenit \textfont\slfam = \tensl \textfont\bffam = \tenbf 2262 \textfont\itfam=\tenit \textfont\slfam=\tensl \textfont\bffam=\tenbf
1178 \textfont\ttfam = \tentt \textfont\sffam = \tensf 2263 \textfont\ttfam=\tentt \textfont\sffam=\tensf
1179 } 2264 }
1180
1181 2265
1182 % The font-changing commands redefine the meanings of \tenSTYLE, instead 2266 % The font-changing commands redefine the meanings of \tenSTYLE, instead
1183 % of just \STYLE. We do this so that font changes will continue to work 2267 % of just \STYLE. We do this because \STYLE needs to also set the
1184 % in math mode, where it is the current \fam that is relevant in most 2268 % current \fam for math mode. Our \STYLE (e.g., \rm) commands hardwire
1185 % cases, not the current font. Plain TeX does \def\bf{\fam=\bffam 2269 % \tenSTYLE to set the current font.
1186 % \tenbf}, for example. By redefining \tenbf, we obviate the need to 2270 %
1187 % redefine \bf itself. 2271 % Each font-changing command also sets the names \lsize (one size lower)
2272 % and \lllsize (three sizes lower). These relative commands are used in
2273 % the LaTeX logo and acronyms.
2274 %
2275 % This all needs generalizing, badly.
2276 %
1188 \def\textfonts{% 2277 \def\textfonts{%
1189 \let\tenrm=\textrm \let\tenit=\textit \let\tensl=\textsl 2278 \let\tenrm=\textrm \let\tenit=\textit \let\tensl=\textsl
1190 \let\tenbf=\textbf \let\tentt=\texttt \let\smallcaps=\textsc 2279 \let\tenbf=\textbf \let\tentt=\texttt \let\smallcaps=\textsc
1191 \let\tensf=\textsf \let\teni=\texti \let\tensy=\textsy \let\tenttsl=\textttsl 2280 \let\tensf=\textsf \let\teni=\texti \let\tensy=\textsy
1192 \resetmathfonts} 2281 \let\tenttsl=\textttsl
2282 \def\curfontsize{text}%
2283 \def\lsize{reduced}\def\lllsize{smaller}%
2284 \resetmathfonts \setleading{\textleading}}
1193 \def\titlefonts{% 2285 \def\titlefonts{%
1194 \let\tenrm=\titlerm \let\tenit=\titleit \let\tensl=\titlesl 2286 \let\tenrm=\titlerm \let\tenit=\titleit \let\tensl=\titlesl
1195 \let\tenbf=\titlebf \let\tentt=\titlett \let\smallcaps=\titlesc 2287 \let\tenbf=\titlebf \let\tentt=\titlett \let\smallcaps=\titlesc
1196 \let\tensf=\titlesf \let\teni=\titlei \let\tensy=\titlesy 2288 \let\tensf=\titlesf \let\teni=\titlei \let\tensy=\titlesy
1197 \let\tenttsl=\titlettsl 2289 \let\tenttsl=\titlettsl
2290 \def\curfontsize{title}%
2291 \def\lsize{chap}\def\lllsize{subsec}%
1198 \resetmathfonts \setleading{25pt}} 2292 \resetmathfonts \setleading{25pt}}
1199 \def\titlefont#1{{\titlefonts\rm #1}} 2293 \def\titlefont#1{{\titlefonts\rm #1}}
1200 \def\chapfonts{% 2294 \def\chapfonts{%
1201 \let\tenrm=\chaprm \let\tenit=\chapit \let\tensl=\chapsl 2295 \let\tenrm=\chaprm \let\tenit=\chapit \let\tensl=\chapsl
1202 \let\tenbf=\chapbf \let\tentt=\chaptt \let\smallcaps=\chapsc 2296 \let\tenbf=\chapbf \let\tentt=\chaptt \let\smallcaps=\chapsc
1203 \let\tensf=\chapsf \let\teni=\chapi \let\tensy=\chapsy \let\tenttsl=\chapttsl 2297 \let\tensf=\chapsf \let\teni=\chapi \let\tensy=\chapsy
2298 \let\tenttsl=\chapttsl
2299 \def\curfontsize{chap}%
2300 \def\lsize{sec}\def\lllsize{text}%
1204 \resetmathfonts \setleading{19pt}} 2301 \resetmathfonts \setleading{19pt}}
1205 \def\secfonts{% 2302 \def\secfonts{%
1206 \let\tenrm=\secrm \let\tenit=\secit \let\tensl=\secsl 2303 \let\tenrm=\secrm \let\tenit=\secit \let\tensl=\secsl
1207 \let\tenbf=\secbf \let\tentt=\sectt \let\smallcaps=\secsc 2304 \let\tenbf=\secbf \let\tentt=\sectt \let\smallcaps=\secsc
1208 \let\tensf=\secsf \let\teni=\seci \let\tensy=\secsy \let\tenttsl=\secttsl 2305 \let\tensf=\secsf \let\teni=\seci \let\tensy=\secsy
2306 \let\tenttsl=\secttsl
2307 \def\curfontsize{sec}%
2308 \def\lsize{subsec}\def\lllsize{reduced}%
1209 \resetmathfonts \setleading{16pt}} 2309 \resetmathfonts \setleading{16pt}}
1210 \def\subsecfonts{% 2310 \def\subsecfonts{%
1211 \let\tenrm=\ssecrm \let\tenit=\ssecit \let\tensl=\ssecsl 2311 \let\tenrm=\ssecrm \let\tenit=\ssecit \let\tensl=\ssecsl
1212 \let\tenbf=\ssecbf \let\tentt=\ssectt \let\smallcaps=\ssecsc 2312 \let\tenbf=\ssecbf \let\tentt=\ssectt \let\smallcaps=\ssecsc
1213 \let\tensf=\ssecsf \let\teni=\sseci \let\tensy=\ssecsy \let\tenttsl=\ssecttsl 2313 \let\tensf=\ssecsf \let\teni=\sseci \let\tensy=\ssecsy
2314 \let\tenttsl=\ssecttsl
2315 \def\curfontsize{ssec}%
2316 \def\lsize{text}\def\lllsize{small}%
1214 \resetmathfonts \setleading{15pt}} 2317 \resetmathfonts \setleading{15pt}}
1215 \let\subsubsecfonts = \subsecfonts % Maybe make sssec fonts scaled magstephalf? 2318 \let\subsubsecfonts = \subsecfonts
2319 \def\reducedfonts{%
2320 \let\tenrm=\reducedrm \let\tenit=\reducedit \let\tensl=\reducedsl
2321 \let\tenbf=\reducedbf \let\tentt=\reducedtt \let\reducedcaps=\reducedsc
2322 \let\tensf=\reducedsf \let\teni=\reducedi \let\tensy=\reducedsy
2323 \let\tenttsl=\reducedttsl
2324 \def\curfontsize{reduced}%
2325 \def\lsize{small}\def\lllsize{smaller}%
2326 \resetmathfonts \setleading{10.5pt}}
1216 \def\smallfonts{% 2327 \def\smallfonts{%
1217 \let\tenrm=\smallrm \let\tenit=\smallit \let\tensl=\smallsl 2328 \let\tenrm=\smallrm \let\tenit=\smallit \let\tensl=\smallsl
1218 \let\tenbf=\smallbf \let\tentt=\smalltt \let\smallcaps=\smallsc 2329 \let\tenbf=\smallbf \let\tentt=\smalltt \let\smallcaps=\smallsc
1219 \let\tensf=\smallsf \let\teni=\smalli \let\tensy=\smallsy 2330 \let\tensf=\smallsf \let\teni=\smalli \let\tensy=\smallsy
1220 \let\tenttsl=\smallttsl 2331 \let\tenttsl=\smallttsl
1221 \resetmathfonts \setleading{11pt}} 2332 \def\curfontsize{small}%
2333 \def\lsize{smaller}\def\lllsize{smaller}%
2334 \resetmathfonts \setleading{10.5pt}}
2335 \def\smallerfonts{%
2336 \let\tenrm=\smallerrm \let\tenit=\smallerit \let\tensl=\smallersl
2337 \let\tenbf=\smallerbf \let\tentt=\smallertt \let\smallcaps=\smallersc
2338 \let\tensf=\smallersf \let\teni=\smalleri \let\tensy=\smallersy
2339 \let\tenttsl=\smallerttsl
2340 \def\curfontsize{smaller}%
2341 \def\lsize{smaller}\def\lllsize{smaller}%
2342 \resetmathfonts \setleading{9.5pt}}
2343
2344 % Set the fonts to use with the @small... environments.
2345 \let\smallexamplefonts = \smallfonts
2346
2347 % About \smallexamplefonts. If we use \smallfonts (9pt), @smallexample
2348 % can fit this many characters:
2349 % 8.5x11=86 smallbook=72 a4=90 a5=69
2350 % If we use \scriptfonts (8pt), then we can fit this many characters:
2351 % 8.5x11=90+ smallbook=80 a4=90+ a5=77
2352 % For me, subjectively, the few extra characters that fit aren't worth
2353 % the additional smallness of 8pt. So I'm making the default 9pt.
2354 %
2355 % By the way, for comparison, here's what fits with @example (10pt):
2356 % 8.5x11=71 smallbook=60 a4=75 a5=58
2357 %
2358 % I wish the USA used A4 paper.
2359 % --karl, 24jan03.
2360
1222 2361
1223 % Set up the default fonts, so we can use them for creating boxes. 2362 % Set up the default fonts, so we can use them for creating boxes.
1224 % 2363 %
1225 \textfonts 2364 \definetextfontsizexi
1226 2365
1227 % Define these so they can be easily changed for other fonts. 2366 % Define these so they can be easily changed for other fonts.
1228 \def\angleleft{$\langle$} 2367 \def\angleleft{$\langle$}
1229 \def\angleright{$\rangle$} 2368 \def\angleright{$\rangle$}
1230 2369
1231 % Count depth in font-changes, for error checks 2370 % Count depth in font-changes, for error checks
1232 \newcount\fontdepth \fontdepth=0 2371 \newcount\fontdepth \fontdepth=0
1233 2372
1234 % Fonts for short table of contents. 2373 % Fonts for short table of contents.
1235 \setfont\shortcontrm\rmshape{12}{1000} 2374 \setfont\shortcontrm\rmshape{12}{1000}{OT1}
1236 \setfont\shortcontbf\bxshape{12}{1000} 2375 \setfont\shortcontbf\bfshape{10}{\magstep1}{OT1} % no cmb12
1237 \setfont\shortcontsl\slshape{12}{1000} 2376 \setfont\shortcontsl\slshape{12}{1000}{OT1}
2377 \setfont\shortconttt\ttshape{12}{1000}{OT1TT}
1238 2378
1239 %% Add scribe-like font environments, plus @l for inline lisp (usually sans 2379 %% Add scribe-like font environments, plus @l for inline lisp (usually sans
1240 %% serif) and @ii for TeX italic 2380 %% serif) and @ii for TeX italic
1241 2381
1242 % \smartitalic{ARG} outputs arg in italics, followed by an italic correction 2382 % \smartitalic{ARG} outputs arg in italics, followed by an italic correction
1243 % unless the following character is such as not to need one. 2383 % unless the following character is such as not to need one.
1244 \def\smartitalicx{\ifx\next,\else\ifx\next-\else\ifx\next.\else\/\fi\fi\fi} 2384 \def\smartitalicx{\ifx\next,\else\ifx\next-\else\ifx\next.\else
1245 \def\smartslanted#1{{\sl #1}\futurelet\next\smartitalicx} 2385 \ptexslash\fi\fi\fi}
1246 \def\smartitalic#1{{\it #1}\futurelet\next\smartitalicx} 2386 \def\smartslanted#1{{\ifusingtt\ttsl\sl #1}\futurelet\next\smartitalicx}
2387 \def\smartitalic#1{{\ifusingtt\ttsl\it #1}\futurelet\next\smartitalicx}
2388
2389 % like \smartslanted except unconditionally uses \ttsl.
2390 % @var is set to this for defun arguments.
2391 \def\ttslanted#1{{\ttsl #1}\futurelet\next\smartitalicx}
2392
2393 % like \smartslanted except unconditionally use \sl. We never want
2394 % ttsl for book titles, do we?
2395 \def\cite#1{{\sl #1}\futurelet\next\smartitalicx}
1247 2396
1248 \let\i=\smartitalic 2397 \let\i=\smartitalic
2398 \let\slanted=\smartslanted
1249 \let\var=\smartslanted 2399 \let\var=\smartslanted
1250 \let\dfn=\smartslanted 2400 \let\dfn=\smartslanted
1251 \let\emph=\smartitalic 2401 \let\emph=\smartitalic
1252 \let\cite=\smartslanted 2402
1253 2403 % @b, explicit bold.
1254 \def\b#1{{\bf #1}} 2404 \def\b#1{{\bf #1}}
1255 \let\strong=\b 2405 \let\strong=\b
2406
2407 % @sansserif, explicit sans.
2408 \def\sansserif#1{{\sf #1}}
1256 2409
1257 % We can't just use \exhyphenpenalty, because that only has effect at 2410 % We can't just use \exhyphenpenalty, because that only has effect at
1258 % the end of a paragraph. Restore normal hyphenation at the end of the 2411 % the end of a paragraph. Restore normal hyphenation at the end of the
1259 % group within which \nohyphenation is presumably called. 2412 % group within which \nohyphenation is presumably called.
1260 % 2413 %
1261 \def\nohyphenation{\hyphenchar\font = -1 \aftergroup\restorehyphenation} 2414 \def\nohyphenation{\hyphenchar\font = -1 \aftergroup\restorehyphenation}
1262 \def\restorehyphenation{\hyphenchar\font = `- } 2415 \def\restorehyphenation{\hyphenchar\font = `- }
1263 2416
2417 % Set sfcode to normal for the chars that usually have another value.
2418 % Can't use plain's \frenchspacing because it uses the `\x notation, and
2419 % sometimes \x has an active definition that messes things up.
2420 %
2421 \catcode`@=11
2422 \def\plainfrenchspacing{%
2423 \sfcode\dotChar =\@m \sfcode\questChar=\@m \sfcode\exclamChar=\@m
2424 \sfcode\colonChar=\@m \sfcode\semiChar =\@m \sfcode\commaChar =\@m
2425 \def\endofsentencespacefactor{1000}% for @. and friends
2426 }
2427 \def\plainnonfrenchspacing{%
2428 \sfcode`\.3000\sfcode`\?3000\sfcode`\!3000
2429 \sfcode`\:2000\sfcode`\;1500\sfcode`\,1250
2430 \def\endofsentencespacefactor{3000}% for @. and friends
2431 }
2432 \catcode`@=\other
2433 \def\endofsentencespacefactor{3000}% default
2434
1264 \def\t#1{% 2435 \def\t#1{%
1265 {\tt \rawbackslash \frenchspacing #1}% 2436 {\tt \rawbackslash \plainfrenchspacing #1}%
1266 \null 2437 \null
1267 } 2438 }
1268 \let\ttfont=\t
1269 \def\samp#1{`\tclose{#1}'\null} 2439 \def\samp#1{`\tclose{#1}'\null}
1270 \setfont\keyrm\rmshape{8}{1000} 2440 \setfont\keyrm\rmshape{8}{1000}{OT1}
1271 \font\keysy=cmsy9 2441 \font\keysy=cmsy9
1272 \def\key#1{{\keyrm\textfont2=\keysy \leavevmode\hbox{% 2442 \def\key#1{{\keyrm\textfont2=\keysy \leavevmode\hbox{%
1273 \raise0.4pt\hbox{\angleleft}\kern-.08em\vtop{% 2443 \raise0.4pt\hbox{\angleleft}\kern-.08em\vtop{%
1274 \vbox{\hrule\kern-0.4pt 2444 \vbox{\hrule\kern-0.4pt
1275 \hbox{\raise0.4pt\hbox{\vphantom{\angleleft}}#1}}% 2445 \hbox{\raise0.4pt\hbox{\vphantom{\angleleft}}#1}}%
1276 \kern-0.4pt\hrule}% 2446 \kern-0.4pt\hrule}%
1277 \kern-.06em\raise0.4pt\hbox{\angleright}}}} 2447 \kern-.06em\raise0.4pt\hbox{\angleright}}}}
2448 \def\key #1{{\nohyphenation \uppercase{#1}}\null}
1278 % The old definition, with no lozenge: 2449 % The old definition, with no lozenge:
1279 %\def\key #1{{\ttsl \nohyphenation \uppercase{#1}}\null} 2450 %\def\key #1{{\ttsl \nohyphenation \uppercase{#1}}\null}
1280 \def\ctrl #1{{\tt \rawbackslash \hat}#1} 2451 \def\ctrl #1{{\tt \rawbackslash \hat}#1}
1281 2452
1282 % @file, @option are the same as @samp. 2453 % @file, @option are the same as @samp.
1298 % 2469 %
1299 % Turn off hyphenation. 2470 % Turn off hyphenation.
1300 \nohyphenation 2471 \nohyphenation
1301 % 2472 %
1302 \rawbackslash 2473 \rawbackslash
1303 \frenchspacing 2474 \plainfrenchspacing
1304 #1% 2475 #1%
1305 }% 2476 }%
1306 \null 2477 \null
1307 } 2478 }
1308 2479
1309 % We *must* turn on hyphenation at `-' and `_' in \code. 2480 % We *must* turn on hyphenation at `-' and `_' in @code.
1310 % Otherwise, it is too hard to avoid overfull hboxes 2481 % Otherwise, it is too hard to avoid overfull hboxes
1311 % in the Emacs manual, the Library manual, etc. 2482 % in the Emacs manual, the Library manual, etc.
1312 2483
1313 % Unfortunately, TeX uses one parameter (\hyphenchar) to control 2484 % Unfortunately, TeX uses one parameter (\hyphenchar) to control
1314 % both hyphenation at - and hyphenation within words. 2485 % both hyphenation at - and hyphenation within words.
1315 % We must therefore turn them both off (\tclose does that) 2486 % We must therefore turn them both off (\tclose does that)
1316 % and arrange explicitly to hyphenate at a dash. 2487 % and arrange explicitly to hyphenate at a dash.
1317 % -- rms. 2488 % -- rms.
1318 { 2489 {
1319 \catcode`\-=\active 2490 \catcode`\-=\active \catcode`\_=\active
1320 \catcode`\_=\active 2491 \catcode`\'=\active \catcode`\`=\active
1321 % 2492 %
1322 \global\def\code{\begingroup 2493 \global\def\code{\begingroup
1323 \catcode`\-=\active \let-\codedash 2494 \catcode\rquoteChar=\active \catcode\lquoteChar=\active
1324 \catcode`\_=\active \let_\codeunder 2495 \let'\codequoteright \let`\codequoteleft
2496 %
2497 \catcode\dashChar=\active \catcode\underChar=\active
2498 \ifallowcodebreaks
2499 \let-\codedash
2500 \let_\codeunder
2501 \else
2502 \let-\realdash
2503 \let_\realunder
2504 \fi
1325 \codex 2505 \codex
1326 } 2506 }
1327 %
1328 % If we end up with any active - characters when handling the index,
1329 % just treat them as a normal -.
1330 \global\def\indexbreaks{\catcode`\-=\active \let-\realdash}
1331 } 2507 }
1332 2508
1333 \def\realdash{-} 2509 \def\realdash{-}
1334 \def\codedash{-\discretionary{}{}{}} 2510 \def\codedash{-\discretionary{}{}{}}
1335 \def\codeunder{\ifusingtt{\normalunderscore\discretionary{}{}{}}{\_}} 2511 \def\codeunder{%
2512 % this is all so @math{@code{var_name}+1} can work. In math mode, _
2513 % is "active" (mathcode"8000) and \normalunderscore (or \char95, etc.)
2514 % will therefore expand the active definition of _, which is us
2515 % (inside @code that is), therefore an endless loop.
2516 \ifusingtt{\ifmmode
2517 \mathchar"075F % class 0=ordinary, family 7=ttfam, pos 0x5F=_.
2518 \else\normalunderscore \fi
2519 \discretionary{}{}{}}%
2520 {\_}%
2521 }
1336 \def\codex #1{\tclose{#1}\endgroup} 2522 \def\codex #1{\tclose{#1}\endgroup}
1337 2523
1338 %\let\exp=\tclose %Was temporary 2524 % An additional complication: the above will allow breaks after, e.g.,
2525 % each of the four underscores in __typeof__. This is undesirable in
2526 % some manuals, especially if they don't have long identifiers in
2527 % general. @allowcodebreaks provides a way to control this.
2528 %
2529 \newif\ifallowcodebreaks \allowcodebreakstrue
2530
2531 \def\keywordtrue{true}
2532 \def\keywordfalse{false}
2533
2534 \parseargdef\allowcodebreaks{%
2535 \def\txiarg{#1}%
2536 \ifx\txiarg\keywordtrue
2537 \allowcodebreakstrue
2538 \else\ifx\txiarg\keywordfalse
2539 \allowcodebreaksfalse
2540 \else
2541 \errhelp = \EMsimple
2542 \errmessage{Unknown @allowcodebreaks option `\txiarg'}%
2543 \fi\fi
2544 }
1339 2545
1340 % @kbd is like @code, except that if the argument is just one @key command, 2546 % @kbd is like @code, except that if the argument is just one @key command,
1341 % then @kbd has no effect. 2547 % then @kbd has no effect.
1342 2548
1343 % @kbdinputstyle -- arg is `distinct' (@kbd uses slanted tty font always), 2549 % @kbdinputstyle -- arg is `distinct' (@kbd uses slanted tty font always),
1344 % `example' (@kbd uses ttsl only inside of @example and friends), 2550 % `example' (@kbd uses ttsl only inside of @example and friends),
1345 % or `code' (@kbd uses normal tty font always). 2551 % or `code' (@kbd uses normal tty font always).
1346 \def\kbdinputstyle{\parsearg\kbdinputstylexxx} 2552 \parseargdef\kbdinputstyle{%
1347 \def\kbdinputstylexxx#1{% 2553 \def\txiarg{#1}%
1348 \def\arg{#1}% 2554 \ifx\txiarg\worddistinct
1349 \ifx\arg\worddistinct
1350 \gdef\kbdexamplefont{\ttsl}\gdef\kbdfont{\ttsl}% 2555 \gdef\kbdexamplefont{\ttsl}\gdef\kbdfont{\ttsl}%
1351 \else\ifx\arg\wordexample 2556 \else\ifx\txiarg\wordexample
1352 \gdef\kbdexamplefont{\ttsl}\gdef\kbdfont{\tt}% 2557 \gdef\kbdexamplefont{\ttsl}\gdef\kbdfont{\tt}%
1353 \else\ifx\arg\wordcode 2558 \else\ifx\txiarg\wordcode
1354 \gdef\kbdexamplefont{\tt}\gdef\kbdfont{\tt}% 2559 \gdef\kbdexamplefont{\tt}\gdef\kbdfont{\tt}%
2560 \else
2561 \errhelp = \EMsimple
2562 \errmessage{Unknown @kbdinputstyle option `\txiarg'}%
1355 \fi\fi\fi 2563 \fi\fi\fi
1356 } 2564 }
1357 \def\worddistinct{distinct} 2565 \def\worddistinct{distinct}
1358 \def\wordexample{example} 2566 \def\wordexample{example}
1359 \def\wordcode{code} 2567 \def\wordcode{code}
1360 2568
1361 % Default is kbdinputdistinct. (Too much of a hassle to call the macro, 2569 % Default is `distinct.'
1362 % the catcodes are wrong for parsearg to work.) 2570 \kbdinputstyle distinct
1363 \gdef\kbdexamplefont{\ttsl}\gdef\kbdfont{\ttsl}
1364 2571
1365 \def\xkey{\key} 2572 \def\xkey{\key}
1366 \def\kbdfoo#1#2#3\par{\def\one{#1}\def\three{#3}\def\threex{??}% 2573 \def\kbdfoo#1#2#3\par{\def\one{#1}\def\three{#3}\def\threex{??}%
1367 \ifx\one\xkey\ifx\threex\three \key{#2}% 2574 \ifx\one\xkey\ifx\threex\three \key{#2}%
1368 \else{\tclose{\kbdfont\look}}\fi 2575 \else{\tclose{\kbdfont\look}}\fi
1369 \else{\tclose{\kbdfont\look}}\fi} 2576 \else{\tclose{\kbdfont\look}}\fi}
1370 2577
1371 % For @url, @env, @command quotes seem unnecessary, so use \code. 2578 % For @indicateurl, @env, @command quotes seem unnecessary, so use \code.
1372 \let\url=\code 2579 \let\indicateurl=\code
1373 \let\env=\code 2580 \let\env=\code
1374 \let\command=\code 2581 \let\command=\code
2582
2583 % @clicksequence{File @click{} Open ...}
2584 \def\clicksequence#1{\begingroup #1\endgroup}
2585
2586 % @clickstyle @arrow (by default)
2587 \parseargdef\clickstyle{\def\click{#1}}
2588 \def\click{\arrow}
1375 2589
1376 % @uref (abbreviation for `urlref') takes an optional (comma-separated) 2590 % @uref (abbreviation for `urlref') takes an optional (comma-separated)
1377 % second argument specifying the text to display and an optional third 2591 % second argument specifying the text to display and an optional third
1378 % arg as text to display instead of (rather than in addition to) the url 2592 % arg as text to display instead of (rather than in addition to) the url
1379 % itself. First (mandatory) arg is the url. Perhaps eventually put in 2593 % itself. First (mandatory) arg is the url. Perhaps eventually put in
1399 \fi 2613 \fi
1400 \fi 2614 \fi
1401 \endlink 2615 \endlink
1402 \endgroup} 2616 \endgroup}
1403 2617
2618 % @url synonym for @uref, since that's how everyone uses it.
2619 %
2620 \let\url=\uref
2621
1404 % rms does not like angle brackets --karl, 17may97. 2622 % rms does not like angle brackets --karl, 17may97.
1405 % So now @email is just like @uref, unless we are pdf. 2623 % So now @email is just like @uref, unless we are pdf.
1406 % 2624 %
1407 %\def\email#1{\angleleft{\tt #1}\angleright} 2625 %\def\email#1{\angleleft{\tt #1}\angleright}
1408 \ifpdf 2626 \ifpdf
1409 \def\email#1{\doemail#1,,\finish} 2627 \def\email#1{\doemail#1,,\finish}
1410 \def\doemail#1,#2,#3\finish{\begingroup 2628 \def\doemail#1,#2,#3\finish{\begingroup
1411 \unsepspaces 2629 \unsepspaces
1440 % Explicit font changes: @r, @sc, undocumented @ii. 2658 % Explicit font changes: @r, @sc, undocumented @ii.
1441 \def\r#1{{\rm #1}} % roman font 2659 \def\r#1{{\rm #1}} % roman font
1442 \def\sc#1{{\smallcaps#1}} % smallcaps font 2660 \def\sc#1{{\smallcaps#1}} % smallcaps font
1443 \def\ii#1{{\it #1}} % italic font 2661 \def\ii#1{{\it #1}} % italic font
1444 2662
1445 % @acronym downcases the argument and prints in smallcaps. 2663 % @acronym for "FBI", "NATO", and the like.
1446 \def\acronym#1{{\smallcaps \lowercase{#1}}} 2664 % We print this one point size smaller, since it's intended for
1447 2665 % all-uppercase.
1448 % @pounds{} is a sterling sign. 2666 %
2667 \def\acronym#1{\doacronym #1,,\finish}
2668 \def\doacronym#1,#2,#3\finish{%
2669 {\selectfonts\lsize #1}%
2670 \def\temp{#2}%
2671 \ifx\temp\empty \else
2672 \space ({\unsepspaces \ignorespaces \temp \unskip})%
2673 \fi
2674 }
2675
2676 % @abbr for "Comput. J." and the like.
2677 % No font change, but don't do end-of-sentence spacing.
2678 %
2679 \def\abbr#1{\doabbr #1,,\finish}
2680 \def\doabbr#1,#2,#3\finish{%
2681 {\plainfrenchspacing #1}%
2682 \def\temp{#2}%
2683 \ifx\temp\empty \else
2684 \space ({\unsepspaces \ignorespaces \temp \unskip})%
2685 \fi
2686 }
2687
2688 % @pounds{} is a sterling sign, which Knuth put in the CM italic font.
2689 %
1449 \def\pounds{{\it\$}} 2690 \def\pounds{{\it\$}}
2691
2692 % @euro{} comes from a separate font, depending on the current style.
2693 % We use the free feym* fonts from the eurosym package by Henrik
2694 % Theiling, which support regular, slanted, bold and bold slanted (and
2695 % "outlined" (blackboard board, sort of) versions, which we don't need).
2696 % It is available from http://www.ctan.org/tex-archive/fonts/eurosym.
2697 %
2698 % Although only regular is the truly official Euro symbol, we ignore
2699 % that. The Euro is designed to be slightly taller than the regular
2700 % font height.
2701 %
2702 % feymr - regular
2703 % feymo - slanted
2704 % feybr - bold
2705 % feybo - bold slanted
2706 %
2707 % There is no good (free) typewriter version, to my knowledge.
2708 % A feymr10 euro is ~7.3pt wide, while a normal cmtt10 char is ~5.25pt wide.
2709 % Hmm.
2710 %
2711 % Also doesn't work in math. Do we need to do math with euro symbols?
2712 % Hope not.
2713 %
2714 %
2715 \def\euro{{\eurofont e}}
2716 \def\eurofont{%
2717 % We set the font at each command, rather than predefining it in
2718 % \textfonts and the other font-switching commands, so that
2719 % installations which never need the symbol don't have to have the
2720 % font installed.
2721 %
2722 % There is only one designed size (nominal 10pt), so we always scale
2723 % that to the current nominal size.
2724 %
2725 % By the way, simply using "at 1em" works for cmr10 and the like, but
2726 % does not work for cmbx10 and other extended/shrunken fonts.
2727 %
2728 \def\eurosize{\csname\curfontsize nominalsize\endcsname}%
2729 %
2730 \ifx\curfontstyle\bfstylename
2731 % bold:
2732 \font\thiseurofont = \ifusingit{feybo10}{feybr10} at \eurosize
2733 \else
2734 % regular:
2735 \font\thiseurofont = \ifusingit{feymo10}{feymr10} at \eurosize
2736 \fi
2737 \thiseurofont
2738 }
2739
2740 % Hacks for glyphs from the EC fonts similar to \euro. We don't
2741 % use \let for the aliases, because sometimes we redefine the original
2742 % macro, and the alias should reflect the redefinition.
2743 \def\guillemetleft{{\ecfont \char"13}}
2744 \def\guillemotleft{\guillemetleft}
2745 \def\guillemetright{{\ecfont \char"14}}
2746 \def\guillemotright{\guillemetright}
2747 \def\guilsinglleft{{\ecfont \char"0E}}
2748 \def\guilsinglright{{\ecfont \char"0F}}
2749 \def\quotedblbase{{\ecfont \char"12}}
2750 \def\quotesinglbase{{\ecfont \char"0D}}
2751 %
2752 \def\ecfont{%
2753 % We can't distinguish serif/sanserif and italic/slanted, but this
2754 % is used for crude hacks anyway (like adding French and German
2755 % quotes to documents typeset with CM, where we lose kerning), so
2756 % hopefully nobody will notice/care.
2757 \edef\ecsize{\csname\curfontsize ecsize\endcsname}%
2758 \edef\nominalsize{\csname\curfontsize nominalsize\endcsname}%
2759 \ifx\curfontstyle\bfstylename
2760 % bold:
2761 \font\thisecfont = ecb\ifusingit{i}{x}\ecsize \space at \nominalsize
2762 \else
2763 % regular:
2764 \font\thisecfont = ec\ifusingit{ti}{rm}\ecsize \space at \nominalsize
2765 \fi
2766 \thisecfont
2767 }
2768
2769 % @registeredsymbol - R in a circle. The font for the R should really
2770 % be smaller yet, but lllsize is the best we can do for now.
2771 % Adapted from the plain.tex definition of \copyright.
2772 %
2773 \def\registeredsymbol{%
2774 $^{{\ooalign{\hfil\raise.07ex\hbox{\selectfonts\lllsize R}%
2775 \hfil\crcr\Orb}}%
2776 }$%
2777 }
2778
2779 % @textdegree - the normal degrees sign.
2780 %
2781 \def\textdegree{$^\circ$}
2782
2783 % Laurent Siebenmann reports \Orb undefined with:
2784 % Textures 1.7.7 (preloaded format=plain 93.10.14) (68K) 16 APR 2004 02:38
2785 % so we'll define it if necessary.
2786 %
2787 \ifx\Orb\undefined
2788 \def\Orb{\mathhexbox20D}
2789 \fi
2790
2791 % Quotes.
2792 \chardef\quotedblleft="5C
2793 \chardef\quotedblright=`\"
2794 \chardef\quoteleft=`\`
2795 \chardef\quoteright=`\'
1450 2796
1451 2797
1452 \message{page headings,} 2798 \message{page headings,}
1453 2799
1454 \newskip\titlepagetopglue \titlepagetopglue = 1.5in 2800 \newskip\titlepagetopglue \titlepagetopglue = 1.5in
1464 \newif\ifsetcontentsaftertitlepage 2810 \newif\ifsetcontentsaftertitlepage
1465 \let\setcontentsaftertitlepage = \setcontentsaftertitlepagetrue 2811 \let\setcontentsaftertitlepage = \setcontentsaftertitlepagetrue
1466 \newif\ifsetshortcontentsaftertitlepage 2812 \newif\ifsetshortcontentsaftertitlepage
1467 \let\setshortcontentsaftertitlepage = \setshortcontentsaftertitlepagetrue 2813 \let\setshortcontentsaftertitlepage = \setshortcontentsaftertitlepagetrue
1468 2814
1469 \def\shorttitlepage{\parsearg\shorttitlepagezzz} 2815 \parseargdef\shorttitlepage{\begingroup\hbox{}\vskip 1.5in \chaprm \centerline{#1}%
1470 \def\shorttitlepagezzz #1{\begingroup\hbox{}\vskip 1.5in \chaprm \centerline{#1}%
1471 \endgroup\page\hbox{}\page} 2816 \endgroup\page\hbox{}\page}
1472 2817
1473 \def\titlepage{\begingroup \parindent=0pt \textfonts 2818 \envdef\titlepage{%
1474 \let\subtitlerm=\tenrm 2819 % Open one extra group, as we want to close it in the middle of \Etitlepage.
1475 \def\subtitlefont{\subtitlerm \normalbaselineskip = 13pt \normalbaselines}% 2820 \begingroup
1476 % 2821 \parindent=0pt \textfonts
1477 \def\authorfont{\authorrm \normalbaselineskip = 16pt \normalbaselines}% 2822 % Leave some space at the very top of the page.
1478 % 2823 \vglue\titlepagetopglue
1479 % Leave some space at the very top of the page. 2824 % No rule at page bottom unless we print one at the top with @title.
1480 \vglue\titlepagetopglue 2825 \finishedtitlepagetrue
1481 % 2826 %
1482 % Now you can print the title using @title. 2827 % Most title ``pages'' are actually two pages long, with space
1483 \def\title{\parsearg\titlezzz}% 2828 % at the top of the second. We don't want the ragged left on the second.
1484 \def\titlezzz##1{\leftline{\titlefonts\rm ##1} 2829 \let\oldpage = \page
1485 % print a rule at the page bottom also. 2830 \def\page{%
1486 \finishedtitlepagefalse
1487 \vskip4pt \hrule height 4pt width \hsize \vskip4pt}%
1488 % No rule at page bottom unless we print one at the top with @title.
1489 \finishedtitlepagetrue
1490 %
1491 % Now you can put text using @subtitle.
1492 \def\subtitle{\parsearg\subtitlezzz}%
1493 \def\subtitlezzz##1{{\subtitlefont \rightline{##1}}}%
1494 %
1495 % @author should come last, but may come many times.
1496 \def\author{\parsearg\authorzzz}%
1497 \def\authorzzz##1{\ifseenauthor\else\vskip 0pt plus 1filll\seenauthortrue\fi
1498 {\authorfont \leftline{##1}}}%
1499 %
1500 % Most title ``pages'' are actually two pages long, with space
1501 % at the top of the second. We don't want the ragged left on the second.
1502 \let\oldpage = \page
1503 \def\page{%
1504 \iffinishedtitlepage\else 2831 \iffinishedtitlepage\else
1505 \finishtitlepage 2832 \finishtitlepage
1506 \fi 2833 \fi
1507 \oldpage
1508 \let\page = \oldpage 2834 \let\page = \oldpage
1509 \hbox{}}% 2835 \page
1510 % \def\page{\oldpage \hbox{}} 2836 \null
2837 }%
1511 } 2838 }
1512 2839
1513 \def\Etitlepage{% 2840 \def\Etitlepage{%
1514 \iffinishedtitlepage\else 2841 \iffinishedtitlepage\else
1515 \finishtitlepage 2842 \finishtitlepage
1516 \fi 2843 \fi
1517 % It is important to do the page break before ending the group, 2844 % It is important to do the page break before ending the group,
1518 % because the headline and footline are only empty inside the group. 2845 % because the headline and footline are only empty inside the group.
1519 % If we use the new definition of \page, we always get a blank page 2846 % If we use the new definition of \page, we always get a blank page
1520 % after the title page, which we certainly don't want. 2847 % after the title page, which we certainly don't want.
1521 \oldpage 2848 \oldpage
1522 \endgroup 2849 \endgroup
1523 % 2850 %
1524 % If they want short, they certainly want long too. 2851 % Need this before the \...aftertitlepage checks so that if they are
1525 \ifsetshortcontentsaftertitlepage 2852 % in effect the toc pages will come out with page numbers.
1526 \shortcontents 2853 \HEADINGSon
1527 \contents 2854 %
1528 \global\let\shortcontents = \relax 2855 % If they want short, they certainly want long too.
1529 \global\let\contents = \relax 2856 \ifsetshortcontentsaftertitlepage
1530 \fi 2857 \shortcontents
1531 % 2858 \contents
1532 \ifsetcontentsaftertitlepage 2859 \global\let\shortcontents = \relax
1533 \contents 2860 \global\let\contents = \relax
1534 \global\let\contents = \relax 2861 \fi
1535 \global\let\shortcontents = \relax 2862 %
1536 \fi 2863 \ifsetcontentsaftertitlepage
1537 % 2864 \contents
1538 \ifpdf \pdfmakepagedesttrue \fi 2865 \global\let\contents = \relax
1539 % 2866 \global\let\shortcontents = \relax
1540 \HEADINGSon 2867 \fi
1541 } 2868 }
1542 2869
1543 \def\finishtitlepage{% 2870 \def\finishtitlepage{%
1544 \vskip4pt \hrule height 2pt width \hsize 2871 \vskip4pt \hrule height 2pt width \hsize
1545 \vskip\titlepagebottomglue 2872 \vskip\titlepagebottomglue
1546 \finishedtitlepagetrue 2873 \finishedtitlepagetrue
1547 } 2874 }
2875
2876 %%% Macros to be used within @titlepage:
2877
2878 \let\subtitlerm=\tenrm
2879 \def\subtitlefont{\subtitlerm \normalbaselineskip = 13pt \normalbaselines}
2880
2881 \def\authorfont{\authorrm \normalbaselineskip = 16pt \normalbaselines
2882 \let\tt=\authortt}
2883
2884 \parseargdef\title{%
2885 \checkenv\titlepage
2886 \leftline{\titlefonts\rm #1}
2887 % print a rule at the page bottom also.
2888 \finishedtitlepagefalse
2889 \vskip4pt \hrule height 4pt width \hsize \vskip4pt
2890 }
2891
2892 \parseargdef\subtitle{%
2893 \checkenv\titlepage
2894 {\subtitlefont \rightline{#1}}%
2895 }
2896
2897 % @author should come last, but may come many times.
2898 % It can also be used inside @quotation.
2899 %
2900 \parseargdef\author{%
2901 \def\temp{\quotation}%
2902 \ifx\thisenv\temp
2903 \def\quotationauthor{#1}% printed in \Equotation.
2904 \else
2905 \checkenv\titlepage
2906 \ifseenauthor\else \vskip 0pt plus 1filll \seenauthortrue \fi
2907 {\authorfont \leftline{#1}}%
2908 \fi
2909 }
2910
1548 2911
1549 %%% Set up page headings and footings. 2912 %%% Set up page headings and footings.
1550 2913
1551 \let\thispage=\folio 2914 \let\thispage=\folio
1552 2915
1553 \newtoks\evenheadline % headline on even pages 2916 \newtoks\evenheadline % headline on even pages
1554 \newtoks\oddheadline % headline on odd pages 2917 \newtoks\oddheadline % headline on odd pages
1555 \newtoks\evenfootline % footline on even pages 2918 \newtoks\evenfootline % footline on even pages
1556 \newtoks\oddfootline % footline on odd pages 2919 \newtoks\oddfootline % footline on odd pages
1557 2920
1558 % Now make Tex use those variables 2921 % Now make TeX use those variables
1559 \headline={{\textfonts\rm \ifodd\pageno \the\oddheadline 2922 \headline={{\textfonts\rm \ifodd\pageno \the\oddheadline
1560 \else \the\evenheadline \fi}} 2923 \else \the\evenheadline \fi}}
1561 \footline={{\textfonts\rm \ifodd\pageno \the\oddfootline 2924 \footline={{\textfonts\rm \ifodd\pageno \the\oddfootline
1562 \else \the\evenfootline \fi}\HEADINGShook} 2925 \else \the\evenfootline \fi}\HEADINGShook}
1563 \let\HEADINGShook=\relax 2926 \let\HEADINGShook=\relax
1567 % @evenheading @thistitle|@thispage|@thischapter 2930 % @evenheading @thistitle|@thispage|@thischapter
1568 % @oddheading @thischapter|@thispage|@thistitle 2931 % @oddheading @thischapter|@thispage|@thistitle
1569 % @evenfooting @thisfile|| 2932 % @evenfooting @thisfile||
1570 % @oddfooting ||@thisfile 2933 % @oddfooting ||@thisfile
1571 2934
2935
1572 \def\evenheading{\parsearg\evenheadingxxx} 2936 \def\evenheading{\parsearg\evenheadingxxx}
2937 \def\evenheadingxxx #1{\evenheadingyyy #1\|\|\|\|\finish}
2938 \def\evenheadingyyy #1\|#2\|#3\|#4\finish{%
2939 \global\evenheadline={\rlap{\centerline{#2}}\line{#1\hfil#3}}}
2940
1573 \def\oddheading{\parsearg\oddheadingxxx} 2941 \def\oddheading{\parsearg\oddheadingxxx}
1574 \def\everyheading{\parsearg\everyheadingxxx} 2942 \def\oddheadingxxx #1{\oddheadingyyy #1\|\|\|\|\finish}
2943 \def\oddheadingyyy #1\|#2\|#3\|#4\finish{%
2944 \global\oddheadline={\rlap{\centerline{#2}}\line{#1\hfil#3}}}
2945
2946 \parseargdef\everyheading{\oddheadingxxx{#1}\evenheadingxxx{#1}}%
1575 2947
1576 \def\evenfooting{\parsearg\evenfootingxxx} 2948 \def\evenfooting{\parsearg\evenfootingxxx}
2949 \def\evenfootingxxx #1{\evenfootingyyy #1\|\|\|\|\finish}
2950 \def\evenfootingyyy #1\|#2\|#3\|#4\finish{%
2951 \global\evenfootline={\rlap{\centerline{#2}}\line{#1\hfil#3}}}
2952
1577 \def\oddfooting{\parsearg\oddfootingxxx} 2953 \def\oddfooting{\parsearg\oddfootingxxx}
1578 \def\everyfooting{\parsearg\everyfootingxxx} 2954 \def\oddfootingxxx #1{\oddfootingyyy #1\|\|\|\|\finish}
1579 2955 \def\oddfootingyyy #1\|#2\|#3\|#4\finish{%
1580 {\catcode`\@=0 %
1581
1582 \gdef\evenheadingxxx #1{\evenheadingyyy #1@|@|@|@|\finish}
1583 \gdef\evenheadingyyy #1@|#2@|#3@|#4\finish{%
1584 \global\evenheadline={\rlap{\centerline{#2}}\line{#1\hfil#3}}}
1585
1586 \gdef\oddheadingxxx #1{\oddheadingyyy #1@|@|@|@|\finish}
1587 \gdef\oddheadingyyy #1@|#2@|#3@|#4\finish{%
1588 \global\oddheadline={\rlap{\centerline{#2}}\line{#1\hfil#3}}}
1589
1590 \gdef\everyheadingxxx#1{\oddheadingxxx{#1}\evenheadingxxx{#1}}%
1591
1592 \gdef\evenfootingxxx #1{\evenfootingyyy #1@|@|@|@|\finish}
1593 \gdef\evenfootingyyy #1@|#2@|#3@|#4\finish{%
1594 \global\evenfootline={\rlap{\centerline{#2}}\line{#1\hfil#3}}}
1595
1596 \gdef\oddfootingxxx #1{\oddfootingyyy #1@|@|@|@|\finish}
1597 \gdef\oddfootingyyy #1@|#2@|#3@|#4\finish{%
1598 \global\oddfootline = {\rlap{\centerline{#2}}\line{#1\hfil#3}}% 2956 \global\oddfootline = {\rlap{\centerline{#2}}\line{#1\hfil#3}}%
1599 % 2957 %
1600 % Leave some space for the footline. Hopefully ok to assume 2958 % Leave some space for the footline. Hopefully ok to assume
1601 % @evenfooting will not be used by itself. 2959 % @evenfooting will not be used by itself.
1602 \global\advance\pageheight by -\baselineskip 2960 \global\advance\pageheight by -12pt
1603 \global\advance\vsize by -\baselineskip 2961 \global\advance\vsize by -12pt
1604 } 2962 }
1605 2963
1606 \gdef\everyfootingxxx#1{\oddfootingxxx{#1}\evenfootingxxx{#1}} 2964 \parseargdef\everyfooting{\oddfootingxxx{#1}\evenfootingxxx{#1}}
1607 % 2965
1608 }% unbind the catcode of @. 2966 % @evenheadingmarks top \thischapter <- chapter at the top of a page
2967 % @evenheadingmarks bottom \thischapter <- chapter at the bottom of a page
2968 %
2969 % The same set of arguments for:
2970 %
2971 % @oddheadingmarks
2972 % @evenfootingmarks
2973 % @oddfootingmarks
2974 % @everyheadingmarks
2975 % @everyfootingmarks
2976
2977 \def\evenheadingmarks{\headingmarks{even}{heading}}
2978 \def\oddheadingmarks{\headingmarks{odd}{heading}}
2979 \def\evenfootingmarks{\headingmarks{even}{footing}}
2980 \def\oddfootingmarks{\headingmarks{odd}{footing}}
2981 \def\everyheadingmarks#1 {\headingmarks{even}{heading}{#1}
2982 \headingmarks{odd}{heading}{#1} }
2983 \def\everyfootingmarks#1 {\headingmarks{even}{footing}{#1}
2984 \headingmarks{odd}{footing}{#1} }
2985 % #1 = even/odd, #2 = heading/footing, #3 = top/bottom.
2986 \def\headingmarks#1#2#3 {%
2987 \expandafter\let\expandafter\temp \csname get#3headingmarks\endcsname
2988 \global\expandafter\let\csname get#1#2marks\endcsname \temp
2989 }
2990
2991 \everyheadingmarks bottom
2992 \everyfootingmarks bottom
1609 2993
1610 % @headings double turns headings on for double-sided printing. 2994 % @headings double turns headings on for double-sided printing.
1611 % @headings single turns headings on for single-sided printing. 2995 % @headings single turns headings on for single-sided printing.
1612 % @headings off turns them off. 2996 % @headings off turns them off.
1613 % @headings on same as @headings double, retained for compatibility. 2997 % @headings on same as @headings double, retained for compatibility.
1617 % By default, they are off at the start of a document, 3001 % By default, they are off at the start of a document,
1618 % and turned `on' after @end titlepage. 3002 % and turned `on' after @end titlepage.
1619 3003
1620 \def\headings #1 {\csname HEADINGS#1\endcsname} 3004 \def\headings #1 {\csname HEADINGS#1\endcsname}
1621 3005
1622 \def\HEADINGSoff{ 3006 \def\HEADINGSoff{%
1623 \global\evenheadline={\hfil} \global\evenfootline={\hfil} 3007 \global\evenheadline={\hfil} \global\evenfootline={\hfil}
1624 \global\oddheadline={\hfil} \global\oddfootline={\hfil}} 3008 \global\oddheadline={\hfil} \global\oddfootline={\hfil}}
1625 \HEADINGSoff 3009 \HEADINGSoff
1626 % When we turn headings on, set the page number to 1. 3010 % When we turn headings on, set the page number to 1.
1627 % For double-sided printing, put current file name in lower left corner, 3011 % For double-sided printing, put current file name in lower left corner,
1628 % chapter name on inside top of right hand pages, document 3012 % chapter name on inside top of right hand pages, document
1629 % title on inside top of left hand pages, and page numbers on outside top 3013 % title on inside top of left hand pages, and page numbers on outside top
1630 % edge of all pages. 3014 % edge of all pages.
1631 \def\HEADINGSdouble{ 3015 \def\HEADINGSdouble{%
1632 \global\pageno=1 3016 \global\pageno=1
1633 \global\evenfootline={\hfil} 3017 \global\evenfootline={\hfil}
1634 \global\oddfootline={\hfil} 3018 \global\oddfootline={\hfil}
1635 \global\evenheadline={\line{\folio\hfil\thistitle}} 3019 \global\evenheadline={\line{\folio\hfil\thistitle}}
1636 \global\oddheadline={\line{\thischapter\hfil\folio}} 3020 \global\oddheadline={\line{\thischapter\hfil\folio}}
1638 } 3022 }
1639 \let\contentsalignmacro = \chappager 3023 \let\contentsalignmacro = \chappager
1640 3024
1641 % For single-sided printing, chapter title goes across top left of page, 3025 % For single-sided printing, chapter title goes across top left of page,
1642 % page number on top right. 3026 % page number on top right.
1643 \def\HEADINGSsingle{ 3027 \def\HEADINGSsingle{%
1644 \global\pageno=1 3028 \global\pageno=1
1645 \global\evenfootline={\hfil} 3029 \global\evenfootline={\hfil}
1646 \global\oddfootline={\hfil} 3030 \global\oddfootline={\hfil}
1647 \global\evenheadline={\line{\thischapter\hfil\folio}} 3031 \global\evenheadline={\line{\thischapter\hfil\folio}}
1648 \global\oddheadline={\line{\thischapter\hfil\folio}} 3032 \global\oddheadline={\line{\thischapter\hfil\folio}}
1668 \global\oddheadline={\line{\thischapter\hfil\folio}} 3052 \global\oddheadline={\line{\thischapter\hfil\folio}}
1669 \global\let\contentsalignmacro = \chappager 3053 \global\let\contentsalignmacro = \chappager
1670 } 3054 }
1671 3055
1672 % Subroutines used in generating headings 3056 % Subroutines used in generating headings
1673 % Produces Day Month Year style of output. 3057 % This produces Day Month Year style of output.
3058 % Only define if not already defined, in case a txi-??.tex file has set
3059 % up a different format (e.g., txi-cs.tex does this).
3060 \ifx\today\undefined
1674 \def\today{% 3061 \def\today{%
1675 \number\day\space 3062 \number\day\space
1676 \ifcase\month 3063 \ifcase\month
1677 \or\putwordMJan\or\putwordMFeb\or\putwordMMar\or\putwordMApr 3064 \or\putwordMJan\or\putwordMFeb\or\putwordMMar\or\putwordMApr
1678 \or\putwordMMay\or\putwordMJun\or\putwordMJul\or\putwordMAug 3065 \or\putwordMMay\or\putwordMJun\or\putwordMJul\or\putwordMAug
1679 \or\putwordMSep\or\putwordMOct\or\putwordMNov\or\putwordMDec 3066 \or\putwordMSep\or\putwordMOct\or\putwordMNov\or\putwordMDec
1680 \fi 3067 \fi
1681 \space\number\year} 3068 \space\number\year}
3069 \fi
1682 3070
1683 % @settitle line... specifies the title of the document, for headings. 3071 % @settitle line... specifies the title of the document, for headings.
1684 % It generates no output of its own. 3072 % It generates no output of its own.
1685 \def\thistitle{\putwordNoTitle} 3073 \def\thistitle{\putwordNoTitle}
1686 \def\settitle{\parsearg\settitlezzz} 3074 \def\settitle{\parsearg{\gdef\thistitle}}
1687 \def\settitlezzz #1{\gdef\thistitle{#1}}
1688 3075
1689 3076
1690 \message{tables,} 3077 \message{tables,}
1691 % Tables -- @table, @ftable, @vtable, @item(x), @kitem(x), @xitem(x). 3078 % Tables -- @table, @ftable, @vtable, @item(x).
1692 3079
1693 % default indentation of table text 3080 % default indentation of table text
1694 \newdimen\tableindent \tableindent=.8in 3081 \newdimen\tableindent \tableindent=.8in
1695 % default indentation of @itemize and @enumerate text 3082 % default indentation of @itemize and @enumerate text
1696 \newdimen\itemindent \itemindent=.3in 3083 \newdimen\itemindent \itemindent=.3in
1698 \newdimen\itemmargin \itemmargin=.1in 3085 \newdimen\itemmargin \itemmargin=.1in
1699 3086
1700 % used internally for \itemindent minus \itemmargin 3087 % used internally for \itemindent minus \itemmargin
1701 \newdimen\itemmax 3088 \newdimen\itemmax
1702 3089
1703 % Note @table, @vtable, and @vtable define @item, @itemx, etc., with 3090 % Note @table, @ftable, and @vtable define @item, @itemx, etc., with
1704 % these defs. 3091 % these defs.
1705 % They also define \itemindex 3092 % They also define \itemindex
1706 % to index the item name in whatever manner is desired (perhaps none). 3093 % to index the item name in whatever manner is desired (perhaps none).
1707 3094
1708 \newif\ifitemxneedsnegativevskip 3095 \newif\ifitemxneedsnegativevskip
1710 \def\itemxpar{\par\ifitemxneedsnegativevskip\nobreak\vskip-\parskip\nobreak\fi} 3097 \def\itemxpar{\par\ifitemxneedsnegativevskip\nobreak\vskip-\parskip\nobreak\fi}
1711 3098
1712 \def\internalBitem{\smallbreak \parsearg\itemzzz} 3099 \def\internalBitem{\smallbreak \parsearg\itemzzz}
1713 \def\internalBitemx{\itemxpar \parsearg\itemzzz} 3100 \def\internalBitemx{\itemxpar \parsearg\itemzzz}
1714 3101
1715 \def\internalBxitem "#1"{\def\xitemsubtopix{#1} \smallbreak \parsearg\xitemzzz}
1716 \def\internalBxitemx "#1"{\def\xitemsubtopix{#1} \itemxpar \parsearg\xitemzzz}
1717
1718 \def\internalBkitem{\smallbreak \parsearg\kitemzzz}
1719 \def\internalBkitemx{\itemxpar \parsearg\kitemzzz}
1720
1721 \def\kitemzzz #1{\dosubind {kw}{\code{#1}}{for {\bf \lastfunction}}%
1722 \itemzzz {#1}}
1723
1724 \def\xitemzzz #1{\dosubind {kw}{\code{#1}}{for {\bf \xitemsubtopic}}%
1725 \itemzzz {#1}}
1726
1727 \def\itemzzz #1{\begingroup % 3102 \def\itemzzz #1{\begingroup %
1728 \advance\hsize by -\rightskip 3103 \advance\hsize by -\rightskip
1729 \advance\hsize by -\tableindent 3104 \advance\hsize by -\tableindent
1730 \setbox0=\hbox{\itemfont{#1}}% 3105 \setbox0=\hbox{\itemindicate{#1}}%
1731 \itemindex{#1}% 3106 \itemindex{#1}%
1732 \nobreak % This prevents a break before @itemx. 3107 \nobreak % This prevents a break before @itemx.
1733 % 3108 %
1734 % If the item text does not fit in the space we have, put it on a line 3109 % If the item text does not fit in the space we have, put it on a line
1735 % by itself, and do not allow a page break either before or after that 3110 % by itself, and do not allow a page break either before or after that
1749 % 3124 %
1750 % We're going to be starting a paragraph, but we don't want the 3125 % We're going to be starting a paragraph, but we don't want the
1751 % \parskip glue -- logically it's part of the @item we just started. 3126 % \parskip glue -- logically it's part of the @item we just started.
1752 \nobreak \vskip-\parskip 3127 \nobreak \vskip-\parskip
1753 % 3128 %
1754 % Stop a page break at the \parskip glue coming up. Unfortunately 3129 % Stop a page break at the \parskip glue coming up. However, if
1755 % we can't prevent a possible page break at the following 3130 % what follows is an environment such as @example, there will be no
1756 % \baselineskip glue. 3131 % \parskip glue; then the negative vskip we just inserted would
1757 \nobreak 3132 % cause the example and the item to crash together. So we use this
3133 % bizarre value of 10001 as a signal to \aboveenvbreak to insert
3134 % \parskip glue after all. Section titles are handled this way also.
3135 %
3136 \penalty 10001
1758 \endgroup 3137 \endgroup
1759 \itemxneedsnegativevskipfalse 3138 \itemxneedsnegativevskipfalse
1760 \else 3139 \else
1761 % The item text fits into the space. Start a paragraph, so that the 3140 % The item text fits into the space. Start a paragraph, so that the
1762 % following text (if any) will end up on the same line. 3141 % following text (if any) will end up on the same line.
1771 \endgroup 3150 \endgroup
1772 \itemxneedsnegativevskiptrue 3151 \itemxneedsnegativevskiptrue
1773 \fi 3152 \fi
1774 } 3153 }
1775 3154
1776 \def\item{\errmessage{@item while not in a table}} 3155 \def\item{\errmessage{@item while not in a list environment}}
1777 \def\itemx{\errmessage{@itemx while not in a table}} 3156 \def\itemx{\errmessage{@itemx while not in a list environment}}
1778 \def\kitem{\errmessage{@kitem while not in a table}}
1779 \def\kitemx{\errmessage{@kitemx while not in a table}}
1780 \def\xitem{\errmessage{@xitem while not in a table}}
1781 \def\xitemx{\errmessage{@xitemx while not in a table}}
1782
1783 % Contains a kludge to get @end[description] to work.
1784 \def\description{\tablez{\dontindex}{1}{}{}{}{}}
1785 3157
1786 % @table, @ftable, @vtable. 3158 % @table, @ftable, @vtable.
1787 \def\table{\begingroup\inENV\obeylines\obeyspaces\tablex} 3159 \envdef\table{%
1788 {\obeylines\obeyspaces% 3160 \let\itemindex\gobble
1789 \gdef\tablex #1^^M{% 3161 \tablecheck{table}%
1790 \tabley\dontindex#1 \endtabley}} 3162 }
1791 3163 \envdef\ftable{%
1792 \def\ftable{\begingroup\inENV\obeylines\obeyspaces\ftablex} 3164 \def\itemindex ##1{\doind {fn}{\code{##1}}}%
1793 {\obeylines\obeyspaces% 3165 \tablecheck{ftable}%
1794 \gdef\ftablex #1^^M{% 3166 }
1795 \tabley\fnitemindex#1 \endtabley 3167 \envdef\vtable{%
1796 \def\Eftable{\endgraf\afterenvbreak\endgroup}% 3168 \def\itemindex ##1{\doind {vr}{\code{##1}}}%
1797 \let\Etable=\relax}} 3169 \tablecheck{vtable}%
1798 3170 }
1799 \def\vtable{\begingroup\inENV\obeylines\obeyspaces\vtablex} 3171 \def\tablecheck#1{%
1800 {\obeylines\obeyspaces% 3172 \ifnum \the\catcode`\^^M=\active
1801 \gdef\vtablex #1^^M{% 3173 \endgroup
1802 \tabley\vritemindex#1 \endtabley 3174 \errmessage{This command won't work in this context; perhaps the problem is
1803 \def\Evtable{\endgraf\afterenvbreak\endgroup}% 3175 that we are \inenvironment\thisenv}%
1804 \let\Etable=\relax}} 3176 \def\next{\doignore{#1}}%
1805 3177 \else
1806 \def\dontindex #1{} 3178 \let\next\tablex
1807 \def\fnitemindex #1{\doind {fn}{\code{#1}}}% 3179 \fi
1808 \def\vritemindex #1{\doind {vr}{\code{#1}}}% 3180 \next
1809 3181 }
1810 {\obeyspaces % 3182 \def\tablex#1{%
1811 \gdef\tabley#1#2 #3 #4 #5 #6 #7\endtabley{\endgroup% 3183 \def\itemindicate{#1}%
1812 \tablez{#1}{#2}{#3}{#4}{#5}{#6}}} 3184 \parsearg\tabley
1813 3185 }
1814 \def\tablez #1#2#3#4#5#6{% 3186 \def\tabley#1{%
1815 \aboveenvbreak % 3187 {%
1816 \begingroup % 3188 \makevalueexpandable
1817 \def\Edescription{\Etable}% Necessary kludge. 3189 \edef\temp{\noexpand\tablez #1\space\space\space}%
1818 \let\itemindex=#1% 3190 \expandafter
1819 \ifnum 0#3>0 \advance \leftskip by #3\mil \fi % 3191 }\temp \endtablez
1820 \ifnum 0#4>0 \tableindent=#4\mil \fi % 3192 }
1821 \ifnum 0#5>0 \advance \rightskip by #5\mil \fi % 3193 \def\tablez #1 #2 #3 #4\endtablez{%
1822 \def\itemfont{#2}% 3194 \aboveenvbreak
1823 \itemmax=\tableindent % 3195 \ifnum 0#1>0 \advance \leftskip by #1\mil \fi
1824 \advance \itemmax by -\itemmargin % 3196 \ifnum 0#2>0 \tableindent=#2\mil \fi
1825 \advance \leftskip by \tableindent % 3197 \ifnum 0#3>0 \advance \rightskip by #3\mil \fi
1826 \exdentamount=\tableindent 3198 \itemmax=\tableindent
1827 \parindent = 0pt 3199 \advance \itemmax by -\itemmargin
1828 \parskip = \smallskipamount 3200 \advance \leftskip by \tableindent
1829 \ifdim \parskip=0pt \parskip=2pt \fi% 3201 \exdentamount=\tableindent
1830 \def\Etable{\endgraf\afterenvbreak\endgroup}% 3202 \parindent = 0pt
1831 \let\item = \internalBitem % 3203 \parskip = \smallskipamount
1832 \let\itemx = \internalBitemx % 3204 \ifdim \parskip=0pt \parskip=2pt \fi
1833 \let\kitem = \internalBkitem % 3205 \let\item = \internalBitem
1834 \let\kitemx = \internalBkitemx % 3206 \let\itemx = \internalBitemx
1835 \let\xitem = \internalBxitem % 3207 }
1836 \let\xitemx = \internalBxitemx % 3208 \def\Etable{\endgraf\afterenvbreak}
1837 } 3209 \let\Eftable\Etable
3210 \let\Evtable\Etable
3211 \let\Eitemize\Etable
3212 \let\Eenumerate\Etable
1838 3213
1839 % This is the counter used by @enumerate, which is really @itemize 3214 % This is the counter used by @enumerate, which is really @itemize
1840 3215
1841 \newcount \itemno 3216 \newcount \itemno
1842 3217
1843 \def\itemize{\parsearg\itemizezzz} 3218 \envdef\itemize{\parsearg\doitemize}
1844 3219
1845 \def\itemizezzz #1{% 3220 \def\doitemize#1{%
1846 \begingroup % ended by the @end itemize 3221 \aboveenvbreak
1847 \itemizey {#1}{\Eitemize} 3222 \itemmax=\itemindent
1848 } 3223 \advance\itemmax by -\itemmargin
1849 3224 \advance\leftskip by \itemindent
1850 \def\itemizey #1#2{% 3225 \exdentamount=\itemindent
1851 \aboveenvbreak % 3226 \parindent=0pt
1852 \itemmax=\itemindent % 3227 \parskip=\smallskipamount
1853 \advance \itemmax by -\itemmargin % 3228 \ifdim\parskip=0pt \parskip=2pt \fi
1854 \advance \leftskip by \itemindent % 3229 \def\itemcontents{#1}%
1855 \exdentamount=\itemindent 3230 % @itemize with no arg is equivalent to @itemize @bullet.
1856 \parindent = 0pt % 3231 \ifx\itemcontents\empty\def\itemcontents{\bullet}\fi
1857 \parskip = \smallskipamount % 3232 \let\item=\itemizeitem
1858 \ifdim \parskip=0pt \parskip=2pt \fi% 3233 }
1859 \def#2{\endgraf\afterenvbreak\endgroup}% 3234
1860 \def\itemcontents{#1}% 3235 % Definition of @item while inside @itemize and @enumerate.
1861 \let\item=\itemizeitem} 3236 %
1862 3237 \def\itemizeitem{%
1863 % Set sfcode to normal for the chars that usually have another value. 3238 \advance\itemno by 1 % for enumerations
1864 % These are `.?!:;,' 3239 {\let\par=\endgraf \smallbreak}% reasonable place to break
1865 \def\frenchspacing{\sfcode46=1000 \sfcode63=1000 \sfcode33=1000 3240 {%
1866 \sfcode58=1000 \sfcode59=1000 \sfcode44=1000 } 3241 % If the document has an @itemize directly after a section title, a
3242 % \nobreak will be last on the list, and \sectionheading will have
3243 % done a \vskip-\parskip. In that case, we don't want to zero
3244 % parskip, or the item text will crash with the heading. On the
3245 % other hand, when there is normal text preceding the item (as there
3246 % usually is), we do want to zero parskip, or there would be too much
3247 % space. In that case, we won't have a \nobreak before. At least
3248 % that's the theory.
3249 \ifnum\lastpenalty<10000 \parskip=0in \fi
3250 \noindent
3251 \hbox to 0pt{\hss \itemcontents \kern\itemmargin}%
3252 \vadjust{\penalty 1200}}% not good to break after first line of item.
3253 \flushcr
3254 }
1867 3255
1868 % \splitoff TOKENS\endmark defines \first to be the first token in 3256 % \splitoff TOKENS\endmark defines \first to be the first token in
1869 % TOKENS, and \rest to be the remainder. 3257 % TOKENS, and \rest to be the remainder.
1870 % 3258 %
1871 \def\splitoff#1#2\endmark{\def\first{#1}\def\rest{#2}}% 3259 \def\splitoff#1#2\endmark{\def\first{#1}\def\rest{#2}}%
1872 3260
1873 % Allow an optional argument of an uppercase letter, lowercase letter, 3261 % Allow an optional argument of an uppercase letter, lowercase letter,
1874 % or number, to specify the first label in the enumerated list. No 3262 % or number, to specify the first label in the enumerated list. No
1875 % argument is the same as `1'. 3263 % argument is the same as `1'.
1876 % 3264 %
1877 \def\enumerate{\parsearg\enumeratezzz} 3265 \envparseargdef\enumerate{\enumeratey #1 \endenumeratey}
1878 \def\enumeratezzz #1{\enumeratey #1 \endenumeratey}
1879 \def\enumeratey #1 #2\endenumeratey{% 3266 \def\enumeratey #1 #2\endenumeratey{%
1880 \begingroup % ended by the @end enumerate
1881 %
1882 % If we were given no argument, pretend we were given `1'. 3267 % If we were given no argument, pretend we were given `1'.
1883 \def\thearg{#1}% 3268 \def\thearg{#1}%
1884 \ifx\thearg\empty \def\thearg{1}\fi 3269 \ifx\thearg\empty \def\thearg{1}\fi
1885 % 3270 %
1886 % Detect if the argument is a single token. If so, it might be a 3271 % Detect if the argument is a single token. If so, it might be a
1947 \fi 3332 \fi
1948 \char\uccode\itemno 3333 \char\uccode\itemno
1949 }% 3334 }%
1950 } 3335 }
1951 3336
1952 % Call itemizey, adding a period to the first argument and supplying the 3337 % Call \doitemize, adding a period to the first argument and supplying the
1953 % common last two arguments. Also subtract one from the initial value in 3338 % common last two arguments. Also subtract one from the initial value in
1954 % \itemno, since @item increments \itemno. 3339 % \itemno, since @item increments \itemno.
1955 % 3340 %
1956 \def\startenumeration#1{% 3341 \def\startenumeration#1{%
1957 \advance\itemno by -1 3342 \advance\itemno by -1
1958 \itemizey{#1.}\Eenumerate\flushcr 3343 \doitemize{#1.}\flushcr
1959 } 3344 }
1960 3345
1961 % @alphaenumerate and @capsenumerate are abbreviations for giving an arg 3346 % @alphaenumerate and @capsenumerate are abbreviations for giving an arg
1962 % to @enumerate. 3347 % to @enumerate.
1963 % 3348 %
1964 \def\alphaenumerate{\enumerate{a}} 3349 \def\alphaenumerate{\enumerate{a}}
1965 \def\capsenumerate{\enumerate{A}} 3350 \def\capsenumerate{\enumerate{A}}
1966 \def\Ealphaenumerate{\Eenumerate} 3351 \def\Ealphaenumerate{\Eenumerate}
1967 \def\Ecapsenumerate{\Eenumerate} 3352 \def\Ecapsenumerate{\Eenumerate}
1968 3353
1969 % Definition of @item while inside @itemize.
1970
1971 \def\itemizeitem{%
1972 \advance\itemno by 1
1973 {\let\par=\endgraf \smallbreak}%
1974 \ifhmode \errmessage{In hmode at itemizeitem}\fi
1975 {\parskip=0in \hskip 0pt
1976 \hbox to 0pt{\hss \itemcontents\hskip \itemmargin}%
1977 \vadjust{\penalty 1200}}%
1978 \flushcr}
1979 3354
1980 % @multitable macros 3355 % @multitable macros
1981 % Amy Hendrickson, 8/18/94, 3/6/96 3356 % Amy Hendrickson, 8/18/94, 3/6/96
1982 % 3357 %
1983 % @multitable ... @end multitable will make as many columns as desired. 3358 % @multitable ... @end multitable will make as many columns as desired.
2000 3375
2001 % Or use a template: 3376 % Or use a template:
2002 % @multitable {Column 1 template} {Column 2 template} {Column 3 template} 3377 % @multitable {Column 1 template} {Column 2 template} {Column 3 template}
2003 % @item ... 3378 % @item ...
2004 % using the widest term desired in each column. 3379 % using the widest term desired in each column.
2005 %
2006 % For those who want to use more than one line's worth of words in
2007 % the preamble, break the line within one argument and it
2008 % will parse correctly, i.e.,
2009 %
2010 % @multitable {Column 1 template} {Column 2 template} {Column 3
2011 % template}
2012 % Not:
2013 % @multitable {Column 1 template} {Column 2 template}
2014 % {Column 3 template}
2015 3380
2016 % Each new table line starts with @item, each subsequent new column 3381 % Each new table line starts with @item, each subsequent new column
2017 % starts with @tab. Empty columns may be produced by supplying @tab's 3382 % starts with @tab. Empty columns may be produced by supplying @tab's
2018 % with nothing between them for as many times as empty columns are needed, 3383 % with nothing between them for as many times as empty columns are needed,
2019 % ie, @tab@tab@tab will produce two empty columns. 3384 % ie, @tab@tab@tab will produce two empty columns.
2020 3385
2021 % @item, @tab, @multitable or @end multitable do not need to be on their 3386 % @item, @tab do not need to be on their own lines, but it will not hurt
2022 % own lines, but it will not hurt if they are. 3387 % if they are.
2023 3388
2024 % Sample multitable: 3389 % Sample multitable:
2025 3390
2026 % @multitable {Column 1 template} {Column 2 template} {Column 3 template} 3391 % @multitable {Column 1 template} {Column 2 template} {Column 3 template}
2027 % @item first col stuff @tab second col stuff @tab third col 3392 % @item first col stuff @tab second col stuff @tab third col
2061 \def\xendsetuptable{\endsetuptable} 3426 \def\xendsetuptable{\endsetuptable}
2062 \let\columnfractions\relax 3427 \let\columnfractions\relax
2063 \def\xcolumnfractions{\columnfractions} 3428 \def\xcolumnfractions{\columnfractions}
2064 \newif\ifsetpercent 3429 \newif\ifsetpercent
2065 3430
2066 % #1 is the part of the @columnfraction before the decimal point, which 3431 % #1 is the @columnfraction, usually a decimal number like .5, but might
2067 % is presumably either 0 or the empty string (but we don't check, we 3432 % be just 1. We just use it, whatever it is.
2068 % just throw it away). #2 is the decimal part, which we use as the 3433 %
2069 % percent of \hsize for this column. 3434 \def\pickupwholefraction#1 {%
2070 \def\pickupwholefraction#1.#2 {%
2071 \global\advance\colcount by 1 3435 \global\advance\colcount by 1
2072 \expandafter\xdef\csname col\the\colcount\endcsname{.#2\hsize}% 3436 \expandafter\xdef\csname col\the\colcount\endcsname{#1\hsize}%
2073 \setuptable 3437 \setuptable
2074 } 3438 }
2075 3439
2076 \newcount\colcount 3440 \newcount\colcount
2077 \def\setuptable#1{% 3441 \def\setuptable#1{%
2084 \else 3448 \else
2085 \ifsetpercent 3449 \ifsetpercent
2086 \let\go\pickupwholefraction 3450 \let\go\pickupwholefraction
2087 \else 3451 \else
2088 \global\advance\colcount by 1 3452 \global\advance\colcount by 1
2089 \setbox0=\hbox{#1\unskip }% Add a normal word space as a separator; 3453 \setbox0=\hbox{#1\unskip\space}% Add a normal word space as a
2090 % typically that is always in the input, anyway. 3454 % separator; typically that is always in the input, anyway.
2091 \expandafter\xdef\csname col\the\colcount\endcsname{\the\wd0}% 3455 \expandafter\xdef\csname col\the\colcount\endcsname{\the\wd0}%
2092 \fi 3456 \fi
2093 \fi 3457 \fi
2094 \ifx\go\pickupwholefraction 3458 \ifx\go\pickupwholefraction
2095 % Put the argument back for the \pickupwholefraction call, so 3459 % Put the argument back for the \pickupwholefraction call, so
2100 \fi% 3464 \fi%
2101 \fi 3465 \fi
2102 \go 3466 \go
2103 } 3467 }
2104 3468
2105 % This used to have \hskip1sp. But then the space in a template line is 3469 % multitable-only commands.
2106 % not enough. That is bad. So let's go back to just & until we 3470 %
2107 % encounter the problem it was intended to solve again. 3471 % @headitem starts a heading row, which we typeset in bold.
2108 % --karl, nathan@acm.org, 20apr99. 3472 % Assignments have to be global since we are inside the implicit group
2109 \def\tab{&} 3473 % of an alignment entry. Note that \everycr resets \everytab.
3474 \def\headitem{\checkenv\multitable \crcr \global\everytab={\bf}\the\everytab}%
3475 %
3476 % A \tab used to include \hskip1sp. But then the space in a template
3477 % line is not enough. That is bad. So let's go back to just `&' until
3478 % we encounter the problem it was intended to solve again.
3479 % --karl, nathan@acm.org, 20apr99.
3480 \def\tab{\checkenv\multitable &\the\everytab}%
2110 3481
2111 % @multitable ... @end multitable definitions: 3482 % @multitable ... @end multitable definitions:
2112 % 3483 %
2113 \def\multitable{\parsearg\dotable} 3484 \newtoks\everytab % insert after every tab.
2114 \def\dotable#1{\bgroup 3485 %
3486 \envdef\multitable{%
2115 \vskip\parskip 3487 \vskip\parskip
2116 \let\item\crcr 3488 \startsavinginserts
3489 %
3490 % @item within a multitable starts a normal row.
3491 % We use \def instead of \let so that if one of the multitable entries
3492 % contains an @itemize, we don't choke on the \item (seen as \crcr aka
3493 % \endtemplate) expanding \doitemize.
3494 \def\item{\crcr}%
3495 %
2117 \tolerance=9500 3496 \tolerance=9500
2118 \hbadness=9500 3497 \hbadness=9500
2119 \setmultitablespacing 3498 \setmultitablespacing
2120 \parskip=\multitableparskip 3499 \parskip=\multitableparskip
2121 \parindent=\multitableparindent 3500 \parindent=\multitableparindent
2122 \overfullrule=0pt 3501 \overfullrule=0pt
2123 \global\colcount=0 3502 \global\colcount=0
2124 \def\Emultitable{\global\setpercentfalse\cr\egroup\egroup}% 3503 %
2125 % 3504 \everycr = {%
3505 \noalign{%
3506 \global\everytab={}%
3507 \global\colcount=0 % Reset the column counter.
3508 % Check for saved footnotes, etc.
3509 \checkinserts
3510 % Keeps underfull box messages off when table breaks over pages.
3511 %\filbreak
3512 % Maybe so, but it also creates really weird page breaks when the
3513 % table breaks over pages. Wouldn't \vfil be better? Wait until the
3514 % problem manifests itself, so it can be fixed for real --karl.
3515 }%
3516 }%
3517 %
3518 \parsearg\domultitable
3519 }
3520 \def\domultitable#1{%
2126 % To parse everything between @multitable and @item: 3521 % To parse everything between @multitable and @item:
2127 \setuptable#1 \endsetuptable 3522 \setuptable#1 \endsetuptable
2128 %
2129 % \everycr will reset column counter, \colcount, at the end of
2130 % each line. Every column entry will cause \colcount to advance by one.
2131 % The table preamble
2132 % looks at the current \colcount to find the correct column width.
2133 \everycr{\noalign{%
2134 %
2135 % \filbreak%% keeps underfull box messages off when table breaks over pages.
2136 % Maybe so, but it also creates really weird page breaks when the table
2137 % breaks over pages. Wouldn't \vfil be better? Wait until the problem
2138 % manifests itself, so it can be fixed for real --karl.
2139 \global\colcount=0\relax}}%
2140 % 3523 %
2141 % This preamble sets up a generic column definition, which will 3524 % This preamble sets up a generic column definition, which will
2142 % be used as many times as user calls for columns. 3525 % be used as many times as user calls for columns.
2143 % \vtop will set a single line and will also let text wrap and 3526 % \vtop will set a single line and will also let text wrap and
2144 % continue for many paragraphs if desired. 3527 % continue for many paragraphs if desired.
2145 \halign\bgroup&\global\advance\colcount by 1\relax 3528 \halign\bgroup &%
2146 \multistrut\vtop{\hsize=\expandafter\csname col\the\colcount\endcsname 3529 \global\advance\colcount by 1
2147 % 3530 \multistrut
2148 % In order to keep entries from bumping into each other 3531 \vtop{%
2149 % we will add a \leftskip of \multitablecolspace to all columns after 3532 % Use the current \colcount to find the correct column width:
2150 % the first one. 3533 \hsize=\expandafter\csname col\the\colcount\endcsname
2151 % 3534 %
2152 % If a template has been used, we will add \multitablecolspace 3535 % In order to keep entries from bumping into each other
2153 % to the width of each template entry. 3536 % we will add a \leftskip of \multitablecolspace to all columns after
2154 % 3537 % the first one.
2155 % If the user has set preamble in terms of percent of \hsize we will 3538 %
2156 % use that dimension as the width of the column, and the \leftskip 3539 % If a template has been used, we will add \multitablecolspace
2157 % will keep entries from bumping into each other. Table will start at 3540 % to the width of each template entry.
2158 % left margin and final column will justify at right margin. 3541 %
2159 % 3542 % If the user has set preamble in terms of percent of \hsize we will
2160 % Make sure we don't inherit \rightskip from the outer environment. 3543 % use that dimension as the width of the column, and the \leftskip
2161 \rightskip=0pt 3544 % will keep entries from bumping into each other. Table will start at
2162 \ifnum\colcount=1 3545 % left margin and final column will justify at right margin.
2163 % The first column will be indented with the surrounding text. 3546 %
2164 \advance\hsize by\leftskip 3547 % Make sure we don't inherit \rightskip from the outer environment.
2165 \else 3548 \rightskip=0pt
2166 \ifsetpercent \else 3549 \ifnum\colcount=1
2167 % If user has not set preamble in terms of percent of \hsize 3550 % The first column will be indented with the surrounding text.
2168 % we will advance \hsize by \multitablecolspace. 3551 \advance\hsize by\leftskip
2169 \advance\hsize by \multitablecolspace 3552 \else
2170 \fi 3553 \ifsetpercent \else
2171 % In either case we will make \leftskip=\multitablecolspace: 3554 % If user has not set preamble in terms of percent of \hsize
2172 \leftskip=\multitablecolspace 3555 % we will advance \hsize by \multitablecolspace.
2173 \fi 3556 \advance\hsize by \multitablecolspace
2174 % Ignoring space at the beginning and end avoids an occasional spurious 3557 \fi
2175 % blank line, when TeX decides to break the line at the space before the 3558 % In either case we will make \leftskip=\multitablecolspace:
2176 % box from the multistrut, so the strut ends up on a line by itself. 3559 \leftskip=\multitablecolspace
2177 % For example: 3560 \fi
2178 % @multitable @columnfractions .11 .89 3561 % Ignoring space at the beginning and end avoids an occasional spurious
2179 % @item @code{#} 3562 % blank line, when TeX decides to break the line at the space before the
2180 % @tab Legal holiday which is valid in major parts of the whole country. 3563 % box from the multistrut, so the strut ends up on a line by itself.
2181 % Is automatically provided with highlighting sequences respectively marking 3564 % For example:
2182 % characters. 3565 % @multitable @columnfractions .11 .89
2183 \noindent\ignorespaces##\unskip\multistrut}\cr 3566 % @item @code{#}
2184 } 3567 % @tab Legal holiday which is valid in major parts of the whole country.
2185 3568 % Is automatically provided with highlighting sequences respectively
2186 \def\setmultitablespacing{% test to see if user has set \multitablelinespace. 3569 % marking characters.
2187 % If so, do nothing. If not, give it an appropriate dimension based on 3570 \noindent\ignorespaces##\unskip\multistrut
2188 % current baselineskip. 3571 }\cr
3572 }
3573 \def\Emultitable{%
3574 \crcr
3575 \egroup % end the \halign
3576 \global\setpercentfalse
3577 }
3578
3579 \def\setmultitablespacing{%
3580 \def\multistrut{\strut}% just use the standard line spacing
3581 %
3582 % Compute \multitablelinespace (if not defined by user) for use in
3583 % \multitableparskip calculation. We used define \multistrut based on
3584 % this, but (ironically) that caused the spacing to be off.
3585 % See bug-texinfo report from Werner Lemberg, 31 Oct 2004 12:52:20 +0100.
2189 \ifdim\multitablelinespace=0pt 3586 \ifdim\multitablelinespace=0pt
2190 \setbox0=\vbox{X}\global\multitablelinespace=\the\baselineskip 3587 \setbox0=\vbox{X}\global\multitablelinespace=\the\baselineskip
2191 \global\advance\multitablelinespace by-\ht0 3588 \global\advance\multitablelinespace by-\ht0
2192 %% strut to put in table in case some entry doesn't have descenders, 3589 \fi
2193 %% to keep lines equally spaced
2194 \let\multistrut = \strut
2195 \else
2196 %% FIXME: what is \box0 supposed to be?
2197 \gdef\multistrut{\vrule height\multitablelinespace depth\dp0
2198 width0pt\relax} \fi
2199 %% Test to see if parskip is larger than space between lines of 3590 %% Test to see if parskip is larger than space between lines of
2200 %% table. If not, do nothing. 3591 %% table. If not, do nothing.
2201 %% If so, set to same dimension as multitablelinespace. 3592 %% If so, set to same dimension as multitablelinespace.
2202 \ifdim\multitableparskip>\multitablelinespace 3593 \ifdim\multitableparskip>\multitablelinespace
2203 \global\multitableparskip=\multitablelinespace 3594 \global\multitableparskip=\multitablelinespace
2210 %% than skip between lines in the table. 3601 %% than skip between lines in the table.
2211 \fi} 3602 \fi}
2212 3603
2213 3604
2214 \message{conditionals,} 3605 \message{conditionals,}
2215 % Prevent errors for section commands. 3606
2216 % Used in @ignore and in failing conditionals. 3607 % @iftex, @ifnotdocbook, @ifnothtml, @ifnotinfo, @ifnotplaintext,
2217 \def\ignoresections{% 3608 % @ifnotxml always succeed. They currently do nothing; we don't
2218 \let\chapter=\relax 3609 % attempt to check whether the conditionals are properly nested. But we
2219 \let\unnumbered=\relax 3610 % have to remember that they are conditionals, so that @end doesn't
2220 \let\top=\relax 3611 % attempt to close an environment group.
2221 \let\unnumberedsec=\relax 3612 %
2222 \let\unnumberedsection=\relax 3613 \def\makecond#1{%
2223 \let\unnumberedsubsec=\relax 3614 \expandafter\let\csname #1\endcsname = \relax
2224 \let\unnumberedsubsection=\relax 3615 \expandafter\let\csname iscond.#1\endcsname = 1
2225 \let\unnumberedsubsubsec=\relax 3616 }
2226 \let\unnumberedsubsubsection=\relax 3617 \makecond{iftex}
2227 \let\section=\relax 3618 \makecond{ifnotdocbook}
2228 \let\subsec=\relax 3619 \makecond{ifnothtml}
2229 \let\subsubsec=\relax 3620 \makecond{ifnotinfo}
2230 \let\subsection=\relax 3621 \makecond{ifnotplaintext}
2231 \let\subsubsection=\relax 3622 \makecond{ifnotxml}
2232 \let\appendix=\relax 3623
2233 \let\appendixsec=\relax 3624 % Ignore @ignore, @ifhtml, @ifinfo, and the like.
2234 \let\appendixsection=\relax 3625 %
2235 \let\appendixsubsec=\relax 3626 \def\direntry{\doignore{direntry}}
2236 \let\appendixsubsection=\relax 3627 \def\documentdescription{\doignore{documentdescription}}
2237 \let\appendixsubsubsec=\relax 3628 \def\docbook{\doignore{docbook}}
2238 \let\appendixsubsubsection=\relax 3629 \def\html{\doignore{html}}
2239 \let\contents=\relax 3630 \def\ifdocbook{\doignore{ifdocbook}}
2240 \let\smallbook=\relax 3631 \def\ifhtml{\doignore{ifhtml}}
2241 \let\titlepage=\relax 3632 \def\ifinfo{\doignore{ifinfo}}
2242 } 3633 \def\ifnottex{\doignore{ifnottex}}
2243 3634 \def\ifplaintext{\doignore{ifplaintext}}
2244 % Used in nested conditionals, where we have to parse the Texinfo source 3635 \def\ifxml{\doignore{ifxml}}
2245 % and so want to turn off most commands, in case they are used
2246 % incorrectly.
2247 %
2248 \def\ignoremorecommands{%
2249 \let\defcodeindex = \relax
2250 \let\defcv = \relax
2251 \let\deffn = \relax
2252 \let\deffnx = \relax
2253 \let\defindex = \relax
2254 \let\defivar = \relax
2255 \let\defmac = \relax
2256 \let\defmethod = \relax
2257 \let\defop = \relax
2258 \let\defopt = \relax
2259 \let\defspec = \relax
2260 \let\deftp = \relax
2261 \let\deftypefn = \relax
2262 \let\deftypefun = \relax
2263 \let\deftypeivar = \relax
2264 \let\deftypeop = \relax
2265 \let\deftypevar = \relax
2266 \let\deftypevr = \relax
2267 \let\defun = \relax
2268 \let\defvar = \relax
2269 \let\defvr = \relax
2270 \let\ref = \relax
2271 \let\xref = \relax
2272 \let\printindex = \relax
2273 \let\pxref = \relax
2274 \let\settitle = \relax
2275 \let\setchapternewpage = \relax
2276 \let\setchapterstyle = \relax
2277 \let\everyheading = \relax
2278 \let\evenheading = \relax
2279 \let\oddheading = \relax
2280 \let\everyfooting = \relax
2281 \let\evenfooting = \relax
2282 \let\oddfooting = \relax
2283 \let\headings = \relax
2284 \let\include = \relax
2285 \let\lowersections = \relax
2286 \let\down = \relax
2287 \let\raisesections = \relax
2288 \let\up = \relax
2289 \let\set = \relax
2290 \let\clear = \relax
2291 \let\item = \relax
2292 }
2293
2294 % Ignore @ignore ... @end ignore.
2295 %
2296 \def\ignore{\doignore{ignore}} 3636 \def\ignore{\doignore{ignore}}
2297
2298 % Ignore @ifinfo, @ifhtml, @ifnottex, @html, @menu, and @direntry text.
2299 %
2300 \def\ifinfo{\doignore{ifinfo}}
2301 \def\ifhtml{\doignore{ifhtml}}
2302 \def\ifnottex{\doignore{ifnottex}}
2303 \def\html{\doignore{html}}
2304 \def\menu{\doignore{menu}} 3637 \def\menu{\doignore{menu}}
2305 \def\direntry{\doignore{direntry}} 3638 \def\xml{\doignore{xml}}
2306 3639
2307 % @dircategory CATEGORY -- specify a category of the dir file 3640 % Ignore text until a line `@end #1', keeping track of nested conditionals.
2308 % which this file should belong to. Ignore this in TeX. 3641 %
2309 \let\dircategory = \comment 3642 % A count to remember the depth of nesting.
2310 3643 \newcount\doignorecount
2311 % Ignore text until a line `@end #1'. 3644
2312 %
2313 \def\doignore#1{\begingroup 3645 \def\doignore#1{\begingroup
2314 % Don't complain about control sequences we have declared \outer. 3646 % Scan in ``verbatim'' mode:
2315 \ignoresections 3647 \obeylines
2316 % 3648 \catcode`\@ = \other
2317 % Define a command to swallow text until we reach `@end #1'. 3649 \catcode`\{ = \other
2318 % This @ is a catcode 12 token (that is the normal catcode of @ in 3650 \catcode`\} = \other
2319 % this texinfo.tex file). We change the catcode of @ below to match.
2320 \long\def\doignoretext##1@end #1{\enddoignore}%
2321 % 3651 %
2322 % Make sure that spaces turn into tokens that match what \doignoretext wants. 3652 % Make sure that spaces turn into tokens that match what \doignoretext wants.
2323 \catcode32 = 10 3653 \spaceisspace
2324 % 3654 %
2325 % Ignore braces, too, so mismatched braces don't cause trouble. 3655 % Count number of #1's that we've seen.
2326 \catcode`\{ = 9 3656 \doignorecount = 0
2327 \catcode`\} = 9 3657 %
2328 % 3658 % Swallow text until we reach the matching `@end #1'.
2329 % We must not have @c interpreted as a control sequence. 3659 \dodoignore{#1}%
2330 \catcode`\@ = 12 3660 }
2331 % 3661
2332 % Make the letter c a comment character so that the rest of the line 3662 { \catcode`_=11 % We want to use \_STOP_ which cannot appear in texinfo source.
2333 % will be ignored. This way, the document can have (for example) 3663 \obeylines %
2334 % @c @end ifinfo 3664 %
2335 % and the @end ifinfo will be properly ignored. 3665 \gdef\dodoignore#1{%
2336 % (We've just changed @ to catcode 12.) 3666 % #1 contains the command name as a string, e.g., `ifinfo'.
2337 \catcode`\c = 14
2338 %
2339 % And now expand that command.
2340 \doignoretext
2341 }
2342
2343 % What we do to finish off ignored text.
2344 %
2345 \def\enddoignore{\endgroup\ignorespaces}%
2346
2347 \newif\ifwarnedobs\warnedobsfalse
2348 \def\obstexwarn{%
2349 \ifwarnedobs\relax\else
2350 % We need to warn folks that they may have trouble with TeX 3.0.
2351 % This uses \immediate\write16 rather than \message to get newlines.
2352 \immediate\write16{}
2353 \immediate\write16{WARNING: for users of Unix TeX 3.0!}
2354 \immediate\write16{This manual trips a bug in TeX version 3.0 (tex hangs).}
2355 \immediate\write16{If you are running another version of TeX, relax.}
2356 \immediate\write16{If you are running Unix TeX 3.0, kill this TeX process.}
2357 \immediate\write16{ Then upgrade your TeX installation if you can.}
2358 \immediate\write16{ (See ftp://ftp.gnu.org/pub/gnu/TeX.README.)}
2359 \immediate\write16{If you are stuck with version 3.0, run the}
2360 \immediate\write16{ script ``tex3patch'' from the Texinfo distribution}
2361 \immediate\write16{ to use a workaround.}
2362 \immediate\write16{}
2363 \global\warnedobstrue
2364 \fi
2365 }
2366
2367 % **In TeX 3.0, setting text in \nullfont hangs tex. For a
2368 % workaround (which requires the file ``dummy.tfm'' to be installed),
2369 % uncomment the following line:
2370 %%%%%\font\nullfont=dummy\let\obstexwarn=\relax
2371
2372 % Ignore text, except that we keep track of conditional commands for
2373 % purposes of nesting, up to an `@end #1' command.
2374 %
2375 \def\nestedignore#1{%
2376 \obstexwarn
2377 % We must actually expand the ignored text to look for the @end
2378 % command, so that nested ignore constructs work. Thus, we put the
2379 % text into a \vbox and then do nothing with the result. To minimize
2380 % the change of memory overflow, we follow the approach outlined on
2381 % page 401 of the TeXbook: make the current font be a dummy font.
2382 %
2383 \setbox0 = \vbox\bgroup
2384 % Don't complain about control sequences we have declared \outer.
2385 \ignoresections
2386 % 3667 %
2387 % Define `@end #1' to end the box, which will in turn undefine the 3668 % Define a command to find the next `@end #1'.
2388 % @end command again. 3669 \long\def\doignoretext##1^^M@end #1{%
2389 \expandafter\def\csname E#1\endcsname{\egroup\ignorespaces}% 3670 \doignoretextyyy##1^^M@#1\_STOP_}%
2390 % 3671 %
2391 % We are going to be parsing Texinfo commands. Most cause no 3672 % And this command to find another #1 command, at the beginning of a
2392 % trouble when they are used incorrectly, but some commands do 3673 % line. (Otherwise, we would consider a line `@c @ifset', for
2393 % complicated argument parsing or otherwise get confused, so we 3674 % example, to count as an @ifset for nesting.)
2394 % undefine them. 3675 \long\def\doignoretextyyy##1^^M@#1##2\_STOP_{\doignoreyyy{##2}\_STOP_}%
2395 % 3676 %
2396 % We can't do anything about stray @-signs, unfortunately; 3677 % And now expand that command.
2397 % they'll produce `undefined control sequence' errors. 3678 \doignoretext ^^M%
2398 \ignoremorecommands 3679 }%
2399 % 3680 }
2400 % Set the current font to be \nullfont, a TeX primitive, and define 3681
2401 % all the font commands to also use \nullfont. We don't use 3682 \def\doignoreyyy#1{%
2402 % dummy.tfm, as suggested in the TeXbook, because not all sites 3683 \def\temp{#1}%
2403 % might have that installed. Therefore, math mode will still 3684 \ifx\temp\empty % Nothing found.
2404 % produce output, but that should be an extremely small amount of 3685 \let\next\doignoretextzzz
2405 % stuff compared to the main input. 3686 \else % Found a nested condition, ...
2406 % 3687 \advance\doignorecount by 1
2407 \nullfont 3688 \let\next\doignoretextyyy % ..., look for another.
2408 \let\tenrm=\nullfont \let\tenit=\nullfont \let\tensl=\nullfont 3689 % If we're here, #1 ends with ^^M\ifinfo (for example).
2409 \let\tenbf=\nullfont \let\tentt=\nullfont \let\smallcaps=\nullfont 3690 \fi
2410 \let\tensf=\nullfont 3691 \next #1% the token \_STOP_ is present just after this macro.
2411 % Similarly for index fonts (mostly for their use in smallexample). 3692 }
2412 \let\smallrm=\nullfont \let\smallit=\nullfont \let\smallsl=\nullfont 3693
2413 \let\smallbf=\nullfont \let\smalltt=\nullfont \let\smallsc=\nullfont 3694 % We have to swallow the remaining "\_STOP_".
2414 \let\smallsf=\nullfont 3695 %
2415 % 3696 \def\doignoretextzzz#1{%
2416 % Don't complain when characters are missing from the fonts. 3697 \ifnum\doignorecount = 0 % We have just found the outermost @end.
2417 \tracinglostchars = 0 3698 \let\next\enddoignore
2418 % 3699 \else % Still inside a nested condition.
2419 % Don't bother to do space factor calculations. 3700 \advance\doignorecount by -1
2420 \frenchspacing 3701 \let\next\doignoretext % Look for the next @end.
2421 % 3702 \fi
2422 % Don't report underfull hboxes. 3703 \next
2423 \hbadness = 10000 3704 }
2424 % 3705
2425 % Do minimal line-breaking. 3706 % Finish off ignored text.
2426 \pretolerance = 10000 3707 { \obeylines%
2427 % 3708 % Ignore anything after the last `@end #1'; this matters in verbatim
2428 % Do not execute instructions in @tex 3709 % environments, where otherwise the newline after an ignored conditional
2429 \def\tex{\doignore{tex}}% 3710 % would result in a blank line in the output.
2430 % Do not execute macro definitions. 3711 \gdef\enddoignore#1^^M{\endgroup\ignorespaces}%
2431 % `c' is a comment character, so the word `macro' will get cut off. 3712 }
2432 \def\macro{\doignore{ma}}% 3713
2433 }
2434 3714
2435 % @set VAR sets the variable VAR to an empty value. 3715 % @set VAR sets the variable VAR to an empty value.
2436 % @set VAR REST-OF-LINE sets VAR to the value REST-OF-LINE. 3716 % @set VAR REST-OF-LINE sets VAR to the value REST-OF-LINE.
2437 % 3717 %
2438 % Since we want to separate VAR from REST-OF-LINE (which might be 3718 % Since we want to separate VAR from REST-OF-LINE (which might be
2439 % empty), we can't just use \parsearg; we have to insert a space of our 3719 % empty), we can't just use \parsearg; we have to insert a space of our
2440 % own to delimit the rest of the line, and then take it out again if we 3720 % own to delimit the rest of the line, and then take it out again if we
2441 % didn't need it. Make sure the catcode of space is correct to avoid 3721 % didn't need it.
2442 % losing inside @example, for instance. 3722 % We rely on the fact that \parsearg sets \catcode`\ =10.
2443 % 3723 %
2444 \def\set{\begingroup\catcode` =10 3724 \parseargdef\set{\setyyy#1 \endsetyyy}
2445 \catcode`\-=12 \catcode`\_=12 % Allow - and _ in VAR.
2446 \parsearg\setxxx}
2447 \def\setxxx#1{\setyyy#1 \endsetyyy}
2448 \def\setyyy#1 #2\endsetyyy{% 3725 \def\setyyy#1 #2\endsetyyy{%
2449 \def\temp{#2}% 3726 {%
2450 \ifx\temp\empty \global\expandafter\let\csname SET#1\endcsname = \empty 3727 \makevalueexpandable
2451 \else \setzzz{#1}#2\endsetzzz % Remove the trailing space \setxxx inserted. 3728 \def\temp{#2}%
2452 \fi 3729 \edef\next{\gdef\makecsname{SET#1}}%
2453 \endgroup 3730 \ifx\temp\empty
2454 } 3731 \next{}%
2455 % Can't use \xdef to pre-expand #2 and save some time, since \temp or 3732 \else
2456 % \next or other control sequences that we've defined might get us into 3733 \setzzz#2\endsetzzz
2457 % an infinite loop. Consider `@set foo @cite{bar}'. 3734 \fi
2458 \def\setzzz#1#2 \endsetzzz{\expandafter\gdef\csname SET#1\endcsname{#2}} 3735 }%
3736 }
3737 % Remove the trailing space \setxxx inserted.
3738 \def\setzzz#1 \endsetzzz{\next{#1}}
2459 3739
2460 % @clear VAR clears (i.e., unsets) the variable VAR. 3740 % @clear VAR clears (i.e., unsets) the variable VAR.
2461 % 3741 %
2462 \def\clear{\parsearg\clearxxx} 3742 \parseargdef\clear{%
2463 \def\clearxxx#1{\global\expandafter\let\csname SET#1\endcsname=\relax} 3743 {%
3744 \makevalueexpandable
3745 \global\expandafter\let\csname SET#1\endcsname=\relax
3746 }%
3747 }
2464 3748
2465 % @value{foo} gets the text saved in variable foo. 3749 % @value{foo} gets the text saved in variable foo.
3750 \def\value{\begingroup\makevalueexpandable\valuexxx}
3751 \def\valuexxx#1{\expandablevalue{#1}\endgroup}
2466 { 3752 {
2467 \catcode`\_ = \active 3753 \catcode`\- = \active \catcode`\_ = \active
2468 % 3754 %
2469 % We might end up with active _ or - characters in the argument if 3755 \gdef\makevalueexpandable{%
2470 % we're called from @code, as @code{@value{foo-bar_}}. So \let any 3756 \let\value = \expandablevalue
2471 % such active characters to their normal equivalents. 3757 % We don't want these characters active, ...
2472 \gdef\value{\begingroup 3758 \catcode`\-=\other \catcode`\_=\other
2473 \catcode`\-=12 \catcode`\_=12 3759 % ..., but we might end up with active ones in the argument if
2474 \indexbreaks \let_\normalunderscore 3760 % we're called from @code, as @code{@value{foo-bar_}}, though.
2475 \valuexxx} 3761 % So \let them to their normal equivalents.
2476 } 3762 \let-\realdash \let_\normalunderscore
2477 \def\valuexxx#1{\expandablevalue{#1}\endgroup} 3763 }
3764 }
2478 3765
2479 % We have this subroutine so that we can handle at least some @value's 3766 % We have this subroutine so that we can handle at least some @value's
2480 % properly in indexes (we \let\value to this in \indexdummies). Ones 3767 % properly in indexes (we call \makevalueexpandable in \indexdummies).
2481 % whose names contain - or _ still won't work, but we can't do anything 3768 % The command has to be fully expandable (if the variable is set), since
2482 % about that. The command has to be fully expandable, since the result 3769 % the result winds up in the index file. This means that if the
2483 % winds up in the index file. This means that if the variable's value 3770 % variable's value contains other Texinfo commands, it's almost certain
2484 % contains other Texinfo commands, it's almost certain it will fail 3771 % it will fail (although perhaps we could fix that with sufficient work
2485 % (although perhaps we could fix that with sufficient work to do a 3772 % to do a one-level expansion on the result, instead of complete).
2486 % one-level expansion on the result, instead of complete).
2487 % 3773 %
2488 \def\expandablevalue#1{% 3774 \def\expandablevalue#1{%
2489 \expandafter\ifx\csname SET#1\endcsname\relax 3775 \expandafter\ifx\csname SET#1\endcsname\relax
2490 {[No value for ``#1'']}% 3776 {[No value for ``#1'']}%
3777 \message{Variable `#1', used in @value, is not set.}%
2491 \else 3778 \else
2492 \csname SET#1\endcsname 3779 \csname SET#1\endcsname
2493 \fi 3780 \fi
2494 } 3781 }
2495 3782
2496 % @ifset VAR ... @end ifset reads the `...' iff VAR has been defined 3783 % @ifset VAR ... @end ifset reads the `...' iff VAR has been defined
2497 % with @set. 3784 % with @set.
2498 % 3785 %
2499 \def\ifset{\parsearg\ifsetxxx} 3786 % To get special treatment of `@end ifset,' call \makeond and the redefine.
2500 \def\ifsetxxx #1{% 3787 %
2501 \expandafter\ifx\csname SET#1\endcsname\relax 3788 \makecond{ifset}
2502 \expandafter\ifsetfail 3789 \def\ifset{\parsearg{\doifset{\let\next=\ifsetfail}}}
2503 \else 3790 \def\doifset#1#2{%
2504 \expandafter\ifsetsucceed 3791 {%
2505 \fi 3792 \makevalueexpandable
2506 } 3793 \let\next=\empty
2507 \def\ifsetsucceed{\conditionalsucceed{ifset}} 3794 \expandafter\ifx\csname SET#2\endcsname\relax
2508 \def\ifsetfail{\nestedignore{ifset}} 3795 #1% If not set, redefine \next.
2509 \defineunmatchedend{ifset} 3796 \fi
3797 \expandafter
3798 }\next
3799 }
3800 \def\ifsetfail{\doignore{ifset}}
2510 3801
2511 % @ifclear VAR ... @end ifclear reads the `...' iff VAR has never been 3802 % @ifclear VAR ... @end ifclear reads the `...' iff VAR has never been
2512 % defined with @set, or has been undefined with @clear. 3803 % defined with @set, or has been undefined with @clear.
2513 % 3804 %
2514 \def\ifclear{\parsearg\ifclearxxx} 3805 % The `\else' inside the `\doifset' parameter is a trick to reuse the
2515 \def\ifclearxxx #1{% 3806 % above code: if the variable is not set, do nothing, if it is set,
2516 \expandafter\ifx\csname SET#1\endcsname\relax 3807 % then redefine \next to \ifclearfail.
2517 \expandafter\ifclearsucceed 3808 %
2518 \else 3809 \makecond{ifclear}
2519 \expandafter\ifclearfail 3810 \def\ifclear{\parsearg{\doifset{\else \let\next=\ifclearfail}}}
2520 \fi 3811 \def\ifclearfail{\doignore{ifclear}}
2521 } 3812
2522 \def\ifclearsucceed{\conditionalsucceed{ifclear}} 3813 % @dircategory CATEGORY -- specify a category of the dir file
2523 \def\ifclearfail{\nestedignore{ifclear}} 3814 % which this file should belong to. Ignore this in TeX.
2524 \defineunmatchedend{ifclear} 3815 \let\dircategory=\comment
2525
2526 % @iftex, @ifnothtml, @ifnotinfo always succeed; we read the text
2527 % following, through the first @end iftex (etc.). Make `@end iftex'
2528 % (etc.) valid only after an @iftex.
2529 %
2530 \def\iftex{\conditionalsucceed{iftex}}
2531 \def\ifnothtml{\conditionalsucceed{ifnothtml}}
2532 \def\ifnotinfo{\conditionalsucceed{ifnotinfo}}
2533 \defineunmatchedend{iftex}
2534 \defineunmatchedend{ifnothtml}
2535 \defineunmatchedend{ifnotinfo}
2536
2537 % We can't just want to start a group at @iftex (for example) and end it
2538 % at @end iftex, since then @set commands inside the conditional have no
2539 % effect (they'd get reverted at the end of the group). So we must
2540 % define \Eiftex to redefine itself to be its previous value. (We can't
2541 % just define it to fail again with an ``unmatched end'' error, since
2542 % the @ifset might be nested.)
2543 %
2544 \def\conditionalsucceed#1{%
2545 \edef\temp{%
2546 % Remember the current value of \E#1.
2547 \let\nece{prevE#1} = \nece{E#1}%
2548 %
2549 % At the `@end #1', redefine \E#1 to be its previous value.
2550 \def\nece{E#1}{\let\nece{E#1} = \nece{prevE#1}}%
2551 }%
2552 \temp
2553 }
2554
2555 % We need to expand lots of \csname's, but we don't want to expand the
2556 % control sequences after we've constructed them.
2557 %
2558 \def\nece#1{\expandafter\noexpand\csname#1\endcsname}
2559 3816
2560 % @defininfoenclose. 3817 % @defininfoenclose.
2561 \let\definfoenclose=\comment 3818 \let\definfoenclose=\comment
2562 3819
2563 3820
2564 \message{indexing,} 3821 \message{indexing,}
2565 % Index generation facilities 3822 % Index generation facilities
2566 3823
2567 % Define \newwrite to be identical to plain tex's \newwrite 3824 % Define \newwrite to be identical to plain tex's \newwrite
2568 % except not \outer, so it can be used within \newindex. 3825 % except not \outer, so it can be used within macros and \if's.
2569 {\catcode`\@=11 3826 \edef\newwrite{\makecsname{ptexnewwrite}}
2570 \gdef\newwrite{\alloc@7\write\chardef\sixt@@n}}
2571 3827
2572 % \newindex {foo} defines an index named foo. 3828 % \newindex {foo} defines an index named foo.
2573 % It automatically defines \fooindex such that 3829 % It automatically defines \fooindex such that
2574 % \fooindex ...rest of line... puts an entry in the index foo. 3830 % \fooindex ...rest of line... puts an entry in the index foo.
2575 % It also defines \fooindfile to be the number of the output channel for 3831 % It also defines \fooindfile to be the number of the output channel for
2585 \expandafter\xdef\csname#1index\endcsname{% % Define @#1index 3841 \expandafter\xdef\csname#1index\endcsname{% % Define @#1index
2586 \noexpand\doindex{#1}} 3842 \noexpand\doindex{#1}}
2587 } 3843 }
2588 3844
2589 % @defindex foo == \newindex{foo} 3845 % @defindex foo == \newindex{foo}
2590 3846 %
2591 \def\defindex{\parsearg\newindex} 3847 \def\defindex{\parsearg\newindex}
2592 3848
2593 % Define @defcodeindex, like @defindex except put all entries in @code. 3849 % Define @defcodeindex, like @defindex except put all entries in @code.
2594 3850 %
3851 \def\defcodeindex{\parsearg\newcodeindex}
3852 %
2595 \def\newcodeindex#1{% 3853 \def\newcodeindex#1{%
2596 \iflinks 3854 \iflinks
2597 \expandafter\newwrite \csname#1indfile\endcsname 3855 \expandafter\newwrite \csname#1indfile\endcsname
2598 \openout \csname#1indfile\endcsname \jobname.#1 3856 \openout \csname#1indfile\endcsname \jobname.#1
2599 \fi 3857 \fi
2600 \expandafter\xdef\csname#1index\endcsname{% 3858 \expandafter\xdef\csname#1index\endcsname{%
2601 \noexpand\docodeindex{#1}} 3859 \noexpand\docodeindex{#1}}%
2602 } 3860 }
2603 3861
2604 \def\defcodeindex{\parsearg\newcodeindex}
2605 3862
2606 % @synindex foo bar makes index foo feed into index bar. 3863 % @synindex foo bar makes index foo feed into index bar.
2607 % Do this instead of @defindex foo if you don't want it as a separate index. 3864 % Do this instead of @defindex foo if you don't want it as a separate index.
2608 % The \closeout helps reduce unnecessary open files; the limit on the 3865 %
2609 % Acorn RISC OS is a mere 16 files.
2610 \def\synindex#1 #2 {%
2611 \expandafter\let\expandafter\synindexfoo\expandafter=\csname#2indfile\endcsname
2612 \expandafter\closeout\csname#1indfile\endcsname
2613 \expandafter\let\csname#1indfile\endcsname=\synindexfoo
2614 \expandafter\xdef\csname#1index\endcsname{% define \xxxindex
2615 \noexpand\doindex{#2}}%
2616 }
2617
2618 % @syncodeindex foo bar similar, but put all entries made for index foo 3866 % @syncodeindex foo bar similar, but put all entries made for index foo
2619 % inside @code. 3867 % inside @code.
2620 \def\syncodeindex#1 #2 {% 3868 %
2621 \expandafter\let\expandafter\synindexfoo\expandafter=\csname#2indfile\endcsname 3869 \def\synindex#1 #2 {\dosynindex\doindex{#1}{#2}}
2622 \expandafter\closeout\csname#1indfile\endcsname 3870 \def\syncodeindex#1 #2 {\dosynindex\docodeindex{#1}{#2}}
2623 \expandafter\let\csname#1indfile\endcsname=\synindexfoo 3871
2624 \expandafter\xdef\csname#1index\endcsname{% define \xxxindex 3872 % #1 is \doindex or \docodeindex, #2 the index getting redefined (foo),
2625 \noexpand\docodeindex{#2}}% 3873 % #3 the target index (bar).
3874 \def\dosynindex#1#2#3{%
3875 % Only do \closeout if we haven't already done it, else we'll end up
3876 % closing the target index.
3877 \expandafter \ifx\csname donesynindex#2\endcsname \undefined
3878 % The \closeout helps reduce unnecessary open files; the limit on the
3879 % Acorn RISC OS is a mere 16 files.
3880 \expandafter\closeout\csname#2indfile\endcsname
3881 \expandafter\let\csname\donesynindex#2\endcsname = 1
3882 \fi
3883 % redefine \fooindfile:
3884 \expandafter\let\expandafter\temp\expandafter=\csname#3indfile\endcsname
3885 \expandafter\let\csname#2indfile\endcsname=\temp
3886 % redefine \fooindex:
3887 \expandafter\xdef\csname#2index\endcsname{\noexpand#1{#3}}%
2626 } 3888 }
2627 3889
2628 % Define \doindex, the driver for all \fooindex macros. 3890 % Define \doindex, the driver for all \fooindex macros.
2629 % Argument #1 is generated by the calling \fooindex macro, 3891 % Argument #1 is generated by the calling \fooindex macro,
2630 % and it is "foo", the name of the index. 3892 % and it is "foo", the name of the index.
2640 3902
2641 % like the previous two, but they put @code around the argument. 3903 % like the previous two, but they put @code around the argument.
2642 \def\docodeindex#1{\edef\indexname{#1}\parsearg\singlecodeindexer} 3904 \def\docodeindex#1{\edef\indexname{#1}\parsearg\singlecodeindexer}
2643 \def\singlecodeindexer #1{\doind{\indexname}{\code{#1}}} 3905 \def\singlecodeindexer #1{\doind{\indexname}{\code{#1}}}
2644 3906
3907 % Take care of Texinfo commands that can appear in an index entry.
3908 % Since there are some commands we want to expand, and others we don't,
3909 % we have to laboriously prevent expansion for those that we don't.
3910 %
2645 \def\indexdummies{% 3911 \def\indexdummies{%
2646 \def\ { }% 3912 \escapechar = `\\ % use backslash in output files.
2647 % Take care of the plain tex accent commands. 3913 \def\@{@}% change to @@ when we switch to @ as escape char in index files.
2648 \def\"{\realbackslash "}% 3914 \def\ {\realbackslash\space }%
2649 \def\`{\realbackslash `}% 3915 %
2650 \def\'{\realbackslash '}% 3916 % Need these in case \tex is in effect and \{ is a \delimiter again.
2651 \def\^{\realbackslash ^}% 3917 % But can't use \lbracecmd and \rbracecmd because texindex assumes
2652 \def\~{\realbackslash ~}% 3918 % braces and backslashes are used only as delimiters.
2653 \def\={\realbackslash =}% 3919 \let\{ = \mylbrace
2654 \def\b{\realbackslash b}% 3920 \let\} = \myrbrace
2655 \def\c{\realbackslash c}% 3921 %
2656 \def\d{\realbackslash d}% 3922 % I don't entirely understand this, but when an index entry is
2657 \def\u{\realbackslash u}% 3923 % generated from a macro call, the \endinput which \scanmacro inserts
2658 \def\v{\realbackslash v}% 3924 % causes processing to be prematurely terminated. This is,
2659 \def\H{\realbackslash H}% 3925 % apparently, because \indexsorttmp is fully expanded, and \endinput
2660 % Take care of the plain tex special European modified letters. 3926 % is an expandable command. The redefinition below makes \endinput
2661 \def\oe{\realbackslash oe}% 3927 % disappear altogether for that purpose -- although logging shows that
2662 \def\ae{\realbackslash ae}% 3928 % processing continues to some further point. On the other hand, it
2663 \def\aa{\realbackslash aa}% 3929 % seems \endinput does not hurt in the printed index arg, since that
2664 \def\OE{\realbackslash OE}% 3930 % is still getting written without apparent harm.
2665 \def\AE{\realbackslash AE}% 3931 %
2666 \def\AA{\realbackslash AA}% 3932 % Sample source (mac-idx3.tex, reported by Graham Percival to
2667 \def\o{\realbackslash o}% 3933 % help-texinfo, 22may06):
2668 \def\O{\realbackslash O}% 3934 % @macro funindex {WORD}
2669 \def\l{\realbackslash l}% 3935 % @findex xyz
2670 \def\L{\realbackslash L}% 3936 % @end macro
2671 \def\ss{\realbackslash ss}% 3937 % ...
2672 % Take care of texinfo commands likely to appear in an index entry. 3938 % @funindex commtest
2673 % (Must be a way to avoid doing expansion at all, and thus not have to 3939 %
2674 % laboriously list every single command here.) 3940 % The above is not enough to reproduce the bug, but it gives the flavor.
2675 \def\@{@}% will be @@ when we switch to @ as escape char. 3941 %
2676 % Need these in case \tex is in effect and \{ is a \delimiter again. 3942 % Sample whatsit resulting:
2677 % But can't use \lbracecmd and \rbracecmd because texindex assumes 3943 % .@write3{\entry{xyz}{@folio }{@code {xyz@endinput }}}
2678 % braces and backslashes are used only as delimiters. 3944 %
2679 \let\{ = \mylbrace 3945 % So:
2680 \let\} = \myrbrace 3946 \let\endinput = \empty
2681 \def\_{{\realbackslash _}}% 3947 %
2682 \def\w{\realbackslash w }% 3948 % Do the redefinitions.
2683 \def\bf{\realbackslash bf }% 3949 \commondummies
2684 %\def\rm{\realbackslash rm }% 3950 }
2685 \def\sl{\realbackslash sl }% 3951
2686 \def\sf{\realbackslash sf}% 3952 % For the aux and toc files, @ is the escape character. So we want to
2687 \def\tt{\realbackslash tt}% 3953 % redefine everything using @ as the escape character (instead of
2688 \def\gtr{\realbackslash gtr}% 3954 % \realbackslash, still used for index files). When everything uses @,
2689 \def\less{\realbackslash less}% 3955 % this will be simpler.
2690 \def\hat{\realbackslash hat}% 3956 %
2691 \def\TeX{\realbackslash TeX}% 3957 \def\atdummies{%
2692 \def\dots{\realbackslash dots }% 3958 \def\@{@@}%
2693 \def\result{\realbackslash result}% 3959 \def\ {@ }%
2694 \def\equiv{\realbackslash equiv}% 3960 \let\{ = \lbraceatcmd
2695 \def\expansion{\realbackslash expansion}% 3961 \let\} = \rbraceatcmd
2696 \def\print{\realbackslash print}% 3962 %
2697 \def\error{\realbackslash error}% 3963 % Do the redefinitions.
2698 \def\point{\realbackslash point}% 3964 \commondummies
2699 \def\copyright{\realbackslash copyright}% 3965 \otherbackslash
2700 \def\tclose##1{\realbackslash tclose {##1}}% 3966 }
2701 \def\code##1{\realbackslash code {##1}}% 3967
2702 \def\uref##1{\realbackslash uref {##1}}% 3968 % Called from \indexdummies and \atdummies.
2703 \def\url##1{\realbackslash url {##1}}% 3969 %
2704 \def\env##1{\realbackslash env {##1}}% 3970 \def\commondummies{%
2705 \def\command##1{\realbackslash command {##1}}% 3971 %
2706 \def\option##1{\realbackslash option {##1}}% 3972 % \definedummyword defines \#1 as \string\#1\space, thus effectively
2707 \def\dotless##1{\realbackslash dotless {##1}}% 3973 % preventing its expansion. This is used only for control% words,
2708 \def\samp##1{\realbackslash samp {##1}}% 3974 % not control letters, because the \space would be incorrect for
2709 \def\,##1{\realbackslash ,{##1}}% 3975 % control characters, but is needed to separate the control word
2710 \def\t##1{\realbackslash t {##1}}% 3976 % from whatever follows.
2711 \def\r##1{\realbackslash r {##1}}% 3977 %
2712 \def\i##1{\realbackslash i {##1}}% 3978 % For control letters, we have \definedummyletter, which omits the
2713 \def\b##1{\realbackslash b {##1}}% 3979 % space.
2714 \def\sc##1{\realbackslash sc {##1}}% 3980 %
2715 \def\cite##1{\realbackslash cite {##1}}% 3981 % These can be used both for control words that take an argument and
2716 \def\key##1{\realbackslash key {##1}}% 3982 % those that do not. If it is followed by {arg} in the input, then
2717 \def\file##1{\realbackslash file {##1}}% 3983 % that will dutifully get written to the index (or wherever).
2718 \def\var##1{\realbackslash var {##1}}% 3984 %
2719 \def\kbd##1{\realbackslash kbd {##1}}% 3985 \def\definedummyword ##1{\def##1{\string##1\space}}%
2720 \def\dfn##1{\realbackslash dfn {##1}}% 3986 \def\definedummyletter##1{\def##1{\string##1}}%
2721 \def\emph##1{\realbackslash emph {##1}}% 3987 \let\definedummyaccent\definedummyletter
2722 \def\acronym##1{\realbackslash acronym {##1}}% 3988 %
2723 % 3989 \commondummiesnofonts
2724 % Handle some cases of @value -- where the variable name does not 3990 %
2725 % contain - or _, and the value does not contain any 3991 \definedummyletter\_%
2726 % (non-fully-expandable) commands. 3992 %
2727 \let\value = \expandablevalue 3993 % Non-English letters.
2728 % 3994 \definedummyword\AA
2729 \unsepspaces 3995 \definedummyword\AE
2730 % Turn off macro expansion 3996 \definedummyword\L
2731 \turnoffmacros 3997 \definedummyword\OE
2732 } 3998 \definedummyword\O
2733 3999 \definedummyword\aa
2734 % If an index command is used in an @example environment, any spaces 4000 \definedummyword\ae
2735 % therein should become regular spaces in the raw index file, not the 4001 \definedummyword\l
2736 % expansion of \tie (\\leavevmode \penalty \@M \ ). 4002 \definedummyword\oe
2737 {\obeyspaces 4003 \definedummyword\o
2738 \gdef\unsepspaces{\obeyspaces\let =\space}} 4004 \definedummyword\ss
2739 4005 \definedummyword\exclamdown
2740 % \indexnofonts no-ops all font-change commands. 4006 \definedummyword\questiondown
2741 % This is used when outputting the strings to sort the index by. 4007 \definedummyword\ordf
2742 \def\indexdummyfont#1{#1} 4008 \definedummyword\ordm
2743 \def\indexdummytex{TeX} 4009 %
2744 \def\indexdummydots{...} 4010 % Although these internal commands shouldn't show up, sometimes they do.
2745 4011 \definedummyword\bf
4012 \definedummyword\gtr
4013 \definedummyword\hat
4014 \definedummyword\less
4015 \definedummyword\sf
4016 \definedummyword\sl
4017 \definedummyword\tclose
4018 \definedummyword\tt
4019 %
4020 \definedummyword\LaTeX
4021 \definedummyword\TeX
4022 %
4023 % Assorted special characters.
4024 \definedummyword\bullet
4025 \definedummyword\comma
4026 \definedummyword\copyright
4027 \definedummyword\registeredsymbol
4028 \definedummyword\dots
4029 \definedummyword\enddots
4030 \definedummyword\equiv
4031 \definedummyword\error
4032 \definedummyword\euro
4033 \definedummyword\guillemetleft
4034 \definedummyword\guillemetright
4035 \definedummyword\guilsinglleft
4036 \definedummyword\guilsinglright
4037 \definedummyword\expansion
4038 \definedummyword\minus
4039 \definedummyword\pounds
4040 \definedummyword\point
4041 \definedummyword\print
4042 \definedummyword\quotedblbase
4043 \definedummyword\quotedblleft
4044 \definedummyword\quotedblright
4045 \definedummyword\quoteleft
4046 \definedummyword\quoteright
4047 \definedummyword\quotesinglbase
4048 \definedummyword\result
4049 \definedummyword\textdegree
4050 %
4051 % We want to disable all macros so that they are not expanded by \write.
4052 \macrolist
4053 %
4054 \normalturnoffactive
4055 %
4056 % Handle some cases of @value -- where it does not contain any
4057 % (non-fully-expandable) commands.
4058 \makevalueexpandable
4059 }
4060
4061 % \commondummiesnofonts: common to \commondummies and \indexnofonts.
4062 %
4063 \def\commondummiesnofonts{%
4064 % Control letters and accents.
4065 \definedummyletter\!%
4066 \definedummyaccent\"%
4067 \definedummyaccent\'%
4068 \definedummyletter\*%
4069 \definedummyaccent\,%
4070 \definedummyletter\.%
4071 \definedummyletter\/%
4072 \definedummyletter\:%
4073 \definedummyaccent\=%
4074 \definedummyletter\?%
4075 \definedummyaccent\^%
4076 \definedummyaccent\`%
4077 \definedummyaccent\~%
4078 \definedummyword\u
4079 \definedummyword\v
4080 \definedummyword\H
4081 \definedummyword\dotaccent
4082 \definedummyword\ringaccent
4083 \definedummyword\tieaccent
4084 \definedummyword\ubaraccent
4085 \definedummyword\udotaccent
4086 \definedummyword\dotless
4087 %
4088 % Texinfo font commands.
4089 \definedummyword\b
4090 \definedummyword\i
4091 \definedummyword\r
4092 \definedummyword\sc
4093 \definedummyword\t
4094 %
4095 % Commands that take arguments.
4096 \definedummyword\acronym
4097 \definedummyword\cite
4098 \definedummyword\code
4099 \definedummyword\command
4100 \definedummyword\dfn
4101 \definedummyword\emph
4102 \definedummyword\env
4103 \definedummyword\file
4104 \definedummyword\kbd
4105 \definedummyword\key
4106 \definedummyword\math
4107 \definedummyword\option
4108 \definedummyword\pxref
4109 \definedummyword\ref
4110 \definedummyword\samp
4111 \definedummyword\strong
4112 \definedummyword\tie
4113 \definedummyword\uref
4114 \definedummyword\url
4115 \definedummyword\var
4116 \definedummyword\verb
4117 \definedummyword\w
4118 \definedummyword\xref
4119 }
4120
4121 % \indexnofonts is used when outputting the strings to sort the index
4122 % by, and when constructing control sequence names. It eliminates all
4123 % control sequences and just writes whatever the best ASCII sort string
4124 % would be for a given command (usually its argument).
4125 %
2746 \def\indexnofonts{% 4126 \def\indexnofonts{%
2747 % Just ignore accents. 4127 % Accent commands should become @asis.
2748 \let\,=\indexdummyfont 4128 \def\definedummyaccent##1{\let##1\asis}%
2749 \let\"=\indexdummyfont 4129 % We can just ignore other control letters.
2750 \let\`=\indexdummyfont 4130 \def\definedummyletter##1{\let##1\empty}%
2751 \let\'=\indexdummyfont 4131 % Hopefully, all control words can become @asis.
2752 \let\^=\indexdummyfont 4132 \let\definedummyword\definedummyaccent
2753 \let\~=\indexdummyfont 4133 %
2754 \let\==\indexdummyfont 4134 \commondummiesnofonts
2755 \let\b=\indexdummyfont 4135 %
2756 \let\c=\indexdummyfont 4136 % Don't no-op \tt, since it isn't a user-level command
2757 \let\d=\indexdummyfont 4137 % and is used in the definitions of the active chars like <, >, |, etc.
2758 \let\u=\indexdummyfont 4138 % Likewise with the other plain tex font commands.
2759 \let\v=\indexdummyfont 4139 %\let\tt=\asis
2760 \let\H=\indexdummyfont 4140 %
2761 \let\dotless=\indexdummyfont 4141 \def\ { }%
2762 % Take care of the plain tex special European modified letters. 4142 \def\@{@}%
2763 \def\oe{oe}% 4143 % how to handle braces?
2764 \def\ae{ae}% 4144 \def\_{\normalunderscore}%
2765 \def\aa{aa}% 4145 %
2766 \def\OE{OE}% 4146 % Non-English letters.
2767 \def\AE{AE}% 4147 \def\AA{AA}%
2768 \def\AA{AA}% 4148 \def\AE{AE}%
2769 \def\o{o}% 4149 \def\L{L}%
2770 \def\O{O}% 4150 \def\OE{OE}%
2771 \def\l{l}% 4151 \def\O{O}%
2772 \def\L{L}% 4152 \def\aa{aa}%
2773 \def\ss{ss}% 4153 \def\ae{ae}%
2774 \let\w=\indexdummyfont 4154 \def\l{l}%
2775 \let\t=\indexdummyfont 4155 \def\oe{oe}%
2776 \let\r=\indexdummyfont 4156 \def\o{o}%
2777 \let\i=\indexdummyfont 4157 \def\ss{ss}%
2778 \let\b=\indexdummyfont 4158 \def\exclamdown{!}%
2779 \let\emph=\indexdummyfont 4159 \def\questiondown{?}%
2780 \let\strong=\indexdummyfont 4160 \def\ordf{a}%
2781 \let\cite=\indexdummyfont 4161 \def\ordm{o}%
2782 \let\sc=\indexdummyfont 4162 %
2783 %Don't no-op \tt, since it isn't a user-level command 4163 \def\LaTeX{LaTeX}%
2784 % and is used in the definitions of the active chars like <, >, |... 4164 \def\TeX{TeX}%
2785 %\let\tt=\indexdummyfont 4165 %
2786 \let\tclose=\indexdummyfont 4166 % Assorted special characters.
2787 \let\code=\indexdummyfont 4167 % (The following {} will end up in the sort string, but that's ok.)
2788 \let\url=\indexdummyfont 4168 \def\bullet{bullet}%
2789 \let\uref=\indexdummyfont 4169 \def\comma{,}%
2790 \let\env=\indexdummyfont 4170 \def\copyright{copyright}%
2791 \let\acronym=\indexdummyfont 4171 \def\registeredsymbol{R}%
2792 \let\command=\indexdummyfont 4172 \def\dots{...}%
2793 \let\option=\indexdummyfont 4173 \def\enddots{...}%
2794 \let\file=\indexdummyfont 4174 \def\equiv{==}%
2795 \let\samp=\indexdummyfont 4175 \def\error{error}%
2796 \let\kbd=\indexdummyfont 4176 \def\euro{euro}%
2797 \let\key=\indexdummyfont 4177 \def\guillemetleft{<<}%
2798 \let\var=\indexdummyfont 4178 \def\guillemetright{>>}%
2799 \let\TeX=\indexdummytex 4179 \def\guilsinglleft{<}%
2800 \let\dots=\indexdummydots 4180 \def\guilsinglright{>}%
2801 \def\@{@}% 4181 \def\expansion{==>}%
2802 } 4182 \def\minus{-}%
2803 4183 \def\pounds{pounds}%
2804 % To define \realbackslash, we must make \ not be an escape. 4184 \def\point{.}%
2805 % We must first make another character (@) an escape 4185 \def\print{-|}%
2806 % so we do not become unable to do a definition. 4186 \def\quotedblbase{"}%
2807 4187 \def\quotedblleft{"}%
2808 {\catcode`\@=0 \catcode`\\=\other 4188 \def\quotedblright{"}%
2809 @gdef@realbackslash{\}} 4189 \def\quoteleft{`}%
4190 \def\quoteright{'}%
4191 \def\quotesinglbase{,}%
4192 \def\result{=>}%
4193 \def\textdegree{degrees}%
4194 %
4195 % We need to get rid of all macros, leaving only the arguments (if present).
4196 % Of course this is not nearly correct, but it is the best we can do for now.
4197 % makeinfo does not expand macros in the argument to @deffn, which ends up
4198 % writing an index entry, and texindex isn't prepared for an index sort entry
4199 % that starts with \.
4200 %
4201 % Since macro invocations are followed by braces, we can just redefine them
4202 % to take a single TeX argument. The case of a macro invocation that
4203 % goes to end-of-line is not handled.
4204 %
4205 \macrolist
4206 }
2810 4207
2811 \let\indexbackslash=0 %overridden during \printindex. 4208 \let\indexbackslash=0 %overridden during \printindex.
2812 \let\SETmarginindex=\relax % put index entries in margin (undocumented)? 4209 \let\SETmarginindex=\relax % put index entries in margin (undocumented)?
2813 4210
2814 % For \ifx comparisons.
2815 \def\emptymacro{\empty}
2816
2817 % Most index entries go through here, but \dosubind is the general case. 4211 % Most index entries go through here, but \dosubind is the general case.
2818 % 4212 % #1 is the index name, #2 is the entry text.
2819 \def\doind#1#2{\dosubind{#1}{#2}\empty} 4213 \def\doind#1#2{\dosubind{#1}{#2}{}}
2820 4214
2821 % Workhorse for all \fooindexes. 4215 % Workhorse for all \fooindexes.
2822 % #1 is name of index, #2 is stuff to put there, #3 is subentry -- 4216 % #1 is name of index, #2 is stuff to put there, #3 is subentry --
2823 % \empty if called from \doind, as we usually are. The main exception 4217 % empty if called from \doind, as we usually are (the main exception
2824 % is with defuns, which call us directly. 4218 % is with most defuns, which call us directly).
2825 % 4219 %
2826 \def\dosubind#1#2#3{% 4220 \def\dosubind#1#2#3{%
4221 \iflinks
4222 {%
4223 % Store the main index entry text (including the third arg).
4224 \toks0 = {#2}%
4225 % If third arg is present, precede it with a space.
4226 \def\thirdarg{#3}%
4227 \ifx\thirdarg\empty \else
4228 \toks0 = \expandafter{\the\toks0 \space #3}%
4229 \fi
4230 %
4231 \edef\writeto{\csname#1indfile\endcsname}%
4232 %
4233 \safewhatsit\dosubindwrite
4234 }%
4235 \fi
4236 }
4237
4238 % Write the entry in \toks0 to the index file:
4239 %
4240 \def\dosubindwrite{%
2827 % Put the index entry in the margin if desired. 4241 % Put the index entry in the margin if desired.
2828 \ifx\SETmarginindex\relax\else 4242 \ifx\SETmarginindex\relax\else
2829 \insert\margin{\hbox{\vrule height8pt depth3pt width0pt #2}}% 4243 \insert\margin{\hbox{\vrule height8pt depth3pt width0pt \the\toks0}}%
2830 \fi 4244 \fi
2831 {% 4245 %
2832 \count255=\lastpenalty 4246 % Remember, we are within a group.
2833 {% 4247 \indexdummies % Must do this here, since \bf, etc expand at this stage
2834 \indexdummies % Must do this here, since \bf, etc expand at this stage 4248 \def\backslashcurfont{\indexbackslash}% \indexbackslash isn't defined now
2835 \escapechar=`\\ 4249 % so it will be output as is; and it will print as backslash.
2836 {% 4250 %
2837 \let\folio = 0% We will expand all macros now EXCEPT \folio. 4251 % Process the index entry with all font commands turned off, to
2838 \def\rawbackslashxx{\indexbackslash}% \indexbackslash isn't defined now 4252 % get the string to sort by.
2839 % so it will be output as is; and it will print as backslash. 4253 {\indexnofonts
2840 % 4254 \edef\temp{\the\toks0}% need full expansion
2841 \def\thirdarg{#3}% 4255 \xdef\indexsorttmp{\temp}%
2842 %
2843 % If third arg is present, precede it with space in sort key.
2844 \ifx\thirdarg\emptymacro
2845 \let\subentry = \empty
2846 \else
2847 \def\subentry{ #3}%
2848 \fi
2849 %
2850 % First process the index entry with all font commands turned
2851 % off to get the string to sort by.
2852 {\indexnofonts \xdef\indexsorttmp{#2\subentry}}%
2853 %
2854 % Now the real index entry with the fonts.
2855 \toks0 = {#2}%
2856 %
2857 % If third (subentry) arg is present, add it to the index
2858 % string. And include a space.
2859 \ifx\thirdarg\emptymacro \else
2860 \toks0 = \expandafter{\the\toks0 \space #3}%
2861 \fi
2862 %
2863 % Set up the complete index entry, with both the sort key
2864 % and the original text, including any font commands. We write
2865 % three arguments to \entry to the .?? file, texindex reduces to
2866 % two when writing the .??s sorted result.
2867 \edef\temp{%
2868 \write\csname#1indfile\endcsname{%
2869 \realbackslash entry{\indexsorttmp}{\folio}{\the\toks0}}%
2870 }%
2871 %
2872 % If a skip is the last thing on the list now, preserve it
2873 % by backing up by \lastskip, doing the \write, then inserting
2874 % the skip again. Otherwise, the whatsit generated by the
2875 % \write will make \lastskip zero. The result is that sequences
2876 % like this:
2877 % @end defun
2878 % @tindex whatever
2879 % @defun ...
2880 % will have extra space inserted, because the \medbreak in the
2881 % start of the @defun won't see the skip inserted by the @end of
2882 % the previous defun.
2883 %
2884 % But don't do any of this if we're not in vertical mode. We
2885 % don't want to do a \vskip and prematurely end a paragraph.
2886 %
2887 % Avoid page breaks due to these extra skips, too.
2888 %
2889 \iflinks
2890 \ifvmode
2891 \skip0 = \lastskip
2892 \ifdim\lastskip = 0pt \else \nobreak\vskip-\lastskip \fi
2893 \fi
2894 %
2895 \temp % do the write
2896 %
2897 %
2898 \ifvmode \ifdim\skip0 = 0pt \else \nobreak\vskip\skip0 \fi \fi
2899 \fi
2900 }%
2901 }%
2902 \penalty\count255
2903 }% 4256 }%
4257 %
4258 % Set up the complete index entry, with both the sort key and
4259 % the original text, including any font commands. We write
4260 % three arguments to \entry to the .?? file (four in the
4261 % subentry case), texindex reduces to two when writing the .??s
4262 % sorted result.
4263 \edef\temp{%
4264 \write\writeto{%
4265 \string\entry{\indexsorttmp}{\noexpand\folio}{\the\toks0}}%
4266 }%
4267 \temp
4268 }
4269
4270 % Take care of unwanted page breaks/skips around a whatsit:
4271 %
4272 % If a skip is the last thing on the list now, preserve it
4273 % by backing up by \lastskip, doing the \write, then inserting
4274 % the skip again. Otherwise, the whatsit generated by the
4275 % \write or \pdfdest will make \lastskip zero. The result is that
4276 % sequences like this:
4277 % @end defun
4278 % @tindex whatever
4279 % @defun ...
4280 % will have extra space inserted, because the \medbreak in the
4281 % start of the @defun won't see the skip inserted by the @end of
4282 % the previous defun.
4283 %
4284 % But don't do any of this if we're not in vertical mode. We
4285 % don't want to do a \vskip and prematurely end a paragraph.
4286 %
4287 % Avoid page breaks due to these extra skips, too.
4288 %
4289 % But wait, there is a catch there:
4290 % We'll have to check whether \lastskip is zero skip. \ifdim is not
4291 % sufficient for this purpose, as it ignores stretch and shrink parts
4292 % of the skip. The only way seems to be to check the textual
4293 % representation of the skip.
4294 %
4295 % The following is almost like \def\zeroskipmacro{0.0pt} except that
4296 % the ``p'' and ``t'' characters have catcode \other, not 11 (letter).
4297 %
4298 \edef\zeroskipmacro{\expandafter\the\csname z@skip\endcsname}
4299 %
4300 \newskip\whatsitskip
4301 \newcount\whatsitpenalty
4302 %
4303 % ..., ready, GO:
4304 %
4305 \def\safewhatsit#1{%
4306 \ifhmode
4307 #1%
4308 \else
4309 % \lastskip and \lastpenalty cannot both be nonzero simultaneously.
4310 \whatsitskip = \lastskip
4311 \edef\lastskipmacro{\the\lastskip}%
4312 \whatsitpenalty = \lastpenalty
4313 %
4314 % If \lastskip is nonzero, that means the last item was a
4315 % skip. And since a skip is discardable, that means this
4316 % -\whatsitskip glue we're inserting is preceded by a
4317 % non-discardable item, therefore it is not a potential
4318 % breakpoint, therefore no \nobreak needed.
4319 \ifx\lastskipmacro\zeroskipmacro
4320 \else
4321 \vskip-\whatsitskip
4322 \fi
4323 %
4324 #1%
4325 %
4326 \ifx\lastskipmacro\zeroskipmacro
4327 % If \lastskip was zero, perhaps the last item was a penalty, and
4328 % perhaps it was >=10000, e.g., a \nobreak. In that case, we want
4329 % to re-insert the same penalty (values >10000 are used for various
4330 % signals); since we just inserted a non-discardable item, any
4331 % following glue (such as a \parskip) would be a breakpoint. For example:
4332 %
4333 % @deffn deffn-whatever
4334 % @vindex index-whatever
4335 % Description.
4336 % would allow a break between the index-whatever whatsit
4337 % and the "Description." paragraph.
4338 \ifnum\whatsitpenalty>9999 \penalty\whatsitpenalty \fi
4339 \else
4340 % On the other hand, if we had a nonzero \lastskip,
4341 % this make-up glue would be preceded by a non-discardable item
4342 % (the whatsit from the \write), so we must insert a \nobreak.
4343 \nobreak\vskip\whatsitskip
4344 \fi
4345 \fi
2904 } 4346 }
2905 4347
2906 % The index entry written in the file actually looks like 4348 % The index entry written in the file actually looks like
2907 % \entry {sortstring}{page}{topic} 4349 % \entry {sortstring}{page}{topic}
2908 % or 4350 % or
2936 % Define the macros used in formatting output of the sorted index material. 4378 % Define the macros used in formatting output of the sorted index material.
2937 4379
2938 % @printindex causes a particular index (the ??s file) to get printed. 4380 % @printindex causes a particular index (the ??s file) to get printed.
2939 % It does not print any chapter heading (usually an @unnumbered). 4381 % It does not print any chapter heading (usually an @unnumbered).
2940 % 4382 %
2941 \def\printindex{\parsearg\doprintindex} 4383 \parseargdef\printindex{\begingroup
2942 \def\doprintindex#1{\begingroup
2943 \dobreak \chapheadingskip{10000}% 4384 \dobreak \chapheadingskip{10000}%
2944 % 4385 %
2945 \smallfonts \rm 4386 \smallfonts \rm
2946 \tolerance = 9500 4387 \tolerance = 9500
2947 \indexbreaks 4388 \plainfrenchspacing
4389 \everypar = {}% don't want the \kern\-parindent from indentation suppression.
2948 % 4390 %
2949 % See if the index file exists and is nonempty. 4391 % See if the index file exists and is nonempty.
2950 % Change catcode of @ here so that if the index file contains 4392 % Change catcode of @ here so that if the index file contains
2951 % \initial {@} 4393 % \initial {@}
2952 % as its first line, TeX doesn't complain about mismatched braces 4394 % as its first line, TeX doesn't complain about mismatched braces
2969 \putwordIndexIsEmpty 4411 \putwordIndexIsEmpty
2970 \else 4412 \else
2971 % Index files are almost Texinfo source, but we use \ as the escape 4413 % Index files are almost Texinfo source, but we use \ as the escape
2972 % character. It would be better to use @, but that's too big a change 4414 % character. It would be better to use @, but that's too big a change
2973 % to make right now. 4415 % to make right now.
2974 \def\indexbackslash{\rawbackslashxx}% 4416 \def\indexbackslash{\backslashcurfont}%
2975 \catcode`\\ = 0 4417 \catcode`\\ = 0
2976 \escapechar = `\\ 4418 \escapechar = `\\
2977 \begindoublecolumns 4419 \begindoublecolumns
2978 \input \jobname.#1s 4420 \input \jobname.#1s
2979 \enddoublecolumns 4421 \enddoublecolumns
2991 % 4433 %
2992 % Remove any glue we may have, we'll be inserting our own. 4434 % Remove any glue we may have, we'll be inserting our own.
2993 \removelastskip 4435 \removelastskip
2994 % 4436 %
2995 % We like breaks before the index initials, so insert a bonus. 4437 % We like breaks before the index initials, so insert a bonus.
2996 \penalty -300 4438 \nobreak
4439 \vskip 0pt plus 3\baselineskip
4440 \penalty 0
4441 \vskip 0pt plus -3\baselineskip
2997 % 4442 %
2998 % Typeset the initial. Making this add up to a whole number of 4443 % Typeset the initial. Making this add up to a whole number of
2999 % baselineskips increases the chance of the dots lining up from column 4444 % baselineskips increases the chance of the dots lining up from column
3000 % to column. It still won't often be perfect, because of the stretch 4445 % to column. It still won't often be perfect, because of the stretch
3001 % we need before each entry, but it's better. 4446 % we need before each entry, but it's better.
3002 % 4447 %
3003 % No shrink because it confuses \balancecolumns. 4448 % No shrink because it confuses \balancecolumns.
3004 \vskip 1.67\baselineskip plus .5\baselineskip 4449 \vskip 1.67\baselineskip plus .5\baselineskip
3005 \leftline{\secbf #1}% 4450 \leftline{\secbf #1}%
3006 \vskip .33\baselineskip plus .1\baselineskip
3007 %
3008 % Do our best not to break after the initial. 4451 % Do our best not to break after the initial.
3009 \nobreak 4452 \nobreak
4453 \vskip .33\baselineskip plus .1\baselineskip
3010 }} 4454 }}
3011 4455
3012 % This typesets a paragraph consisting of #1, dot leaders, and then #2 4456 % \entry typesets a paragraph consisting of the text (#1), dot leaders, and
3013 % flush to the right margin. It is used for index and table of contents 4457 % then page number (#2) flushed to the right margin. It is used for index
3014 % entries. The paragraph is indented by \leftskip. 4458 % and table of contents entries. The paragraph is indented by \leftskip.
3015 % 4459 %
3016 \def\entry#1#2{\begingroup 4460 % A straightforward implementation would start like this:
3017 % 4461 % \def\entry#1#2{...
3018 % Start a new paragraph if necessary, so our assignments below can't 4462 % But this freezes the catcodes in the argument, and can cause problems to
3019 % affect previous text. 4463 % @code, which sets - active. This problem was fixed by a kludge---
4464 % ``-'' was active throughout whole index, but this isn't really right.
4465 %
4466 % The right solution is to prevent \entry from swallowing the whole text.
4467 % --kasal, 21nov03
4468 \def\entry{%
4469 \begingroup
4470 %
4471 % Start a new paragraph if necessary, so our assignments below can't
4472 % affect previous text.
4473 \par
4474 %
4475 % Do not fill out the last line with white space.
4476 \parfillskip = 0in
4477 %
4478 % No extra space above this paragraph.
4479 \parskip = 0in
4480 %
4481 % Do not prefer a separate line ending with a hyphen to fewer lines.
4482 \finalhyphendemerits = 0
4483 %
4484 % \hangindent is only relevant when the entry text and page number
4485 % don't both fit on one line. In that case, bob suggests starting the
4486 % dots pretty far over on the line. Unfortunately, a large
4487 % indentation looks wrong when the entry text itself is broken across
4488 % lines. So we use a small indentation and put up with long leaders.
4489 %
4490 % \hangafter is reset to 1 (which is the value we want) at the start
4491 % of each paragraph, so we need not do anything with that.
4492 \hangindent = 2em
4493 %
4494 % When the entry text needs to be broken, just fill out the first line
4495 % with blank space.
4496 \rightskip = 0pt plus1fil
4497 %
4498 % A bit of stretch before each entry for the benefit of balancing
4499 % columns.
4500 \vskip 0pt plus1pt
4501 %
4502 % Swallow the left brace of the text (first parameter):
4503 \afterassignment\doentry
4504 \let\temp =
4505 }
4506 \def\doentry{%
4507 \bgroup % Instead of the swallowed brace.
4508 \noindent
4509 \aftergroup\finishentry
4510 % And now comes the text of the entry.
4511 }
4512 \def\finishentry#1{%
4513 % #1 is the page number.
4514 %
4515 % The following is kludged to not output a line of dots in the index if
4516 % there are no page numbers. The next person who breaks this will be
4517 % cursed by a Unix daemon.
4518 \setbox\boxA = \hbox{#1}%
4519 \ifdim\wd\boxA = 0pt
4520 \ %
4521 \else
4522 %
4523 % If we must, put the page number on a line of its own, and fill out
4524 % this line with blank space. (The \hfil is overwhelmed with the
4525 % fill leaders glue in \indexdotfill if the page number does fit.)
4526 \hfil\penalty50
4527 \null\nobreak\indexdotfill % Have leaders before the page number.
4528 %
4529 % The `\ ' here is removed by the implicit \unskip that TeX does as
4530 % part of (the primitive) \par. Without it, a spurious underfull
4531 % \hbox ensues.
4532 \ifpdf
4533 \pdfgettoks#1.%
4534 \ \the\toksA
4535 \else
4536 \ #1%
4537 \fi
4538 \fi
4539 \par
4540 \endgroup
4541 }
4542
4543 % Like plain.tex's \dotfill, except uses up at least 1 em.
4544 \def\indexdotfill{\cleaders
4545 \hbox{$\mathsurround=0pt \mkern1.5mu.\mkern1.5mu$}\hskip 1em plus 1fill}
4546
4547 \def\primary #1{\line{#1\hfil}}
4548
4549 \newskip\secondaryindent \secondaryindent=0.5cm
4550 \def\secondary#1#2{{%
4551 \parfillskip=0in
4552 \parskip=0in
4553 \hangindent=1in
4554 \hangafter=1
4555 \noindent\hskip\secondaryindent\hbox{#1}\indexdotfill
4556 \ifpdf
4557 \pdfgettoks#2.\ \the\toksA % The page number ends the paragraph.
4558 \else
4559 #2
4560 \fi
3020 \par 4561 \par
3021 %
3022 % Do not fill out the last line with white space.
3023 \parfillskip = 0in
3024 %
3025 % No extra space above this paragraph.
3026 \parskip = 0in
3027 %
3028 % Do not prefer a separate line ending with a hyphen to fewer lines.
3029 \finalhyphendemerits = 0
3030 %
3031 % \hangindent is only relevant when the entry text and page number
3032 % don't both fit on one line. In that case, bob suggests starting the
3033 % dots pretty far over on the line. Unfortunately, a large
3034 % indentation looks wrong when the entry text itself is broken across
3035 % lines. So we use a small indentation and put up with long leaders.
3036 %
3037 % \hangafter is reset to 1 (which is the value we want) at the start
3038 % of each paragraph, so we need not do anything with that.
3039 \hangindent = 2em
3040 %
3041 % When the entry text needs to be broken, just fill out the first line
3042 % with blank space.
3043 \rightskip = 0pt plus1fil
3044 %
3045 % A bit of stretch before each entry for the benefit of balancing columns.
3046 \vskip 0pt plus1pt
3047 %
3048 % Start a ``paragraph'' for the index entry so the line breaking
3049 % parameters we've set above will have an effect.
3050 \noindent
3051 %
3052 % Insert the text of the index entry. TeX will do line-breaking on it.
3053 #1%
3054 % The following is kludged to not output a line of dots in the index if
3055 % there are no page numbers. The next person who breaks this will be
3056 % cursed by a Unix daemon.
3057 \def\tempa{{\rm }}%
3058 \def\tempb{#2}%
3059 \edef\tempc{\tempa}%
3060 \edef\tempd{\tempb}%
3061 \ifx\tempc\tempd\ \else%
3062 %
3063 % If we must, put the page number on a line of its own, and fill out
3064 % this line with blank space. (The \hfil is overwhelmed with the
3065 % fill leaders glue in \indexdotfill if the page number does fit.)
3066 \hfil\penalty50
3067 \null\nobreak\indexdotfill % Have leaders before the page number.
3068 %
3069 % The `\ ' here is removed by the implicit \unskip that TeX does as
3070 % part of (the primitive) \par. Without it, a spurious underfull
3071 % \hbox ensues.
3072 \ifpdf
3073 \pdfgettoks#2.\ \the\toksA % The page number ends the paragraph.
3074 \else
3075 \ #2% The page number ends the paragraph.
3076 \fi
3077 \fi%
3078 \par
3079 \endgroup}
3080
3081 % Like \dotfill except takes at least 1 em.
3082 \def\indexdotfill{\cleaders
3083 \hbox{$\mathsurround=0pt \mkern1.5mu ${\it .}$ \mkern1.5mu$}\hskip 1em plus 1fill}
3084
3085 \def\primary #1{\line{#1\hfil}}
3086
3087 \newskip\secondaryindent \secondaryindent=0.5cm
3088
3089 \def\secondary #1#2{
3090 {\parfillskip=0in \parskip=0in
3091 \hangindent =1in \hangafter=1
3092 \noindent\hskip\secondaryindent\hbox{#1}\indexdotfill #2\par
3093 }} 4562 }}
3094 4563
3095 % Define two-column mode, which we use to typeset indexes. 4564 % Define two-column mode, which we use to typeset indexes.
3096 % Adapted from the TeXbook, page 416, which is to say, 4565 % Adapted from the TeXbook, page 416, which is to say,
3097 % the manmac.tex format used to print the TeXbook itself. 4566 % the manmac.tex format used to print the TeXbook itself.
3147 \divide\doublecolumnhsize by 2 4616 \divide\doublecolumnhsize by 2
3148 \hsize = \doublecolumnhsize 4617 \hsize = \doublecolumnhsize
3149 % 4618 %
3150 % Double the \vsize as well. (We don't need a separate register here, 4619 % Double the \vsize as well. (We don't need a separate register here,
3151 % since nobody clobbers \vsize.) 4620 % since nobody clobbers \vsize.)
3152 \advance\vsize by -\ht\partialpage
3153 \vsize = 2\vsize 4621 \vsize = 2\vsize
3154 } 4622 }
3155 4623
3156 % The double-column output routine for all double-column pages except 4624 % The double-column output routine for all double-column pages except
3157 % the last. 4625 % the last.
3161 % Get the available space for the double columns -- the normal 4629 % Get the available space for the double columns -- the normal
3162 % (undoubled) page height minus any material left over from the 4630 % (undoubled) page height minus any material left over from the
3163 % previous page. 4631 % previous page.
3164 \dimen@ = \vsize 4632 \dimen@ = \vsize
3165 \divide\dimen@ by 2 4633 \divide\dimen@ by 2
4634 \advance\dimen@ by -\ht\partialpage
3166 % 4635 %
3167 % box0 will be the left-hand column, box2 the right. 4636 % box0 will be the left-hand column, box2 the right.
3168 \setbox0=\vsplit255 to\dimen@ \setbox2=\vsplit255 to\dimen@ 4637 \setbox0=\vsplit255 to\dimen@ \setbox2=\vsplit255 to\dimen@
3169 \onepageout\pagesofar 4638 \onepageout\pagesofar
3170 \unvbox255 4639 \unvbox255
3171 \penalty\outputpenalty 4640 \penalty\outputpenalty
3172 } 4641 }
4642 %
4643 % Re-output the contents of the output page -- any previous material,
4644 % followed by the two boxes we just split, in box0 and box2.
3173 \def\pagesofar{% 4645 \def\pagesofar{%
3174 % Re-output the contents of the output page -- any previous material,
3175 % followed by the two boxes we just split, in box0 and box2.
3176 \unvbox\partialpage 4646 \unvbox\partialpage
3177 % 4647 %
3178 \hsize = \doublecolumnhsize 4648 \hsize = \doublecolumnhsize
3179 \wd0=\hsize \wd2=\hsize 4649 \wd0=\hsize \wd2=\hsize
3180 \hbox to\pagewidth{\box0\hfil\box2}% 4650 \hbox to\pagewidth{\box0\hfil\box2}%
3181 } 4651 }
4652 %
4653 % All done with double columns.
3182 \def\enddoublecolumns{% 4654 \def\enddoublecolumns{%
4655 % The following penalty ensures that the page builder is exercised
4656 % _before_ we change the output routine. This is necessary in the
4657 % following situation:
4658 %
4659 % The last section of the index consists only of a single entry.
4660 % Before this section, \pagetotal is less than \pagegoal, so no
4661 % break occurs before the last section starts. However, the last
4662 % section, consisting of \initial and the single \entry, does not
4663 % fit on the page and has to be broken off. Without the following
4664 % penalty the page builder will not be exercised until \eject
4665 % below, and by that time we'll already have changed the output
4666 % routine to the \balancecolumns version, so the next-to-last
4667 % double-column page will be processed with \balancecolumns, which
4668 % is wrong: The two columns will go to the main vertical list, with
4669 % the broken-off section in the recent contributions. As soon as
4670 % the output routine finishes, TeX starts reconsidering the page
4671 % break. The two columns and the broken-off section both fit on the
4672 % page, because the two columns now take up only half of the page
4673 % goal. When TeX sees \eject from below which follows the final
4674 % section, it invokes the new output routine that we've set after
4675 % \balancecolumns below; \onepageout will try to fit the two columns
4676 % and the final section into the vbox of \pageheight (see
4677 % \pagebody), causing an overfull box.
4678 %
4679 % Note that glue won't work here, because glue does not exercise the
4680 % page builder, unlike penalties (see The TeXbook, pp. 280-281).
4681 \penalty0
4682 %
3183 \output = {% 4683 \output = {%
3184 % Split the last of the double-column material. Leave it on the 4684 % Split the last of the double-column material. Leave it on the
3185 % current page, no automatic page break. 4685 % current page, no automatic page break.
3186 \balancecolumns 4686 \balancecolumns
3187 % 4687 %
3201 % the current page. We're now back to normal single-column 4701 % the current page. We're now back to normal single-column
3202 % typesetting, so reset \pagegoal to the normal \vsize (after the 4702 % typesetting, so reset \pagegoal to the normal \vsize (after the
3203 % \endgroup where \vsize got restored). 4703 % \endgroup where \vsize got restored).
3204 \pagegoal = \vsize 4704 \pagegoal = \vsize
3205 } 4705 }
4706 %
4707 % Called at the end of the double column material.
3206 \def\balancecolumns{% 4708 \def\balancecolumns{%
3207 % Called at the end of the double column material.
3208 \setbox0 = \vbox{\unvbox255}% like \box255 but more efficient, see p.120. 4709 \setbox0 = \vbox{\unvbox255}% like \box255 but more efficient, see p.120.
3209 \dimen@ = \ht0 4710 \dimen@ = \ht0
3210 \advance\dimen@ by \topskip 4711 \advance\dimen@ by \topskip
3211 \advance\dimen@ by-\baselineskip 4712 \advance\dimen@ by-\baselineskip
3212 \divide\dimen@ by 2 % target to split to 4713 \divide\dimen@ by 2 % target to split to
3232 4733
3233 4734
3234 \message{sectioning,} 4735 \message{sectioning,}
3235 % Chapters, sections, etc. 4736 % Chapters, sections, etc.
3236 4737
4738 % \unnumberedno is an oxymoron, of course. But we count the unnumbered
4739 % sections so that we can refer to them unambiguously in the pdf
4740 % outlines by their "section number". We avoid collisions with chapter
4741 % numbers by starting them at 10000. (If a document ever has 10000
4742 % chapters, we're in trouble anyway, I'm sure.)
4743 \newcount\unnumberedno \unnumberedno = 10000
3237 \newcount\chapno 4744 \newcount\chapno
3238 \newcount\secno \secno=0 4745 \newcount\secno \secno=0
3239 \newcount\subsecno \subsecno=0 4746 \newcount\subsecno \subsecno=0
3240 \newcount\subsubsecno \subsubsecno=0 4747 \newcount\subsubsecno \subsubsecno=0
3241 4748
3242 % This counter is funny since it counts through charcodes of letters A, B, ... 4749 % This counter is funny since it counts through charcodes of letters A, B, ...
3243 \newcount\appendixno \appendixno = `\@ 4750 \newcount\appendixno \appendixno = `\@
4751 %
3244 % \def\appendixletter{\char\the\appendixno} 4752 % \def\appendixletter{\char\the\appendixno}
3245 % We do the following for the sake of pdftex, which needs the actual 4753 % We do the following ugly conditional instead of the above simple
4754 % construct for the sake of pdftex, which needs the actual
3246 % letter in the expansion, not just typeset. 4755 % letter in the expansion, not just typeset.
4756 %
3247 \def\appendixletter{% 4757 \def\appendixletter{%
3248 \ifnum\appendixno=`A A% 4758 \ifnum\appendixno=`A A%
3249 \else\ifnum\appendixno=`B B% 4759 \else\ifnum\appendixno=`B B%
3250 \else\ifnum\appendixno=`C C% 4760 \else\ifnum\appendixno=`C C%
3251 \else\ifnum\appendixno=`D D% 4761 \else\ifnum\appendixno=`D D%
3277 % with the same letter (or @) in the toc without it. 4787 % with the same letter (or @) in the toc without it.
3278 \else\char\the\appendixno 4788 \else\char\the\appendixno
3279 \fi\fi\fi\fi\fi\fi\fi\fi\fi\fi\fi\fi\fi 4789 \fi\fi\fi\fi\fi\fi\fi\fi\fi\fi\fi\fi\fi
3280 \fi\fi\fi\fi\fi\fi\fi\fi\fi\fi\fi\fi\fi} 4790 \fi\fi\fi\fi\fi\fi\fi\fi\fi\fi\fi\fi\fi}
3281 4791
3282 % Each @chapter defines this as the name of the chapter. 4792 % Each @chapter defines these (using marks) as the number+name, number
3283 % page headings and footings can use it. @section does likewise. 4793 % and name of the chapter. Page headings and footings can use
4794 % these. @section does likewise.
3284 \def\thischapter{} 4795 \def\thischapter{}
4796 \def\thischapternum{}
4797 \def\thischaptername{}
3285 \def\thissection{} 4798 \def\thissection{}
4799 \def\thissectionnum{}
4800 \def\thissectionname{}
3286 4801
3287 \newcount\absseclevel % used to calculate proper heading level 4802 \newcount\absseclevel % used to calculate proper heading level
3288 \newcount\secbase\secbase=0 % @raise/lowersections modify this count 4803 \newcount\secbase\secbase=0 % @raisesections/@lowersections modify this count
3289 4804
3290 % @raisesections: treat @section as chapter, @subsection as section, etc. 4805 % @raisesections: treat @section as chapter, @subsection as section, etc.
3291 \def\raisesections{\global\advance\secbase by -1} 4806 \def\raisesections{\global\advance\secbase by -1}
3292 \let\up=\raisesections % original BFox name 4807 \let\up=\raisesections % original BFox name
3293 4808
3294 % @lowersections: treat @chapter as section, @section as subsection, etc. 4809 % @lowersections: treat @chapter as section, @section as subsection, etc.
3295 \def\lowersections{\global\advance\secbase by 1} 4810 \def\lowersections{\global\advance\secbase by 1}
3296 \let\down=\lowersections % original BFox name 4811 \let\down=\lowersections % original BFox name
3297 4812
3298 % Choose a numbered-heading macro 4813 % we only have subsub.
3299 % #1 is heading level if unmodified by @raisesections or @lowersections 4814 \chardef\maxseclevel = 3
3300 % #2 is text for heading 4815 %
3301 \def\numhead#1#2{\absseclevel=\secbase\advance\absseclevel by #1 4816 % A numbered section within an unnumbered changes to unnumbered too.
3302 \ifcase\absseclevel 4817 % To achive this, remember the "biggest" unnum. sec. we are currently in:
3303 \chapterzzz{#2} 4818 \chardef\unmlevel = \maxseclevel
3304 \or 4819 %
3305 \seczzz{#2} 4820 % Trace whether the current chapter is an appendix or not:
3306 \or 4821 % \chapheadtype is "N" or "A", unnumbered chapters are ignored.
3307 \numberedsubseczzz{#2} 4822 \def\chapheadtype{N}
3308 \or 4823
3309 \numberedsubsubseczzz{#2} 4824 % Choose a heading macro
3310 \else 4825 % #1 is heading type
3311 \ifnum \absseclevel<0 4826 % #2 is heading level
3312 \chapterzzz{#2} 4827 % #3 is text for heading
4828 \def\genhead#1#2#3{%
4829 % Compute the abs. sec. level:
4830 \absseclevel=#2
4831 \advance\absseclevel by \secbase
4832 % Make sure \absseclevel doesn't fall outside the range:
4833 \ifnum \absseclevel < 0
4834 \absseclevel = 0
3313 \else 4835 \else
3314 \numberedsubsubseczzz{#2} 4836 \ifnum \absseclevel > 3
4837 \absseclevel = 3
4838 \fi
3315 \fi 4839 \fi
3316 \fi 4840 % The heading type:
3317 } 4841 \def\headtype{#1}%
3318 4842 \if \headtype U%
3319 % like \numhead, but chooses appendix heading levels 4843 \ifnum \absseclevel < \unmlevel
3320 \def\apphead#1#2{\absseclevel=\secbase\advance\absseclevel by #1 4844 \chardef\unmlevel = \absseclevel
3321 \ifcase\absseclevel 4845 \fi
3322 \appendixzzz{#2}
3323 \or
3324 \appendixsectionzzz{#2}
3325 \or
3326 \appendixsubseczzz{#2}
3327 \or
3328 \appendixsubsubseczzz{#2}
3329 \else
3330 \ifnum \absseclevel<0
3331 \appendixzzz{#2}
3332 \else 4846 \else
3333 \appendixsubsubseczzz{#2} 4847 % Check for appendix sections:
4848 \ifnum \absseclevel = 0
4849 \edef\chapheadtype{\headtype}%
4850 \else
4851 \if \headtype A\if \chapheadtype N%
4852 \errmessage{@appendix... within a non-appendix chapter}%
4853 \fi\fi
4854 \fi
4855 % Check for numbered within unnumbered:
4856 \ifnum \absseclevel > \unmlevel
4857 \def\headtype{U}%
4858 \else
4859 \chardef\unmlevel = 3
4860 \fi
3334 \fi 4861 \fi
3335 \fi 4862 % Now print the heading:
3336 } 4863 \if \headtype U%
3337 4864 \ifcase\absseclevel
3338 % like \numhead, but chooses numberless heading levels 4865 \unnumberedzzz{#3}%
3339 \def\unnmhead#1#2{\absseclevel=\secbase\advance\absseclevel by #1 4866 \or \unnumberedseczzz{#3}%
3340 \ifcase\absseclevel 4867 \or \unnumberedsubseczzz{#3}%
3341 \unnumberedzzz{#2} 4868 \or \unnumberedsubsubseczzz{#3}%
3342 \or 4869 \fi
3343 \unnumberedseczzz{#2}
3344 \or
3345 \unnumberedsubseczzz{#2}
3346 \or
3347 \unnumberedsubsubseczzz{#2}
3348 \else
3349 \ifnum \absseclevel<0
3350 \unnumberedzzz{#2}
3351 \else 4870 \else
3352 \unnumberedsubsubseczzz{#2} 4871 \if \headtype A%
4872 \ifcase\absseclevel
4873 \appendixzzz{#3}%
4874 \or \appendixsectionzzz{#3}%
4875 \or \appendixsubseczzz{#3}%
4876 \or \appendixsubsubseczzz{#3}%
4877 \fi
4878 \else
4879 \ifcase\absseclevel
4880 \chapterzzz{#3}%
4881 \or \seczzz{#3}%
4882 \or \numberedsubseczzz{#3}%
4883 \or \numberedsubsubseczzz{#3}%
4884 \fi
4885 \fi
3353 \fi 4886 \fi
3354 \fi 4887 \suppressfirstparagraphindent
3355 } 4888 }
3356 4889
3357 % @chapter, @appendix, @unnumbered. 4890 % an interface:
3358 \def\thischaptername{No Chapter Title} 4891 \def\numhead{\genhead N}
3359 \outer\def\chapter{\parsearg\chapteryyy} 4892 \def\apphead{\genhead A}
3360 \def\chapteryyy #1{\numhead0{#1}} % normally numhead0 calls chapterzzz 4893 \def\unnmhead{\genhead U}
3361 \def\chapterzzz #1{% 4894
3362 \secno=0 \subsecno=0 \subsubsecno=0 4895 % @chapter, @appendix, @unnumbered. Increment top-level counter, reset
3363 \global\advance \chapno by 1 \message{\putwordChapter\space \the\chapno}% 4896 % all lower-level sectioning counters to zero.
3364 \chapmacro {#1}{\the\chapno}% 4897 %
3365 \gdef\thissection{#1}% 4898 % Also set \chaplevelprefix, which we prepend to @float sequence numbers
3366 \gdef\thischaptername{#1}% 4899 % (e.g., figures), q.v. By default (before any chapter), that is empty.
3367 % We don't substitute the actual chapter name into \thischapter 4900 \let\chaplevelprefix = \empty
3368 % because we don't want its macros evaluated now. 4901 %
3369 \xdef\thischapter{\putwordChapter{} \the\chapno: \noexpand\thischaptername}% 4902 \outer\parseargdef\chapter{\numhead0{#1}} % normally numhead0 calls chapterzzz
3370 \toks0 = {#1}% 4903 \def\chapterzzz#1{%
3371 \edef\temp{\noexpand\writetocentry{\realbackslash chapentry{\the\toks0}% 4904 % section resetting is \global in case the chapter is in a group, such
3372 {\the\chapno}}}% 4905 % as an @include file.
3373 \temp 4906 \global\secno=0 \global\subsecno=0 \global\subsubsecno=0
3374 \donoderef 4907 \global\advance\chapno by 1
3375 \global\let\section = \numberedsec 4908 %
3376 \global\let\subsection = \numberedsubsec 4909 % Used for \float.
3377 \global\let\subsubsection = \numberedsubsubsec 4910 \gdef\chaplevelprefix{\the\chapno.}%
3378 } 4911 \resetallfloatnos
3379 4912 %
3380 \outer\def\appendix{\parsearg\appendixyyy} 4913 \message{\putwordChapter\space \the\chapno}%
3381 \def\appendixyyy #1{\apphead0{#1}} % normally apphead0 calls appendixzzz 4914 %
3382 \def\appendixzzz #1{% 4915 % Write the actual heading.
3383 \secno=0 \subsecno=0 \subsubsecno=0 4916 \chapmacro{#1}{Ynumbered}{\the\chapno}%
3384 \global\advance \appendixno by 1 4917 %
3385 \message{\putwordAppendix\space \appendixletter}% 4918 % So @section and the like are numbered underneath this chapter.
3386 \chapmacro {#1}{\putwordAppendix{} \appendixletter}% 4919 \global\let\section = \numberedsec
3387 \gdef\thissection{#1}% 4920 \global\let\subsection = \numberedsubsec
3388 \gdef\thischaptername{#1}% 4921 \global\let\subsubsection = \numberedsubsubsec
3389 \xdef\thischapter{\putwordAppendix{} \appendixletter: \noexpand\thischaptername}% 4922 }
3390 \toks0 = {#1}% 4923
3391 \edef\temp{\noexpand\writetocentry{\realbackslash chapentry{\the\toks0}% 4924 \outer\parseargdef\appendix{\apphead0{#1}} % normally apphead0 calls appendixzzz
3392 {\putwordAppendix{} \appendixletter}}}% 4925 \def\appendixzzz#1{%
3393 \temp 4926 \global\secno=0 \global\subsecno=0 \global\subsubsecno=0
3394 \appendixnoderef 4927 \global\advance\appendixno by 1
3395 \global\let\section = \appendixsec 4928 \gdef\chaplevelprefix{\appendixletter.}%
3396 \global\let\subsection = \appendixsubsec 4929 \resetallfloatnos
3397 \global\let\subsubsection = \appendixsubsubsec 4930 %
4931 \def\appendixnum{\putwordAppendix\space \appendixletter}%
4932 \message{\appendixnum}%
4933 %
4934 \chapmacro{#1}{Yappendix}{\appendixletter}%
4935 %
4936 \global\let\section = \appendixsec
4937 \global\let\subsection = \appendixsubsec
4938 \global\let\subsubsection = \appendixsubsubsec
4939 }
4940
4941 \outer\parseargdef\unnumbered{\unnmhead0{#1}} % normally unnmhead0 calls unnumberedzzz
4942 \def\unnumberedzzz#1{%
4943 \global\secno=0 \global\subsecno=0 \global\subsubsecno=0
4944 \global\advance\unnumberedno by 1
4945 %
4946 % Since an unnumbered has no number, no prefix for figures.
4947 \global\let\chaplevelprefix = \empty
4948 \resetallfloatnos
4949 %
4950 % This used to be simply \message{#1}, but TeX fully expands the
4951 % argument to \message. Therefore, if #1 contained @-commands, TeX
4952 % expanded them. For example, in `@unnumbered The @cite{Book}', TeX
4953 % expanded @cite (which turns out to cause errors because \cite is meant
4954 % to be executed, not expanded).
4955 %
4956 % Anyway, we don't want the fully-expanded definition of @cite to appear
4957 % as a result of the \message, we just want `@cite' itself. We use
4958 % \the<toks register> to achieve this: TeX expands \the<toks> only once,
4959 % simply yielding the contents of <toks register>. (We also do this for
4960 % the toc entries.)
4961 \toks0 = {#1}%
4962 \message{(\the\toks0)}%
4963 %
4964 \chapmacro{#1}{Ynothing}{\the\unnumberedno}%
4965 %
4966 \global\let\section = \unnumberedsec
4967 \global\let\subsection = \unnumberedsubsec
4968 \global\let\subsubsection = \unnumberedsubsubsec
3398 } 4969 }
3399 4970
3400 % @centerchap is like @unnumbered, but the heading is centered. 4971 % @centerchap is like @unnumbered, but the heading is centered.
3401 \outer\def\centerchap{\parsearg\centerchapyyy} 4972 \outer\parseargdef\centerchap{%
3402 \def\centerchapyyy #1{{\let\unnumbchapmacro=\centerchapmacro \unnumberedyyy{#1}}} 4973 % Well, we could do the following in a group, but that would break
4974 % an assumption that \chapmacro is called at the outermost level.
4975 % Thus we are safer this way: --kasal, 24feb04
4976 \let\centerparametersmaybe = \centerparameters
4977 \unnmhead0{#1}%
4978 \let\centerparametersmaybe = \relax
4979 }
3403 4980
3404 % @top is like @unnumbered. 4981 % @top is like @unnumbered.
3405 \outer\def\top{\parsearg\unnumberedyyy} 4982 \let\top\unnumbered
3406
3407 \outer\def\unnumbered{\parsearg\unnumberedyyy}
3408 \def\unnumberedyyy #1{\unnmhead0{#1}} % normally unnmhead0 calls unnumberedzzz
3409 \def\unnumberedzzz #1{%
3410 \secno=0 \subsecno=0 \subsubsecno=0
3411 %
3412 % This used to be simply \message{#1}, but TeX fully expands the
3413 % argument to \message. Therefore, if #1 contained @-commands, TeX
3414 % expanded them. For example, in `@unnumbered The @cite{Book}', TeX
3415 % expanded @cite (which turns out to cause errors because \cite is meant
3416 % to be executed, not expanded).
3417 %
3418 % Anyway, we don't want the fully-expanded definition of @cite to appear
3419 % as a result of the \message, we just want `@cite' itself. We use
3420 % \the<toks register> to achieve this: TeX expands \the<toks> only once,
3421 % simply yielding the contents of <toks register>. (We also do this for
3422 % the toc entries.)
3423 \toks0 = {#1}\message{(\the\toks0)}%
3424 %
3425 \unnumbchapmacro {#1}%
3426 \gdef\thischapter{#1}\gdef\thissection{#1}%
3427 \toks0 = {#1}%
3428 \edef\temp{\noexpand\writetocentry{\realbackslash unnumbchapentry{\the\toks0}}}%
3429 \temp
3430 \unnumbnoderef
3431 \global\let\section = \unnumberedsec
3432 \global\let\subsection = \unnumberedsubsec
3433 \global\let\subsubsection = \unnumberedsubsubsec
3434 }
3435 4983
3436 % Sections. 4984 % Sections.
3437 \outer\def\numberedsec{\parsearg\secyyy} 4985 \outer\parseargdef\numberedsec{\numhead1{#1}} % normally calls seczzz
3438 \def\secyyy #1{\numhead1{#1}} % normally calls seczzz 4986 \def\seczzz#1{%
3439 \def\seczzz #1{% 4987 \global\subsecno=0 \global\subsubsecno=0 \global\advance\secno by 1
3440 \subsecno=0 \subsubsecno=0 \global\advance \secno by 1 % 4988 \sectionheading{#1}{sec}{Ynumbered}{\the\chapno.\the\secno}%
3441 \gdef\thissection{#1}\secheading {#1}{\the\chapno}{\the\secno}% 4989 }
3442 \toks0 = {#1}% 4990
3443 \edef\temp{\noexpand\writetocentry{\realbackslash secentry{\the\toks0}% 4991 \outer\parseargdef\appendixsection{\apphead1{#1}} % normally calls appendixsectionzzz
3444 {\the\chapno}{\the\secno}}}% 4992 \def\appendixsectionzzz#1{%
3445 \temp 4993 \global\subsecno=0 \global\subsubsecno=0 \global\advance\secno by 1
3446 \donoderef 4994 \sectionheading{#1}{sec}{Yappendix}{\appendixletter.\the\secno}%
3447 \nobreak 4995 }
3448 } 4996 \let\appendixsec\appendixsection
3449 4997
3450 \outer\def\appendixsection{\parsearg\appendixsecyyy} 4998 \outer\parseargdef\unnumberedsec{\unnmhead1{#1}} % normally calls unnumberedseczzz
3451 \outer\def\appendixsec{\parsearg\appendixsecyyy} 4999 \def\unnumberedseczzz#1{%
3452 \def\appendixsecyyy #1{\apphead1{#1}} % normally calls appendixsectionzzz 5000 \global\subsecno=0 \global\subsubsecno=0 \global\advance\secno by 1
3453 \def\appendixsectionzzz #1{% 5001 \sectionheading{#1}{sec}{Ynothing}{\the\unnumberedno.\the\secno}%
3454 \subsecno=0 \subsubsecno=0 \global\advance \secno by 1 %
3455 \gdef\thissection{#1}\secheading {#1}{\appendixletter}{\the\secno}%
3456 \toks0 = {#1}%
3457 \edef\temp{\noexpand\writetocentry{\realbackslash secentry{\the\toks0}%
3458 {\appendixletter}{\the\secno}}}%
3459 \temp
3460 \appendixnoderef
3461 \nobreak
3462 }
3463
3464 \outer\def\unnumberedsec{\parsearg\unnumberedsecyyy}
3465 \def\unnumberedsecyyy #1{\unnmhead1{#1}} % normally calls unnumberedseczzz
3466 \def\unnumberedseczzz #1{%
3467 \plainsecheading {#1}\gdef\thissection{#1}%
3468 \toks0 = {#1}%
3469 \edef\temp{\noexpand\writetocentry{\realbackslash unnumbsecentry{\the\toks0}}}%
3470 \temp
3471 \unnumbnoderef
3472 \nobreak
3473 } 5002 }
3474 5003
3475 % Subsections. 5004 % Subsections.
3476 \outer\def\numberedsubsec{\parsearg\numberedsubsecyyy} 5005 \outer\parseargdef\numberedsubsec{\numhead2{#1}} % normally calls numberedsubseczzz
3477 \def\numberedsubsecyyy #1{\numhead2{#1}} % normally calls numberedsubseczzz 5006 \def\numberedsubseczzz#1{%
3478 \def\numberedsubseczzz #1{% 5007 \global\subsubsecno=0 \global\advance\subsecno by 1
3479 \gdef\thissection{#1}\subsubsecno=0 \global\advance \subsecno by 1 % 5008 \sectionheading{#1}{subsec}{Ynumbered}{\the\chapno.\the\secno.\the\subsecno}%
3480 \subsecheading {#1}{\the\chapno}{\the\secno}{\the\subsecno}% 5009 }
3481 \toks0 = {#1}% 5010
3482 \edef\temp{\noexpand\writetocentry{\realbackslash subsecentry{\the\toks0}% 5011 \outer\parseargdef\appendixsubsec{\apphead2{#1}} % normally calls appendixsubseczzz
3483 {\the\chapno}{\the\secno}{\the\subsecno}}}% 5012 \def\appendixsubseczzz#1{%
3484 \temp 5013 \global\subsubsecno=0 \global\advance\subsecno by 1
3485 \donoderef 5014 \sectionheading{#1}{subsec}{Yappendix}%
3486 \nobreak 5015 {\appendixletter.\the\secno.\the\subsecno}%
3487 } 5016 }
3488 5017
3489 \outer\def\appendixsubsec{\parsearg\appendixsubsecyyy} 5018 \outer\parseargdef\unnumberedsubsec{\unnmhead2{#1}} %normally calls unnumberedsubseczzz
3490 \def\appendixsubsecyyy #1{\apphead2{#1}} % normally calls appendixsubseczzz 5019 \def\unnumberedsubseczzz#1{%
3491 \def\appendixsubseczzz #1{% 5020 \global\subsubsecno=0 \global\advance\subsecno by 1
3492 \gdef\thissection{#1}\subsubsecno=0 \global\advance \subsecno by 1 % 5021 \sectionheading{#1}{subsec}{Ynothing}%
3493 \subsecheading {#1}{\appendixletter}{\the\secno}{\the\subsecno}% 5022 {\the\unnumberedno.\the\secno.\the\subsecno}%
3494 \toks0 = {#1}%
3495 \edef\temp{\noexpand\writetocentry{\realbackslash subsecentry{\the\toks0}%
3496 {\appendixletter}{\the\secno}{\the\subsecno}}}%
3497 \temp
3498 \appendixnoderef
3499 \nobreak
3500 }
3501
3502 \outer\def\unnumberedsubsec{\parsearg\unnumberedsubsecyyy}
3503 \def\unnumberedsubsecyyy #1{\unnmhead2{#1}} %normally calls unnumberedsubseczzz
3504 \def\unnumberedsubseczzz #1{%
3505 \plainsubsecheading {#1}\gdef\thissection{#1}%
3506 \toks0 = {#1}%
3507 \edef\temp{\noexpand\writetocentry{\realbackslash unnumbsubsecentry%
3508 {\the\toks0}}}%
3509 \temp
3510 \unnumbnoderef
3511 \nobreak
3512 } 5023 }
3513 5024
3514 % Subsubsections. 5025 % Subsubsections.
3515 \outer\def\numberedsubsubsec{\parsearg\numberedsubsubsecyyy} 5026 \outer\parseargdef\numberedsubsubsec{\numhead3{#1}} % normally numberedsubsubseczzz
3516 \def\numberedsubsubsecyyy #1{\numhead3{#1}} % normally numberedsubsubseczzz 5027 \def\numberedsubsubseczzz#1{%
3517 \def\numberedsubsubseczzz #1{% 5028 \global\advance\subsubsecno by 1
3518 \gdef\thissection{#1}\global\advance \subsubsecno by 1 % 5029 \sectionheading{#1}{subsubsec}{Ynumbered}%
3519 \subsubsecheading {#1} 5030 {\the\chapno.\the\secno.\the\subsecno.\the\subsubsecno}%
3520 {\the\chapno}{\the\secno}{\the\subsecno}{\the\subsubsecno}% 5031 }
3521 \toks0 = {#1}% 5032
3522 \edef\temp{\noexpand\writetocentry{\realbackslash subsubsecentry{\the\toks0}% 5033 \outer\parseargdef\appendixsubsubsec{\apphead3{#1}} % normally appendixsubsubseczzz
3523 {\the\chapno}{\the\secno}{\the\subsecno}{\the\subsubsecno}}}% 5034 \def\appendixsubsubseczzz#1{%
3524 \temp 5035 \global\advance\subsubsecno by 1
3525 \donoderef 5036 \sectionheading{#1}{subsubsec}{Yappendix}%
3526 \nobreak 5037 {\appendixletter.\the\secno.\the\subsecno.\the\subsubsecno}%
3527 } 5038 }
3528 5039
3529 \outer\def\appendixsubsubsec{\parsearg\appendixsubsubsecyyy} 5040 \outer\parseargdef\unnumberedsubsubsec{\unnmhead3{#1}} %normally unnumberedsubsubseczzz
3530 \def\appendixsubsubsecyyy #1{\apphead3{#1}} % normally appendixsubsubseczzz 5041 \def\unnumberedsubsubseczzz#1{%
3531 \def\appendixsubsubseczzz #1{% 5042 \global\advance\subsubsecno by 1
3532 \gdef\thissection{#1}\global\advance \subsubsecno by 1 % 5043 \sectionheading{#1}{subsubsec}{Ynothing}%
3533 \subsubsecheading {#1} 5044 {\the\unnumberedno.\the\secno.\the\subsecno.\the\subsubsecno}%
3534 {\appendixletter}{\the\secno}{\the\subsecno}{\the\subsubsecno}% 5045 }
3535 \toks0 = {#1}%
3536 \edef\temp{\noexpand\writetocentry{\realbackslash subsubsecentry{\the\toks0}%
3537 {\appendixletter}{\the\secno}{\the\subsecno}{\the\subsubsecno}}}%
3538 \temp
3539 \appendixnoderef
3540 \nobreak
3541 }
3542
3543 \outer\def\unnumberedsubsubsec{\parsearg\unnumberedsubsubsecyyy}
3544 \def\unnumberedsubsubsecyyy #1{\unnmhead3{#1}} %normally unnumberedsubsubseczzz
3545 \def\unnumberedsubsubseczzz #1{%
3546 \plainsubsubsecheading {#1}\gdef\thissection{#1}%
3547 \toks0 = {#1}%
3548 \edef\temp{\noexpand\writetocentry{\realbackslash unnumbsubsubsecentry%
3549 {\the\toks0}}}%
3550 \temp
3551 \unnumbnoderef
3552 \nobreak
3553 }
3554
3555 % These are variants which are not "outer", so they can appear in @ifinfo.
3556 % Actually, they should now be obsolete; ordinary section commands should work.
3557 \def\infotop{\parsearg\unnumberedzzz}
3558 \def\infounnumbered{\parsearg\unnumberedzzz}
3559 \def\infounnumberedsec{\parsearg\unnumberedseczzz}
3560 \def\infounnumberedsubsec{\parsearg\unnumberedsubseczzz}
3561 \def\infounnumberedsubsubsec{\parsearg\unnumberedsubsubseczzz}
3562
3563 \def\infoappendix{\parsearg\appendixzzz}
3564 \def\infoappendixsec{\parsearg\appendixseczzz}
3565 \def\infoappendixsubsec{\parsearg\appendixsubseczzz}
3566 \def\infoappendixsubsubsec{\parsearg\appendixsubsubseczzz}
3567
3568 \def\infochapter{\parsearg\chapterzzz}
3569 \def\infosection{\parsearg\sectionzzz}
3570 \def\infosubsection{\parsearg\subsectionzzz}
3571 \def\infosubsubsection{\parsearg\subsubsectionzzz}
3572 5046
3573 % These macros control what the section commands do, according 5047 % These macros control what the section commands do, according
3574 % to what kind of chapter we are in (ordinary, appendix, or unnumbered). 5048 % to what kind of chapter we are in (ordinary, appendix, or unnumbered).
3575 % Define them by default for a numbered chapter. 5049 % Define them by default for a numbered chapter.
3576 \global\let\section = \numberedsec 5050 \let\section = \numberedsec
3577 \global\let\subsection = \numberedsubsec 5051 \let\subsection = \numberedsubsec
3578 \global\let\subsubsection = \numberedsubsubsec 5052 \let\subsubsection = \numberedsubsubsec
3579 5053
3580 % Define @majorheading, @heading and @subheading 5054 % Define @majorheading, @heading and @subheading
3581 5055
3582 % NOTE on use of \vbox for chapter headings, section headings, and such: 5056 % NOTE on use of \vbox for chapter headings, section headings, and such:
3583 % 1) We use \vbox rather than the earlier \line to permit 5057 % 1) We use \vbox rather than the earlier \line to permit
3586 % heading is obnoxious; this forbids it. 5060 % heading is obnoxious; this forbids it.
3587 % 3) Likewise, headings look best if no \parindent is used, and 5061 % 3) Likewise, headings look best if no \parindent is used, and
3588 % if justification is not attempted. Hence \raggedright. 5062 % if justification is not attempted. Hence \raggedright.
3589 5063
3590 5064
3591 \def\majorheading{\parsearg\majorheadingzzz} 5065 \def\majorheading{%
3592 \def\majorheadingzzz #1{% 5066 {\advance\chapheadingskip by 10pt \chapbreak }%
3593 {\advance\chapheadingskip by 10pt \chapbreak }% 5067 \parsearg\chapheadingzzz
3594 {\chapfonts \vbox{\hyphenpenalty=10000\tolerance=5000 5068 }
3595 \parindent=0pt\raggedright 5069
3596 \rm #1\hfill}}\bigskip \par\penalty 200} 5070 \def\chapheading{\chapbreak \parsearg\chapheadingzzz}
3597 5071 \def\chapheadingzzz#1{%
3598 \def\chapheading{\parsearg\chapheadingzzz} 5072 {\chapfonts \vbox{\hyphenpenalty=10000\tolerance=5000
3599 \def\chapheadingzzz #1{\chapbreak % 5073 \parindent=0pt\raggedright
3600 {\chapfonts \vbox{\hyphenpenalty=10000\tolerance=5000 5074 \rm #1\hfill}}%
3601 \parindent=0pt\raggedright 5075 \bigskip \par\penalty 200\relax
3602 \rm #1\hfill}}\bigskip \par\penalty 200} 5076 \suppressfirstparagraphindent
5077 }
3603 5078
3604 % @heading, @subheading, @subsubheading. 5079 % @heading, @subheading, @subsubheading.
3605 \def\heading{\parsearg\plainsecheading} 5080 \parseargdef\heading{\sectionheading{#1}{sec}{Yomitfromtoc}{}
3606 \def\subheading{\parsearg\plainsubsecheading} 5081 \suppressfirstparagraphindent}
3607 \def\subsubheading{\parsearg\plainsubsubsecheading} 5082 \parseargdef\subheading{\sectionheading{#1}{subsec}{Yomitfromtoc}{}
5083 \suppressfirstparagraphindent}
5084 \parseargdef\subsubheading{\sectionheading{#1}{subsubsec}{Yomitfromtoc}{}
5085 \suppressfirstparagraphindent}
3608 5086
3609 % These macros generate a chapter, section, etc. heading only 5087 % These macros generate a chapter, section, etc. heading only
3610 % (including whitespace, linebreaking, etc. around it), 5088 % (including whitespace, linebreaking, etc. around it),
3611 % given all the information in convenient, parsed form. 5089 % given all the information in convenient, parsed form.
3612 5090
3613 %%% Args are the skip and penalty (usually negative) 5091 %%% Args are the skip and penalty (usually negative)
3614 \def\dobreak#1#2{\par\ifdim\lastskip<#1\removelastskip\penalty#2\vskip#1\fi} 5092 \def\dobreak#1#2{\par\ifdim\lastskip<#1\removelastskip\penalty#2\vskip#1\fi}
3615 5093
3616 \def\setchapterstyle #1 {\csname CHAPF#1\endcsname}
3617
3618 %%% Define plain chapter starts, and page on/off switching for it 5094 %%% Define plain chapter starts, and page on/off switching for it
3619 % Parameter controlling skip before chapter headings (if needed) 5095 % Parameter controlling skip before chapter headings (if needed)
3620 5096
3621 \newskip\chapheadingskip 5097 \newskip\chapheadingskip
3622 5098
3623 \def\chapbreak{\dobreak \chapheadingskip {-4000}} 5099 \def\chapbreak{\dobreak \chapheadingskip {-4000}}
3624 \def\chappager{\par\vfill\supereject} 5100 \def\chappager{\par\vfill\supereject}
3625 \def\chapoddpage{\chappager \ifodd\pageno \else \hbox to 0pt{} \chappager\fi} 5101 % Because \domark is called before \chapoddpage, the filler page will
5102 % get the headings for the next chapter, which is wrong. But we don't
5103 % care -- we just disable all headings on the filler page.
5104 \def\chapoddpage{%
5105 \chappager
5106 \ifodd\pageno \else
5107 \begingroup
5108 \evenheadline={\hfil}\evenfootline={\hfil}%
5109 \oddheadline={\hfil}\oddfootline={\hfil}%
5110 \hbox to 0pt{}%
5111 \chappager
5112 \endgroup
5113 \fi
5114 }
3626 5115
3627 \def\setchapternewpage #1 {\csname CHAPPAG#1\endcsname} 5116 \def\setchapternewpage #1 {\csname CHAPPAG#1\endcsname}
3628 5117
3629 \def\CHAPPAGoff{% 5118 \def\CHAPPAGoff{%
3630 \global\let\contentsalignmacro = \chappager 5119 \global\let\contentsalignmacro = \chappager
3635 \global\let\contentsalignmacro = \chappager 5124 \global\let\contentsalignmacro = \chappager
3636 \global\let\pchapsepmacro=\chappager 5125 \global\let\pchapsepmacro=\chappager
3637 \global\let\pagealignmacro=\chappager 5126 \global\let\pagealignmacro=\chappager
3638 \global\def\HEADINGSon{\HEADINGSsingle}} 5127 \global\def\HEADINGSon{\HEADINGSsingle}}
3639 5128
3640 \def\CHAPPAGodd{ 5129 \def\CHAPPAGodd{%
3641 \global\let\contentsalignmacro = \chapoddpage 5130 \global\let\contentsalignmacro = \chapoddpage
3642 \global\let\pchapsepmacro=\chapoddpage 5131 \global\let\pchapsepmacro=\chapoddpage
3643 \global\let\pagealignmacro=\chapoddpage 5132 \global\let\pagealignmacro=\chapoddpage
3644 \global\def\HEADINGSon{\HEADINGSdouble}} 5133 \global\def\HEADINGSon{\HEADINGSdouble}}
3645 5134
3646 \CHAPPAGon 5135 \CHAPPAGon
3647 5136
3648 \def\CHAPFplain{ 5137 % Chapter opening.
3649 \global\let\chapmacro=\chfplain 5138 %
3650 \global\let\unnumbchapmacro=\unnchfplain 5139 % #1 is the text, #2 is the section type (Ynumbered, Ynothing,
3651 \global\let\centerchapmacro=\centerchfplain} 5140 % Yappendix, Yomitfromtoc), #3 the chapter number.
3652 5141 %
3653 % Plain chapter opening. 5142 % To test against our argument.
3654 % #1 is the text, #2 the chapter number or empty if unnumbered. 5143 \def\Ynothingkeyword{Ynothing}
3655 \def\chfplain#1#2{% 5144 \def\Yomitfromtockeyword{Yomitfromtoc}
5145 \def\Yappendixkeyword{Yappendix}
5146 %
5147 \def\chapmacro#1#2#3{%
5148 % Insert the first mark before the heading break (see notes for \domark).
5149 \let\prevchapterdefs=\lastchapterdefs
5150 \let\prevsectiondefs=\lastsectiondefs
5151 \gdef\lastsectiondefs{\gdef\thissectionname{}\gdef\thissectionnum{}%
5152 \gdef\thissection{}}%
5153 %
5154 \def\temptype{#2}%
5155 \ifx\temptype\Ynothingkeyword
5156 \gdef\lastchapterdefs{\gdef\thischaptername{#1}\gdef\thischapternum{}%
5157 \gdef\thischapter{\thischaptername}}%
5158 \else\ifx\temptype\Yomitfromtockeyword
5159 \gdef\lastchapterdefs{\gdef\thischaptername{#1}\gdef\thischapternum{}%
5160 \gdef\thischapter{}}%
5161 \else\ifx\temptype\Yappendixkeyword
5162 \toks0={#1}%
5163 \xdef\lastchapterdefs{%
5164 \gdef\noexpand\thischaptername{\the\toks0}%
5165 \gdef\noexpand\thischapternum{\appendixletter}%
5166 \gdef\noexpand\thischapter{\putwordAppendix{} \noexpand\thischapternum:
5167 \noexpand\thischaptername}%
5168 }%
5169 \else
5170 \toks0={#1}%
5171 \xdef\lastchapterdefs{%
5172 \gdef\noexpand\thischaptername{\the\toks0}%
5173 \gdef\noexpand\thischapternum{\the\chapno}%
5174 \gdef\noexpand\thischapter{\putwordChapter{} \noexpand\thischapternum:
5175 \noexpand\thischaptername}%
5176 }%
5177 \fi\fi\fi
5178 %
5179 % Output the mark. Pass it through \safewhatsit, to take care of
5180 % the preceding space.
5181 \safewhatsit\domark
5182 %
5183 % Insert the chapter heading break.
3656 \pchapsepmacro 5184 \pchapsepmacro
5185 %
5186 % Now the second mark, after the heading break. No break points
5187 % between here and the heading.
5188 \let\prevchapterdefs=\lastchapterdefs
5189 \let\prevsectiondefs=\lastsectiondefs
5190 \domark
5191 %
3657 {% 5192 {%
3658 \chapfonts \rm 5193 \chapfonts \rm
3659 \def\chapnum{#2}% 5194 %
3660 \setbox0 = \hbox{#2\ifx\chapnum\empty\else\enspace\fi}% 5195 % Have to define \lastsection before calling \donoderef, because the
5196 % xref code eventually uses it. On the other hand, it has to be called
5197 % after \pchapsepmacro, or the headline will change too soon.
5198 \gdef\lastsection{#1}%
5199 %
5200 % Only insert the separating space if we have a chapter/appendix
5201 % number, and don't print the unnumbered ``number''.
5202 \ifx\temptype\Ynothingkeyword
5203 \setbox0 = \hbox{}%
5204 \def\toctype{unnchap}%
5205 \else\ifx\temptype\Yomitfromtockeyword
5206 \setbox0 = \hbox{}% contents like unnumbered, but no toc entry
5207 \def\toctype{omit}%
5208 \else\ifx\temptype\Yappendixkeyword
5209 \setbox0 = \hbox{\putwordAppendix{} #3\enspace}%
5210 \def\toctype{app}%
5211 \else
5212 \setbox0 = \hbox{#3\enspace}%
5213 \def\toctype{numchap}%
5214 \fi\fi\fi
5215 %
5216 % Write the toc entry for this chapter. Must come before the
5217 % \donoderef, because we include the current node name in the toc
5218 % entry, and \donoderef resets it to empty.
5219 \writetocentry{\toctype}{#1}{#3}%
5220 %
5221 % For pdftex, we have to write out the node definition (aka, make
5222 % the pdfdest) after any page break, but before the actual text has
5223 % been typeset. If the destination for the pdf outline is after the
5224 % text, then jumping from the outline may wind up with the text not
5225 % being visible, for instance under high magnification.
5226 \donoderef{#2}%
5227 %
5228 % Typeset the actual heading.
5229 \nobreak % Avoid page breaks at the interline glue.
3661 \vbox{\hyphenpenalty=10000 \tolerance=5000 \parindent=0pt \raggedright 5230 \vbox{\hyphenpenalty=10000 \tolerance=5000 \parindent=0pt \raggedright
3662 \hangindent = \wd0 \centerparametersmaybe 5231 \hangindent=\wd0 \centerparametersmaybe
3663 \unhbox0 #1\par}% 5232 \unhbox0 #1\par}%
3664 }% 5233 }%
3665 \nobreak\bigskip % no page break after a chapter title 5234 \nobreak\bigskip % no page break after a chapter title
3666 \nobreak 5235 \nobreak
3667 } 5236 }
3668 5237
3669 % Plain opening for unnumbered.
3670 \def\unnchfplain#1{\chfplain{#1}{}}
3671
3672 % @centerchap -- centered and unnumbered. 5238 % @centerchap -- centered and unnumbered.
3673 \let\centerparametersmaybe = \relax 5239 \let\centerparametersmaybe = \relax
3674 \def\centerchfplain#1{{% 5240 \def\centerparameters{%
3675 \def\centerparametersmaybe{% 5241 \advance\rightskip by 3\rightskip
3676 \advance\rightskip by 3\rightskip 5242 \leftskip = \rightskip
3677 \leftskip = \rightskip 5243 \parfillskip = 0pt
3678 \parfillskip = 0pt 5244 }
3679 }% 5245
3680 \chfplain{#1}{}% 5246
3681 }} 5247 % I don't think this chapter style is supported any more, so I'm not
3682 5248 % updating it with the new noderef stuff. We'll see. --karl, 11aug03.
3683 \CHAPFplain % The default 5249 %
3684 5250 \def\setchapterstyle #1 {\csname CHAPF#1\endcsname}
5251 %
3685 \def\unnchfopen #1{% 5252 \def\unnchfopen #1{%
3686 \chapoddpage {\chapfonts \vbox{\hyphenpenalty=10000\tolerance=5000 5253 \chapoddpage {\chapfonts \vbox{\hyphenpenalty=10000\tolerance=5000
3687 \parindent=0pt\raggedright 5254 \parindent=0pt\raggedright
3688 \rm #1\hfill}}\bigskip \par\nobreak 5255 \rm #1\hfill}}\bigskip \par\nobreak
3689 } 5256 }
3690
3691 \def\chfopen #1#2{\chapoddpage {\chapfonts 5257 \def\chfopen #1#2{\chapoddpage {\chapfonts
3692 \vbox to 3in{\vfil \hbox to\hsize{\hfil #2} \hbox to\hsize{\hfil #1} \vfil}}% 5258 \vbox to 3in{\vfil \hbox to\hsize{\hfil #2} \hbox to\hsize{\hfil #1} \vfil}}%
3693 \par\penalty 5000 % 5259 \par\penalty 5000 %
3694 } 5260 }
3695
3696 \def\centerchfopen #1{% 5261 \def\centerchfopen #1{%
3697 \chapoddpage {\chapfonts \vbox{\hyphenpenalty=10000\tolerance=5000 5262 \chapoddpage {\chapfonts \vbox{\hyphenpenalty=10000\tolerance=5000
3698 \parindent=0pt 5263 \parindent=0pt
3699 \hfill {\rm #1}\hfill}}\bigskip \par\nobreak 5264 \hfill {\rm #1}\hfill}}\bigskip \par\nobreak
3700 } 5265 }
3701 5266 \def\CHAPFopen{%
3702 \def\CHAPFopen{ 5267 \global\let\chapmacro=\chfopen
3703 \global\let\chapmacro=\chfopen 5268 \global\let\centerchapmacro=\centerchfopen}
3704 \global\let\unnumbchapmacro=\unnchfopen 5269
3705 \global\let\centerchapmacro=\centerchfopen} 5270
3706 5271 % Section titles. These macros combine the section number parts and
3707 5272 % call the generic \sectionheading to do the printing.
3708 % Section titles. 5273 %
3709 \newskip\secheadingskip 5274 \newskip\secheadingskip
3710 \def\secheadingbreak{\dobreak \secheadingskip {-1000}} 5275 \def\secheadingbreak{\dobreak \secheadingskip{-1000}}
3711 \def\secheading#1#2#3{\sectionheading{sec}{#2.#3}{#1}}
3712 \def\plainsecheading#1{\sectionheading{sec}{}{#1}}
3713 5276
3714 % Subsection titles. 5277 % Subsection titles.
3715 \newskip \subsecheadingskip 5278 \newskip\subsecheadingskip
3716 \def\subsecheadingbreak{\dobreak \subsecheadingskip {-500}} 5279 \def\subsecheadingbreak{\dobreak \subsecheadingskip{-500}}
3717 \def\subsecheading#1#2#3#4{\sectionheading{subsec}{#2.#3.#4}{#1}}
3718 \def\plainsubsecheading#1{\sectionheading{subsec}{}{#1}}
3719 5280
3720 % Subsubsection titles. 5281 % Subsubsection titles.
3721 \let\subsubsecheadingskip = \subsecheadingskip 5282 \def\subsubsecheadingskip{\subsecheadingskip}
3722 \let\subsubsecheadingbreak = \subsecheadingbreak 5283 \def\subsubsecheadingbreak{\subsecheadingbreak}
3723 \def\subsubsecheading#1#2#3#4#5{\sectionheading{subsubsec}{#2.#3.#4.#5}{#1}} 5284
3724 \def\plainsubsubsecheading#1{\sectionheading{subsubsec}{}{#1}} 5285
3725 5286 % Print any size, any type, section title.
3726 5287 %
3727 % Print any size section title. 5288 % #1 is the text, #2 is the section level (sec/subsec/subsubsec), #3 is
3728 % 5289 % the section type for xrefs (Ynumbered, Ynothing, Yappendix), #4 is the
3729 % #1 is the section type (sec/subsec/subsubsec), #2 is the section 5290 % section number.
3730 % number (maybe empty), #3 the text. 5291 %
3731 \def\sectionheading#1#2#3{% 5292 \def\seckeyword{sec}
3732 {% 5293 %
3733 \expandafter\advance\csname #1headingskip\endcsname by \parskip 5294 \def\sectionheading#1#2#3#4{%
3734 \csname #1headingbreak\endcsname
3735 }%
3736 {% 5295 {%
3737 % Switch to the right set of fonts. 5296 % Switch to the right set of fonts.
3738 \csname #1fonts\endcsname \rm 5297 \csname #2fonts\endcsname \rm
3739 % 5298 %
3740 % Only insert the separating space if we have a section number. 5299 \def\sectionlevel{#2}%
3741 \def\secnum{#2}% 5300 \def\temptype{#3}%
3742 \setbox0 = \hbox{#2\ifx\secnum\empty\else\enspace\fi}%
3743 % 5301 %
5302 % Insert first mark before the heading break (see notes for \domark).
5303 \let\prevsectiondefs=\lastsectiondefs
5304 \ifx\temptype\Ynothingkeyword
5305 \ifx\sectionlevel\seckeyword
5306 \gdef\lastsectiondefs{\gdef\thissectionname{#1}\gdef\thissectionnum{}%
5307 \gdef\thissection{\thissectionname}}%
5308 \fi
5309 \else\ifx\temptype\Yomitfromtockeyword
5310 % Don't redefine \thissection.
5311 \else\ifx\temptype\Yappendixkeyword
5312 \ifx\sectionlevel\seckeyword
5313 \toks0={#1}%
5314 \xdef\lastsectiondefs{%
5315 \gdef\noexpand\thissectionname{\the\toks0}%
5316 \gdef\noexpand\thissectionnum{#4}%
5317 \gdef\noexpand\thissection{\putwordSection{} \noexpand\thissectionnum:
5318 \noexpand\thissectionname}%
5319 }%
5320 \fi
5321 \else
5322 \ifx\sectionlevel\seckeyword
5323 \toks0={#1}%
5324 \xdef\lastsectiondefs{%
5325 \gdef\noexpand\thissectionname{\the\toks0}%
5326 \gdef\noexpand\thissectionnum{#4}%
5327 \gdef\noexpand\thissection{\putwordSection{} \noexpand\thissectionnum:
5328 \noexpand\thissectionname}%
5329 }%
5330 \fi
5331 \fi\fi\fi
5332 %
5333 % Output the mark. Pass it through \safewhatsit, to take care of
5334 % the preceding space.
5335 \safewhatsit\domark
5336 %
5337 % Insert space above the heading.
5338 \csname #2headingbreak\endcsname
5339 %
5340 % Now the second mark, after the heading break. No break points
5341 % between here and the heading.
5342 \let\prevsectiondefs=\lastsectiondefs
5343 \domark
5344 %
5345 % Only insert the space after the number if we have a section number.
5346 \ifx\temptype\Ynothingkeyword
5347 \setbox0 = \hbox{}%
5348 \def\toctype{unn}%
5349 \gdef\lastsection{#1}%
5350 \else\ifx\temptype\Yomitfromtockeyword
5351 % for @headings -- no section number, don't include in toc,
5352 % and don't redefine \lastsection.
5353 \setbox0 = \hbox{}%
5354 \def\toctype{omit}%
5355 \let\sectionlevel=\empty
5356 \else\ifx\temptype\Yappendixkeyword
5357 \setbox0 = \hbox{#4\enspace}%
5358 \def\toctype{app}%
5359 \gdef\lastsection{#1}%
5360 \else
5361 \setbox0 = \hbox{#4\enspace}%
5362 \def\toctype{num}%
5363 \gdef\lastsection{#1}%
5364 \fi\fi\fi
5365 %
5366 % Write the toc entry (before \donoderef). See comments in \chapmacro.
5367 \writetocentry{\toctype\sectionlevel}{#1}{#4}%
5368 %
5369 % Write the node reference (= pdf destination for pdftex).
5370 % Again, see comments in \chapmacro.
5371 \donoderef{#3}%
5372 %
5373 % Interline glue will be inserted when the vbox is completed.
5374 % That glue will be a valid breakpoint for the page, since it'll be
5375 % preceded by a whatsit (usually from the \donoderef, or from the
5376 % \writetocentry if there was no node). We don't want to allow that
5377 % break, since then the whatsits could end up on page n while the
5378 % section is on page n+1, thus toc/etc. are wrong. Debian bug 276000.
5379 \nobreak
5380 %
5381 % Output the actual section heading.
3744 \vbox{\hyphenpenalty=10000 \tolerance=5000 \parindent=0pt \raggedright 5382 \vbox{\hyphenpenalty=10000 \tolerance=5000 \parindent=0pt \raggedright
3745 \hangindent = \wd0 % zero if no section number 5383 \hangindent=\wd0 % zero if no section number
3746 \unhbox0 #3}% 5384 \unhbox0 #1}%
3747 }% 5385 }%
3748 \ifdim\parskip<10pt \nobreak\kern10pt\nobreak\kern-\parskip\fi \nobreak 5386 % Add extra space after the heading -- half of whatever came above it.
5387 % Don't allow stretch, though.
5388 \kern .5 \csname #2headingskip\endcsname
5389 %
5390 % Do not let the kern be a potential breakpoint, as it would be if it
5391 % was followed by glue.
5392 \nobreak
5393 %
5394 % We'll almost certainly start a paragraph next, so don't let that
5395 % glue accumulate. (Not a breakpoint because it's preceded by a
5396 % discardable item.)
5397 \vskip-\parskip
5398 %
5399 % This is purely so the last item on the list is a known \penalty >
5400 % 10000. This is so \startdefun can avoid allowing breakpoints after
5401 % section headings. Otherwise, it would insert a valid breakpoint between:
5402 %
5403 % @section sec-whatever
5404 % @deffn def-whatever
5405 \penalty 10001
3749 } 5406 }
3750 5407
3751 5408
3752 \message{toc,} 5409 \message{toc,}
3753 % Table of contents. 5410 % Table of contents.
3754 \newwrite\tocfile 5411 \newwrite\tocfile
3755 5412
3756 % Write an entry to the toc file, opening it if necessary. 5413 % Write an entry to the toc file, opening it if necessary.
3757 % Called from @chapter, etc. We supply {\folio} at the end of the 5414 % Called from @chapter, etc.
3758 % argument, which will end up as the last argument to the \...entry macro. 5415 %
3759 % 5416 % Example usage: \writetocentry{sec}{Section Name}{\the\chapno.\the\secno}
3760 % We open the .toc file here instead of at @setfilename or any other 5417 % We append the current node name (if any) and page number as additional
3761 % given time so that @contents can be put in the document anywhere. 5418 % arguments for the \{chap,sec,...}entry macros which will eventually
5419 % read this. The node name is used in the pdf outlines as the
5420 % destination to jump to.
5421 %
5422 % We open the .toc file for writing here instead of at @setfilename (or
5423 % any other fixed time) so that @contents can be anywhere in the document.
5424 % But if #1 is `omit', then we don't do anything. This is used for the
5425 % table of contents chapter openings themselves.
3762 % 5426 %
3763 \newif\iftocfileopened 5427 \newif\iftocfileopened
3764 \def\writetocentry#1{% 5428 \def\omitkeyword{omit}%
3765 \iftocfileopened\else 5429 %
3766 \immediate\openout\tocfile = \jobname.toc 5430 \def\writetocentry#1#2#3{%
3767 \global\tocfileopenedtrue 5431 \edef\writetoctype{#1}%
5432 \ifx\writetoctype\omitkeyword \else
5433 \iftocfileopened\else
5434 \immediate\openout\tocfile = \jobname.toc
5435 \global\tocfileopenedtrue
5436 \fi
5437 %
5438 \iflinks
5439 {\atdummies
5440 \edef\temp{%
5441 \write\tocfile{@#1entry{#2}{#3}{\lastnode}{\noexpand\folio}}}%
5442 \temp
5443 }%
5444 \fi
3768 \fi 5445 \fi
3769 \iflinks \write\tocfile{#1{\folio}}\fi 5446 %
5447 % Tell \shipout to create a pdf destination on each page, if we're
5448 % writing pdf. These are used in the table of contents. We can't
5449 % just write one on every page because the title pages are numbered
5450 % 1 and 2 (the page numbers aren't printed), and so are the first
5451 % two pages of the document. Thus, we'd have two destinations named
5452 % `1', and two named `2'.
5453 \ifpdf \global\pdfmakepagedesttrue \fi
5454 }
5455
5456
5457 % These characters do not print properly in the Computer Modern roman
5458 % fonts, so we must take special care. This is more or less redundant
5459 % with the Texinfo input format setup at the end of this file.
5460 %
5461 \def\activecatcodes{%
5462 \catcode`\"=\active
5463 \catcode`\$=\active
5464 \catcode`\<=\active
5465 \catcode`\>=\active
5466 \catcode`\\=\active
5467 \catcode`\^=\active
5468 \catcode`\_=\active
5469 \catcode`\|=\active
5470 \catcode`\~=\active
5471 }
5472
5473
5474 % Read the toc file, which is essentially Texinfo input.
5475 \def\readtocfile{%
5476 \setupdatafile
5477 \activecatcodes
5478 \input \tocreadfilename
3770 } 5479 }
3771 5480
3772 \newskip\contentsrightmargin \contentsrightmargin=1in 5481 \newskip\contentsrightmargin \contentsrightmargin=1in
3773 \newcount\savepageno 5482 \newcount\savepageno
3774 \newcount\lastnegativepageno \lastnegativepageno = -1 5483 \newcount\lastnegativepageno \lastnegativepageno = -1
3775 5484
3776 % Finish up the main text and prepare to read what we've written 5485 % Prepare to read what we've written to \tocfile.
3777 % to \tocfile.
3778 % 5486 %
3779 \def\startcontents#1{% 5487 \def\startcontents#1{%
3780 % If @setchapternewpage on, and @headings double, the contents should 5488 % If @setchapternewpage on, and @headings double, the contents should
3781 % start on an odd page, unlike chapters. Thus, we maintain 5489 % start on an odd page, unlike chapters. Thus, we maintain
3782 % \contentsalignmacro in parallel with \pagealignmacro. 5490 % \contentsalignmacro in parallel with \pagealignmacro.
3783 % From: Torbjorn Granlund <tege@matematik.su.se> 5491 % From: Torbjorn Granlund <tege@matematik.su.se>
3784 \contentsalignmacro 5492 \contentsalignmacro
3785 \immediate\closeout\tocfile 5493 \immediate\closeout\tocfile
3786 % 5494 %
3787 % Don't need to put `Contents' or `Short Contents' in the headline. 5495 % Don't need to put `Contents' or `Short Contents' in the headline.
3788 % It is abundantly clear what they are. 5496 % It is abundantly clear what they are.
3789 \unnumbchapmacro{#1}\def\thischapter{}% 5497 \chapmacro{#1}{Yomitfromtoc}{}%
3790 \savepageno = \pageno 5498 %
3791 \begingroup % Set up to handle contents files properly. 5499 \savepageno = \pageno
3792 \catcode`\\=0 \catcode`\{=1 \catcode`\}=2 \catcode`\@=11 5500 \begingroup % Set up to handle contents files properly.
3793 % We can't do this, because then an actual ^ in a section 5501 \raggedbottom % Worry more about breakpoints than the bottom.
3794 % title fails, e.g., @chapter ^ -- exponentiation. --karl, 9jul97. 5502 \advance\hsize by -\contentsrightmargin % Don't use the full line length.
3795 %\catcode`\^=7 % to see ^^e4 as \"a etc. juha@piuha.ydi.vtt.fi 5503 %
3796 \raggedbottom % Worry more about breakpoints than the bottom. 5504 % Roman numerals for page numbers.
3797 \advance\hsize by -\contentsrightmargin % Don't use the full line length. 5505 \ifnum \pageno>0 \global\pageno = \lastnegativepageno \fi
3798 % 5506 }
3799 % Roman numerals for page numbers. 5507
3800 \ifnum \pageno>0 \pageno = \lastnegativepageno \fi 5508 % redefined for the two-volume lispref. We always output on
3801 } 5509 % \jobname.toc even if this is redefined.
3802 5510 %
5511 \def\tocreadfilename{\jobname.toc}
3803 5512
3804 % Normal (long) toc. 5513 % Normal (long) toc.
5514 %
3805 \def\contents{% 5515 \def\contents{%
3806 \startcontents{\putwordTOC}% 5516 \startcontents{\putwordTOC}%
3807 \openin 1 \jobname.toc 5517 \openin 1 \tocreadfilename\space
3808 \ifeof 1 \else 5518 \ifeof 1 \else
3809 \closein 1 5519 \readtocfile
3810 \input \jobname.toc 5520 \fi
3811 \fi 5521 \vfill \eject
3812 \vfill \eject 5522 \contentsalignmacro % in case @setchapternewpage odd is in effect
3813 \contentsalignmacro % in case @setchapternewpage odd is in effect 5523 \ifeof 1 \else
3814 \pdfmakeoutlines 5524 \pdfmakeoutlines
3815 \endgroup 5525 \fi
3816 \lastnegativepageno = \pageno 5526 \closein 1
3817 \pageno = \savepageno 5527 \endgroup
5528 \lastnegativepageno = \pageno
5529 \global\pageno = \savepageno
3818 } 5530 }
3819 5531
3820 % And just the chapters. 5532 % And just the chapters.
3821 \def\summarycontents{% 5533 \def\summarycontents{%
3822 \startcontents{\putwordShortTOC}% 5534 \startcontents{\putwordShortTOC}%
3823 % 5535 %
3824 \let\chapentry = \shortchapentry 5536 \let\numchapentry = \shortchapentry
3825 \let\unnumbchapentry = \shortunnumberedentry 5537 \let\appentry = \shortchapentry
3826 % We want a true roman here for the page numbers. 5538 \let\unnchapentry = \shortunnchapentry
3827 \secfonts 5539 % We want a true roman here for the page numbers.
3828 \let\rm=\shortcontrm \let\bf=\shortcontbf \let\sl=\shortcontsl 5540 \secfonts
3829 \rm 5541 \let\rm=\shortcontrm \let\bf=\shortcontbf
3830 \hyphenpenalty = 10000 5542 \let\sl=\shortcontsl \let\tt=\shortconttt
3831 \advance\baselineskip by 1pt % Open it up a little. 5543 \rm
3832 \def\secentry ##1##2##3##4{} 5544 \hyphenpenalty = 10000
3833 \def\unnumbsecentry ##1##2{} 5545 \advance\baselineskip by 1pt % Open it up a little.
3834 \def\subsecentry ##1##2##3##4##5{} 5546 \def\numsecentry##1##2##3##4{}
3835 \def\unnumbsubsecentry ##1##2{} 5547 \let\appsecentry = \numsecentry
3836 \def\subsubsecentry ##1##2##3##4##5##6{} 5548 \let\unnsecentry = \numsecentry
3837 \def\unnumbsubsubsecentry ##1##2{} 5549 \let\numsubsecentry = \numsecentry
3838 \openin 1 \jobname.toc 5550 \let\appsubsecentry = \numsecentry
3839 \ifeof 1 \else 5551 \let\unnsubsecentry = \numsecentry
3840 \closein 1 5552 \let\numsubsubsecentry = \numsecentry
3841 \input \jobname.toc 5553 \let\appsubsubsecentry = \numsecentry
3842 \fi 5554 \let\unnsubsubsecentry = \numsecentry
3843 \vfill \eject 5555 \openin 1 \tocreadfilename\space
3844 \contentsalignmacro % in case @setchapternewpage odd is in effect 5556 \ifeof 1 \else
3845 \endgroup 5557 \readtocfile
3846 \lastnegativepageno = \pageno 5558 \fi
3847 \pageno = \savepageno 5559 \closein 1
5560 \vfill \eject
5561 \contentsalignmacro % in case @setchapternewpage odd is in effect
5562 \endgroup
5563 \lastnegativepageno = \pageno
5564 \global\pageno = \savepageno
3848 } 5565 }
3849 \let\shortcontents = \summarycontents 5566 \let\shortcontents = \summarycontents
3850 5567
3851 \ifpdf 5568 % Typeset the label for a chapter or appendix for the short contents.
3852 \pdfcatalog{/PageMode /UseOutlines}% 5569 % The arg is, e.g., `A' for an appendix, or `3' for a chapter.
3853 \fi 5570 %
5571 \def\shortchaplabel#1{%
5572 % This space should be enough, since a single number is .5em, and the
5573 % widest letter (M) is 1em, at least in the Computer Modern fonts.
5574 % But use \hss just in case.
5575 % (This space doesn't include the extra space that gets added after
5576 % the label; that gets put in by \shortchapentry above.)
5577 %
5578 % We'd like to right-justify chapter numbers, but that looks strange
5579 % with appendix letters. And right-justifying numbers and
5580 % left-justifying letters looks strange when there is less than 10
5581 % chapters. Have to read the whole toc once to know how many chapters
5582 % there are before deciding ...
5583 \hbox to 1em{#1\hss}%
5584 }
3854 5585
3855 % These macros generate individual entries in the table of contents. 5586 % These macros generate individual entries in the table of contents.
3856 % The first argument is the chapter or section name. 5587 % The first argument is the chapter or section name.
3857 % The last argument is the page number. 5588 % The last argument is the page number.
3858 % The arguments in between are the chapter number, section number, ... 5589 % The arguments in between are the chapter number, section number, ...
3859 5590
3860 % Chapter-level things, for both the long and short contents. 5591 % Chapters, in the main contents.
3861 \def\chapentry#1#2#3{\dochapentry{#2\labelspace#1}{#3}} 5592 \def\numchapentry#1#2#3#4{\dochapentry{#2\labelspace#1}{#4}}
3862 5593 %
3863 % See comments in \dochapentry re vbox and related settings 5594 % Chapters, in the short toc.
3864 \def\shortchapentry#1#2#3{% 5595 % See comments in \dochapentry re vbox and related settings.
3865 \tocentry{\shortchaplabel{#2}\labelspace #1}{\doshortpageno\bgroup#3\egroup}% 5596 \def\shortchapentry#1#2#3#4{%
3866 } 5597 \tocentry{\shortchaplabel{#2}\labelspace #1}{\doshortpageno\bgroup#4\egroup}%
3867 5598 }
3868 % Typeset the label for a chapter or appendix for the short contents. 5599
3869 % The arg is, e.g. `Appendix A' for an appendix, or `3' for a chapter. 5600 % Appendices, in the main contents.
3870 % We could simplify the code here by writing out an \appendixentry 5601 % Need the word Appendix, and a fixed-size box.
3871 % command in the toc file for appendices, instead of using \chapentry 5602 %
3872 % for both, but it doesn't seem worth it. 5603 \def\appendixbox#1{%
3873 % 5604 % We use M since it's probably the widest letter.
3874 \newdimen\shortappendixwidth 5605 \setbox0 = \hbox{\putwordAppendix{} M}%
3875 % 5606 \hbox to \wd0{\putwordAppendix{} #1\hss}}
3876 \def\shortchaplabel#1{% 5607 %
3877 % Compute width of word "Appendix", may change with language. 5608 \def\appentry#1#2#3#4{\dochapentry{\appendixbox{#2}\labelspace#1}{#4}}
3878 \setbox0 = \hbox{\shortcontrm \putwordAppendix}% 5609
3879 \shortappendixwidth = \wd0 5610 % Unnumbered chapters.
3880 % 5611 \def\unnchapentry#1#2#3#4{\dochapentry{#1}{#4}}
3881 % We typeset #1 in a box of constant width, regardless of the text of 5612 \def\shortunnchapentry#1#2#3#4{\tocentry{#1}{\doshortpageno\bgroup#4\egroup}}
3882 % #1, so the chapter titles will come out aligned.
3883 \setbox0 = \hbox{#1}%
3884 \dimen0 = \ifdim\wd0 > \shortappendixwidth \shortappendixwidth \else 0pt \fi
3885 %
3886 % This space should be plenty, since a single number is .5em, and the
3887 % widest letter (M) is 1em, at least in the Computer Modern fonts.
3888 % (This space doesn't include the extra space that gets added after
3889 % the label; that gets put in by \shortchapentry above.)
3890 \advance\dimen0 by 1.1em
3891 \hbox to \dimen0{#1\hfil}%
3892 }
3893
3894 \def\unnumbchapentry#1#2{\dochapentry{#1}{#2}}
3895 \def\shortunnumberedentry#1#2{\tocentry{#1}{\doshortpageno\bgroup#2\egroup}}
3896 5613
3897 % Sections. 5614 % Sections.
3898 \def\secentry#1#2#3#4{\dosecentry{#2.#3\labelspace#1}{#4}} 5615 \def\numsecentry#1#2#3#4{\dosecentry{#2\labelspace#1}{#4}}
3899 \def\unnumbsecentry#1#2{\dosecentry{#1}{#2}} 5616 \let\appsecentry=\numsecentry
5617 \def\unnsecentry#1#2#3#4{\dosecentry{#1}{#4}}
3900 5618
3901 % Subsections. 5619 % Subsections.
3902 \def\subsecentry#1#2#3#4#5{\dosubsecentry{#2.#3.#4\labelspace#1}{#5}} 5620 \def\numsubsecentry#1#2#3#4{\dosubsecentry{#2\labelspace#1}{#4}}
3903 \def\unnumbsubsecentry#1#2{\dosubsecentry{#1}{#2}} 5621 \let\appsubsecentry=\numsubsecentry
5622 \def\unnsubsecentry#1#2#3#4{\dosubsecentry{#1}{#4}}
3904 5623
3905 % And subsubsections. 5624 % And subsubsections.
3906 \def\subsubsecentry#1#2#3#4#5#6{% 5625 \def\numsubsubsecentry#1#2#3#4{\dosubsubsecentry{#2\labelspace#1}{#4}}
3907 \dosubsubsecentry{#2.#3.#4.#5\labelspace#1}{#6}} 5626 \let\appsubsubsecentry=\numsubsubsecentry
3908 \def\unnumbsubsubsecentry#1#2{\dosubsubsecentry{#1}{#2}} 5627 \def\unnsubsubsecentry#1#2#3#4{\dosubsubsecentry{#1}{#4}}
3909 5628
3910 % This parameter controls the indentation of the various levels. 5629 % This parameter controls the indentation of the various levels.
3911 \newdimen\tocindent \tocindent = 3pc 5630 % Same as \defaultparindent.
5631 \newdimen\tocindent \tocindent = 15pt
3912 5632
3913 % Now for the actual typesetting. In all these, #1 is the text and #2 is the 5633 % Now for the actual typesetting. In all these, #1 is the text and #2 is the
3914 % page number. 5634 % page number.
3915 % 5635 %
3916 % If the toc has to be broken over pages, we want it to be at chapters 5636 % If the toc has to be broken over pages, we want it to be at chapters
3937 \def\dosubsubsecentry#1#2{\begingroup 5657 \def\dosubsubsecentry#1#2{\begingroup
3938 \subsubsecentryfonts \leftskip=3\tocindent 5658 \subsubsecentryfonts \leftskip=3\tocindent
3939 \tocentry{#1}{\dopageno\bgroup#2\egroup}% 5659 \tocentry{#1}{\dopageno\bgroup#2\egroup}%
3940 \endgroup} 5660 \endgroup}
3941 5661
3942 % Final typesetting of a toc entry; we use the same \entry macro as for 5662 % We use the same \entry macro as for the index entries.
3943 % the index entries, but we want to suppress hyphenation here. (We 5663 \let\tocentry = \entry
3944 % can't do that in the \entry macro, since index entries might consist
3945 % of hyphenated-identifiers-that-do-not-fit-on-a-line-and-nothing-else.)
3946 \def\tocentry#1#2{\begingroup
3947 \vskip 0pt plus1pt % allow a little stretch for the sake of nice page breaks
3948 % Do not use \turnoffactive in these arguments. Since the toc is
3949 % typeset in cmr, so characters such as _ would come out wrong; we
3950 % have to do the usual translation tricks.
3951 \entry{#1}{#2}%
3952 \endgroup}
3953 5664
3954 % Space between chapter (or whatever) number and the title. 5665 % Space between chapter (or whatever) number and the title.
3955 \def\labelspace{\hskip1em \relax} 5666 \def\labelspace{\hskip1em \relax}
3956 5667
3957 \def\dopageno#1{{\rm #1}} 5668 \def\dopageno#1{{\rm #1}}
3958 \def\doshortpageno#1{{\rm #1}} 5669 \def\doshortpageno#1{{\rm #1}}
3959 5670
3960 \def\chapentryfonts{\secfonts \rm} 5671 \def\chapentryfonts{\secfonts \rm}
3961 \def\secentryfonts{\textfonts} 5672 \def\secentryfonts{\textfonts}
3962 \let\subsecentryfonts = \textfonts 5673 \def\subsecentryfonts{\textfonts}
3963 \let\subsubsecentryfonts = \textfonts 5674 \def\subsubsecentryfonts{\textfonts}
3964 5675
3965 5676
3966 \message{environments,} 5677 \message{environments,}
3967 % @foo ... @end foo. 5678 % @foo ... @end foo.
3968 5679
3969 % Since these characters are used in examples, it should be an even number of 5680 % @point{}, @result{}, @expansion{}, @print{}, @equiv{}.
5681 %
5682 % Since these characters are used in examples, they should be an even number of
3970 % \tt widths. Each \tt character is 1en, so two makes it 1em. 5683 % \tt widths. Each \tt character is 1en, so two makes it 1em.
3971 % Furthermore, these definitions must come after we define our fonts. 5684 %
3972 \newbox\dblarrowbox \newbox\longdblarrowbox
3973 \newbox\pushcharbox \newbox\bullbox
3974 \newbox\equivbox \newbox\errorbox
3975
3976 %{\tentt
3977 %\global\setbox\dblarrowbox = \hbox to 1em{\hfil$\Rightarrow$\hfil}
3978 %\global\setbox\longdblarrowbox = \hbox to 1em{\hfil$\mapsto$\hfil}
3979 %\global\setbox\pushcharbox = \hbox to 1em{\hfil$\dashv$\hfil}
3980 %\global\setbox\equivbox = \hbox to 1em{\hfil$\ptexequiv$\hfil}
3981 % Adapted from the manmac format (p.420 of TeXbook)
3982 %\global\setbox\bullbox = \hbox to 1em{\kern.15em\vrule height .75ex width .85ex
3983 % depth .1ex\hfil}
3984 %}
3985
3986 % @point{}, @result{}, @expansion{}, @print{}, @equiv{}.
3987 \def\point{$\star$} 5685 \def\point{$\star$}
3988 \def\result{\leavevmode\raise.15ex\hbox to 1em{\hfil$\Rightarrow$\hfil}} 5686 \def\arrow{\leavevmode\raise.05ex\hbox to 1em{\hfil$\rightarrow$\hfil}}
3989 \def\expansion{\leavevmode\raise.1ex\hbox to 1em{\hfil$\mapsto$\hfil}} 5687 \def\result{\leavevmode\raise.05ex\hbox to 1em{\hfil$\Rightarrow$\hfil}}
5688 \def\expansion{\leavevmode\hbox to 1em{\hfil$\mapsto$\hfil}}
3990 \def\print{\leavevmode\lower.1ex\hbox to 1em{\hfil$\dashv$\hfil}} 5689 \def\print{\leavevmode\lower.1ex\hbox to 1em{\hfil$\dashv$\hfil}}
3991 \def\equiv{\leavevmode\lower.1ex\hbox to 1em{\hfil$\ptexequiv$\hfil}} 5690 \def\equiv{\leavevmode\hbox to 1em{\hfil$\ptexequiv$\hfil}}
3992 5691
5692 % The @error{} command.
3993 % Adapted from the TeXbook's \boxit. 5693 % Adapted from the TeXbook's \boxit.
5694 %
5695 \newbox\errorbox
5696 %
3994 {\tentt \global\dimen0 = 3em}% Width of the box. 5697 {\tentt \global\dimen0 = 3em}% Width of the box.
3995 \dimen2 = .55pt % Thickness of rules 5698 \dimen2 = .55pt % Thickness of rules
3996 % The text. (`r' is open on the right, `e' somewhat less so on the left.) 5699 % The text. (`r' is open on the right, `e' somewhat less so on the left.)
3997 \setbox0 = \hbox{\kern-.75pt \tensf error\kern-1.5pt} 5700 \setbox0 = \hbox{\kern-.75pt \reducedsf error\kern-1.5pt}
3998 5701 %
3999 \global\setbox\errorbox=\hbox to \dimen0{\hfil 5702 \setbox\errorbox=\hbox to \dimen0{\hfil
4000 \hsize = \dimen0 \advance\hsize by -5.8pt % Space to left+right. 5703 \hsize = \dimen0 \advance\hsize by -5.8pt % Space to left+right.
4001 \advance\hsize by -2\dimen2 % Rules. 5704 \advance\hsize by -2\dimen2 % Rules.
4002 \vbox{ 5705 \vbox{%
4003 \hrule height\dimen2 5706 \hrule height\dimen2
4004 \hbox{\vrule width\dimen2 \kern3pt % Space to left of text. 5707 \hbox{\vrule width\dimen2 \kern3pt % Space to left of text.
4005 \vtop{\kern2.4pt \box0 \kern2.4pt}% Space above/below. 5708 \vtop{\kern2.4pt \box0 \kern2.4pt}% Space above/below.
4006 \kern3pt\vrule width\dimen2}% Space to right. 5709 \kern3pt\vrule width\dimen2}% Space to right.
4007 \hrule height\dimen2} 5710 \hrule height\dimen2}
4008 \hfil} 5711 \hfil}
4009 5712 %
4010 % The @error{} command.
4011 \def\error{\leavevmode\lower.7ex\copy\errorbox} 5713 \def\error{\leavevmode\lower.7ex\copy\errorbox}
4012 5714
4013 % @tex ... @end tex escapes into raw Tex temporarily. 5715 % @tex ... @end tex escapes into raw Tex temporarily.
4014 % One exception: @ is still an escape character, so that @end tex works. 5716 % One exception: @ is still an escape character, so that @end tex works.
4015 % But \@ or @@ will get a plain tex @ character. 5717 % But \@ or @@ will get a plain tex @ character.
4016 5718
4017 \def\tex{\begingroup 5719 \envdef\tex{%
4018 \catcode `\\=0 \catcode `\{=1 \catcode `\}=2 5720 \catcode `\\=0 \catcode `\{=1 \catcode `\}=2
4019 \catcode `\$=3 \catcode `\&=4 \catcode `\#=6 5721 \catcode `\$=3 \catcode `\&=4 \catcode `\#=6
4020 \catcode `\^=7 \catcode `\_=8 \catcode `\~=13 \let~=\tie 5722 \catcode `\^=7 \catcode `\_=8 \catcode `\~=\active \let~=\tie
4021 \catcode `\%=14 5723 \catcode `\%=14
4022 \catcode 43=12 % plus 5724 \catcode `\+=\other
4023 \catcode`\"=12 5725 \catcode `\"=\other
4024 \catcode`\==12 5726 \catcode `\|=\other
4025 \catcode`\|=12 5727 \catcode `\<=\other
4026 \catcode`\<=12 5728 \catcode `\>=\other
4027 \catcode`\>=12
4028 \escapechar=`\\ 5729 \escapechar=`\\
4029 % 5730 %
4030 \let\b=\ptexb 5731 \let\b=\ptexb
4031 \let\bullet=\ptexbullet 5732 \let\bullet=\ptexbullet
4032 \let\c=\ptexc 5733 \let\c=\ptexc
4034 \let\.=\ptexdot 5735 \let\.=\ptexdot
4035 \let\dots=\ptexdots 5736 \let\dots=\ptexdots
4036 \let\equiv=\ptexequiv 5737 \let\equiv=\ptexequiv
4037 \let\!=\ptexexclam 5738 \let\!=\ptexexclam
4038 \let\i=\ptexi 5739 \let\i=\ptexi
5740 \let\indent=\ptexindent
5741 \let\noindent=\ptexnoindent
4039 \let\{=\ptexlbrace 5742 \let\{=\ptexlbrace
4040 \let\+=\tabalign 5743 \let\+=\tabalign
4041 \let\}=\ptexrbrace 5744 \let\}=\ptexrbrace
5745 \let\/=\ptexslash
4042 \let\*=\ptexstar 5746 \let\*=\ptexstar
4043 \let\t=\ptext 5747 \let\t=\ptext
5748 \expandafter \let\csname top\endcsname=\ptextop % outer
5749 \let\frenchspacing=\plainfrenchspacing
4044 % 5750 %
4045 \def\endldots{\mathinner{\ldots\ldots\ldots\ldots}}% 5751 \def\endldots{\mathinner{\ldots\ldots\ldots\ldots}}%
4046 \def\enddots{\relax\ifmmode\endldots\else$\mathsurround=0pt \endldots\,$\fi}% 5752 \def\enddots{\relax\ifmmode\endldots\else$\mathsurround=0pt \endldots\,$\fi}%
4047 \def\@{@}% 5753 \def\@{@}%
4048 \let\Etex=\endgroup} 5754 }
4049 5755 % There is no need to define \Etex.
4050 % Define @lisp ... @endlisp. 5756
4051 % @lisp does a \begingroup so it can rebind things, 5757 % Define @lisp ... @end lisp.
4052 % including the definition of @endlisp (which normally is erroneous). 5758 % @lisp environment forms a group so it can rebind things,
5759 % including the definition of @end lisp (which normally is erroneous).
4053 5760
4054 % Amount to narrow the margins by for @lisp. 5761 % Amount to narrow the margins by for @lisp.
4055 \newskip\lispnarrowing \lispnarrowing=0.4in 5762 \newskip\lispnarrowing \lispnarrowing=0.4in
4056 5763
4057 % This is the definition that ^^M gets inside @lisp, @example, and other 5764 % This is the definition that ^^M gets inside @lisp, @example, and other
4058 % such environments. \null is better than a space, since it doesn't 5765 % such environments. \null is better than a space, since it doesn't
4059 % have any width. 5766 % have any width.
4060 \def\lisppar{\null\endgraf} 5767 \def\lisppar{\null\endgraf}
4061 5768
4062 % Make each space character in the input produce a normal interword
4063 % space in the output. Don't allow a line break at this space, as this
4064 % is used only in environments like @example, where each line of input
4065 % should produce a line of output anyway.
4066 %
4067 {\obeyspaces %
4068 \gdef\sepspaces{\obeyspaces\let =\tie}}
4069
4070 % Define \obeyedspace to be our active space, whatever it is. This is
4071 % for use in \parsearg.
4072 {\sepspaces%
4073 \global\let\obeyedspace= }
4074
4075 % This space is always present above and below environments. 5769 % This space is always present above and below environments.
4076 \newskip\envskipamount \envskipamount = 0pt 5770 \newskip\envskipamount \envskipamount = 0pt
4077 5771
4078 % Make spacing and below environment symmetrical. We use \parskip here 5772 % Make spacing and below environment symmetrical. We use \parskip here
4079 % to help in doing that, since in @example-like environments \parskip 5773 % to help in doing that, since in @example-like environments \parskip
4080 % is reset to zero; thus the \afterenvbreak inserts no space -- but the 5774 % is reset to zero; thus the \afterenvbreak inserts no space -- but the
4081 % start of the next paragraph will insert \parskip 5775 % start of the next paragraph will insert \parskip.
4082 % 5776 %
4083 \def\aboveenvbreak{{\advance\envskipamount by \parskip 5777 \def\aboveenvbreak{{%
4084 \endgraf \ifdim\lastskip<\envskipamount 5778 % =10000 instead of <10000 because of a special case in \itemzzz and
4085 \removelastskip \penalty-50 \vskip\envskipamount \fi}} 5779 % \sectionheading, q.v.
5780 \ifnum \lastpenalty=10000 \else
5781 \advance\envskipamount by \parskip
5782 \endgraf
5783 \ifdim\lastskip<\envskipamount
5784 \removelastskip
5785 % it's not a good place to break if the last penalty was \nobreak
5786 % or better ...
5787 \ifnum\lastpenalty<10000 \penalty-50 \fi
5788 \vskip\envskipamount
5789 \fi
5790 \fi
5791 }}
4086 5792
4087 \let\afterenvbreak = \aboveenvbreak 5793 \let\afterenvbreak = \aboveenvbreak
4088 5794
4089 % \nonarrowing is a flag. If "set", @lisp etc don't narrow margins. 5795 % \nonarrowing is a flag. If "set", @lisp etc don't narrow margins; it will
5796 % also clear it, so that its embedded environments do the narrowing again.
4090 \let\nonarrowing=\relax 5797 \let\nonarrowing=\relax
4091 5798
4092 % @cartouche ... @end cartouche: draw rectangle w/rounded corners around 5799 % @cartouche ... @end cartouche: draw rectangle w/rounded corners around
4093 % environment contents. 5800 % environment contents.
4094 \font\circle=lcircle10 5801 \font\circle=lcircle10
4108 \cbl\leaders\hrule height\circthick\hfil\cbr 5815 \cbl\leaders\hrule height\circthick\hfil\cbr
4109 \hskip\rskip}} 5816 \hskip\rskip}}
4110 % 5817 %
4111 \newskip\lskip\newskip\rskip 5818 \newskip\lskip\newskip\rskip
4112 5819
4113 \long\def\cartouche{% 5820 \envdef\cartouche{%
4114 \begingroup 5821 \ifhmode\par\fi % can't be in the midst of a paragraph.
4115 \lskip=\leftskip \rskip=\rightskip 5822 \startsavinginserts
4116 \leftskip=0pt\rightskip=0pt %we want these *outside*. 5823 \lskip=\leftskip \rskip=\rightskip
4117 \cartinner=\hsize \advance\cartinner by-\lskip 5824 \leftskip=0pt\rightskip=0pt % we want these *outside*.
4118 \advance\cartinner by-\rskip 5825 \cartinner=\hsize \advance\cartinner by-\lskip
4119 \cartouter=\hsize 5826 \advance\cartinner by-\rskip
4120 \advance\cartouter by 18.4pt % allow for 3pt kerns on either 5827 \cartouter=\hsize
4121 % side, and for 6pt waste from 5828 \advance\cartouter by 18.4pt % allow for 3pt kerns on either
4122 % each corner char, and rule thickness 5829 % side, and for 6pt waste from
4123 \normbskip=\baselineskip \normpskip=\parskip \normlskip=\lineskip 5830 % each corner char, and rule thickness
4124 % Flag to tell @lisp, etc., not to narrow margin. 5831 \normbskip=\baselineskip \normpskip=\parskip \normlskip=\lineskip
4125 \let\nonarrowing=\comment 5832 % Flag to tell @lisp, etc., not to narrow margin.
4126 \vbox\bgroup 5833 \let\nonarrowing = t%
4127 \baselineskip=0pt\parskip=0pt\lineskip=0pt 5834 \vbox\bgroup
4128 \carttop 5835 \baselineskip=0pt\parskip=0pt\lineskip=0pt
4129 \hbox\bgroup 5836 \carttop
4130 \hskip\lskip 5837 \hbox\bgroup
4131 \vrule\kern3pt 5838 \hskip\lskip
4132 \vbox\bgroup 5839 \vrule\kern3pt
4133 \hsize=\cartinner 5840 \vbox\bgroup
4134 \kern3pt 5841 \kern3pt
4135 \begingroup 5842 \hsize=\cartinner
4136 \baselineskip=\normbskip 5843 \baselineskip=\normbskip
4137 \lineskip=\normlskip 5844 \lineskip=\normlskip
4138 \parskip=\normpskip 5845 \parskip=\normpskip
4139 \vskip -\parskip 5846 \vskip -\parskip
5847 \comment % For explanation, see the end of \def\group.
5848 }
4140 \def\Ecartouche{% 5849 \def\Ecartouche{%
4141 \endgroup 5850 \ifhmode\par\fi
4142 \kern3pt 5851 \kern3pt
4143 \egroup 5852 \egroup
4144 \kern3pt\vrule 5853 \kern3pt\vrule
4145 \hskip\rskip 5854 \hskip\rskip
4146 \egroup 5855 \egroup
4147 \cartbot 5856 \cartbot
4148 \egroup 5857 \egroup
4149 \endgroup 5858 \checkinserts
4150 }} 5859 }
4151 5860
4152 5861
4153 % This macro is called at the beginning of all the @example variants, 5862 % This macro is called at the beginning of all the @example variants,
4154 % inside a group. 5863 % inside a group.
4155 \def\nonfillstart{% 5864 \def\nonfillstart{%
4156 \aboveenvbreak 5865 \aboveenvbreak
4157 \inENV % This group ends at the end of the body
4158 \hfuzz = 12pt % Don't be fussy 5866 \hfuzz = 12pt % Don't be fussy
4159 \sepspaces % Make spaces be word-separators rather than space tokens. 5867 \sepspaces % Make spaces be word-separators rather than space tokens.
4160 \singlespace
4161 \let\par = \lisppar % don't ignore blank lines 5868 \let\par = \lisppar % don't ignore blank lines
4162 \obeylines % each line of input is a line of output 5869 \obeylines % each line of input is a line of output
4163 \parskip = 0pt 5870 \parskip = 0pt
4164 \parindent = 0pt 5871 \parindent = 0pt
4165 \emergencystretch = 0pt % don't try to avoid overfull boxes 5872 \emergencystretch = 0pt % don't try to avoid overfull boxes
4166 % @cartouche defines \nonarrowing to inhibit narrowing
4167 % at next level down.
4168 \ifx\nonarrowing\relax 5873 \ifx\nonarrowing\relax
4169 \advance \leftskip by \lispnarrowing 5874 \advance \leftskip by \lispnarrowing
4170 \exdentamount=\lispnarrowing 5875 \exdentamount=\lispnarrowing
4171 \let\exdent=\nofillexdent 5876 \else
4172 \let\nonarrowing=\relax 5877 \let\nonarrowing = \relax
4173 \fi 5878 \fi
4174 } 5879 \let\exdent=\nofillexdent
4175 5880 }
4176 % Define the \E... control sequence only if we are inside the particular 5881
4177 % environment, so the error checking in \end will work. 5882 % If you want all examples etc. small: @set dispenvsize small.
4178 % 5883 % If you want even small examples the full size: @set dispenvsize nosmall.
4179 % To end an @example-like environment, we first end the paragraph (via 5884 % This affects the following displayed environments:
4180 % \afterenvbreak's vertical glue), and then the group. That way we keep 5885 % @example, @display, @format, @lisp
4181 % the zero \parskip that the environments set -- \parskip glue will be 5886 %
4182 % inserted at the beginning of the next paragraph in the document, after 5887 \def\smallword{small}
4183 % the environment. 5888 \def\nosmallword{nosmall}
4184 % 5889 \let\SETdispenvsize\relax
4185 \def\nonfillfinish{\afterenvbreak\endgroup} 5890 \def\setnormaldispenv{%
4186 5891 \ifx\SETdispenvsize\smallword
4187 % @lisp: indented, narrowed, typewriter font. 5892 % end paragraph for sake of leading, in case document has no blank
4188 \def\lisp{\begingroup 5893 % line. This is redundant with what happens in \aboveenvbreak, but
5894 % we need to do it before changing the fonts, and it's inconvenient
5895 % to change the fonts afterward.
5896 \ifnum \lastpenalty=10000 \else \endgraf \fi
5897 \smallexamplefonts \rm
5898 \fi
5899 }
5900 \def\setsmalldispenv{%
5901 \ifx\SETdispenvsize\nosmallword
5902 \else
5903 \ifnum \lastpenalty=10000 \else \endgraf \fi
5904 \smallexamplefonts \rm
5905 \fi
5906 }
5907
5908 % We often define two environments, @foo and @smallfoo.
5909 % Let's do it by one command:
5910 \def\makedispenv #1#2{
5911 \expandafter\envdef\csname#1\endcsname {\setnormaldispenv #2}
5912 \expandafter\envdef\csname small#1\endcsname {\setsmalldispenv #2}
5913 \expandafter\let\csname E#1\endcsname \afterenvbreak
5914 \expandafter\let\csname Esmall#1\endcsname \afterenvbreak
5915 }
5916
5917 % Define two synonyms:
5918 \def\maketwodispenvs #1#2#3{
5919 \makedispenv{#1}{#3}
5920 \makedispenv{#2}{#3}
5921 }
5922
5923 % @lisp: indented, narrowed, typewriter font; @example: same as @lisp.
5924 %
5925 % @smallexample and @smalllisp: use smaller fonts.
5926 % Originally contributed by Pavel@xerox.
5927 %
5928 \maketwodispenvs {lisp}{example}{%
4189 \nonfillstart 5929 \nonfillstart
4190 \let\Elisp = \nonfillfinish 5930 \tt\quoteexpand
4191 \tt
4192 \let\kbdfont = \kbdexamplefont % Allow @kbd to do something special. 5931 \let\kbdfont = \kbdexamplefont % Allow @kbd to do something special.
4193 \gobble % eat return 5932 \gobble % eat return
4194 } 5933 }
4195 5934 % @display/@smalldisplay: same as @lisp except keep current font.
4196 % @example: Same as @lisp. 5935 %
4197 \def\example{\begingroup \def\Eexample{\nonfillfinish\endgroup}\lisp} 5936 \makedispenv {display}{%
4198
4199 % @small... is usually equivalent to the non-small (@smallbook
4200 % redefines). We must call \example (or whatever) last in the
4201 % definition, since it reads the return following the @example (or
4202 % whatever) command.
4203 %
4204 % This actually allows (for example) @end display inside an
4205 % @smalldisplay. Too bad, but makeinfo will catch the error anyway.
4206 %
4207 \def\smalldisplay{\begingroup\def\Esmalldisplay{\nonfillfinish\endgroup}\display}
4208 \def\smallexample{\begingroup\def\Esmallexample{\nonfillfinish\endgroup}\lisp}
4209 \def\smallformat{\begingroup\def\Esmallformat{\nonfillfinish\endgroup}\format}
4210 \def\smalllisp{\begingroup\def\Esmalllisp{\nonfillfinish\endgroup}\lisp}
4211
4212 % Real @smallexample and @smalllisp (when @smallbook): use smaller fonts.
4213 % Originally contributed by Pavel@xerox.
4214 \def\smalllispx{\begingroup
4215 \def\Esmalllisp{\nonfillfinish\endgroup}%
4216 \def\Esmallexample{\nonfillfinish\endgroup}%
4217 \smallfonts
4218 \lisp
4219 }
4220
4221 % @display: same as @lisp except keep current font.
4222 %
4223 \def\display{\begingroup
4224 \nonfillstart 5937 \nonfillstart
4225 \let\Edisplay = \nonfillfinish
4226 \gobble 5938 \gobble
4227 } 5939 }
4228 5940
4229 % @smalldisplay (when @smallbook): @display plus smaller fonts. 5941 % @format/@smallformat: same as @display except don't narrow margins.
4230 % 5942 %
4231 \def\smalldisplayx{\begingroup 5943 \makedispenv{format}{%
4232 \def\Esmalldisplay{\nonfillfinish\endgroup}% 5944 \let\nonarrowing = t%
4233 \smallfonts \rm
4234 \display
4235 }
4236
4237 % @format: same as @display except don't narrow margins.
4238 %
4239 \def\format{\begingroup
4240 \let\nonarrowing = t
4241 \nonfillstart 5945 \nonfillstart
4242 \let\Eformat = \nonfillfinish
4243 \gobble 5946 \gobble
4244 } 5947 }
4245 5948
4246 % @smallformat (when @smallbook): @format plus smaller fonts. 5949 % @flushleft: same as @format, but doesn't obey \SETdispenvsize.
4247 % 5950 \envdef\flushleft{%
4248 \def\smallformatx{\begingroup 5951 \let\nonarrowing = t%
4249 \def\Esmallformat{\nonfillfinish\endgroup}% 5952 \nonfillstart
4250 \smallfonts \rm 5953 \gobble
4251 \format 5954 }
4252 } 5955 \let\Eflushleft = \afterenvbreak
4253
4254 % @flushleft (same as @format).
4255 %
4256 \def\flushleft{\begingroup \def\Eflushleft{\nonfillfinish\endgroup}\format}
4257 5956
4258 % @flushright. 5957 % @flushright.
4259 % 5958 %
4260 \def\flushright{\begingroup 5959 \envdef\flushright{%
4261 \let\nonarrowing = t 5960 \let\nonarrowing = t%
4262 \nonfillstart 5961 \nonfillstart
4263 \let\Eflushright = \nonfillfinish
4264 \advance\leftskip by 0pt plus 1fill 5962 \advance\leftskip by 0pt plus 1fill
4265 \gobble 5963 \gobble
4266 } 5964 }
5965 \let\Eflushright = \afterenvbreak
5966
4267 5967
4268 % @quotation does normal linebreaking (hence we can't use \nonfillstart) 5968 % @quotation does normal linebreaking (hence we can't use \nonfillstart)
4269 % and narrows the margins. 5969 % and narrows the margins. We keep \parskip nonzero in general, since
4270 % 5970 % we're doing normal filling. So, when using \aboveenvbreak and
4271 \def\quotation{% 5971 % \afterenvbreak, temporarily make \parskip 0.
4272 \begingroup\inENV %This group ends at the end of the @quotation body 5972 %
5973 \envdef\quotation{%
4273 {\parskip=0pt \aboveenvbreak}% because \aboveenvbreak inserts \parskip 5974 {\parskip=0pt \aboveenvbreak}% because \aboveenvbreak inserts \parskip
4274 \singlespace
4275 \parindent=0pt 5975 \parindent=0pt
4276 % We have retained a nonzero parskip for the environment, since we're
4277 % doing normal filling. So to avoid extra space below the environment...
4278 \def\Equotation{\parskip = 0pt \nonfillfinish}%
4279 % 5976 %
4280 % @cartouche defines \nonarrowing to inhibit narrowing at next level down. 5977 % @cartouche defines \nonarrowing to inhibit narrowing at next level down.
4281 \ifx\nonarrowing\relax 5978 \ifx\nonarrowing\relax
4282 \advance\leftskip by \lispnarrowing 5979 \advance\leftskip by \lispnarrowing
4283 \advance\rightskip by \lispnarrowing 5980 \advance\rightskip by \lispnarrowing
4284 \exdentamount = \lispnarrowing 5981 \exdentamount = \lispnarrowing
5982 \else
4285 \let\nonarrowing = \relax 5983 \let\nonarrowing = \relax
4286 \fi 5984 \fi
5985 \parsearg\quotationlabel
5986 }
5987
5988 % We have retained a nonzero parskip for the environment, since we're
5989 % doing normal filling.
5990 %
5991 \def\Equotation{%
5992 \par
5993 \ifx\quotationauthor\undefined\else
5994 % indent a bit.
5995 \leftline{\kern 2\leftskip \sl ---\quotationauthor}%
5996 \fi
5997 {\parskip=0pt \afterenvbreak}%
5998 }
5999
6000 % If we're given an argument, typeset it in bold with a colon after.
6001 \def\quotationlabel#1{%
6002 \def\temp{#1}%
6003 \ifx\temp\empty \else
6004 {\bf #1: }%
6005 \fi
6006 }
6007
6008
6009 % LaTeX-like @verbatim...@end verbatim and @verb{<char>...<char>}
6010 % If we want to allow any <char> as delimiter,
6011 % we need the curly braces so that makeinfo sees the @verb command, eg:
6012 % `@verbx...x' would look like the '@verbx' command. --janneke@gnu.org
6013 %
6014 % [Knuth]: Donald Ervin Knuth, 1996. The TeXbook.
6015 %
6016 % [Knuth] p.344; only we need to do the other characters Texinfo sets
6017 % active too. Otherwise, they get lost as the first character on a
6018 % verbatim line.
6019 \def\dospecials{%
6020 \do\ \do\\\do\{\do\}\do\$\do\&%
6021 \do\#\do\^\do\^^K\do\_\do\^^A\do\%\do\~%
6022 \do\<\do\>\do\|\do\@\do+\do\"%
6023 }
6024 %
6025 % [Knuth] p. 380
6026 \def\uncatcodespecials{%
6027 \def\do##1{\catcode`##1=\other}\dospecials}
6028 %
6029 % [Knuth] pp. 380,381,391
6030 % Disable Spanish ligatures ?` and !` of \tt font
6031 \begingroup
6032 \catcode`\`=\active\gdef`{\relax\lq}
6033 \endgroup
6034 %
6035 % Setup for the @verb command.
6036 %
6037 % Eight spaces for a tab
6038 \begingroup
6039 \catcode`\^^I=\active
6040 \gdef\tabeightspaces{\catcode`\^^I=\active\def^^I{\ \ \ \ \ \ \ \ }}
6041 \endgroup
6042 %
6043 \def\setupverb{%
6044 \tt % easiest (and conventionally used) font for verbatim
6045 \def\par{\leavevmode\endgraf}%
6046 \catcode`\`=\active
6047 \tabeightspaces
6048 % Respect line breaks,
6049 % print special symbols as themselves, and
6050 % make each space count
6051 % must do in this order:
6052 \obeylines \uncatcodespecials \sepspaces
6053 }
6054
6055 % Setup for the @verbatim environment
6056 %
6057 % Real tab expansion
6058 \newdimen\tabw \setbox0=\hbox{\tt\space} \tabw=8\wd0 % tab amount
6059 %
6060 \def\starttabbox{\setbox0=\hbox\bgroup}
6061
6062 % Allow an option to not replace quotes with a regular directed right
6063 % quote/apostrophe (char 0x27), but instead use the undirected quote
6064 % from cmtt (char 0x0d). The undirected quote is ugly, so don't make it
6065 % the default, but it works for pasting with more pdf viewers (at least
6066 % evince), the lilypond developers report. xpdf does work with the
6067 % regular 0x27.
6068 %
6069 \def\codequoteright{%
6070 \expandafter\ifx\csname SETtxicodequoteundirected\endcsname\relax
6071 \expandafter\ifx\csname SETcodequoteundirected\endcsname\relax
6072 '%
6073 \else \char'15 \fi
6074 \else \char'15 \fi
6075 }
6076 %
6077 % and a similar option for the left quote char vs. a grave accent.
6078 % Modern fonts display ASCII 0x60 as a grave accent, so some people like
6079 % the code environments to do likewise.
6080 %
6081 \def\codequoteleft{%
6082 \expandafter\ifx\csname SETtxicodequotebacktick\endcsname\relax
6083 \expandafter\ifx\csname SETcodequotebacktick\endcsname\relax
6084 `%
6085 \else \char'22 \fi
6086 \else \char'22 \fi
6087 }
6088 %
6089 \begingroup
6090 \catcode`\^^I=\active
6091 \gdef\tabexpand{%
6092 \catcode`\^^I=\active
6093 \def^^I{\leavevmode\egroup
6094 \dimen0=\wd0 % the width so far, or since the previous tab
6095 \divide\dimen0 by\tabw
6096 \multiply\dimen0 by\tabw % compute previous multiple of \tabw
6097 \advance\dimen0 by\tabw % advance to next multiple of \tabw
6098 \wd0=\dimen0 \box0 \starttabbox
6099 }%
6100 }
6101 \catcode`\'=\active
6102 \gdef\rquoteexpand{\catcode\rquoteChar=\active \def'{\codequoteright}}%
6103 %
6104 \catcode`\`=\active
6105 \gdef\lquoteexpand{\catcode\lquoteChar=\active \def`{\codequoteleft}}%
6106 %
6107 \gdef\quoteexpand{\rquoteexpand \lquoteexpand}%
6108 \endgroup
6109
6110 % start the verbatim environment.
6111 \def\setupverbatim{%
6112 \let\nonarrowing = t%
6113 \nonfillstart
6114 % Easiest (and conventionally used) font for verbatim
6115 \tt
6116 \def\par{\leavevmode\egroup\box0\endgraf}%
6117 \catcode`\`=\active
6118 \tabexpand
6119 \quoteexpand
6120 % Respect line breaks,
6121 % print special symbols as themselves, and
6122 % make each space count
6123 % must do in this order:
6124 \obeylines \uncatcodespecials \sepspaces
6125 \everypar{\starttabbox}%
6126 }
6127
6128 % Do the @verb magic: verbatim text is quoted by unique
6129 % delimiter characters. Before first delimiter expect a
6130 % right brace, after last delimiter expect closing brace:
6131 %
6132 % \def\doverb'{'<char>#1<char>'}'{#1}
6133 %
6134 % [Knuth] p. 382; only eat outer {}
6135 \begingroup
6136 \catcode`[=1\catcode`]=2\catcode`\{=\other\catcode`\}=\other
6137 \gdef\doverb{#1[\def\next##1#1}[##1\endgroup]\next]
6138 \endgroup
6139 %
6140 \def\verb{\begingroup\setupverb\doverb}
6141 %
6142 %
6143 % Do the @verbatim magic: define the macro \doverbatim so that
6144 % the (first) argument ends when '@end verbatim' is reached, ie:
6145 %
6146 % \def\doverbatim#1@end verbatim{#1}
6147 %
6148 % For Texinfo it's a lot easier than for LaTeX,
6149 % because texinfo's \verbatim doesn't stop at '\end{verbatim}':
6150 % we need not redefine '\', '{' and '}'.
6151 %
6152 % Inspired by LaTeX's verbatim command set [latex.ltx]
6153 %
6154 \begingroup
6155 \catcode`\ =\active
6156 \obeylines %
6157 % ignore everything up to the first ^^M, that's the newline at the end
6158 % of the @verbatim input line itself. Otherwise we get an extra blank
6159 % line in the output.
6160 \xdef\doverbatim#1^^M#2@end verbatim{#2\noexpand\end\gobble verbatim}%
6161 % We really want {...\end verbatim} in the body of the macro, but
6162 % without the active space; thus we have to use \xdef and \gobble.
6163 \endgroup
6164 %
6165 \envdef\verbatim{%
6166 \setupverbatim\doverbatim
6167 }
6168 \let\Everbatim = \afterenvbreak
6169
6170
6171 % @verbatiminclude FILE - insert text of file in verbatim environment.
6172 %
6173 \def\verbatiminclude{\parseargusing\filenamecatcodes\doverbatiminclude}
6174 %
6175 \def\doverbatiminclude#1{%
6176 {%
6177 \makevalueexpandable
6178 \setupverbatim
6179 \input #1
6180 \afterenvbreak
6181 }%
6182 }
6183
6184 % @copying ... @end copying.
6185 % Save the text away for @insertcopying later.
6186 %
6187 % We save the uninterpreted tokens, rather than creating a box.
6188 % Saving the text in a box would be much easier, but then all the
6189 % typesetting commands (@smallbook, font changes, etc.) have to be done
6190 % beforehand -- and a) we want @copying to be done first in the source
6191 % file; b) letting users define the frontmatter in as flexible order as
6192 % possible is very desirable.
6193 %
6194 \def\copying{\checkenv{}\begingroup\scanargctxt\docopying}
6195 \def\docopying#1@end copying{\endgroup\def\copyingtext{#1}}
6196 %
6197 \def\insertcopying{%
6198 \begingroup
6199 \parindent = 0pt % paragraph indentation looks wrong on title page
6200 \scanexp\copyingtext
6201 \endgroup
4287 } 6202 }
4288 6203
4289 6204
4290 \message{defuns,} 6205 \message{defuns,}
4291 % @defun etc. 6206 % @defun etc.
4292 6207
4293 % Allow user to change definition object font (\df) internally
4294 \def\setdeffont #1 {\csname DEF#1\endcsname}
4295
4296 \newskip\defbodyindent \defbodyindent=.4in 6208 \newskip\defbodyindent \defbodyindent=.4in
4297 \newskip\defargsindent \defargsindent=50pt 6209 \newskip\defargsindent \defargsindent=50pt
4298 \newskip\deftypemargin \deftypemargin=12pt
4299 \newskip\deflastargmargin \deflastargmargin=18pt 6210 \newskip\deflastargmargin \deflastargmargin=18pt
4300 6211 \newcount\defunpenalty
4301 \newcount\parencount 6212
4302 % define \functionparens, which makes ( and ) and & do special things. 6213 % Start the processing of @deffn:
4303 % \functionparens affects the group it is contained in. 6214 \def\startdefun{%
6215 \ifnum\lastpenalty<10000
6216 \medbreak
6217 \defunpenalty=10003 % Will keep this @deffn together with the
6218 % following @def command, see below.
6219 \else
6220 % If there are two @def commands in a row, we'll have a \nobreak,
6221 % which is there to keep the function description together with its
6222 % header. But if there's nothing but headers, we need to allow a
6223 % break somewhere. Check specifically for penalty 10002, inserted
6224 % by \printdefunline, instead of 10000, since the sectioning
6225 % commands also insert a nobreak penalty, and we don't want to allow
6226 % a break between a section heading and a defun.
6227 %
6228 % As a minor refinement, we avoid "club" headers by signalling
6229 % with penalty of 10003 after the very first @deffn in the
6230 % sequence (see above), and penalty of 10002 after any following
6231 % @def command.
6232 \ifnum\lastpenalty=10002 \penalty2000 \else \defunpenalty=10002 \fi
6233 %
6234 % Similarly, after a section heading, do not allow a break.
6235 % But do insert the glue.
6236 \medskip % preceded by discardable penalty, so not a breakpoint
6237 \fi
6238 %
6239 \parindent=0in
6240 \advance\leftskip by \defbodyindent
6241 \exdentamount=\defbodyindent
6242 }
6243
6244 \def\dodefunx#1{%
6245 % First, check whether we are in the right environment:
6246 \checkenv#1%
6247 %
6248 % As above, allow line break if we have multiple x headers in a row.
6249 % It's not a great place, though.
6250 \ifnum\lastpenalty=10002 \penalty3000 \else \defunpenalty=10002 \fi
6251 %
6252 % And now, it's time to reuse the body of the original defun:
6253 \expandafter\gobbledefun#1%
6254 }
6255 \def\gobbledefun#1\startdefun{}
6256
6257 % \printdefunline \deffnheader{text}
6258 %
6259 \def\printdefunline#1#2{%
6260 \begingroup
6261 % call \deffnheader:
6262 #1#2 \endheader
6263 % common ending:
6264 \interlinepenalty = 10000
6265 \advance\rightskip by 0pt plus 1fil
6266 \endgraf
6267 \nobreak\vskip -\parskip
6268 \penalty\defunpenalty % signal to \startdefun and \dodefunx
6269 % Some of the @defun-type tags do not enable magic parentheses,
6270 % rendering the following check redundant. But we don't optimize.
6271 \checkparencounts
6272 \endgroup
6273 }
6274
6275 \def\Edefun{\endgraf\medbreak}
6276
6277 % \makedefun{deffn} creates \deffn, \deffnx and \Edeffn;
6278 % the only thing remaining is to define \deffnheader.
6279 %
6280 \def\makedefun#1{%
6281 \expandafter\let\csname E#1\endcsname = \Edefun
6282 \edef\temp{\noexpand\domakedefun
6283 \makecsname{#1}\makecsname{#1x}\makecsname{#1header}}%
6284 \temp
6285 }
6286
6287 % \domakedefun \deffn \deffnx \deffnheader
6288 %
6289 % Define \deffn and \deffnx, without parameters.
6290 % \deffnheader has to be defined explicitly.
6291 %
6292 \def\domakedefun#1#2#3{%
6293 \envdef#1{%
6294 \startdefun
6295 \parseargusing\activeparens{\printdefunline#3}%
6296 }%
6297 \def#2{\dodefunx#1}%
6298 \def#3%
6299 }
6300
6301 %%% Untyped functions:
6302
6303 % @deffn category name args
6304 \makedefun{deffn}{\deffngeneral{}}
6305
6306 % @deffn category class name args
6307 \makedefun{defop}#1 {\defopon{#1\ \putwordon}}
6308
6309 % \defopon {category on}class name args
6310 \def\defopon#1#2 {\deffngeneral{\putwordon\ \code{#2}}{#1\ \code{#2}} }
6311
6312 % \deffngeneral {subind}category name args
6313 %
6314 \def\deffngeneral#1#2 #3 #4\endheader{%
6315 % Remember that \dosubind{fn}{foo}{} is equivalent to \doind{fn}{foo}.
6316 \dosubind{fn}{\code{#3}}{#1}%
6317 \defname{#2}{}{#3}\magicamp\defunargs{#4\unskip}%
6318 }
6319
6320 %%% Typed functions:
6321
6322 % @deftypefn category type name args
6323 \makedefun{deftypefn}{\deftypefngeneral{}}
6324
6325 % @deftypeop category class type name args
6326 \makedefun{deftypeop}#1 {\deftypeopon{#1\ \putwordon}}
6327
6328 % \deftypeopon {category on}class type name args
6329 \def\deftypeopon#1#2 {\deftypefngeneral{\putwordon\ \code{#2}}{#1\ \code{#2}} }
6330
6331 % \deftypefngeneral {subind}category type name args
6332 %
6333 \def\deftypefngeneral#1#2 #3 #4 #5\endheader{%
6334 \dosubind{fn}{\code{#4}}{#1}%
6335 \defname{#2}{#3}{#4}\defunargs{#5\unskip}%
6336 }
6337
6338 %%% Typed variables:
6339
6340 % @deftypevr category type var args
6341 \makedefun{deftypevr}{\deftypecvgeneral{}}
6342
6343 % @deftypecv category class type var args
6344 \makedefun{deftypecv}#1 {\deftypecvof{#1\ \putwordof}}
6345
6346 % \deftypecvof {category of}class type var args
6347 \def\deftypecvof#1#2 {\deftypecvgeneral{\putwordof\ \code{#2}}{#1\ \code{#2}} }
6348
6349 % \deftypecvgeneral {subind}category type var args
6350 %
6351 \def\deftypecvgeneral#1#2 #3 #4 #5\endheader{%
6352 \dosubind{vr}{\code{#4}}{#1}%
6353 \defname{#2}{#3}{#4}\defunargs{#5\unskip}%
6354 }
6355
6356 %%% Untyped variables:
6357
6358 % @defvr category var args
6359 \makedefun{defvr}#1 {\deftypevrheader{#1} {} }
6360
6361 % @defcv category class var args
6362 \makedefun{defcv}#1 {\defcvof{#1\ \putwordof}}
6363
6364 % \defcvof {category of}class var args
6365 \def\defcvof#1#2 {\deftypecvof{#1}#2 {} }
6366
6367 %%% Type:
6368 % @deftp category name args
6369 \makedefun{deftp}#1 #2 #3\endheader{%
6370 \doind{tp}{\code{#2}}%
6371 \defname{#1}{}{#2}\defunargs{#3\unskip}%
6372 }
6373
6374 % Remaining @defun-like shortcuts:
6375 \makedefun{defun}{\deffnheader{\putwordDeffunc} }
6376 \makedefun{defmac}{\deffnheader{\putwordDefmac} }
6377 \makedefun{defspec}{\deffnheader{\putwordDefspec} }
6378 \makedefun{deftypefun}{\deftypefnheader{\putwordDeffunc} }
6379 \makedefun{defvar}{\defvrheader{\putwordDefvar} }
6380 \makedefun{defopt}{\defvrheader{\putwordDefopt} }
6381 \makedefun{deftypevar}{\deftypevrheader{\putwordDefvar} }
6382 \makedefun{defmethod}{\defopon\putwordMethodon}
6383 \makedefun{deftypemethod}{\deftypeopon\putwordMethodon}
6384 \makedefun{defivar}{\defcvof\putwordInstanceVariableof}
6385 \makedefun{deftypeivar}{\deftypecvof\putwordInstanceVariableof}
6386
6387 % \defname, which formats the name of the @def (not the args).
6388 % #1 is the category, such as "Function".
6389 % #2 is the return type, if any.
6390 % #3 is the function name.
6391 %
6392 % We are followed by (but not passed) the arguments, if any.
6393 %
6394 \def\defname#1#2#3{%
6395 % Get the values of \leftskip and \rightskip as they were outside the @def...
6396 \advance\leftskip by -\defbodyindent
6397 %
6398 % How we'll format the type name. Putting it in brackets helps
6399 % distinguish it from the body text that may end up on the next line
6400 % just below it.
6401 \def\temp{#1}%
6402 \setbox0=\hbox{\kern\deflastargmargin \ifx\temp\empty\else [\rm\temp]\fi}
6403 %
6404 % Figure out line sizes for the paragraph shape.
6405 % The first line needs space for \box0; but if \rightskip is nonzero,
6406 % we need only space for the part of \box0 which exceeds it:
6407 \dimen0=\hsize \advance\dimen0 by -\wd0 \advance\dimen0 by \rightskip
6408 % The continuations:
6409 \dimen2=\hsize \advance\dimen2 by -\defargsindent
6410 % (plain.tex says that \dimen1 should be used only as global.)
6411 \parshape 2 0in \dimen0 \defargsindent \dimen2
6412 %
6413 % Put the type name to the right margin.
6414 \noindent
6415 \hbox to 0pt{%
6416 \hfil\box0 \kern-\hsize
6417 % \hsize has to be shortened this way:
6418 \kern\leftskip
6419 % Intentionally do not respect \rightskip, since we need the space.
6420 }%
6421 %
6422 % Allow all lines to be underfull without complaint:
6423 \tolerance=10000 \hbadness=10000
6424 \exdentamount=\defbodyindent
6425 {%
6426 % defun fonts. We use typewriter by default (used to be bold) because:
6427 % . we're printing identifiers, they should be in tt in principle.
6428 % . in languages with many accents, such as Czech or French, it's
6429 % common to leave accents off identifiers. The result looks ok in
6430 % tt, but exceedingly strange in rm.
6431 % . we don't want -- and --- to be treated as ligatures.
6432 % . this still does not fix the ?` and !` ligatures, but so far no
6433 % one has made identifiers using them :).
6434 \df \tt
6435 \def\temp{#2}% return value type
6436 \ifx\temp\empty\else \tclose{\temp} \fi
6437 #3% output function name
6438 }%
6439 {\rm\enskip}% hskip 0.5 em of \tenrm
6440 %
6441 \boldbrax
6442 % arguments will be output next, if any.
6443 }
6444
6445 % Print arguments in slanted roman (not ttsl), inconsistently with using
6446 % tt for the name. This is because literal text is sometimes needed in
6447 % the argument list (groff manual), and ttsl and tt are not very
6448 % distinguishable. Prevent hyphenation at `-' chars.
6449 %
6450 \def\defunargs#1{%
6451 % use sl by default (not ttsl),
6452 % tt for the names.
6453 \df \sl \hyphenchar\font=0
6454 %
6455 % On the other hand, if an argument has two dashes (for instance), we
6456 % want a way to get ttsl. Let's try @var for that.
6457 \let\var=\ttslanted
6458 #1%
6459 \sl\hyphenchar\font=45
6460 }
6461
6462 % We want ()&[] to print specially on the defun line.
6463 %
4304 \def\activeparens{% 6464 \def\activeparens{%
4305 \catcode`\(=\active \catcode`\)=\active \catcode`\&=\active 6465 \catcode`\(=\active \catcode`\)=\active
4306 \catcode`\[=\active \catcode`\]=\active} 6466 \catcode`\[=\active \catcode`\]=\active
6467 \catcode`\&=\active
6468 }
4307 6469
4308 % Make control sequences which act like normal parenthesis chars. 6470 % Make control sequences which act like normal parenthesis chars.
4309 \let\lparen = ( \let\rparen = ) 6471 \let\lparen = ( \let\rparen = )
4310
4311 {\activeparens % Now, smart parens don't turn on until &foo (see \amprm)
4312 6472
4313 % Be sure that we always have a definition for `(', etc. For example, 6473 % Be sure that we always have a definition for `(', etc. For example,
4314 % if the fn name has parens in it, \boldbrax will not be in effect yet, 6474 % if the fn name has parens in it, \boldbrax will not be in effect yet,
4315 % so TeX would otherwise complain about undefined control sequence. 6475 % so TeX would otherwise complain about undefined control sequence.
4316 \global\let(=\lparen \global\let)=\rparen 6476 {
4317 \global\let[=\lbrack \global\let]=\rbrack 6477 \activeparens
4318 6478 \global\let(=\lparen \global\let)=\rparen
4319 \gdef\functionparens{\boldbrax\let&=\amprm\parencount=0 } 6479 \global\let[=\lbrack \global\let]=\rbrack
4320 \gdef\boldbrax{\let(=\opnr\let)=\clnr\let[=\lbrb\let]=\rbrb} 6480 \global\let& = \&
4321 % This is used to turn on special parens 6481
4322 % but make & act ordinary (given that it's active). 6482 \gdef\boldbrax{\let(=\opnr\let)=\clnr\let[=\lbrb\let]=\rbrb}
4323 \gdef\boldbraxnoamp{\let(=\opnr\let)=\clnr\let[=\lbrb\let]=\rbrb\let&=\ampnr} 6483 \gdef\magicamp{\let&=\amprm}
4324 6484 }
4325 % Definitions of (, ) and & used in args for functions. 6485
4326 % This is the definition of ( outside of all parentheses. 6486 \newcount\parencount
4327 \gdef\oprm#1 {{\rm\char`\(}#1 \bf \let(=\opnested 6487
6488 % If we encounter &foo, then turn on ()-hacking afterwards
6489 \newif\ifampseen
6490 \def\amprm#1 {\ampseentrue{\bf\&#1 }}
6491
6492 \def\parenfont{%
6493 \ifampseen
6494 % At the first level, print parens in roman,
6495 % otherwise use the default font.
6496 \ifnum \parencount=1 \rm \fi
6497 \else
6498 % The \sf parens (in \boldbrax) actually are a little bolder than
6499 % the contained text. This is especially needed for [ and ] .
6500 \sf
6501 \fi
6502 }
6503 \def\infirstlevel#1{%
6504 \ifampseen
6505 \ifnum\parencount=1
6506 #1%
6507 \fi
6508 \fi
6509 }
6510 \def\bfafterword#1 {#1 \bf}
6511
6512 \def\opnr{%
4328 \global\advance\parencount by 1 6513 \global\advance\parencount by 1
4329 } 6514 {\parenfont(}%
4330 % 6515 \infirstlevel \bfafterword
4331 % This is the definition of ( when already inside a level of parens. 6516 }
4332 \gdef\opnested{\char`\(\global\advance\parencount by 1 } 6517 \def\clnr{%
4333 % 6518 {\parenfont)}%
4334 \gdef\clrm{% Print a paren in roman if it is taking us back to depth of 0. 6519 \infirstlevel \sl
4335 % also in that case restore the outer-level definition of (. 6520 \global\advance\parencount by -1
4336 \ifnum \parencount=1 {\rm \char `\)}\sl \let(=\oprm \else \char `\) \fi 6521 }
4337 \global\advance \parencount by -1 } 6522
4338 % If we encounter &foo, then turn on ()-hacking afterwards 6523 \newcount\brackcount
4339 \gdef\amprm#1 {{\rm\&#1}\let(=\oprm \let)=\clrm\ } 6524 \def\lbrb{%
4340 % 6525 \global\advance\brackcount by 1
4341 \gdef\normalparens{\boldbrax\let&=\ampnr} 6526 {\bf[}%
4342 } % End of definition inside \activeparens 6527 }
4343 %% These parens (in \boldbrax) actually are a little bolder than the 6528 \def\rbrb{%
4344 %% contained text. This is especially needed for [ and ] 6529 {\bf]}%
4345 \def\opnr{{\sf\char`\(}\global\advance\parencount by 1 } 6530 \global\advance\brackcount by -1
4346 \def\clnr{{\sf\char`\)}\global\advance\parencount by -1 } 6531 }
4347 \let\ampnr = \& 6532
4348 \def\lbrb{{\bf\char`\[}} 6533 \def\checkparencounts{%
4349 \def\rbrb{{\bf\char`\]}} 6534 \ifnum\parencount=0 \else \badparencount \fi
4350 6535 \ifnum\brackcount=0 \else \badbrackcount \fi
4351 % Active &'s sneak into the index arguments, so make sure it's defined. 6536 }
4352 { 6537 % these should not use \errmessage; the glibc manual, at least, actually
4353 \catcode`& = 13 6538 % has such constructs (when documenting function pointers).
4354 \global\let& = \ampnr 6539 \def\badparencount{%
4355 } 6540 \message{Warning: unbalanced parentheses in @def...}%
4356 6541 \global\parencount=0
4357 % First, defname, which formats the header line itself. 6542 }
4358 % #1 should be the function name. 6543 \def\badbrackcount{%
4359 % #2 should be the type of definition, such as "Function". 6544 \message{Warning: unbalanced square brackets in @def...}%
4360 6545 \global\brackcount=0
4361 \def\defname #1#2{% 6546 }
4362 % Get the values of \leftskip and \rightskip as they were
4363 % outside the @def...
4364 \dimen2=\leftskip
4365 \advance\dimen2 by -\defbodyindent
4366 \noindent
4367 \setbox0=\hbox{\hskip \deflastargmargin{\rm #2}\hskip \deftypemargin}%
4368 \dimen0=\hsize \advance \dimen0 by -\wd0 % compute size for first line
4369 \dimen1=\hsize \advance \dimen1 by -\defargsindent %size for continuations
4370 \parshape 2 0in \dimen0 \defargsindent \dimen1
4371 % Now output arg 2 ("Function" or some such)
4372 % ending at \deftypemargin from the right margin,
4373 % but stuck inside a box of width 0 so it does not interfere with linebreaking
4374 {% Adjust \hsize to exclude the ambient margins,
4375 % so that \rightline will obey them.
4376 \advance \hsize by -\dimen2
4377 \rlap{\rightline{{\rm #2}\hskip -1.25pc }}}%
4378 % Make all lines underfull and no complaints:
4379 \tolerance=10000 \hbadness=10000
4380 \advance\leftskip by -\defbodyindent
4381 \exdentamount=\defbodyindent
4382 {\df #1}\enskip % Generate function name
4383 }
4384
4385 % Actually process the body of a definition
4386 % #1 should be the terminating control sequence, such as \Edefun.
4387 % #2 should be the "another name" control sequence, such as \defunx.
4388 % #3 should be the control sequence that actually processes the header,
4389 % such as \defunheader.
4390
4391 \def\defparsebody #1#2#3{\begingroup\inENV% Environment for definitionbody
4392 \medbreak %
4393 % Define the end token that this defining construct specifies
4394 % so that it will exit this group.
4395 \def#1{\endgraf\endgroup\medbreak}%
4396 \def#2{\begingroup\obeylines\activeparens\spacesplit#3}%
4397 \parindent=0in
4398 \advance\leftskip by \defbodyindent
4399 \exdentamount=\defbodyindent
4400 \begingroup %
4401 \catcode 61=\active % 61 is `='
4402 \obeylines\activeparens\spacesplit#3}
4403
4404 % #1 is the \E... control sequence to end the definition (which we define).
4405 % #2 is the \...x control sequence for consecutive fns (which we define).
4406 % #3 is the control sequence to call to resume processing.
4407 % #4, delimited by the space, is the class name.
4408 %
4409 \def\defmethparsebody#1#2#3#4 {\begingroup\inENV %
4410 \medbreak %
4411 % Define the end token that this defining construct specifies
4412 % so that it will exit this group.
4413 \def#1{\endgraf\endgroup\medbreak}%
4414 \def#2##1 {\begingroup\obeylines\activeparens\spacesplit{#3{##1}}}%
4415 \parindent=0in
4416 \advance\leftskip by \defbodyindent
4417 \exdentamount=\defbodyindent
4418 \begingroup\obeylines\activeparens\spacesplit{#3{#4}}}
4419
4420 % Used for @deftypemethod and @deftypeivar.
4421 % #1 is the \E... control sequence to end the definition (which we define).
4422 % #2 is the \...x control sequence for consecutive fns (which we define).
4423 % #3 is the control sequence to call to resume processing.
4424 % #4, delimited by a space, is the class name.
4425 % #5 is the method's return type.
4426 %
4427 \def\deftypemethparsebody#1#2#3#4 #5 {\begingroup\inENV
4428 \medbreak
4429 \def#1{\endgraf\endgroup\medbreak}%
4430 \def#2##1 ##2 {\begingroup\obeylines\activeparens\spacesplit{#3{##1}{##2}}}%
4431 \parindent=0in
4432 \advance\leftskip by \defbodyindent
4433 \exdentamount=\defbodyindent
4434 \begingroup\obeylines\activeparens\spacesplit{#3{#4}{#5}}}
4435
4436 % Used for @deftypeop. The change from \deftypemethparsebody is an
4437 % extra argument at the beginning which is the `category', instead of it
4438 % being the hardwired string `Method' or `Instance Variable'. We have
4439 % to account for this both in the \...x definition and in parsing the
4440 % input at hand. Thus also need a control sequence (passed as #5) for
4441 % the \E... definition to assign the category name to.
4442 %
4443 \def\deftypeopparsebody#1#2#3#4#5 #6 {\begingroup\inENV
4444 \medbreak
4445 \def#1{\endgraf\endgroup\medbreak}%
4446 \def#2##1 ##2 ##3 {%
4447 \def#4{##1}%
4448 \begingroup\obeylines\activeparens\spacesplit{#3{##2}{##3}}}%
4449 \parindent=0in
4450 \advance\leftskip by \defbodyindent
4451 \exdentamount=\defbodyindent
4452 \begingroup\obeylines\activeparens\spacesplit{#3{#5}{#6}}}
4453
4454 \def\defopparsebody #1#2#3#4#5 {\begingroup\inENV %
4455 \medbreak %
4456 % Define the end token that this defining construct specifies
4457 % so that it will exit this group.
4458 \def#1{\endgraf\endgroup\medbreak}%
4459 \def#2##1 ##2 {\def#4{##1}%
4460 \begingroup\obeylines\activeparens\spacesplit{#3{##2}}}%
4461 \parindent=0in
4462 \advance\leftskip by \defbodyindent
4463 \exdentamount=\defbodyindent
4464 \begingroup\obeylines\activeparens\spacesplit{#3{#5}}}
4465
4466 % These parsing functions are similar to the preceding ones
4467 % except that they do not make parens into active characters.
4468 % These are used for "variables" since they have no arguments.
4469
4470 \def\defvarparsebody #1#2#3{\begingroup\inENV% Environment for definitionbody
4471 \medbreak %
4472 % Define the end token that this defining construct specifies
4473 % so that it will exit this group.
4474 \def#1{\endgraf\endgroup\medbreak}%
4475 \def#2{\begingroup\obeylines\spacesplit#3}%
4476 \parindent=0in
4477 \advance\leftskip by \defbodyindent
4478 \exdentamount=\defbodyindent
4479 \begingroup %
4480 \catcode 61=\active %
4481 \obeylines\spacesplit#3}
4482
4483 % This is used for \def{tp,vr}parsebody. It could probably be used for
4484 % some of the others, too, with some judicious conditionals.
4485 %
4486 \def\parsebodycommon#1#2#3{%
4487 \begingroup\inENV %
4488 \medbreak %
4489 % Define the end token that this defining construct specifies
4490 % so that it will exit this group.
4491 \def#1{\endgraf\endgroup\medbreak}%
4492 \def#2##1 {\begingroup\obeylines\spacesplit{#3{##1}}}%
4493 \parindent=0in
4494 \advance\leftskip by \defbodyindent
4495 \exdentamount=\defbodyindent
4496 \begingroup\obeylines
4497 }
4498
4499 \def\defvrparsebody#1#2#3#4 {%
4500 \parsebodycommon{#1}{#2}{#3}%
4501 \spacesplit{#3{#4}}%
4502 }
4503
4504 % This loses on `@deftp {Data Type} {struct termios}' -- it thinks the
4505 % type is just `struct', because we lose the braces in `{struct
4506 % termios}' when \spacesplit reads its undelimited argument. Sigh.
4507 % \let\deftpparsebody=\defvrparsebody
4508 %
4509 % So, to get around this, we put \empty in with the type name. That
4510 % way, TeX won't find exactly `{...}' as an undelimited argument, and
4511 % won't strip off the braces.
4512 %
4513 \def\deftpparsebody #1#2#3#4 {%
4514 \parsebodycommon{#1}{#2}{#3}%
4515 \spacesplit{\parsetpheaderline{#3{#4}}}\empty
4516 }
4517
4518 % Fine, but then we have to eventually remove the \empty *and* the
4519 % braces (if any). That's what this does.
4520 %
4521 \def\removeemptybraces\empty#1\relax{#1}
4522
4523 % After \spacesplit has done its work, this is called -- #1 is the final
4524 % thing to call, #2 the type name (which starts with \empty), and #3
4525 % (which might be empty) the arguments.
4526 %
4527 \def\parsetpheaderline#1#2#3{%
4528 #1{\removeemptybraces#2\relax}{#3}%
4529 }%
4530
4531 \def\defopvarparsebody #1#2#3#4#5 {\begingroup\inENV %
4532 \medbreak %
4533 % Define the end token that this defining construct specifies
4534 % so that it will exit this group.
4535 \def#1{\endgraf\endgroup\medbreak}%
4536 \def#2##1 ##2 {\def#4{##1}%
4537 \begingroup\obeylines\spacesplit{#3{##2}}}%
4538 \parindent=0in
4539 \advance\leftskip by \defbodyindent
4540 \exdentamount=\defbodyindent
4541 \begingroup\obeylines\spacesplit{#3{#5}}}
4542
4543 % Split up #2 at the first space token.
4544 % call #1 with two arguments:
4545 % the first is all of #2 before the space token,
4546 % the second is all of #2 after that space token.
4547 % If #2 contains no space token, all of it is passed as the first arg
4548 % and the second is passed as empty.
4549
4550 {\obeylines
4551 \gdef\spacesplit#1#2^^M{\endgroup\spacesplitfoo{#1}#2 \relax\spacesplitfoo}%
4552 \long\gdef\spacesplitfoo#1#2 #3#4\spacesplitfoo{%
4553 \ifx\relax #3%
4554 #1{#2}{}\else #1{#2}{#3#4}\fi}}
4555
4556 % So much for the things common to all kinds of definitions.
4557
4558 % Define @defun.
4559
4560 % First, define the processing that is wanted for arguments of \defun
4561 % Use this to expand the args and terminate the paragraph they make up
4562
4563 \def\defunargs#1{\functionparens \sl
4564 % Expand, preventing hyphenation at `-' chars.
4565 % Note that groups don't affect changes in \hyphenchar.
4566 % Set the font temporarily and use \font in case \setfont made \tensl a macro.
4567 {\tensl\hyphenchar\font=0}%
4568 #1%
4569 {\tensl\hyphenchar\font=45}%
4570 \ifnum\parencount=0 \else \errmessage{Unbalanced parentheses in @def}\fi%
4571 \interlinepenalty=10000
4572 \advance\rightskip by 0pt plus 1fil
4573 \endgraf\nobreak\vskip -\parskip\nobreak
4574 }
4575
4576 \def\deftypefunargs #1{%
4577 % Expand, preventing hyphenation at `-' chars.
4578 % Note that groups don't affect changes in \hyphenchar.
4579 % Use \boldbraxnoamp, not \functionparens, so that & is not special.
4580 \boldbraxnoamp
4581 \tclose{#1}% avoid \code because of side effects on active chars
4582 \interlinepenalty=10000
4583 \advance\rightskip by 0pt plus 1fil
4584 \endgraf\nobreak\vskip -\parskip\nobreak
4585 }
4586
4587 % Do complete processing of one @defun or @defunx line already parsed.
4588
4589 % @deffn Command forward-char nchars
4590
4591 \def\deffn{\defmethparsebody\Edeffn\deffnx\deffnheader}
4592
4593 \def\deffnheader #1#2#3{\doind {fn}{\code{#2}}%
4594 \begingroup\defname {#2}{#1}\defunargs{#3}\endgroup %
4595 \catcode 61=\other % Turn off change made in \defparsebody
4596 }
4597
4598 % @defun == @deffn Function
4599
4600 \def\defun{\defparsebody\Edefun\defunx\defunheader}
4601
4602 \def\defunheader #1#2{\doind {fn}{\code{#1}}% Make entry in function index
4603 \begingroup\defname {#1}{\putwordDeffunc}%
4604 \defunargs {#2}\endgroup %
4605 \catcode 61=\other % Turn off change made in \defparsebody
4606 }
4607
4608 % @deftypefun int foobar (int @var{foo}, float @var{bar})
4609
4610 \def\deftypefun{\defparsebody\Edeftypefun\deftypefunx\deftypefunheader}
4611
4612 % #1 is the data type. #2 is the name and args.
4613 \def\deftypefunheader #1#2{\deftypefunheaderx{#1}#2 \relax}
4614 % #1 is the data type, #2 the name, #3 the args.
4615 \def\deftypefunheaderx #1#2 #3\relax{%
4616 \doind {fn}{\code{#2}}% Make entry in function index
4617 \begingroup\defname {\defheaderxcond#1\relax$$$#2}{\putwordDeftypefun}%
4618 \deftypefunargs {#3}\endgroup %
4619 \catcode 61=\other % Turn off change made in \defparsebody
4620 }
4621
4622 % @deftypefn {Library Function} int foobar (int @var{foo}, float @var{bar})
4623
4624 \def\deftypefn{\defmethparsebody\Edeftypefn\deftypefnx\deftypefnheader}
4625
4626 % \defheaderxcond#1\relax$$$
4627 % puts #1 in @code, followed by a space, but does nothing if #1 is null.
4628 \def\defheaderxcond#1#2$$${\ifx#1\relax\else\code{#1#2} \fi}
4629
4630 % #1 is the classification. #2 is the data type. #3 is the name and args.
4631 \def\deftypefnheader #1#2#3{\deftypefnheaderx{#1}{#2}#3 \relax}
4632 % #1 is the classification, #2 the data type, #3 the name, #4 the args.
4633 \def\deftypefnheaderx #1#2#3 #4\relax{%
4634 \doind {fn}{\code{#3}}% Make entry in function index
4635 \begingroup
4636 \normalparens % notably, turn off `&' magic, which prevents
4637 % at least some C++ text from working
4638 \defname {\defheaderxcond#2\relax$$$#3}{#1}%
4639 \deftypefunargs {#4}\endgroup %
4640 \catcode 61=\other % Turn off change made in \defparsebody
4641 }
4642
4643 % @defmac == @deffn Macro
4644
4645 \def\defmac{\defparsebody\Edefmac\defmacx\defmacheader}
4646
4647 \def\defmacheader #1#2{\doind {fn}{\code{#1}}% Make entry in function index
4648 \begingroup\defname {#1}{\putwordDefmac}%
4649 \defunargs {#2}\endgroup %
4650 \catcode 61=\other % Turn off change made in \defparsebody
4651 }
4652
4653 % @defspec == @deffn Special Form
4654
4655 \def\defspec{\defparsebody\Edefspec\defspecx\defspecheader}
4656
4657 \def\defspecheader #1#2{\doind {fn}{\code{#1}}% Make entry in function index
4658 \begingroup\defname {#1}{\putwordDefspec}%
4659 \defunargs {#2}\endgroup %
4660 \catcode 61=\other % Turn off change made in \defparsebody
4661 }
4662
4663 % @defop CATEGORY CLASS OPERATION ARG...
4664 %
4665 \def\defop #1 {\def\defoptype{#1}%
4666 \defopparsebody\Edefop\defopx\defopheader\defoptype}
4667 %
4668 \def\defopheader#1#2#3{%
4669 \dosubind {fn}{\code{#2}}{\putwordon\ #1}% Make entry in function index
4670 \begingroup\defname {#2}{\defoptype\ \putwordon\ #1}%
4671 \defunargs {#3}\endgroup %
4672 }
4673
4674 % @deftypeop CATEGORY CLASS TYPE OPERATION ARG...
4675 %
4676 \def\deftypeop #1 {\def\deftypeopcategory{#1}%
4677 \deftypeopparsebody\Edeftypeop\deftypeopx\deftypeopheader
4678 \deftypeopcategory}
4679 %
4680 % #1 is the class name, #2 the data type, #3 the operation name, #4 the args.
4681 \def\deftypeopheader#1#2#3#4{%
4682 \dosubind{fn}{\code{#3}}{\putwordon\ \code{#1}}% entry in function index
4683 \begingroup
4684 \defname{\defheaderxcond#2\relax$$$#3}
4685 {\deftypeopcategory\ \putwordon\ \code{#1}}%
4686 \deftypefunargs{#4}%
4687 \endgroup
4688 }
4689
4690 % @deftypemethod CLASS TYPE METHOD ARG...
4691 %
4692 \def\deftypemethod{%
4693 \deftypemethparsebody\Edeftypemethod\deftypemethodx\deftypemethodheader}
4694 %
4695 % #1 is the class name, #2 the data type, #3 the method name, #4 the args.
4696 \def\deftypemethodheader#1#2#3#4{%
4697 \dosubind{fn}{\code{#3}}{\putwordon\ \code{#1}}% entry in function index
4698 \begingroup
4699 \defname{\defheaderxcond#2\relax$$$#3}{\putwordMethodon\ \code{#1}}%
4700 \deftypefunargs{#4}%
4701 \endgroup
4702 }
4703
4704 % @deftypeivar CLASS TYPE VARNAME
4705 %
4706 \def\deftypeivar{%
4707 \deftypemethparsebody\Edeftypeivar\deftypeivarx\deftypeivarheader}
4708 %
4709 % #1 is the class name, #2 the data type, #3 the variable name.
4710 \def\deftypeivarheader#1#2#3{%
4711 \dosubind{vr}{\code{#3}}{\putwordof\ \code{#1}}% entry in variable index
4712 \begingroup
4713 \defname{#3}{\putwordInstanceVariableof\ \code{#1}}%
4714 \defvarargs{#3}%
4715 \endgroup
4716 }
4717
4718 % @defmethod == @defop Method
4719 %
4720 \def\defmethod{\defmethparsebody\Edefmethod\defmethodx\defmethodheader}
4721 %
4722 % #1 is the class name, #2 the method name, #3 the args.
4723 \def\defmethodheader#1#2#3{%
4724 \dosubind{fn}{\code{#2}}{\putwordon\ \code{#1}}% entry in function index
4725 \begingroup
4726 \defname{#2}{\putwordMethodon\ \code{#1}}%
4727 \defunargs{#3}%
4728 \endgroup
4729 }
4730
4731 % @defcv {Class Option} foo-class foo-flag
4732
4733 \def\defcv #1 {\def\defcvtype{#1}%
4734 \defopvarparsebody\Edefcv\defcvx\defcvarheader\defcvtype}
4735
4736 \def\defcvarheader #1#2#3{%
4737 \dosubind {vr}{\code{#2}}{\putwordof\ #1}% Make entry in var index
4738 \begingroup\defname {#2}{\defcvtype\ \putwordof\ #1}%
4739 \defvarargs {#3}\endgroup %
4740 }
4741
4742 % @defivar CLASS VARNAME == @defcv {Instance Variable} CLASS VARNAME
4743 %
4744 \def\defivar{\defvrparsebody\Edefivar\defivarx\defivarheader}
4745 %
4746 \def\defivarheader#1#2#3{%
4747 \dosubind {vr}{\code{#2}}{\putwordof\ #1}% entry in var index
4748 \begingroup
4749 \defname{#2}{\putwordInstanceVariableof\ #1}%
4750 \defvarargs{#3}%
4751 \endgroup
4752 }
4753
4754 % @defvar
4755 % First, define the processing that is wanted for arguments of @defvar.
4756 % This is actually simple: just print them in roman.
4757 % This must expand the args and terminate the paragraph they make up
4758 \def\defvarargs #1{\normalparens #1%
4759 \interlinepenalty=10000
4760 \endgraf\nobreak\vskip -\parskip\nobreak}
4761
4762 % @defvr Counter foo-count
4763
4764 \def\defvr{\defvrparsebody\Edefvr\defvrx\defvrheader}
4765
4766 \def\defvrheader #1#2#3{\doind {vr}{\code{#2}}%
4767 \begingroup\defname {#2}{#1}\defvarargs{#3}\endgroup}
4768
4769 % @defvar == @defvr Variable
4770
4771 \def\defvar{\defvarparsebody\Edefvar\defvarx\defvarheader}
4772
4773 \def\defvarheader #1#2{\doind {vr}{\code{#1}}% Make entry in var index
4774 \begingroup\defname {#1}{\putwordDefvar}%
4775 \defvarargs {#2}\endgroup %
4776 }
4777
4778 % @defopt == @defvr {User Option}
4779
4780 \def\defopt{\defvarparsebody\Edefopt\defoptx\defoptheader}
4781
4782 \def\defoptheader #1#2{\doind {vr}{\code{#1}}% Make entry in var index
4783 \begingroup\defname {#1}{\putwordDefopt}%
4784 \defvarargs {#2}\endgroup %
4785 }
4786
4787 % @deftypevar int foobar
4788
4789 \def\deftypevar{\defvarparsebody\Edeftypevar\deftypevarx\deftypevarheader}
4790
4791 % #1 is the data type. #2 is the name, perhaps followed by text that
4792 % is actually part of the data type, which should not be put into the index.
4793 \def\deftypevarheader #1#2{%
4794 \dovarind#2 \relax% Make entry in variables index
4795 \begingroup\defname {\defheaderxcond#1\relax$$$#2}{\putwordDeftypevar}%
4796 \interlinepenalty=10000
4797 \endgraf\nobreak\vskip -\parskip\nobreak
4798 \endgroup}
4799 \def\dovarind#1 #2\relax{\doind{vr}{\code{#1}}}
4800
4801 % @deftypevr {Global Flag} int enable
4802
4803 \def\deftypevr{\defvrparsebody\Edeftypevr\deftypevrx\deftypevrheader}
4804
4805 \def\deftypevrheader #1#2#3{\dovarind#3 \relax%
4806 \begingroup\defname {\defheaderxcond#2\relax$$$#3}{#1}
4807 \interlinepenalty=10000
4808 \endgraf\nobreak\vskip -\parskip\nobreak
4809 \endgroup}
4810
4811 % Now define @deftp
4812 % Args are printed in bold, a slight difference from @defvar.
4813
4814 \def\deftpargs #1{\bf \defvarargs{#1}}
4815
4816 % @deftp Class window height width ...
4817
4818 \def\deftp{\deftpparsebody\Edeftp\deftpx\deftpheader}
4819
4820 \def\deftpheader #1#2#3{\doind {tp}{\code{#2}}%
4821 \begingroup\defname {#2}{#1}\deftpargs{#3}\endgroup}
4822
4823 % These definitions are used if you use @defunx (etc.)
4824 % anywhere other than immediately after a @defun or @defunx.
4825 %
4826 \def\defcvx#1 {\errmessage{@defcvx in invalid context}}
4827 \def\deffnx#1 {\errmessage{@deffnx in invalid context}}
4828 \def\defivarx#1 {\errmessage{@defivarx in invalid context}}
4829 \def\defmacx#1 {\errmessage{@defmacx in invalid context}}
4830 \def\defmethodx#1 {\errmessage{@defmethodx in invalid context}}
4831 \def\defoptx #1 {\errmessage{@defoptx in invalid context}}
4832 \def\defopx#1 {\errmessage{@defopx in invalid context}}
4833 \def\defspecx#1 {\errmessage{@defspecx in invalid context}}
4834 \def\deftpx#1 {\errmessage{@deftpx in invalid context}}
4835 \def\deftypefnx#1 {\errmessage{@deftypefnx in invalid context}}
4836 \def\deftypefunx#1 {\errmessage{@deftypefunx in invalid context}}
4837 \def\deftypeivarx#1 {\errmessage{@deftypeivarx in invalid context}}
4838 \def\deftypemethodx#1 {\errmessage{@deftypemethodx in invalid context}}
4839 \def\deftypeopx#1 {\errmessage{@deftypeopx in invalid context}}
4840 \def\deftypevarx#1 {\errmessage{@deftypevarx in invalid context}}
4841 \def\deftypevrx#1 {\errmessage{@deftypevrx in invalid context}}
4842 \def\defunx#1 {\errmessage{@defunx in invalid context}}
4843 \def\defvarx#1 {\errmessage{@defvarx in invalid context}}
4844 \def\defvrx#1 {\errmessage{@defvrx in invalid context}}
4845 6547
4846 6548
4847 \message{macros,} 6549 \message{macros,}
4848 % @macro. 6550 % @macro.
4849 6551
4850 % To do this right we need a feature of e-TeX, \scantokens, 6552 % To do this right we need a feature of e-TeX, \scantokens,
4851 % which we arrange to emulate with a temporary file in ordinary TeX. 6553 % which we arrange to emulate with a temporary file in ordinary TeX.
4852 \ifx\eTeXversion\undefined 6554 \ifx\eTeXversion\undefined
4853 \newwrite\macscribble 6555 \newwrite\macscribble
4854 \def\scanmacro#1{% 6556 \def\scantokens#1{%
4855 \begingroup \newlinechar`\^^M 6557 \toks0={#1}%
4856 % Undo catcode changes of \startcontents and \doprintindex 6558 \immediate\openout\macscribble=\jobname.tmp
4857 \catcode`\@=0 \catcode`\\=12 \escapechar=`\@ 6559 \immediate\write\macscribble{\the\toks0}%
4858 % Append \endinput to make sure that TeX does not see the ending newline. 6560 \immediate\closeout\macscribble
4859 \toks0={#1\endinput}% 6561 \input \jobname.tmp
4860 \immediate\openout\macscribble=\jobname.tmp 6562 }
4861 \immediate\write\macscribble{\the\toks0}% 6563 \fi
4862 \immediate\closeout\macscribble 6564
4863 \let\xeatspaces\eatspaces
4864 \input \jobname.tmp
4865 \endgroup
4866 }
4867 \else
4868 \def\scanmacro#1{% 6565 \def\scanmacro#1{%
4869 \begingroup \newlinechar`\^^M 6566 \begingroup
4870 % Undo catcode changes of \startcontents and \doprintindex 6567 \newlinechar`\^^M
4871 \catcode`\@=0 \catcode`\\=12 \escapechar=`\@ 6568 \let\xeatspaces\eatspaces
4872 \let\xeatspaces\eatspaces\scantokens{#1\endinput}\endgroup} 6569 % Undo catcode changes of \startcontents and \doprintindex
4873 \fi 6570 % When called from @insertcopying or (short)caption, we need active
6571 % backslash to get it printed correctly. Previously, we had
6572 % \catcode`\\=\other instead. We'll see whether a problem appears
6573 % with macro expansion. --kasal, 19aug04
6574 \catcode`\@=0 \catcode`\\=\active \escapechar=`\@
6575 % ... and \example
6576 \spaceisspace
6577 %
6578 % Append \endinput to make sure that TeX does not see the ending newline.
6579 % I've verified that it is necessary both for e-TeX and for ordinary TeX
6580 % --kasal, 29nov03
6581 \scantokens{#1\endinput}%
6582 \endgroup
6583 }
6584
6585 \def\scanexp#1{%
6586 \edef\temp{\noexpand\scanmacro{#1}}%
6587 \temp
6588 }
4874 6589
4875 \newcount\paramno % Count of parameters 6590 \newcount\paramno % Count of parameters
4876 \newtoks\macname % Macro name 6591 \newtoks\macname % Macro name
4877 \newif\ifrecursive % Is it recursive? 6592 \newif\ifrecursive % Is it recursive?
4878 \def\macrolist{} % List of all defined macros in the form 6593
4879 % \do\macro1\do\macro2... 6594 % List of all defined macros in the form
6595 % \definedummyword\macro1\definedummyword\macro2...
6596 % Currently is also contains all @aliases; the list can be split
6597 % if there is a need.
6598 \def\macrolist{}
6599
6600 % Add the macro to \macrolist
6601 \def\addtomacrolist#1{\expandafter \addtomacrolistxxx \csname#1\endcsname}
6602 \def\addtomacrolistxxx#1{%
6603 \toks0 = \expandafter{\macrolist\definedummyword#1}%
6604 \xdef\macrolist{\the\toks0}%
6605 }
4880 6606
4881 % Utility routines. 6607 % Utility routines.
4882 % Thisdoes \let #1 = #2, except with \csnames. 6608 % This does \let #1 = #2, with \csnames; that is,
6609 % \let \csname#1\endcsname = \csname#2\endcsname
6610 % (except of course we have to play expansion games).
6611 %
4883 \def\cslet#1#2{% 6612 \def\cslet#1#2{%
4884 \expandafter\expandafter 6613 \expandafter\let
4885 \expandafter\let 6614 \csname#1\expandafter\endcsname
4886 \expandafter\expandafter 6615 \csname#2\endcsname
4887 \csname#1\endcsname 6616 }
4888 \csname#2\endcsname}
4889 6617
4890 % Trim leading and trailing spaces off a string. 6618 % Trim leading and trailing spaces off a string.
4891 % Concepts from aro-bend problem 15 (see CTAN). 6619 % Concepts from aro-bend problem 15 (see CTAN).
4892 {\catcode`\@=11 6620 {\catcode`\@=11
4893 \gdef\eatspaces #1{\expandafter\trim@\expandafter{#1 }} 6621 \gdef\eatspaces #1{\expandafter\trim@\expandafter{#1 }}
4896 \def\unbrace#1{#1} 6624 \def\unbrace#1{#1}
4897 \unbrace{\gdef\trim@@@ #1 } #2@{#1} 6625 \unbrace{\gdef\trim@@@ #1 } #2@{#1}
4898 } 6626 }
4899 6627
4900 % Trim a single trailing ^^M off a string. 6628 % Trim a single trailing ^^M off a string.
4901 {\catcode`\^^M=12\catcode`\Q=3% 6629 {\catcode`\^^M=\other \catcode`\Q=3%
4902 \gdef\eatcr #1{\eatcra #1Q^^MQ}% 6630 \gdef\eatcr #1{\eatcra #1Q^^MQ}%
4903 \gdef\eatcra#1^^MQ{\eatcrb#1Q}% 6631 \gdef\eatcra#1^^MQ{\eatcrb#1Q}%
4904 \gdef\eatcrb#1Q#2Q{#1}% 6632 \gdef\eatcrb#1Q#2Q{#1}%
4905 } 6633 }
4906 6634
4907 % Macro bodies are absorbed as an argument in a context where 6635 % Macro bodies are absorbed as an argument in a context where
4908 % all characters are catcode 10, 11 or 12, except \ which is active 6636 % all characters are catcode 10, 11 or 12, except \ which is active
4909 % (as in normal texinfo). It is necessary to change the definition of \. 6637 % (as in normal texinfo). It is necessary to change the definition of \.
4910 6638
6639 % Non-ASCII encodings make 8-bit characters active, so un-activate
6640 % them to avoid their expansion. Must do this non-globally, to
6641 % confine the change to the current group.
6642
4911 % It's necessary to have hard CRs when the macro is executed. This is 6643 % It's necessary to have hard CRs when the macro is executed. This is
4912 % done by making ^^M (\endlinechar) catcode 12 when reading the macro 6644 % done by making ^^M (\endlinechar) catcode 12 when reading the macro
4913 % body, and then making it the \newlinechar in \scanmacro. 6645 % body, and then making it the \newlinechar in \scanmacro.
4914 6646
6647 \def\scanctxt{%
6648 \catcode`\"=\other
6649 \catcode`\+=\other
6650 \catcode`\<=\other
6651 \catcode`\>=\other
6652 \catcode`\@=\other
6653 \catcode`\^=\other
6654 \catcode`\_=\other
6655 \catcode`\|=\other
6656 \catcode`\~=\other
6657 \ifx\declaredencoding\ascii \else \setnonasciicharscatcodenonglobal\other \fi
6658 }
6659
6660 \def\scanargctxt{%
6661 \scanctxt
6662 \catcode`\\=\other
6663 \catcode`\^^M=\other
6664 }
6665
4915 \def\macrobodyctxt{% 6666 \def\macrobodyctxt{%
4916 \catcode`\~=12 6667 \scanctxt
4917 \catcode`\^=12 6668 \catcode`\{=\other
4918 \catcode`\_=12 6669 \catcode`\}=\other
4919 \catcode`\|=12 6670 \catcode`\^^M=\other
4920 \catcode`\<=12 6671 \usembodybackslash
4921 \catcode`\>=12 6672 }
4922 \catcode`\+=12
4923 \catcode`\{=12
4924 \catcode`\}=12
4925 \catcode`\@=12
4926 \catcode`\^^M=12
4927 \usembodybackslash}
4928 6673
4929 \def\macroargctxt{% 6674 \def\macroargctxt{%
4930 \catcode`\~=12 6675 \scanctxt
4931 \catcode`\^=12 6676 \catcode`\\=\other
4932 \catcode`\_=12 6677 }
4933 \catcode`\|=12
4934 \catcode`\<=12
4935 \catcode`\>=12
4936 \catcode`\+=12
4937 \catcode`\@=12
4938 \catcode`\\=12}
4939 6678
4940 % \mbodybackslash is the definition of \ in @macro bodies. 6679 % \mbodybackslash is the definition of \ in @macro bodies.
4941 % It maps \foo\ => \csname macarg.foo\endcsname => #N 6680 % It maps \foo\ => \csname macarg.foo\endcsname => #N
4942 % where N is the macro parameter number. 6681 % where N is the macro parameter number.
4943 % We define \csname macarg.\endcsname to be \realbackslash, so 6682 % We define \csname macarg.\endcsname to be \realbackslash, so
4961 \fi 6700 \fi
4962 \if1\csname ismacro.\the\macname\endcsname 6701 \if1\csname ismacro.\the\macname\endcsname
4963 \message{Warning: redefining \the\macname}% 6702 \message{Warning: redefining \the\macname}%
4964 \else 6703 \else
4965 \expandafter\ifx\csname \the\macname\endcsname \relax 6704 \expandafter\ifx\csname \the\macname\endcsname \relax
4966 \else \errmessage{The name \the\macname\space is reserved}\fi 6705 \else \errmessage{Macro name \the\macname\space already defined}\fi
4967 \global\cslet{macsave.\the\macname}{\the\macname}% 6706 \global\cslet{macsave.\the\macname}{\the\macname}%
4968 \global\expandafter\let\csname ismacro.\the\macname\endcsname=1% 6707 \global\expandafter\let\csname ismacro.\the\macname\endcsname=1%
4969 % Add the macroname to \macrolist 6708 \addtomacrolist{\the\macname}%
4970 \toks0 = \expandafter{\macrolist\do}%
4971 \xdef\macrolist{\the\toks0
4972 \expandafter\noexpand\csname\the\macname\endcsname}%
4973 \fi 6709 \fi
4974 \begingroup \macrobodyctxt 6710 \begingroup \macrobodyctxt
4975 \ifrecursive \expandafter\parsermacbody 6711 \ifrecursive \expandafter\parsermacbody
4976 \else \expandafter\parsemacbody 6712 \else \expandafter\parsemacbody
4977 \fi} 6713 \fi}
4978 6714
4979 \def\unmacro{\parsearg\unmacroxxx} 6715 \parseargdef\unmacro{%
4980 \def\unmacroxxx#1{%
4981 \if1\csname ismacro.#1\endcsname 6716 \if1\csname ismacro.#1\endcsname
4982 \global\cslet{#1}{macsave.#1}% 6717 \global\cslet{#1}{macsave.#1}%
4983 \global\expandafter\let \csname ismacro.#1\endcsname=0% 6718 \global\expandafter\let \csname ismacro.#1\endcsname=0%
4984 % Remove the macro name from \macrolist 6719 % Remove the macro name from \macrolist:
4985 \begingroup 6720 \begingroup
4986 \edef\tempa{\expandafter\noexpand\csname#1\endcsname}% 6721 \expandafter\let\csname#1\endcsname \relax
4987 \def\do##1{% 6722 \let\definedummyword\unmacrodo
4988 \def\tempb{##1}% 6723 \xdef\macrolist{\macrolist}%
4989 \ifx\tempa\tempb
4990 % remove this
4991 \else
4992 \toks0 = \expandafter{\newmacrolist\do}%
4993 \edef\newmacrolist{\the\toks0\expandafter\noexpand\tempa}%
4994 \fi}%
4995 \def\newmacrolist{}%
4996 % Execute macro list to define \newmacrolist
4997 \macrolist
4998 \global\let\macrolist\newmacrolist
4999 \endgroup 6724 \endgroup
5000 \else 6725 \else
5001 \errmessage{Macro #1 not defined}% 6726 \errmessage{Macro #1 not defined}%
6727 \fi
6728 }
6729
6730 % Called by \do from \dounmacro on each macro. The idea is to omit any
6731 % macro definitions that have been changed to \relax.
6732 %
6733 \def\unmacrodo#1{%
6734 \ifx #1\relax
6735 % remove this
6736 \else
6737 \noexpand\definedummyword \noexpand#1%
5002 \fi 6738 \fi
5003 } 6739 }
5004 6740
5005 % This makes use of the obscure feature that if the last token of a 6741 % This makes use of the obscure feature that if the last token of a
5006 % <parameter list> is #, then the preceding argument is delimited by 6742 % <parameter list> is #, then the preceding argument is delimited by
5109 6845
5110 % \braceorline decides whether the next nonwhitespace character is a 6846 % \braceorline decides whether the next nonwhitespace character is a
5111 % {. If so it reads up to the closing }, if not, it reads the whole 6847 % {. If so it reads up to the closing }, if not, it reads the whole
5112 % line. Whatever was read is then fed to the next control sequence 6848 % line. Whatever was read is then fed to the next control sequence
5113 % as an argument (by \parsebrace or \parsearg) 6849 % as an argument (by \parsebrace or \parsearg)
5114 \def\braceorline#1{\let\next=#1\futurelet\nchar\braceorlinexxx} 6850 \def\braceorline#1{\let\macnamexxx=#1\futurelet\nchar\braceorlinexxx}
5115 \def\braceorlinexxx{% 6851 \def\braceorlinexxx{%
5116 \ifx\nchar\bgroup\else 6852 \ifx\nchar\bgroup\else
5117 \expandafter\parsearg 6853 \expandafter\parsearg
5118 \fi \next} 6854 \fi \macnamexxx}
5119
5120 % We mant to disable all macros during \shipout so that they are not
5121 % expanded by \write.
5122 \def\turnoffmacros{\begingroup \def\do##1{\let\noexpand##1=\relax}%
5123 \edef\next{\macrolist}\expandafter\endgroup\next}
5124 6855
5125 6856
5126 % @alias. 6857 % @alias.
5127 % We need some trickery to remove the optional spaces around the equal 6858 % We need some trickery to remove the optional spaces around the equal
5128 % sign. Just make them active and then expand them all to nothing. 6859 % sign. Just make them active and then expand them all to nothing.
5129 \def\alias{\begingroup\obeyspaces\parsearg\aliasxxx} 6860 \def\alias{\parseargusing\obeyspaces\aliasxxx}
5130 \def\aliasxxx #1{\aliasyyy#1\relax} 6861 \def\aliasxxx #1{\aliasyyy#1\relax}
5131 \def\aliasyyy #1=#2\relax{\ignoreactivespaces 6862 \def\aliasyyy #1=#2\relax{%
5132 \edef\next{\global\let\expandafter\noexpand\csname#1\endcsname=% 6863 {%
5133 \expandafter\noexpand\csname#2\endcsname}% 6864 \expandafter\let\obeyedspace=\empty
5134 \expandafter\endgroup\next} 6865 \addtomacrolist{#1}%
6866 \xdef\next{\global\let\makecsname{#1}=\makecsname{#2}}%
6867 }%
6868 \next
6869 }
5135 6870
5136 6871
5137 \message{cross references,} 6872 \message{cross references,}
5138 % @xref etc.
5139 6873
5140 \newwrite\auxfile 6874 \newwrite\auxfile
5141
5142 \newif\ifhavexrefs % True if xref values are known. 6875 \newif\ifhavexrefs % True if xref values are known.
5143 \newif\ifwarnedxrefs % True if we warned once that they aren't known. 6876 \newif\ifwarnedxrefs % True if we warned once that they aren't known.
5144 6877
5145 % @inforef is relatively simple. 6878 % @inforef is relatively simple.
5146 \def\inforef #1{\inforefzzz #1,,,,**} 6879 \def\inforef #1{\inforefzzz #1,,,,**}
5147 \def\inforefzzz #1,#2,#3,#4**{\putwordSee{} \putwordInfo{} \putwordfile{} \file{\ignorespaces #3{}}, 6880 \def\inforefzzz #1,#2,#3,#4**{\putwordSee{} \putwordInfo{} \putwordfile{} \file{\ignorespaces #3{}},
5148 node \samp{\ignorespaces#1{}}} 6881 node \samp{\ignorespaces#1{}}}
5149 6882
5150 % @node's job is to define \lastnode. 6883 % @node's only job in TeX is to define \lastnode, which is used in
5151 \def\node{\ENVcheck\parsearg\nodezzz} 6884 % cross-references. The @node line might or might not have commas, and
5152 \def\nodezzz#1{\nodexxx [#1,]} 6885 % might or might not have spaces before the first comma, like:
5153 \def\nodexxx[#1,#2]{\gdef\lastnode{#1}} 6886 % @node foo , bar , ...
6887 % We don't want such trailing spaces in the node name.
6888 %
6889 \parseargdef\node{\checkenv{}\donode #1 ,\finishnodeparse}
6890 %
6891 % also remove a trailing comma, in case of something like this:
6892 % @node Help-Cross, , , Cross-refs
6893 \def\donode#1 ,#2\finishnodeparse{\dodonode #1,\finishnodeparse}
6894 \def\dodonode#1,#2\finishnodeparse{\gdef\lastnode{#1}}
6895
5154 \let\nwnode=\node 6896 \let\nwnode=\node
5155 \let\lastnode=\relax 6897 \let\lastnode=\empty
5156 6898
5157 % The sectioning commands (@chapter, etc.) call these. 6899 % Write a cross-reference definition for the current node. #1 is the
5158 \def\donoderef{% 6900 % type (Ynumbered, Yappendix, Ynothing).
5159 \ifx\lastnode\relax\else 6901 %
5160 \expandafter\expandafter\expandafter\setref{\lastnode}% 6902 \def\donoderef#1{%
5161 {Ysectionnumberandtype}% 6903 \ifx\lastnode\empty\else
5162 \global\let\lastnode=\relax 6904 \setref{\lastnode}{#1}%
6905 \global\let\lastnode=\empty
5163 \fi 6906 \fi
5164 } 6907 }
5165 \def\unnumbnoderef{% 6908
5166 \ifx\lastnode\relax\else 6909 % @anchor{NAME} -- define xref target at arbitrary point.
5167 \expandafter\expandafter\expandafter\setref{\lastnode}{Ynothing}% 6910 %
5168 \global\let\lastnode=\relax 6911 \newcount\savesfregister
6912 %
6913 \def\savesf{\relax \ifhmode \savesfregister=\spacefactor \fi}
6914 \def\restoresf{\relax \ifhmode \spacefactor=\savesfregister \fi}
6915 \def\anchor#1{\savesf \setref{#1}{Ynothing}\restoresf \ignorespaces}
6916
6917 % \setref{NAME}{SNT} defines a cross-reference point NAME (a node or an
6918 % anchor), which consists of three parts:
6919 % 1) NAME-title - the current sectioning name taken from \lastsection,
6920 % or the anchor name.
6921 % 2) NAME-snt - section number and type, passed as the SNT arg, or
6922 % empty for anchors.
6923 % 3) NAME-pg - the page number.
6924 %
6925 % This is called from \donoderef, \anchor, and \dofloat. In the case of
6926 % floats, there is an additional part, which is not written here:
6927 % 4) NAME-lof - the text as it should appear in a @listoffloats.
6928 %
6929 \def\setref#1#2{%
6930 \pdfmkdest{#1}%
6931 \iflinks
6932 {%
6933 \atdummies % preserve commands, but don't expand them
6934 \edef\writexrdef##1##2{%
6935 \write\auxfile{@xrdef{#1-% #1 of \setref, expanded by the \edef
6936 ##1}{##2}}% these are parameters of \writexrdef
6937 }%
6938 \toks0 = \expandafter{\lastsection}%
6939 \immediate \writexrdef{title}{\the\toks0 }%
6940 \immediate \writexrdef{snt}{\csname #2\endcsname}% \Ynumbered etc.
6941 \safewhatsit{\writexrdef{pg}{\folio}}% will be written later, during \shipout
6942 }%
5169 \fi 6943 \fi
5170 } 6944 }
5171 \def\appendixnoderef{%
5172 \ifx\lastnode\relax\else
5173 \expandafter\expandafter\expandafter\setref{\lastnode}%
5174 {Yappendixletterandtype}%
5175 \global\let\lastnode=\relax
5176 \fi
5177 }
5178
5179
5180 % @anchor{NAME} -- define xref target at arbitrary point.
5181 %
5182 \newcount\savesfregister
5183 \gdef\savesf{\relax \ifhmode \savesfregister=\spacefactor \fi}
5184 \gdef\restoresf{\relax \ifhmode \spacefactor=\savesfregister \fi}
5185 \gdef\anchor#1{\savesf \setref{#1}{Ynothing}\restoresf \ignorespaces}
5186
5187 % \setref{NAME}{SNT} defines a cross-reference point NAME, namely
5188 % NAME-title, NAME-pg, and NAME-SNT. Called from \foonoderef. We have
5189 % to set \indexdummies so commands such as @code in a section title
5190 % aren't expanded. It would be nicer not to expand the titles in the
5191 % first place, but there's so many layers that that is hard to do.
5192 %
5193 \def\setref#1#2{{%
5194 \indexdummies
5195 \pdfmkdest{#1}%
5196 \dosetq{#1-title}{Ytitle}%
5197 \dosetq{#1-pg}{Ypagenumber}%
5198 \dosetq{#1-snt}{#2}%
5199 }}
5200 6945
5201 % @xref, @pxref, and @ref generate cross-references. For \xrefX, #1 is 6946 % @xref, @pxref, and @ref generate cross-references. For \xrefX, #1 is
5202 % the node name, #2 the name of the Info cross-reference, #3 the printed 6947 % the node name, #2 the name of the Info cross-reference, #3 the printed
5203 % node name, #4 the name of the Info file, #5 the name of the printed 6948 % node name, #4 the name of the Info file, #5 the name of the printed
5204 % manual. All but the node name can be omitted. 6949 % manual. All but the node name can be omitted.
5207 \def\xref#1{\putwordSee{} \xrefX[#1,,,,,,,]} 6952 \def\xref#1{\putwordSee{} \xrefX[#1,,,,,,,]}
5208 \def\ref#1{\xrefX[#1,,,,,,,]} 6953 \def\ref#1{\xrefX[#1,,,,,,,]}
5209 \def\xrefX[#1,#2,#3,#4,#5,#6]{\begingroup 6954 \def\xrefX[#1,#2,#3,#4,#5,#6]{\begingroup
5210 \unsepspaces 6955 \unsepspaces
5211 \def\printedmanual{\ignorespaces #5}% 6956 \def\printedmanual{\ignorespaces #5}%
5212 \def\printednodename{\ignorespaces #3}% 6957 \def\printedrefname{\ignorespaces #3}%
5213 \setbox1=\hbox{\printedmanual}% 6958 \setbox1=\hbox{\printedmanual\unskip}%
5214 \setbox0=\hbox{\printednodename}% 6959 \setbox0=\hbox{\printedrefname\unskip}%
5215 \ifdim \wd0 = 0pt 6960 \ifdim \wd0 = 0pt
5216 % No printed node name was explicitly given. 6961 % No printed node name was explicitly given.
5217 \expandafter\ifx\csname SETxref-automatic-section-title\endcsname\relax 6962 \expandafter\ifx\csname SETxref-automatic-section-title\endcsname\relax
5218 % Use the node name inside the square brackets. 6963 % Use the node name inside the square brackets.
5219 \def\printednodename{\ignorespaces #1}% 6964 \def\printedrefname{\ignorespaces #1}%
5220 \else 6965 \else
5221 % Use the actual chapter/section title appear inside 6966 % Use the actual chapter/section title appear inside
5222 % the square brackets. Use the real section title if we have it. 6967 % the square brackets. Use the real section title if we have it.
5223 \ifdim \wd1 > 0pt 6968 \ifdim \wd1 > 0pt
5224 % It is in another manual, so we don't have it. 6969 % It is in another manual, so we don't have it.
5225 \def\printednodename{\ignorespaces #1}% 6970 \def\printedrefname{\ignorespaces #1}%
5226 \else 6971 \else
5227 \ifhavexrefs 6972 \ifhavexrefs
5228 % We know the real title if we have the xref values. 6973 % We know the real title if we have the xref values.
5229 \def\printednodename{\refx{#1-title}{}}% 6974 \def\printedrefname{\refx{#1-title}{}}%
5230 \else 6975 \else
5231 % Otherwise just copy the Info node name. 6976 % Otherwise just copy the Info node name.
5232 \def\printednodename{\ignorespaces #1}% 6977 \def\printedrefname{\ignorespaces #1}%
5233 \fi% 6978 \fi%
5234 \fi 6979 \fi
5235 \fi 6980 \fi
5236 \fi 6981 \fi
5237 % 6982 %
5238 % If we use \unhbox0 and \unhbox1 to print the node names, TeX does not 6983 % Make link in pdf output.
5239 % insert empty discretionaries after hyphens, which means that it will
5240 % not find a line break at a hyphen in a node names. Since some manuals
5241 % are best written with fairly long node names, containing hyphens, this
5242 % is a loss. Therefore, we give the text of the node name again, so it
5243 % is as if TeX is seeing it for the first time.
5244 \ifpdf 6984 \ifpdf
5245 \leavevmode 6985 {\indexnofonts
5246 \getfilename{#4}% 6986 \turnoffactive
5247 \ifnum\filenamelength>0 6987 % This expands tokens, so do it after making catcode changes, so _
5248 \startlink attr{/Border [0 0 0]}% 6988 % etc. don't get their TeX definitions.
5249 goto file{\the\filename.pdf} name{#1@}% 6989 \getfilename{#4}%
6990 %
6991 % See comments at \activebackslashdouble.
6992 {\activebackslashdouble \xdef\pdfxrefdest{#1}%
6993 \backslashparens\pdfxrefdest}%
6994 %
6995 \leavevmode
6996 \startlink attr{/Border [0 0 0]}%
6997 \ifnum\filenamelength>0
6998 goto file{\the\filename.pdf} name{\pdfxrefdest}%
6999 \else
7000 goto name{\pdfmkpgn{\pdfxrefdest}}%
7001 \fi
7002 }%
7003 \setcolor{\linkcolor}%
7004 \fi
7005 %
7006 % Float references are printed completely differently: "Figure 1.2"
7007 % instead of "[somenode], p.3". We distinguish them by the
7008 % LABEL-title being set to a magic string.
7009 {%
7010 % Have to otherify everything special to allow the \csname to
7011 % include an _ in the xref name, etc.
7012 \indexnofonts
7013 \turnoffactive
7014 \expandafter\global\expandafter\let\expandafter\Xthisreftitle
7015 \csname XR#1-title\endcsname
7016 }%
7017 \iffloat\Xthisreftitle
7018 % If the user specified the print name (third arg) to the ref,
7019 % print it instead of our usual "Figure 1.2".
7020 \ifdim\wd0 = 0pt
7021 \refx{#1-snt}{}%
5250 \else 7022 \else
5251 \startlink attr{/Border [0 0 0]}% 7023 \printedrefname
5252 goto name{#1@}%
5253 \fi 7024 \fi
5254 \linkcolor 7025 %
5255 \fi 7026 % if the user also gave the printed manual name (fifth arg), append
5256 % 7027 % "in MANUALNAME".
5257 \ifdim \wd1 > 0pt 7028 \ifdim \wd1 > 0pt
5258 \putwordsection{} ``\printednodename'' \putwordin{} \cite{\printedmanual}% 7029 \space \putwordin{} \cite{\printedmanual}%
7030 \fi
5259 \else 7031 \else
5260 % _ (for example) has to be the character _ for the purposes of the 7032 % node/anchor (non-float) references.
5261 % control sequence corresponding to the node, but it has to expand 7033 %
5262 % into the usual \leavevmode...\vrule stuff for purposes of 7034 % If we use \unhbox0 and \unhbox1 to print the node names, TeX does not
5263 % printing. So we \turnoffactive for the \refx-snt, back on for the 7035 % insert empty discretionaries after hyphens, which means that it will
5264 % printing, back off for the \refx-pg. 7036 % not find a line break at a hyphen in a node names. Since some manuals
5265 {\normalturnoffactive 7037 % are best written with fairly long node names, containing hyphens, this
5266 % Only output a following space if the -snt ref is nonempty; for 7038 % is a loss. Therefore, we give the text of the node name again, so it
5267 % @unnumbered and @anchor, it won't be. 7039 % is as if TeX is seeing it for the first time.
5268 \setbox2 = \hbox{\ignorespaces \refx{#1-snt}{}}% 7040 \ifdim \wd1 > 0pt
5269 \ifdim \wd2 > 0pt \refx{#1-snt}\space\fi 7041 \putwordSection{} ``\printedrefname'' \putwordin{} \cite{\printedmanual}%
5270 }% 7042 \else
5271 % [mynode], 7043 % _ (for example) has to be the character _ for the purposes of the
5272 [\printednodename],\space 7044 % control sequence corresponding to the node, but it has to expand
5273 % page 3 7045 % into the usual \leavevmode...\vrule stuff for purposes of
5274 \turnoffactive \putwordpage\tie\refx{#1-pg}{}% 7046 % printing. So we \turnoffactive for the \refx-snt, back on for the
7047 % printing, back off for the \refx-pg.
7048 {\turnoffactive
7049 % Only output a following space if the -snt ref is nonempty; for
7050 % @unnumbered and @anchor, it won't be.
7051 \setbox2 = \hbox{\ignorespaces \refx{#1-snt}{}}%
7052 \ifdim \wd2 > 0pt \refx{#1-snt}\space\fi
7053 }%
7054 % output the `[mynode]' via a macro so it can be overridden.
7055 \xrefprintnodename\printedrefname
7056 %
7057 % But we always want a comma and a space:
7058 ,\space
7059 %
7060 % output the `page 3'.
7061 \turnoffactive \putwordpage\tie\refx{#1-pg}{}%
7062 \fi
5275 \fi 7063 \fi
5276 \endlink 7064 \endlink
5277 \endgroup} 7065 \endgroup}
5278 7066
5279 % \dosetq is the interface for calls from other macros 7067 % This macro is called from \xrefX for the `[nodename]' part of xref
5280 7068 % output. It's a separate macro only so it can be changed more easily,
5281 % Use \normalturnoffactive so that punctuation chars such as underscore 7069 % since square brackets don't work well in some documents. Particularly
5282 % and backslash work in node names. (\turnoffactive doesn't do \.) 7070 % one that Bob is working on :).
5283 \def\dosetq#1#2{% 7071 %
5284 {\let\folio=0% 7072 \def\xrefprintnodename#1{[#1]}
5285 \normalturnoffactive 7073
5286 \edef\next{\write\auxfile{\internalsetq{#1}{#2}}}% 7074 % Things referred to by \setref.
5287 \iflinks 7075 %
5288 \next
5289 \fi
5290 }%
5291 }
5292
5293 % \internalsetq {foo}{page} expands into
5294 % CHARACTERS 'xrdef {foo}{...expansion of \Ypage...}
5295 % When the aux file is read, ' is the escape character
5296
5297 \def\internalsetq #1#2{'xrdef {#1}{\csname #2\endcsname}}
5298
5299 % Things to be expanded by \internalsetq
5300
5301 \def\Ypagenumber{\folio}
5302
5303 \def\Ytitle{\thissection}
5304
5305 \def\Ynothing{} 7076 \def\Ynothing{}
5306 7077 \def\Yomitfromtoc{}
5307 \def\Ysectionnumberandtype{% 7078 \def\Ynumbered{%
5308 \ifnum\secno=0 \putwordChapter\xreftie\the\chapno % 7079 \ifnum\secno=0
5309 \else \ifnum \subsecno=0 \putwordSection\xreftie\the\chapno.\the\secno % 7080 \putwordChapter@tie \the\chapno
5310 \else \ifnum \subsubsecno=0 % 7081 \else \ifnum\subsecno=0
5311 \putwordSection\xreftie\the\chapno.\the\secno.\the\subsecno % 7082 \putwordSection@tie \the\chapno.\the\secno
5312 \else % 7083 \else \ifnum\subsubsecno=0
5313 \putwordSection\xreftie\the\chapno.\the\secno.\the\subsecno.\the\subsubsecno % 7084 \putwordSection@tie \the\chapno.\the\secno.\the\subsecno
5314 \fi \fi \fi } 7085 \else
5315 7086 \putwordSection@tie \the\chapno.\the\secno.\the\subsecno.\the\subsubsecno
5316 \def\Yappendixletterandtype{% 7087 \fi\fi\fi
5317 \ifnum\secno=0 \putwordAppendix\xreftie'char\the\appendixno{}% 7088 }
5318 \else \ifnum \subsecno=0 \putwordSection\xreftie'char\the\appendixno.\the\secno % 7089 \def\Yappendix{%
5319 \else \ifnum \subsubsecno=0 % 7090 \ifnum\secno=0
5320 \putwordSection\xreftie'char\the\appendixno.\the\secno.\the\subsecno % 7091 \putwordAppendix@tie @char\the\appendixno{}%
5321 \else % 7092 \else \ifnum\subsecno=0
5322 \putwordSection\xreftie'char\the\appendixno.\the\secno.\the\subsecno.\the\subsubsecno % 7093 \putwordSection@tie @char\the\appendixno.\the\secno
5323 \fi \fi \fi } 7094 \else \ifnum\subsubsecno=0
5324 7095 \putwordSection@tie @char\the\appendixno.\the\secno.\the\subsecno
5325 \gdef\xreftie{'tie} 7096 \else
5326 7097 \putwordSection@tie
5327 % Use TeX 3.0's \inputlineno to get the line number, for better error 7098 @char\the\appendixno.\the\secno.\the\subsecno.\the\subsubsecno
5328 % messages, but if we're using an old version of TeX, don't do anything. 7099 \fi\fi\fi
5329 % 7100 }
5330 \ifx\inputlineno\thisisundefined
5331 \let\linenumber = \empty % Non-3.0.
5332 \else
5333 \def\linenumber{\the\inputlineno:\space}
5334 \fi
5335 7101
5336 % Define \refx{NAME}{SUFFIX} to reference a cross-reference string named NAME. 7102 % Define \refx{NAME}{SUFFIX} to reference a cross-reference string named NAME.
5337 % If its value is nonempty, SUFFIX is output afterward. 7103 % If its value is nonempty, SUFFIX is output afterward.
5338 7104 %
5339 \def\refx#1#2{% 7105 \def\refx#1#2{%
5340 \expandafter\ifx\csname X#1\endcsname\relax 7106 {%
7107 \indexnofonts
7108 \otherbackslash
7109 \expandafter\global\expandafter\let\expandafter\thisrefX
7110 \csname XR#1\endcsname
7111 }%
7112 \ifx\thisrefX\relax
5341 % If not defined, say something at least. 7113 % If not defined, say something at least.
5342 \angleleft un\-de\-fined\angleright 7114 \angleleft un\-de\-fined\angleright
5343 \iflinks 7115 \iflinks
5344 \ifhavexrefs 7116 \ifhavexrefs
5345 \message{\linenumber Undefined cross reference `#1'.}% 7117 \message{\linenumber Undefined cross reference `#1'.}%
5350 \fi 7122 \fi
5351 \fi 7123 \fi
5352 \fi 7124 \fi
5353 \else 7125 \else
5354 % It's defined, so just use it. 7126 % It's defined, so just use it.
5355 \csname X#1\endcsname 7127 \thisrefX
5356 \fi 7128 \fi
5357 #2% Output the suffix in any case. 7129 #2% Output the suffix in any case.
5358 } 7130 }
5359 7131
5360 % This is the macro invoked by entries in the aux file. 7132 % This is the macro invoked by entries in the aux file. Usually it's
5361 % 7133 % just a \def (we prepend XR to the control sequence name to avoid
5362 \def\xrdef#1{\begingroup 7134 % collisions). But if this is a float type, we have more work to do.
5363 % Reenable \ as an escape while reading the second argument. 7135 %
5364 \catcode`\\ = 0 7136 \def\xrdef#1#2{%
5365 \afterassignment\endgroup 7137 {% The node name might contain 8-bit characters, which in our current
5366 \expandafter\gdef\csname X#1\endcsname 7138 % implementation are changed to commands like @'e. Don't let these
7139 % mess up the control sequence name.
7140 \indexnofonts
7141 \turnoffactive
7142 \xdef\safexrefname{#1}%
7143 }%
7144 %
7145 \expandafter\gdef\csname XR\safexrefname\endcsname{#2}% remember this xref
7146 %
7147 % Was that xref control sequence that we just defined for a float?
7148 \expandafter\iffloat\csname XR\safexrefname\endcsname
7149 % it was a float, and we have the (safe) float type in \iffloattype.
7150 \expandafter\let\expandafter\floatlist
7151 \csname floatlist\iffloattype\endcsname
7152 %
7153 % Is this the first time we've seen this float type?
7154 \expandafter\ifx\floatlist\relax
7155 \toks0 = {\do}% yes, so just \do
7156 \else
7157 % had it before, so preserve previous elements in list.
7158 \toks0 = \expandafter{\floatlist\do}%
7159 \fi
7160 %
7161 % Remember this xref in the control sequence \floatlistFLOATTYPE,
7162 % for later use in \listoffloats.
7163 \expandafter\xdef\csname floatlist\iffloattype\endcsname{\the\toks0
7164 {\safexrefname}}%
7165 \fi
5367 } 7166 }
5368 7167
5369 % Read the last existing aux file, if any. No error if none exists. 7168 % Read the last existing aux file, if any. No error if none exists.
5370 \def\readauxfile{\begingroup 7169 %
7170 \def\tryauxfile{%
7171 \openin 1 \jobname.aux
7172 \ifeof 1 \else
7173 \readdatafile{aux}%
7174 \global\havexrefstrue
7175 \fi
7176 \closein 1
7177 }
7178
7179 \def\setupdatafile{%
5371 \catcode`\^^@=\other 7180 \catcode`\^^@=\other
5372 \catcode`\^^A=\other 7181 \catcode`\^^A=\other
5373 \catcode`\^^B=\other 7182 \catcode`\^^B=\other
5374 \catcode`\^^C=\other 7183 \catcode`\^^C=\other
5375 \catcode`\^^D=\other 7184 \catcode`\^^D=\other
5393 \catcode`\^^[=\other 7202 \catcode`\^^[=\other
5394 \catcode`\^^\=\other 7203 \catcode`\^^\=\other
5395 \catcode`\^^]=\other 7204 \catcode`\^^]=\other
5396 \catcode`\^^^=\other 7205 \catcode`\^^^=\other
5397 \catcode`\^^_=\other 7206 \catcode`\^^_=\other
5398 \catcode`\@=\other 7207 % It was suggested to set the catcode of ^ to 7, which would allow ^^e4 etc.
5399 \catcode`\^=\other
5400 % It was suggested to define this as 7, which would allow ^^e4 etc.
5401 % in xref tags, i.e., node names. But since ^^e4 notation isn't 7208 % in xref tags, i.e., node names. But since ^^e4 notation isn't
5402 % supported in the main text, it doesn't seem desirable. Furthermore, 7209 % supported in the main text, it doesn't seem desirable. Furthermore,
5403 % that is not enough: for node names that actually contain a ^ 7210 % that is not enough: for node names that actually contain a ^
5404 % character, we would end up writing a line like this: 'xrdef {'hat 7211 % character, we would end up writing a line like this: 'xrdef {'hat
5405 % b-title}{'hat b} and \xrdef does a \csname...\endcsname on the first 7212 % b-title}{'hat b} and \xrdef does a \csname...\endcsname on the first
5408 % 7215 %
5409 % The other change necessary for this was to define \auxhat: 7216 % The other change necessary for this was to define \auxhat:
5410 % \def\auxhat{\def^{'hat }}% extra space so ok if followed by letter 7217 % \def\auxhat{\def^{'hat }}% extra space so ok if followed by letter
5411 % and then to call \auxhat in \setq. 7218 % and then to call \auxhat in \setq.
5412 % 7219 %
7220 \catcode`\^=\other
7221 %
7222 % Special characters. Should be turned off anyway, but...
5413 \catcode`\~=\other 7223 \catcode`\~=\other
5414 \catcode`\[=\other 7224 \catcode`\[=\other
5415 \catcode`\]=\other 7225 \catcode`\]=\other
5416 \catcode`\"=\other 7226 \catcode`\"=\other
5417 \catcode`\_=\other 7227 \catcode`\_=\other
5419 \catcode`\<=\other 7229 \catcode`\<=\other
5420 \catcode`\>=\other 7230 \catcode`\>=\other
5421 \catcode`\$=\other 7231 \catcode`\$=\other
5422 \catcode`\#=\other 7232 \catcode`\#=\other
5423 \catcode`\&=\other 7233 \catcode`\&=\other
7234 \catcode`\%=\other
5424 \catcode`+=\other % avoid \+ for paranoia even though we've turned it off 7235 \catcode`+=\other % avoid \+ for paranoia even though we've turned it off
5425 % Make the characters 128-255 be printing characters 7236 %
7237 % This is to support \ in node names and titles, since the \
7238 % characters end up in a \csname. It's easier than
7239 % leaving it active and making its active definition an actual \
7240 % character. What I don't understand is why it works in the *value*
7241 % of the xrdef. Seems like it should be a catcode12 \, and that
7242 % should not typeset properly. But it works, so I'm moving on for
7243 % now. --karl, 15jan04.
7244 \catcode`\\=\other
7245 %
7246 % Make the characters 128-255 be printing characters.
5426 {% 7247 {%
5427 \count 1=128 7248 \count1=128
5428 \def\loop{% 7249 \def\loop{%
5429 \catcode\count 1=\other 7250 \catcode\count1=\other
5430 \advance\count 1 by 1 7251 \advance\count1 by 1
5431 \ifnum \count 1<256 \loop \fi 7252 \ifnum \count1<256 \loop \fi
5432 }% 7253 }%
5433 }% 7254 }%
5434 % The aux file uses ' as the escape (for now). 7255 %
5435 % Turn off \ as an escape so we do not lose on 7256 % @ is our escape character in .aux files, and we need braces.
5436 % entries which were dumped with control sequences in their names.
5437 % For example, 'xrdef {$\leq $-fun}{page ...} made by @defun ^^
5438 % Reference to such entries still does not work the way one would wish,
5439 % but at least they do not bomb out when the aux file is read in.
5440 \catcode`\{=1 7257 \catcode`\{=1
5441 \catcode`\}=2 7258 \catcode`\}=2
5442 \catcode`\%=\other 7259 \catcode`\@=0
5443 \catcode`\'=0 7260 }
5444 \catcode`\\=\other 7261
5445 % 7262 \def\readdatafile#1{%
5446 \openin 1 \jobname.aux 7263 \begingroup
5447 \ifeof 1 \else 7264 \setupdatafile
5448 \closein 1 7265 \input\jobname.#1
5449 \input \jobname.aux
5450 \global\havexrefstrue
5451 \global\warnedobstrue
5452 \fi
5453 % Open the new aux file. TeX will close it automatically at exit.
5454 \openout\auxfile=\jobname.aux
5455 \endgroup} 7266 \endgroup}
5456 7267
5457 7268
5458 % Footnotes. 7269 \message{insertions,}
7270 % including footnotes.
5459 7271
5460 \newcount \footnoteno 7272 \newcount \footnoteno
5461 7273
5462 % The trailing space in the following definition for supereject is 7274 % The trailing space in the following definition for supereject is
5463 % vital for proper filling; pages come out unaligned when you do a 7275 % vital for proper filling; pages come out unaligned when you do a
5467 \def\supereject{\par\penalty -20000\footnoteno =0 } 7279 \def\supereject{\par\penalty -20000\footnoteno =0 }
5468 7280
5469 % @footnotestyle is meaningful for info output only. 7281 % @footnotestyle is meaningful for info output only.
5470 \let\footnotestyle=\comment 7282 \let\footnotestyle=\comment
5471 7283
5472 \let\ptexfootnote=\footnote
5473
5474 {\catcode `\@=11 7284 {\catcode `\@=11
5475 % 7285 %
5476 % Auto-number footnotes. Otherwise like plain. 7286 % Auto-number footnotes. Otherwise like plain.
5477 \gdef\footnote{% 7287 \gdef\footnote{%
7288 \let\indent=\ptexindent
7289 \let\noindent=\ptexnoindent
5478 \global\advance\footnoteno by \@ne 7290 \global\advance\footnoteno by \@ne
5479 \edef\thisfootno{$^{\the\footnoteno}$}% 7291 \edef\thisfootno{$^{\the\footnoteno}$}%
5480 % 7292 %
5481 % In case the footnote comes at the end of a sentence, preserve the 7293 % In case the footnote comes at the end of a sentence, preserve the
5482 % extra spacing after we do the footnote number. 7294 % extra spacing after we do the footnote number.
5483 \let\@sf\empty 7295 \let\@sf\empty
5484 \ifhmode\edef\@sf{\spacefactor\the\spacefactor}\/\fi 7296 \ifhmode\edef\@sf{\spacefactor\the\spacefactor}\ptexslash\fi
5485 % 7297 %
5486 % Remove inadvertent blank space before typesetting the footnote number. 7298 % Remove inadvertent blank space before typesetting the footnote number.
5487 \unskip 7299 \unskip
5488 \thisfootno\@sf 7300 \thisfootno\@sf
5489 \footnotezzz 7301 \dofootnote
5490 }% 7302 }%
5491 7303
5492 % Don't bother with the trickery in plain.tex to not require the 7304 % Don't bother with the trickery in plain.tex to not require the
5493 % footnote text as a parameter. Our footnotes don't need to be so general. 7305 % footnote text as a parameter. Our footnotes don't need to be so general.
5494 % 7306 %
5495 % Oh yes, they do; otherwise, @ifset and anything else that uses 7307 % Oh yes, they do; otherwise, @ifset (and anything else that uses
5496 % \parseargline fail inside footnotes because the tokens are fixed when 7308 % \parseargline) fails inside footnotes because the tokens are fixed when
5497 % the footnote is read. --karl, 16nov96. 7309 % the footnote is read. --karl, 16nov96.
5498 % 7310 %
5499 \long\gdef\footnotezzz{\insert\footins\bgroup 7311 \gdef\dofootnote{%
7312 \insert\footins\bgroup
5500 % We want to typeset this text as a normal paragraph, even if the 7313 % We want to typeset this text as a normal paragraph, even if the
5501 % footnote reference occurs in (for example) a display environment. 7314 % footnote reference occurs in (for example) a display environment.
5502 % So reset some parameters. 7315 % So reset some parameters.
7316 \hsize=\pagewidth
5503 \interlinepenalty\interfootnotelinepenalty 7317 \interlinepenalty\interfootnotelinepenalty
5504 \splittopskip\ht\strutbox % top baseline for broken footnotes 7318 \splittopskip\ht\strutbox % top baseline for broken footnotes
5505 \splitmaxdepth\dp\strutbox 7319 \splitmaxdepth\dp\strutbox
5506 \floatingpenalty\@MM 7320 \floatingpenalty\@MM
5507 \leftskip\z@skip 7321 \leftskip\z@skip
5510 \xspaceskip\z@skip 7324 \xspaceskip\z@skip
5511 \parindent\defaultparindent 7325 \parindent\defaultparindent
5512 % 7326 %
5513 \smallfonts \rm 7327 \smallfonts \rm
5514 % 7328 %
5515 % Hang the footnote text off the number. 7329 % Because we use hanging indentation in footnotes, a @noindent appears
5516 \hang 7330 % to exdent this text, so make it be a no-op. makeinfo does not use
7331 % hanging indentation so @noindent can still be needed within footnote
7332 % text after an @example or the like (not that this is good style).
7333 \let\noindent = \relax
7334 %
7335 % Hang the footnote text off the number. Use \everypar in case the
7336 % footnote extends for more than one paragraph.
7337 \everypar = {\hang}%
5517 \textindent{\thisfootno}% 7338 \textindent{\thisfootno}%
5518 % 7339 %
5519 % Don't crash into the line above the footnote text. Since this 7340 % Don't crash into the line above the footnote text. Since this
5520 % expands into a box, it must come within the paragraph, lest it 7341 % expands into a box, it must come within the paragraph, lest it
5521 % provide a place where TeX can split the footnote. 7342 % provide a place where TeX can split the footnote.
5522 \footstrut 7343 \footstrut
5523 \futurelet\next\fo@t 7344 \futurelet\next\fo@t
5524 } 7345 }
5525 \def\fo@t{\ifcat\bgroup\noexpand\next \let\next\f@@t
5526 \else\let\next\f@t\fi \next}
5527 \def\f@@t{\bgroup\aftergroup\@foot\let\next}
5528 \def\f@t#1{#1\@foot}
5529 \def\@foot{\strut\par\egroup}
5530
5531 }%end \catcode `\@=11 7346 }%end \catcode `\@=11
5532 7347
5533 % Set the baselineskip to #1, and the lineskip and strut size 7348 % In case a @footnote appears in a vbox, save the footnote text and create
5534 % correspondingly. There is no deep meaning behind these magic numbers 7349 % the real \insert just after the vbox finished. Otherwise, the insertion
5535 % used as factors; they just match (closely enough) what Knuth defined. 7350 % would be lost.
5536 % 7351 % Similarly, if a @footnote appears inside an alignment, save the footnote
5537 \def\lineskipfactor{.08333} 7352 % text to a box and make the \insert when a row of the table is finished.
5538 \def\strutheightpercent{.70833} 7353 % And the same can be done for other insert classes. --kasal, 16nov03.
5539 \def\strutdepthpercent {.29167} 7354
5540 % 7355 % Replace the \insert primitive by a cheating macro.
5541 \def\setleading#1{% 7356 % Deeper inside, just make sure that the saved insertions are not spilled
5542 \normalbaselineskip = #1\relax 7357 % out prematurely.
5543 \normallineskip = \lineskipfactor\normalbaselineskip 7358 %
5544 \normalbaselines 7359 \def\startsavinginserts{%
5545 \setbox\strutbox =\hbox{% 7360 \ifx \insert\ptexinsert
5546 \vrule width0pt height\strutheightpercent\baselineskip 7361 \let\insert\saveinsert
5547 depth \strutdepthpercent \baselineskip 7362 \else
5548 }% 7363 \let\checkinserts\relax
5549 } 7364 \fi
5550 7365 }
5551 % @| inserts a changebar to the left of the current line. It should 7366
5552 % surround any changed text. This approach does *not* work if the 7367 % This \insert replacement works for both \insert\footins{foo} and
5553 % change spans more than two lines of output. To handle that, we would 7368 % \insert\footins\bgroup foo\egroup, but it doesn't work for \insert27{foo}.
5554 % have adopt a much more difficult approach (putting marks into the main 7369 %
5555 % vertical list for the beginning and end of each change). 7370 \def\saveinsert#1{%
5556 % 7371 \edef\next{\noexpand\savetobox \makeSAVEname#1}%
5557 \def\|{% 7372 \afterassignment\next
5558 % \vadjust can only be used in horizontal mode. 7373 % swallow the left brace
5559 \leavevmode 7374 \let\temp =
5560 % 7375 }
5561 % Append this vertical mode material after the current line in the output. 7376 \def\makeSAVEname#1{\makecsname{SAVE\expandafter\gobble\string#1}}
5562 \vadjust{% 7377 \def\savetobox#1{\global\setbox#1 = \vbox\bgroup \unvbox#1}
5563 % We want to insert a rule with the height and depth of the current 7378
5564 % leading; that is exactly what \strutbox is supposed to record. 7379 \def\checksaveins#1{\ifvoid#1\else \placesaveins#1\fi}
5565 \vskip-\baselineskip 7380
5566 % 7381 \def\placesaveins#1{%
5567 % \vadjust-items are inserted at the left edge of the type. So 7382 \ptexinsert \csname\expandafter\gobblesave\string#1\endcsname
5568 % the \llap here moves out into the left-hand margin. 7383 {\box#1}%
5569 \llap{% 7384 }
5570 % 7385
5571 % For a thicker or thinner bar, change the `1pt'. 7386 % eat @SAVE -- beware, all of them have catcode \other:
5572 \vrule height\baselineskip width1pt 7387 {
5573 % 7388 \def\dospecials{\do S\do A\do V\do E} \uncatcodespecials % ;-)
5574 % This is the space between the bar and the text. 7389 \gdef\gobblesave @SAVE{}
5575 \hskip 12pt 7390 }
5576 }% 7391
5577 }% 7392 % initialization:
5578 } 7393 \def\newsaveins #1{%
5579 7394 \edef\next{\noexpand\newsaveinsX \makeSAVEname#1}%
5580 % For a final copy, take out the rectangles 7395 \next
5581 % that mark overfull boxes (in case you have decided 7396 }
5582 % that the text looks ok even though it passes the margin). 7397 \def\newsaveinsX #1{%
5583 % 7398 \csname newbox\endcsname #1%
5584 \def\finalout{\overfullrule=0pt} 7399 \expandafter\def\expandafter\checkinserts\expandafter{\checkinserts
7400 \checksaveins #1}%
7401 }
7402
7403 % initialize:
7404 \let\checkinserts\empty
7405 \newsaveins\footins
7406 \newsaveins\margin
7407
5585 7408
5586 % @image. We use the macros from epsf.tex to support this. 7409 % @image. We use the macros from epsf.tex to support this.
5587 % If epsf.tex is not installed and @image is used, we complain. 7410 % If epsf.tex is not installed and @image is used, we complain.
5588 % 7411 %
5589 % Check for and read epsf.tex up front. If we read it only at @image 7412 % Check for and read epsf.tex up front. If we read it only at @image
5590 % time, we might be inside a group, and then its definitions would get 7413 % time, we might be inside a group, and then its definitions would get
5591 % undone and the next image would fail. 7414 % undone and the next image would fail.
5592 \openin 1 = epsf.tex 7415 \openin 1 = epsf.tex
5593 \ifeof 1 \else 7416 \ifeof 1 \else
5594 \closein 1 7417 % Do not bother showing banner with epsf.tex v2.7k (available in
5595 % Do not bother showing banner with post-v2.7 epsf.tex (available in 7418 % doc/epsf.tex and on ctan).
5596 % doc/epsf.tex until it shows up on ctan).
5597 \def\epsfannounce{\toks0 = }% 7419 \def\epsfannounce{\toks0 = }%
5598 \input epsf.tex 7420 \input epsf.tex
5599 \fi 7421 \fi
7422 \closein 1
5600 % 7423 %
5601 % We will only complain once about lack of epsf.tex. 7424 % We will only complain once about lack of epsf.tex.
5602 \newif\ifwarnednoepsf 7425 \newif\ifwarnednoepsf
5603 \newhelp\noepsfhelp{epsf.tex must be installed for images to 7426 \newhelp\noepsfhelp{epsf.tex must be installed for images to
5604 work. It is also included in the Texinfo distribution, or you can get 7427 work. It is also included in the Texinfo distribution, or you can get
5610 \errhelp = \noepsfhelp 7433 \errhelp = \noepsfhelp
5611 \errmessage{epsf.tex not found, images will be ignored}% 7434 \errmessage{epsf.tex not found, images will be ignored}%
5612 \global\warnednoepsftrue 7435 \global\warnednoepsftrue
5613 \fi 7436 \fi
5614 \else 7437 \else
5615 \imagexxx #1,,,\finish 7438 \imagexxx #1,,,,,\finish
5616 \fi 7439 \fi
5617 } 7440 }
5618 % 7441 %
5619 % Arguments to @image: 7442 % Arguments to @image:
5620 % #1 is (mandatory) image filename; we tack on .eps extension. 7443 % #1 is (mandatory) image filename; we tack on .eps extension.
5621 % #2 is (optional) width, #3 is (optional) height. 7444 % #2 is (optional) width, #3 is (optional) height.
5622 % #4 is just the usual extra ignored arg for parsing this stuff. 7445 % #4 is (ignored optional) html alt text.
5623 \def\imagexxx#1,#2,#3,#4\finish{% 7446 % #5 is (ignored optional) extension.
7447 % #6 is just the usual extra ignored arg for parsing this stuff.
7448 \newif\ifimagevmode
7449 \def\imagexxx#1,#2,#3,#4,#5,#6\finish{\begingroup
7450 \catcode`\^^M = 5 % in case we're inside an example
7451 \normalturnoffactive % allow _ et al. in names
7452 % If the image is by itself, center it.
7453 \ifvmode
7454 \imagevmodetrue
7455 \nobreak\medskip
7456 % Usually we'll have text after the image which will insert
7457 % \parskip glue, so insert it here too to equalize the space
7458 % above and below.
7459 \nobreak\vskip\parskip
7460 \nobreak
7461 \fi
7462 %
7463 % Leave vertical mode so that indentation from an enclosing
7464 % environment such as @quotation is respected. On the other hand, if
7465 % it's at the top level, we don't want the normal paragraph indentation.
7466 \noindent
7467 %
7468 % Output the image.
5624 \ifpdf 7469 \ifpdf
5625 \centerline{\dopdfimage{#1}{#2}{#3}}% 7470 \dopdfimage{#1}{#2}{#3}%
5626 \else 7471 \else
5627 % \epsfbox itself resets \epsf?size at each figure. 7472 % \epsfbox itself resets \epsf?size at each figure.
5628 \setbox0 = \hbox{\ignorespaces #2}\ifdim\wd0 > 0pt \epsfxsize=#2\relax \fi 7473 \setbox0 = \hbox{\ignorespaces #2}\ifdim\wd0 > 0pt \epsfxsize=#2\relax \fi
5629 \setbox0 = \hbox{\ignorespaces #3}\ifdim\wd0 > 0pt \epsfysize=#3\relax \fi 7474 \setbox0 = \hbox{\ignorespaces #3}\ifdim\wd0 > 0pt \epsfysize=#3\relax \fi
7475 \epsfbox{#1.eps}%
7476 \fi
7477 %
7478 \ifimagevmode \medskip \fi % space after the standalone image
7479 \endgroup}
7480
7481
7482 % @float FLOATTYPE,LABEL,LOC ... @end float for displayed figures, tables,
7483 % etc. We don't actually implement floating yet, we always include the
7484 % float "here". But it seemed the best name for the future.
7485 %
7486 \envparseargdef\float{\eatcommaspace\eatcommaspace\dofloat#1, , ,\finish}
7487
7488 % There may be a space before second and/or third parameter; delete it.
7489 \def\eatcommaspace#1, {#1,}
7490
7491 % #1 is the optional FLOATTYPE, the text label for this float, typically
7492 % "Figure", "Table", "Example", etc. Can't contain commas. If omitted,
7493 % this float will not be numbered and cannot be referred to.
7494 %
7495 % #2 is the optional xref label. Also must be present for the float to
7496 % be referable.
7497 %
7498 % #3 is the optional positioning argument; for now, it is ignored. It
7499 % will somehow specify the positions allowed to float to (here, top, bottom).
7500 %
7501 % We keep a separate counter for each FLOATTYPE, which we reset at each
7502 % chapter-level command.
7503 \let\resetallfloatnos=\empty
7504 %
7505 \def\dofloat#1,#2,#3,#4\finish{%
7506 \let\thiscaption=\empty
7507 \let\thisshortcaption=\empty
7508 %
7509 % don't lose footnotes inside @float.
7510 %
7511 % BEWARE: when the floats start float, we have to issue warning whenever an
7512 % insert appears inside a float which could possibly float. --kasal, 26may04
7513 %
7514 \startsavinginserts
7515 %
7516 % We can't be used inside a paragraph.
7517 \par
7518 %
7519 \vtop\bgroup
7520 \def\floattype{#1}%
7521 \def\floatlabel{#2}%
7522 \def\floatloc{#3}% we do nothing with this yet.
7523 %
7524 \ifx\floattype\empty
7525 \let\safefloattype=\empty
7526 \else
7527 {%
7528 % the floattype might have accents or other special characters,
7529 % but we need to use it in a control sequence name.
7530 \indexnofonts
7531 \turnoffactive
7532 \xdef\safefloattype{\floattype}%
7533 }%
7534 \fi
7535 %
7536 % If label is given but no type, we handle that as the empty type.
7537 \ifx\floatlabel\empty \else
7538 % We want each FLOATTYPE to be numbered separately (Figure 1,
7539 % Table 1, Figure 2, ...). (And if no label, no number.)
7540 %
7541 \expandafter\getfloatno\csname\safefloattype floatno\endcsname
7542 \global\advance\floatno by 1
7543 %
7544 {%
7545 % This magic value for \lastsection is output by \setref as the
7546 % XREFLABEL-title value. \xrefX uses it to distinguish float
7547 % labels (which have a completely different output format) from
7548 % node and anchor labels. And \xrdef uses it to construct the
7549 % lists of floats.
7550 %
7551 \edef\lastsection{\floatmagic=\safefloattype}%
7552 \setref{\floatlabel}{Yfloat}%
7553 }%
7554 \fi
7555 %
7556 % start with \parskip glue, I guess.
7557 \vskip\parskip
7558 %
7559 % Don't suppress indentation if a float happens to start a section.
7560 \restorefirstparagraphindent
7561 }
7562
7563 % we have these possibilities:
7564 % @float Foo,lbl & @caption{Cap}: Foo 1.1: Cap
7565 % @float Foo,lbl & no caption: Foo 1.1
7566 % @float Foo & @caption{Cap}: Foo: Cap
7567 % @float Foo & no caption: Foo
7568 % @float ,lbl & Caption{Cap}: 1.1: Cap
7569 % @float ,lbl & no caption: 1.1
7570 % @float & @caption{Cap}: Cap
7571 % @float & no caption:
7572 %
7573 \def\Efloat{%
7574 \let\floatident = \empty
7575 %
7576 % In all cases, if we have a float type, it comes first.
7577 \ifx\floattype\empty \else \def\floatident{\floattype}\fi
7578 %
7579 % If we have an xref label, the number comes next.
7580 \ifx\floatlabel\empty \else
7581 \ifx\floattype\empty \else % if also had float type, need tie first.
7582 \appendtomacro\floatident{\tie}%
7583 \fi
7584 % the number.
7585 \appendtomacro\floatident{\chaplevelprefix\the\floatno}%
7586 \fi
7587 %
7588 % Start the printed caption with what we've constructed in
7589 % \floatident, but keep it separate; we need \floatident again.
7590 \let\captionline = \floatident
7591 %
7592 \ifx\thiscaption\empty \else
7593 \ifx\floatident\empty \else
7594 \appendtomacro\captionline{: }% had ident, so need a colon between
7595 \fi
7596 %
7597 % caption text.
7598 \appendtomacro\captionline{\scanexp\thiscaption}%
7599 \fi
7600 %
7601 % If we have anything to print, print it, with space before.
7602 % Eventually this needs to become an \insert.
7603 \ifx\captionline\empty \else
7604 \vskip.5\parskip
7605 \captionline
7606 %
7607 % Space below caption.
7608 \vskip\parskip
7609 \fi
7610 %
7611 % If have an xref label, write the list of floats info. Do this
7612 % after the caption, to avoid chance of it being a breakpoint.
7613 \ifx\floatlabel\empty \else
7614 % Write the text that goes in the lof to the aux file as
7615 % \floatlabel-lof. Besides \floatident, we include the short
7616 % caption if specified, else the full caption if specified, else nothing.
7617 {%
7618 \atdummies
7619 %
7620 % since we read the caption text in the macro world, where ^^M
7621 % is turned into a normal character, we have to scan it back, so
7622 % we don't write the literal three characters "^^M" into the aux file.
7623 \scanexp{%
7624 \xdef\noexpand\gtemp{%
7625 \ifx\thisshortcaption\empty
7626 \thiscaption
7627 \else
7628 \thisshortcaption
7629 \fi
7630 }%
7631 }%
7632 \immediate\write\auxfile{@xrdef{\floatlabel-lof}{\floatident
7633 \ifx\gtemp\empty \else : \gtemp \fi}}%
7634 }%
7635 \fi
7636 \egroup % end of \vtop
7637 %
7638 % place the captured inserts
7639 %
7640 % BEWARE: when the floats start floating, we have to issue warning
7641 % whenever an insert appears inside a float which could possibly
7642 % float. --kasal, 26may04
7643 %
7644 \checkinserts
7645 }
7646
7647 % Append the tokens #2 to the definition of macro #1, not expanding either.
7648 %
7649 \def\appendtomacro#1#2{%
7650 \expandafter\def\expandafter#1\expandafter{#1#2}%
7651 }
7652
7653 % @caption, @shortcaption
7654 %
7655 \def\caption{\docaption\thiscaption}
7656 \def\shortcaption{\docaption\thisshortcaption}
7657 \def\docaption{\checkenv\float \bgroup\scanargctxt\defcaption}
7658 \def\defcaption#1#2{\egroup \def#1{#2}}
7659
7660 % The parameter is the control sequence identifying the counter we are
7661 % going to use. Create it if it doesn't exist and assign it to \floatno.
7662 \def\getfloatno#1{%
7663 \ifx#1\relax
7664 % Haven't seen this figure type before.
7665 \csname newcount\endcsname #1%
7666 %
7667 % Remember to reset this floatno at the next chap.
7668 \expandafter\gdef\expandafter\resetallfloatnos
7669 \expandafter{\resetallfloatnos #1=0 }%
7670 \fi
7671 \let\floatno#1%
7672 }
7673
7674 % \setref calls this to get the XREFLABEL-snt value. We want an @xref
7675 % to the FLOATLABEL to expand to "Figure 3.1". We call \setref when we
7676 % first read the @float command.
7677 %
7678 \def\Yfloat{\floattype@tie \chaplevelprefix\the\floatno}%
7679
7680 % Magic string used for the XREFLABEL-title value, so \xrefX can
7681 % distinguish floats from other xref types.
7682 \def\floatmagic{!!float!!}
7683
7684 % #1 is the control sequence we are passed; we expand into a conditional
7685 % which is true if #1 represents a float ref. That is, the magic
7686 % \lastsection value which we \setref above.
7687 %
7688 \def\iffloat#1{\expandafter\doiffloat#1==\finish}
7689 %
7690 % #1 is (maybe) the \floatmagic string. If so, #2 will be the
7691 % (safe) float type for this float. We set \iffloattype to #2.
7692 %
7693 \def\doiffloat#1=#2=#3\finish{%
7694 \def\temp{#1}%
7695 \def\iffloattype{#2}%
7696 \ifx\temp\floatmagic
7697 }
7698
7699 % @listoffloats FLOATTYPE - print a list of floats like a table of contents.
7700 %
7701 \parseargdef\listoffloats{%
7702 \def\floattype{#1}% floattype
7703 {%
7704 % the floattype might have accents or other special characters,
7705 % but we need to use it in a control sequence name.
7706 \indexnofonts
7707 \turnoffactive
7708 \xdef\safefloattype{\floattype}%
7709 }%
7710 %
7711 % \xrdef saves the floats as a \do-list in \floatlistSAFEFLOATTYPE.
7712 \expandafter\ifx\csname floatlist\safefloattype\endcsname \relax
7713 \ifhavexrefs
7714 % if the user said @listoffloats foo but never @float foo.
7715 \message{\linenumber No `\safefloattype' floats to list.}%
7716 \fi
7717 \else
5630 \begingroup 7718 \begingroup
5631 \catcode`\^^M = 5 % in case we're inside an example 7719 \leftskip=\tocindent % indent these entries like a toc
5632 % If the image is by itself, center it. 7720 \let\do=\listoffloatsdo
5633 \ifvmode 7721 \csname floatlist\safefloattype\endcsname
5634 \nobreak\bigskip
5635 % Usually we'll have text after the image which will insert
5636 % \parskip glue, so insert it here too to equalize the space
5637 % above and below.
5638 \nobreak\vskip\parskip
5639 \nobreak
5640 \centerline{\epsfbox{#1.eps}}%
5641 \bigbreak
5642 \else
5643 % In the middle of a paragraph, no extra space.
5644 \epsfbox{#1.eps}%
5645 \fi
5646 \endgroup 7722 \endgroup
5647 \fi 7723 \fi
5648 } 7724 }
5649 7725
7726 % This is called on each entry in a list of floats. We're passed the
7727 % xref label, in the form LABEL-title, which is how we save it in the
7728 % aux file. We strip off the -title and look up \XRLABEL-lof, which
7729 % has the text we're supposed to typeset here.
7730 %
7731 % Figures without xref labels will not be included in the list (since
7732 % they won't appear in the aux file).
7733 %
7734 \def\listoffloatsdo#1{\listoffloatsdoentry#1\finish}
7735 \def\listoffloatsdoentry#1-title\finish{{%
7736 % Can't fully expand XR#1-lof because it can contain anything. Just
7737 % pass the control sequence. On the other hand, XR#1-pg is just the
7738 % page number, and we want to fully expand that so we can get a link
7739 % in pdf output.
7740 \toksA = \expandafter{\csname XR#1-lof\endcsname}%
7741 %
7742 % use the same \entry macro we use to generate the TOC and index.
7743 \edef\writeentry{\noexpand\entry{\the\toksA}{\csname XR#1-pg\endcsname}}%
7744 \writeentry
7745 }}
7746
5650 7747
5651 \message{localization,} 7748 \message{localization,}
5652 % and i18n.
5653 7749
5654 % @documentlanguage is usually given very early, just after 7750 % @documentlanguage is usually given very early, just after
5655 % @setfilename. If done too late, it may not override everything 7751 % @setfilename. If done too late, it may not override everything
5656 % properly. Single argument is the language abbreviation. 7752 % properly. Single argument is the language (de) or locale (de_DE)
5657 % It would be nice if we could set up a hyphenation file here. 7753 % abbreviation. It would be nice if we could set up a hyphenation file.
5658 % 7754 %
5659 \def\documentlanguage{\parsearg\dodocumentlanguage} 7755 {
5660 \def\dodocumentlanguage#1{% 7756 \catcode`\_ = \active
7757 \globaldefs=1
7758 \parseargdef\documentlanguage{\begingroup
7759 \let_=\normalunderscore % normal _ character for filenames
5661 \tex % read txi-??.tex file in plain TeX. 7760 \tex % read txi-??.tex file in plain TeX.
5662 % Read the file if it exists. 7761 % Read the file by the name they passed if it exists.
7762 \openin 1 txi-#1.tex
7763 \ifeof 1
7764 \documentlanguagetrywithoutunderscore{#1_\finish}%
7765 \else
7766 \input txi-#1.tex
7767 \fi
7768 \closein 1
7769 \endgroup
7770 \endgroup}
7771 }
7772 %
7773 % If they passed de_DE, and txi-de_DE.tex doesn't exist,
7774 % try txi-de.tex.
7775 %
7776 \def\documentlanguagetrywithoutunderscore#1_#2\finish{%
5663 \openin 1 txi-#1.tex 7777 \openin 1 txi-#1.tex
5664 \ifeof1 7778 \ifeof 1
5665 \errhelp = \nolanghelp 7779 \errhelp = \nolanghelp
5666 \errmessage{Cannot read language file txi-#1.tex}% 7780 \errmessage{Cannot read language file txi-#1.tex}%
5667 \let\temp = \relax
5668 \else 7781 \else
5669 \def\temp{\input txi-#1.tex }% 7782 \input txi-#1.tex
5670 \fi 7783 \fi
5671 \temp 7784 \closein 1
5672 \endgroup 7785 }
5673 } 7786 %
5674 \newhelp\nolanghelp{The given language definition file cannot be found or 7787 \newhelp\nolanghelp{The given language definition file cannot be found or
5675 is empty. Maybe you need to install it? In the current directory 7788 is empty. Maybe you need to install it? In the current directory
5676 should work if nowhere else does.} 7789 should work if nowhere else does.}
5677 7790
5678 7791 % Set the catcode of characters 128 through 255 to the specified number.
5679 % @documentencoding should change something in TeX eventually, most 7792 %
5680 % likely, but for now just recognize it. 7793 \def\setnonasciicharscatcode#1{%
5681 \let\documentencoding = \comment 7794 \count255=128
5682 7795 \loop\ifnum\count255<256
5683 7796 \global\catcode\count255=#1\relax
5684 % Page size parameters. 7797 \advance\count255 by 1
5685 % 7798 \repeat
7799 }
7800
7801 \def\setnonasciicharscatcodenonglobal#1{%
7802 \count255=128
7803 \loop\ifnum\count255<256
7804 \catcode\count255=#1\relax
7805 \advance\count255 by 1
7806 \repeat
7807 }
7808
7809 % @documentencoding sets the definition of non-ASCII characters
7810 % according to the specified encoding.
7811 %
7812 \parseargdef\documentencoding{%
7813 % Encoding being declared for the document.
7814 \def\declaredencoding{\csname #1.enc\endcsname}%
7815 %
7816 % Supported encodings: names converted to tokens in order to be able
7817 % to compare them with \ifx.
7818 \def\ascii{\csname US-ASCII.enc\endcsname}%
7819 \def\latnine{\csname ISO-8859-15.enc\endcsname}%
7820 \def\latone{\csname ISO-8859-1.enc\endcsname}%
7821 \def\lattwo{\csname ISO-8859-2.enc\endcsname}%
7822 \def\utfeight{\csname UTF-8.enc\endcsname}%
7823 %
7824 \ifx \declaredencoding \ascii
7825 \asciichardefs
7826 %
7827 \else \ifx \declaredencoding \lattwo
7828 \setnonasciicharscatcode\active
7829 \lattwochardefs
7830 %
7831 \else \ifx \declaredencoding \latone
7832 \setnonasciicharscatcode\active
7833 \latonechardefs
7834 %
7835 \else \ifx \declaredencoding \latnine
7836 \setnonasciicharscatcode\active
7837 \latninechardefs
7838 %
7839 \else \ifx \declaredencoding \utfeight
7840 \setnonasciicharscatcode\active
7841 \utfeightchardefs
7842 %
7843 \else
7844 \message{Unknown document encoding #1, ignoring.}%
7845 %
7846 \fi % utfeight
7847 \fi % latnine
7848 \fi % latone
7849 \fi % lattwo
7850 \fi % ascii
7851 }
7852
7853 % A message to be logged when using a character that isn't available
7854 % the default font encoding (OT1).
7855 %
7856 \def\missingcharmsg#1{\message{Character missing in OT1 encoding: #1.}}
7857
7858 % Take account of \c (plain) vs. \, (Texinfo) difference.
7859 \def\cedilla#1{\ifx\c\ptexc\c{#1}\else\,{#1}\fi}
7860
7861 % First, make active non-ASCII characters in order for them to be
7862 % correctly categorized when TeX reads the replacement text of
7863 % macros containing the character definitions.
7864 \setnonasciicharscatcode\active
7865 %
7866 % Latin1 (ISO-8859-1) character definitions.
7867 \def\latonechardefs{%
7868 \gdef^^a0{~}
7869 \gdef^^a1{\exclamdown}
7870 \gdef^^a2{\missingcharmsg{CENT SIGN}}
7871 \gdef^^a3{{\pounds}}
7872 \gdef^^a4{\missingcharmsg{CURRENCY SIGN}}
7873 \gdef^^a5{\missingcharmsg{YEN SIGN}}
7874 \gdef^^a6{\missingcharmsg{BROKEN BAR}}
7875 \gdef^^a7{\S}
7876 \gdef^^a8{\"{}}
7877 \gdef^^a9{\copyright}
7878 \gdef^^aa{\ordf}
7879 \gdef^^ab{\missingcharmsg{LEFT-POINTING DOUBLE ANGLE QUOTATION MARK}}
7880 \gdef^^ac{$\lnot$}
7881 \gdef^^ad{\-}
7882 \gdef^^ae{\registeredsymbol}
7883 \gdef^^af{\={}}
7884 %
7885 \gdef^^b0{\textdegree}
7886 \gdef^^b1{$\pm$}
7887 \gdef^^b2{$^2$}
7888 \gdef^^b3{$^3$}
7889 \gdef^^b4{\'{}}
7890 \gdef^^b5{$\mu$}
7891 \gdef^^b6{\P}
7892 %
7893 \gdef^^b7{$^.$}
7894 \gdef^^b8{\cedilla\ }
7895 \gdef^^b9{$^1$}
7896 \gdef^^ba{\ordm}
7897 %
7898 \gdef^^bb{\missingcharmsg{RIGHT-POINTING DOUBLE ANGLE QUOTATION MARK}}
7899 \gdef^^bc{$1\over4$}
7900 \gdef^^bd{$1\over2$}
7901 \gdef^^be{$3\over4$}
7902 \gdef^^bf{\questiondown}
7903 %
7904 \gdef^^c0{\`A}
7905 \gdef^^c1{\'A}
7906 \gdef^^c2{\^A}
7907 \gdef^^c3{\~A}
7908 \gdef^^c4{\"A}
7909 \gdef^^c5{\ringaccent A}
7910 \gdef^^c6{\AE}
7911 \gdef^^c7{\cedilla C}
7912 \gdef^^c8{\`E}
7913 \gdef^^c9{\'E}
7914 \gdef^^ca{\^E}
7915 \gdef^^cb{\"E}
7916 \gdef^^cc{\`I}
7917 \gdef^^cd{\'I}
7918 \gdef^^ce{\^I}
7919 \gdef^^cf{\"I}
7920 %
7921 \gdef^^d0{\missingcharmsg{LATIN CAPITAL LETTER ETH}}
7922 \gdef^^d1{\~N}
7923 \gdef^^d2{\`O}
7924 \gdef^^d3{\'O}
7925 \gdef^^d4{\^O}
7926 \gdef^^d5{\~O}
7927 \gdef^^d6{\"O}
7928 \gdef^^d7{$\times$}
7929 \gdef^^d8{\O}
7930 \gdef^^d9{\`U}
7931 \gdef^^da{\'U}
7932 \gdef^^db{\^U}
7933 \gdef^^dc{\"U}
7934 \gdef^^dd{\'Y}
7935 \gdef^^de{\missingcharmsg{LATIN CAPITAL LETTER THORN}}
7936 \gdef^^df{\ss}
7937 %
7938 \gdef^^e0{\`a}
7939 \gdef^^e1{\'a}
7940 \gdef^^e2{\^a}
7941 \gdef^^e3{\~a}
7942 \gdef^^e4{\"a}
7943 \gdef^^e5{\ringaccent a}
7944 \gdef^^e6{\ae}
7945 \gdef^^e7{\cedilla c}
7946 \gdef^^e8{\`e}
7947 \gdef^^e9{\'e}
7948 \gdef^^ea{\^e}
7949 \gdef^^eb{\"e}
7950 \gdef^^ec{\`{\dotless i}}
7951 \gdef^^ed{\'{\dotless i}}
7952 \gdef^^ee{\^{\dotless i}}
7953 \gdef^^ef{\"{\dotless i}}
7954 %
7955 \gdef^^f0{\missingcharmsg{LATIN SMALL LETTER ETH}}
7956 \gdef^^f1{\~n}
7957 \gdef^^f2{\`o}
7958 \gdef^^f3{\'o}
7959 \gdef^^f4{\^o}
7960 \gdef^^f5{\~o}
7961 \gdef^^f6{\"o}
7962 \gdef^^f7{$\div$}
7963 \gdef^^f8{\o}
7964 \gdef^^f9{\`u}
7965 \gdef^^fa{\'u}
7966 \gdef^^fb{\^u}
7967 \gdef^^fc{\"u}
7968 \gdef^^fd{\'y}
7969 \gdef^^fe{\missingcharmsg{LATIN SMALL LETTER THORN}}
7970 \gdef^^ff{\"y}
7971 }
7972
7973 % Latin9 (ISO-8859-15) encoding character definitions.
7974 \def\latninechardefs{%
7975 % Encoding is almost identical to Latin1.
7976 \latonechardefs
7977 %
7978 \gdef^^a4{\euro}
7979 \gdef^^a6{\v S}
7980 \gdef^^a8{\v s}
7981 \gdef^^b4{\v Z}
7982 \gdef^^b8{\v z}
7983 \gdef^^bc{\OE}
7984 \gdef^^bd{\oe}
7985 \gdef^^be{\"Y}
7986 }
7987
7988 % Latin2 (ISO-8859-2) character definitions.
7989 \def\lattwochardefs{%
7990 \gdef^^a0{~}
7991 \gdef^^a1{\missingcharmsg{LATIN CAPITAL LETTER A WITH OGONEK}}
7992 \gdef^^a2{\u{}}
7993 \gdef^^a3{\L}
7994 \gdef^^a4{\missingcharmsg{CURRENCY SIGN}}
7995 \gdef^^a5{\v L}
7996 \gdef^^a6{\'S}
7997 \gdef^^a7{\S}
7998 \gdef^^a8{\"{}}
7999 \gdef^^a9{\v S}
8000 \gdef^^aa{\cedilla S}
8001 \gdef^^ab{\v T}
8002 \gdef^^ac{\'Z}
8003 \gdef^^ad{\-}
8004 \gdef^^ae{\v Z}
8005 \gdef^^af{\dotaccent Z}
8006 %
8007 \gdef^^b0{\textdegree}
8008 \gdef^^b1{\missingcharmsg{LATIN SMALL LETTER A WITH OGONEK}}
8009 \gdef^^b2{\missingcharmsg{OGONEK}}
8010 \gdef^^b3{\l}
8011 \gdef^^b4{\'{}}
8012 \gdef^^b5{\v l}
8013 \gdef^^b6{\'s}
8014 \gdef^^b7{\v{}}
8015 \gdef^^b8{\cedilla\ }
8016 \gdef^^b9{\v s}
8017 \gdef^^ba{\cedilla s}
8018 \gdef^^bb{\v t}
8019 \gdef^^bc{\'z}
8020 \gdef^^bd{\H{}}
8021 \gdef^^be{\v z}
8022 \gdef^^bf{\dotaccent z}
8023 %
8024 \gdef^^c0{\'R}
8025 \gdef^^c1{\'A}
8026 \gdef^^c2{\^A}
8027 \gdef^^c3{\u A}
8028 \gdef^^c4{\"A}
8029 \gdef^^c5{\'L}
8030 \gdef^^c6{\'C}
8031 \gdef^^c7{\cedilla C}
8032 \gdef^^c8{\v C}
8033 \gdef^^c9{\'E}
8034 \gdef^^ca{\missingcharmsg{LATIN CAPITAL LETTER E WITH OGONEK}}
8035 \gdef^^cb{\"E}
8036 \gdef^^cc{\v E}
8037 \gdef^^cd{\'I}
8038 \gdef^^ce{\^I}
8039 \gdef^^cf{\v D}
8040 %
8041 \gdef^^d0{\missingcharmsg{LATIN CAPITAL LETTER D WITH STROKE}}
8042 \gdef^^d1{\'N}
8043 \gdef^^d2{\v N}
8044 \gdef^^d3{\'O}
8045 \gdef^^d4{\^O}
8046 \gdef^^d5{\H O}
8047 \gdef^^d6{\"O}
8048 \gdef^^d7{$\times$}
8049 \gdef^^d8{\v R}
8050 \gdef^^d9{\ringaccent U}
8051 \gdef^^da{\'U}
8052 \gdef^^db{\H U}
8053 \gdef^^dc{\"U}
8054 \gdef^^dd{\'Y}
8055 \gdef^^de{\cedilla T}
8056 \gdef^^df{\ss}
8057 %
8058 \gdef^^e0{\'r}
8059 \gdef^^e1{\'a}
8060 \gdef^^e2{\^a}
8061 \gdef^^e3{\u a}
8062 \gdef^^e4{\"a}
8063 \gdef^^e5{\'l}
8064 \gdef^^e6{\'c}
8065 \gdef^^e7{\cedilla c}
8066 \gdef^^e8{\v c}
8067 \gdef^^e9{\'e}
8068 \gdef^^ea{\missingcharmsg{LATIN SMALL LETTER E WITH OGONEK}}
8069 \gdef^^eb{\"e}
8070 \gdef^^ec{\v e}
8071 \gdef^^ed{\'\i}
8072 \gdef^^ee{\^\i}
8073 \gdef^^ef{\v d}
8074 %
8075 \gdef^^f0{\missingcharmsg{LATIN SMALL LETTER D WITH STROKE}}
8076 \gdef^^f1{\'n}
8077 \gdef^^f2{\v n}
8078 \gdef^^f3{\'o}
8079 \gdef^^f4{\^o}
8080 \gdef^^f5{\H o}
8081 \gdef^^f6{\"o}
8082 \gdef^^f7{$\div$}
8083 \gdef^^f8{\v r}
8084 \gdef^^f9{\ringaccent u}
8085 \gdef^^fa{\'u}
8086 \gdef^^fb{\H u}
8087 \gdef^^fc{\"u}
8088 \gdef^^fd{\'y}
8089 \gdef^^fe{\cedilla t}
8090 \gdef^^ff{\dotaccent{}}
8091 }
8092
8093 % UTF-8 character definitions.
8094 %
8095 % This code to support UTF-8 is based on LaTeX's utf8.def, with some
8096 % changes for Texinfo conventions. It is included here under the GPL by
8097 % permission from Frank Mittelbach and the LaTeX team.
8098 %
8099 \newcount\countUTFx
8100 \newcount\countUTFy
8101 \newcount\countUTFz
8102
8103 \gdef\UTFviiiTwoOctets#1#2{\expandafter
8104 \UTFviiiDefined\csname u8:#1\string #2\endcsname}
8105 %
8106 \gdef\UTFviiiThreeOctets#1#2#3{\expandafter
8107 \UTFviiiDefined\csname u8:#1\string #2\string #3\endcsname}
8108 %
8109 \gdef\UTFviiiFourOctets#1#2#3#4{\expandafter
8110 \UTFviiiDefined\csname u8:#1\string #2\string #3\string #4\endcsname}
8111
8112 \gdef\UTFviiiDefined#1{%
8113 \ifx #1\relax
8114 \message{\linenumber Unicode char \string #1 not defined for Texinfo}%
8115 \else
8116 \expandafter #1%
8117 \fi
8118 }
8119
8120 \begingroup
8121 \catcode`\~13
8122 \catcode`\"12
8123
8124 \def\UTFviiiLoop{%
8125 \global\catcode\countUTFx\active
8126 \uccode`\~\countUTFx
8127 \uppercase\expandafter{\UTFviiiTmp}%
8128 \advance\countUTFx by 1
8129 \ifnum\countUTFx < \countUTFy
8130 \expandafter\UTFviiiLoop
8131 \fi}
8132
8133 \countUTFx = "C2
8134 \countUTFy = "E0
8135 \def\UTFviiiTmp{%
8136 \xdef~{\noexpand\UTFviiiTwoOctets\string~}}
8137 \UTFviiiLoop
8138
8139 \countUTFx = "E0
8140 \countUTFy = "F0
8141 \def\UTFviiiTmp{%
8142 \xdef~{\noexpand\UTFviiiThreeOctets\string~}}
8143 \UTFviiiLoop
8144
8145 \countUTFx = "F0
8146 \countUTFy = "F4
8147 \def\UTFviiiTmp{%
8148 \xdef~{\noexpand\UTFviiiFourOctets\string~}}
8149 \UTFviiiLoop
8150 \endgroup
8151
8152 \begingroup
8153 \catcode`\"=12
8154 \catcode`\<=12
8155 \catcode`\.=12
8156 \catcode`\,=12
8157 \catcode`\;=12
8158 \catcode`\!=12
8159 \catcode`\~=13
8160
8161 \gdef\DeclareUnicodeCharacter#1#2{%
8162 \countUTFz = "#1\relax
8163 \wlog{\space\space defining Unicode char U+#1 (decimal \the\countUTFz)}%
8164 \begingroup
8165 \parseXMLCharref
8166 \def\UTFviiiTwoOctets##1##2{%
8167 \csname u8:##1\string ##2\endcsname}%
8168 \def\UTFviiiThreeOctets##1##2##3{%
8169 \csname u8:##1\string ##2\string ##3\endcsname}%
8170 \def\UTFviiiFourOctets##1##2##3##4{%
8171 \csname u8:##1\string ##2\string ##3\string ##4\endcsname}%
8172 \expandafter\expandafter\expandafter\expandafter
8173 \expandafter\expandafter\expandafter
8174 \gdef\UTFviiiTmp{#2}%
8175 \endgroup}
8176
8177 \gdef\parseXMLCharref{%
8178 \ifnum\countUTFz < "A0\relax
8179 \errhelp = \EMsimple
8180 \errmessage{Cannot define Unicode char value < 00A0}%
8181 \else\ifnum\countUTFz < "800\relax
8182 \parseUTFviiiA,%
8183 \parseUTFviiiB C\UTFviiiTwoOctets.,%
8184 \else\ifnum\countUTFz < "10000\relax
8185 \parseUTFviiiA;%
8186 \parseUTFviiiA,%
8187 \parseUTFviiiB E\UTFviiiThreeOctets.{,;}%
8188 \else
8189 \parseUTFviiiA;%
8190 \parseUTFviiiA,%
8191 \parseUTFviiiA!%
8192 \parseUTFviiiB F\UTFviiiFourOctets.{!,;}%
8193 \fi\fi\fi
8194 }
8195
8196 \gdef\parseUTFviiiA#1{%
8197 \countUTFx = \countUTFz
8198 \divide\countUTFz by 64
8199 \countUTFy = \countUTFz
8200 \multiply\countUTFz by 64
8201 \advance\countUTFx by -\countUTFz
8202 \advance\countUTFx by 128
8203 \uccode `#1\countUTFx
8204 \countUTFz = \countUTFy}
8205
8206 \gdef\parseUTFviiiB#1#2#3#4{%
8207 \advance\countUTFz by "#10\relax
8208 \uccode `#3\countUTFz
8209 \uppercase{\gdef\UTFviiiTmp{#2#3#4}}}
8210 \endgroup
8211
8212 \def\utfeightchardefs{%
8213 \DeclareUnicodeCharacter{00A0}{\tie}
8214 \DeclareUnicodeCharacter{00A1}{\exclamdown}
8215 \DeclareUnicodeCharacter{00A3}{\pounds}
8216 \DeclareUnicodeCharacter{00A8}{\"{ }}
8217 \DeclareUnicodeCharacter{00A9}{\copyright}
8218 \DeclareUnicodeCharacter{00AA}{\ordf}
8219 \DeclareUnicodeCharacter{00AB}{\guillemetleft}
8220 \DeclareUnicodeCharacter{00AD}{\-}
8221 \DeclareUnicodeCharacter{00AE}{\registeredsymbol}
8222 \DeclareUnicodeCharacter{00AF}{\={ }}
8223
8224 \DeclareUnicodeCharacter{00B0}{\ringaccent{ }}
8225 \DeclareUnicodeCharacter{00B4}{\'{ }}
8226 \DeclareUnicodeCharacter{00B8}{\cedilla{ }}
8227 \DeclareUnicodeCharacter{00BA}{\ordm}
8228 \DeclareUnicodeCharacter{00BB}{\guillemetright}
8229 \DeclareUnicodeCharacter{00BF}{\questiondown}
8230
8231 \DeclareUnicodeCharacter{00C0}{\`A}
8232 \DeclareUnicodeCharacter{00C1}{\'A}
8233 \DeclareUnicodeCharacter{00C2}{\^A}
8234 \DeclareUnicodeCharacter{00C3}{\~A}
8235 \DeclareUnicodeCharacter{00C4}{\"A}
8236 \DeclareUnicodeCharacter{00C5}{\AA}
8237 \DeclareUnicodeCharacter{00C6}{\AE}
8238 \DeclareUnicodeCharacter{00C7}{\cedilla{C}}
8239 \DeclareUnicodeCharacter{00C8}{\`E}
8240 \DeclareUnicodeCharacter{00C9}{\'E}
8241 \DeclareUnicodeCharacter{00CA}{\^E}
8242 \DeclareUnicodeCharacter{00CB}{\"E}
8243 \DeclareUnicodeCharacter{00CC}{\`I}
8244 \DeclareUnicodeCharacter{00CD}{\'I}
8245 \DeclareUnicodeCharacter{00CE}{\^I}
8246 \DeclareUnicodeCharacter{00CF}{\"I}
8247
8248 \DeclareUnicodeCharacter{00D1}{\~N}
8249 \DeclareUnicodeCharacter{00D2}{\`O}
8250 \DeclareUnicodeCharacter{00D3}{\'O}
8251 \DeclareUnicodeCharacter{00D4}{\^O}
8252 \DeclareUnicodeCharacter{00D5}{\~O}
8253 \DeclareUnicodeCharacter{00D6}{\"O}
8254 \DeclareUnicodeCharacter{00D8}{\O}
8255 \DeclareUnicodeCharacter{00D9}{\`U}
8256 \DeclareUnicodeCharacter{00DA}{\'U}
8257 \DeclareUnicodeCharacter{00DB}{\^U}
8258 \DeclareUnicodeCharacter{00DC}{\"U}
8259 \DeclareUnicodeCharacter{00DD}{\'Y}
8260 \DeclareUnicodeCharacter{00DF}{\ss}
8261
8262 \DeclareUnicodeCharacter{00E0}{\`a}
8263 \DeclareUnicodeCharacter{00E1}{\'a}
8264 \DeclareUnicodeCharacter{00E2}{\^a}
8265 \DeclareUnicodeCharacter{00E3}{\~a}
8266 \DeclareUnicodeCharacter{00E4}{\"a}
8267 \DeclareUnicodeCharacter{00E5}{\aa}
8268 \DeclareUnicodeCharacter{00E6}{\ae}
8269 \DeclareUnicodeCharacter{00E7}{\cedilla{c}}
8270 \DeclareUnicodeCharacter{00E8}{\`e}
8271 \DeclareUnicodeCharacter{00E9}{\'e}
8272 \DeclareUnicodeCharacter{00EA}{\^e}
8273 \DeclareUnicodeCharacter{00EB}{\"e}
8274 \DeclareUnicodeCharacter{00EC}{\`{\dotless{i}}}
8275 \DeclareUnicodeCharacter{00ED}{\'{\dotless{i}}}
8276 \DeclareUnicodeCharacter{00EE}{\^{\dotless{i}}}
8277 \DeclareUnicodeCharacter{00EF}{\"{\dotless{i}}}
8278
8279 \DeclareUnicodeCharacter{00F1}{\~n}
8280 \DeclareUnicodeCharacter{00F2}{\`o}
8281 \DeclareUnicodeCharacter{00F3}{\'o}
8282 \DeclareUnicodeCharacter{00F4}{\^o}
8283 \DeclareUnicodeCharacter{00F5}{\~o}
8284 \DeclareUnicodeCharacter{00F6}{\"o}
8285 \DeclareUnicodeCharacter{00F8}{\o}
8286 \DeclareUnicodeCharacter{00F9}{\`u}
8287 \DeclareUnicodeCharacter{00FA}{\'u}
8288 \DeclareUnicodeCharacter{00FB}{\^u}
8289 \DeclareUnicodeCharacter{00FC}{\"u}
8290 \DeclareUnicodeCharacter{00FD}{\'y}
8291 \DeclareUnicodeCharacter{00FF}{\"y}
8292
8293 \DeclareUnicodeCharacter{0100}{\=A}
8294 \DeclareUnicodeCharacter{0101}{\=a}
8295 \DeclareUnicodeCharacter{0102}{\u{A}}
8296 \DeclareUnicodeCharacter{0103}{\u{a}}
8297 \DeclareUnicodeCharacter{0106}{\'C}
8298 \DeclareUnicodeCharacter{0107}{\'c}
8299 \DeclareUnicodeCharacter{0108}{\^C}
8300 \DeclareUnicodeCharacter{0109}{\^c}
8301 \DeclareUnicodeCharacter{010A}{\dotaccent{C}}
8302 \DeclareUnicodeCharacter{010B}{\dotaccent{c}}
8303 \DeclareUnicodeCharacter{010C}{\v{C}}
8304 \DeclareUnicodeCharacter{010D}{\v{c}}
8305 \DeclareUnicodeCharacter{010E}{\v{D}}
8306
8307 \DeclareUnicodeCharacter{0112}{\=E}
8308 \DeclareUnicodeCharacter{0113}{\=e}
8309 \DeclareUnicodeCharacter{0114}{\u{E}}
8310 \DeclareUnicodeCharacter{0115}{\u{e}}
8311 \DeclareUnicodeCharacter{0116}{\dotaccent{E}}
8312 \DeclareUnicodeCharacter{0117}{\dotaccent{e}}
8313 \DeclareUnicodeCharacter{011A}{\v{E}}
8314 \DeclareUnicodeCharacter{011B}{\v{e}}
8315 \DeclareUnicodeCharacter{011C}{\^G}
8316 \DeclareUnicodeCharacter{011D}{\^g}
8317 \DeclareUnicodeCharacter{011E}{\u{G}}
8318 \DeclareUnicodeCharacter{011F}{\u{g}}
8319
8320 \DeclareUnicodeCharacter{0120}{\dotaccent{G}}
8321 \DeclareUnicodeCharacter{0121}{\dotaccent{g}}
8322 \DeclareUnicodeCharacter{0124}{\^H}
8323 \DeclareUnicodeCharacter{0125}{\^h}
8324 \DeclareUnicodeCharacter{0128}{\~I}
8325 \DeclareUnicodeCharacter{0129}{\~{\dotless{i}}}
8326 \DeclareUnicodeCharacter{012A}{\=I}
8327 \DeclareUnicodeCharacter{012B}{\={\dotless{i}}}
8328 \DeclareUnicodeCharacter{012C}{\u{I}}
8329 \DeclareUnicodeCharacter{012D}{\u{\dotless{i}}}
8330
8331 \DeclareUnicodeCharacter{0130}{\dotaccent{I}}
8332 \DeclareUnicodeCharacter{0131}{\dotless{i}}
8333 \DeclareUnicodeCharacter{0132}{IJ}
8334 \DeclareUnicodeCharacter{0133}{ij}
8335 \DeclareUnicodeCharacter{0134}{\^J}
8336 \DeclareUnicodeCharacter{0135}{\^{\dotless{j}}}
8337 \DeclareUnicodeCharacter{0139}{\'L}
8338 \DeclareUnicodeCharacter{013A}{\'l}
8339
8340 \DeclareUnicodeCharacter{0141}{\L}
8341 \DeclareUnicodeCharacter{0142}{\l}
8342 \DeclareUnicodeCharacter{0143}{\'N}
8343 \DeclareUnicodeCharacter{0144}{\'n}
8344 \DeclareUnicodeCharacter{0147}{\v{N}}
8345 \DeclareUnicodeCharacter{0148}{\v{n}}
8346 \DeclareUnicodeCharacter{014C}{\=O}
8347 \DeclareUnicodeCharacter{014D}{\=o}
8348 \DeclareUnicodeCharacter{014E}{\u{O}}
8349 \DeclareUnicodeCharacter{014F}{\u{o}}
8350
8351 \DeclareUnicodeCharacter{0150}{\H{O}}
8352 \DeclareUnicodeCharacter{0151}{\H{o}}
8353 \DeclareUnicodeCharacter{0152}{\OE}
8354 \DeclareUnicodeCharacter{0153}{\oe}
8355 \DeclareUnicodeCharacter{0154}{\'R}
8356 \DeclareUnicodeCharacter{0155}{\'r}
8357 \DeclareUnicodeCharacter{0158}{\v{R}}
8358 \DeclareUnicodeCharacter{0159}{\v{r}}
8359 \DeclareUnicodeCharacter{015A}{\'S}
8360 \DeclareUnicodeCharacter{015B}{\'s}
8361 \DeclareUnicodeCharacter{015C}{\^S}
8362 \DeclareUnicodeCharacter{015D}{\^s}
8363 \DeclareUnicodeCharacter{015E}{\cedilla{S}}
8364 \DeclareUnicodeCharacter{015F}{\cedilla{s}}
8365
8366 \DeclareUnicodeCharacter{0160}{\v{S}}
8367 \DeclareUnicodeCharacter{0161}{\v{s}}
8368 \DeclareUnicodeCharacter{0162}{\cedilla{t}}
8369 \DeclareUnicodeCharacter{0163}{\cedilla{T}}
8370 \DeclareUnicodeCharacter{0164}{\v{T}}
8371
8372 \DeclareUnicodeCharacter{0168}{\~U}
8373 \DeclareUnicodeCharacter{0169}{\~u}
8374 \DeclareUnicodeCharacter{016A}{\=U}
8375 \DeclareUnicodeCharacter{016B}{\=u}
8376 \DeclareUnicodeCharacter{016C}{\u{U}}
8377 \DeclareUnicodeCharacter{016D}{\u{u}}
8378 \DeclareUnicodeCharacter{016E}{\ringaccent{U}}
8379 \DeclareUnicodeCharacter{016F}{\ringaccent{u}}
8380
8381 \DeclareUnicodeCharacter{0170}{\H{U}}
8382 \DeclareUnicodeCharacter{0171}{\H{u}}
8383 \DeclareUnicodeCharacter{0174}{\^W}
8384 \DeclareUnicodeCharacter{0175}{\^w}
8385 \DeclareUnicodeCharacter{0176}{\^Y}
8386 \DeclareUnicodeCharacter{0177}{\^y}
8387 \DeclareUnicodeCharacter{0178}{\"Y}
8388 \DeclareUnicodeCharacter{0179}{\'Z}
8389 \DeclareUnicodeCharacter{017A}{\'z}
8390 \DeclareUnicodeCharacter{017B}{\dotaccent{Z}}
8391 \DeclareUnicodeCharacter{017C}{\dotaccent{z}}
8392 \DeclareUnicodeCharacter{017D}{\v{Z}}
8393 \DeclareUnicodeCharacter{017E}{\v{z}}
8394
8395 \DeclareUnicodeCharacter{01C4}{D\v{Z}}
8396 \DeclareUnicodeCharacter{01C5}{D\v{z}}
8397 \DeclareUnicodeCharacter{01C6}{d\v{z}}
8398 \DeclareUnicodeCharacter{01C7}{LJ}
8399 \DeclareUnicodeCharacter{01C8}{Lj}
8400 \DeclareUnicodeCharacter{01C9}{lj}
8401 \DeclareUnicodeCharacter{01CA}{NJ}
8402 \DeclareUnicodeCharacter{01CB}{Nj}
8403 \DeclareUnicodeCharacter{01CC}{nj}
8404 \DeclareUnicodeCharacter{01CD}{\v{A}}
8405 \DeclareUnicodeCharacter{01CE}{\v{a}}
8406 \DeclareUnicodeCharacter{01CF}{\v{I}}
8407
8408 \DeclareUnicodeCharacter{01D0}{\v{\dotless{i}}}
8409 \DeclareUnicodeCharacter{01D1}{\v{O}}
8410 \DeclareUnicodeCharacter{01D2}{\v{o}}
8411 \DeclareUnicodeCharacter{01D3}{\v{U}}
8412 \DeclareUnicodeCharacter{01D4}{\v{u}}
8413
8414 \DeclareUnicodeCharacter{01E2}{\={\AE}}
8415 \DeclareUnicodeCharacter{01E3}{\={\ae}}
8416 \DeclareUnicodeCharacter{01E6}{\v{G}}
8417 \DeclareUnicodeCharacter{01E7}{\v{g}}
8418 \DeclareUnicodeCharacter{01E8}{\v{K}}
8419 \DeclareUnicodeCharacter{01E9}{\v{k}}
8420
8421 \DeclareUnicodeCharacter{01F0}{\v{\dotless{j}}}
8422 \DeclareUnicodeCharacter{01F1}{DZ}
8423 \DeclareUnicodeCharacter{01F2}{Dz}
8424 \DeclareUnicodeCharacter{01F3}{dz}
8425 \DeclareUnicodeCharacter{01F4}{\'G}
8426 \DeclareUnicodeCharacter{01F5}{\'g}
8427 \DeclareUnicodeCharacter{01F8}{\`N}
8428 \DeclareUnicodeCharacter{01F9}{\`n}
8429 \DeclareUnicodeCharacter{01FC}{\'{\AE}}
8430 \DeclareUnicodeCharacter{01FD}{\'{\ae}}
8431 \DeclareUnicodeCharacter{01FE}{\'{\O}}
8432 \DeclareUnicodeCharacter{01FF}{\'{\o}}
8433
8434 \DeclareUnicodeCharacter{021E}{\v{H}}
8435 \DeclareUnicodeCharacter{021F}{\v{h}}
8436
8437 \DeclareUnicodeCharacter{0226}{\dotaccent{A}}
8438 \DeclareUnicodeCharacter{0227}{\dotaccent{a}}
8439 \DeclareUnicodeCharacter{0228}{\cedilla{E}}
8440 \DeclareUnicodeCharacter{0229}{\cedilla{e}}
8441 \DeclareUnicodeCharacter{022E}{\dotaccent{O}}
8442 \DeclareUnicodeCharacter{022F}{\dotaccent{o}}
8443
8444 \DeclareUnicodeCharacter{0232}{\=Y}
8445 \DeclareUnicodeCharacter{0233}{\=y}
8446 \DeclareUnicodeCharacter{0237}{\dotless{j}}
8447
8448 \DeclareUnicodeCharacter{1E02}{\dotaccent{B}}
8449 \DeclareUnicodeCharacter{1E03}{\dotaccent{b}}
8450 \DeclareUnicodeCharacter{1E04}{\udotaccent{B}}
8451 \DeclareUnicodeCharacter{1E05}{\udotaccent{b}}
8452 \DeclareUnicodeCharacter{1E06}{\ubaraccent{B}}
8453 \DeclareUnicodeCharacter{1E07}{\ubaraccent{b}}
8454 \DeclareUnicodeCharacter{1E0A}{\dotaccent{D}}
8455 \DeclareUnicodeCharacter{1E0B}{\dotaccent{d}}
8456 \DeclareUnicodeCharacter{1E0C}{\udotaccent{D}}
8457 \DeclareUnicodeCharacter{1E0D}{\udotaccent{d}}
8458 \DeclareUnicodeCharacter{1E0E}{\ubaraccent{D}}
8459 \DeclareUnicodeCharacter{1E0F}{\ubaraccent{d}}
8460
8461 \DeclareUnicodeCharacter{1E1E}{\dotaccent{F}}
8462 \DeclareUnicodeCharacter{1E1F}{\dotaccent{f}}
8463
8464 \DeclareUnicodeCharacter{1E20}{\=G}
8465 \DeclareUnicodeCharacter{1E21}{\=g}
8466 \DeclareUnicodeCharacter{1E22}{\dotaccent{H}}
8467 \DeclareUnicodeCharacter{1E23}{\dotaccent{h}}
8468 \DeclareUnicodeCharacter{1E24}{\udotaccent{H}}
8469 \DeclareUnicodeCharacter{1E25}{\udotaccent{h}}
8470 \DeclareUnicodeCharacter{1E26}{\"H}
8471 \DeclareUnicodeCharacter{1E27}{\"h}
8472
8473 \DeclareUnicodeCharacter{1E30}{\'K}
8474 \DeclareUnicodeCharacter{1E31}{\'k}
8475 \DeclareUnicodeCharacter{1E32}{\udotaccent{K}}
8476 \DeclareUnicodeCharacter{1E33}{\udotaccent{k}}
8477 \DeclareUnicodeCharacter{1E34}{\ubaraccent{K}}
8478 \DeclareUnicodeCharacter{1E35}{\ubaraccent{k}}
8479 \DeclareUnicodeCharacter{1E36}{\udotaccent{L}}
8480 \DeclareUnicodeCharacter{1E37}{\udotaccent{l}}
8481 \DeclareUnicodeCharacter{1E3A}{\ubaraccent{L}}
8482 \DeclareUnicodeCharacter{1E3B}{\ubaraccent{l}}
8483 \DeclareUnicodeCharacter{1E3E}{\'M}
8484 \DeclareUnicodeCharacter{1E3F}{\'m}
8485
8486 \DeclareUnicodeCharacter{1E40}{\dotaccent{M}}
8487 \DeclareUnicodeCharacter{1E41}{\dotaccent{m}}
8488 \DeclareUnicodeCharacter{1E42}{\udotaccent{M}}
8489 \DeclareUnicodeCharacter{1E43}{\udotaccent{m}}
8490 \DeclareUnicodeCharacter{1E44}{\dotaccent{N}}
8491 \DeclareUnicodeCharacter{1E45}{\dotaccent{n}}
8492 \DeclareUnicodeCharacter{1E46}{\udotaccent{N}}
8493 \DeclareUnicodeCharacter{1E47}{\udotaccent{n}}
8494 \DeclareUnicodeCharacter{1E48}{\ubaraccent{N}}
8495 \DeclareUnicodeCharacter{1E49}{\ubaraccent{n}}
8496
8497 \DeclareUnicodeCharacter{1E54}{\'P}
8498 \DeclareUnicodeCharacter{1E55}{\'p}
8499 \DeclareUnicodeCharacter{1E56}{\dotaccent{P}}
8500 \DeclareUnicodeCharacter{1E57}{\dotaccent{p}}
8501 \DeclareUnicodeCharacter{1E58}{\dotaccent{R}}
8502 \DeclareUnicodeCharacter{1E59}{\dotaccent{r}}
8503 \DeclareUnicodeCharacter{1E5A}{\udotaccent{R}}
8504 \DeclareUnicodeCharacter{1E5B}{\udotaccent{r}}
8505 \DeclareUnicodeCharacter{1E5E}{\ubaraccent{R}}
8506 \DeclareUnicodeCharacter{1E5F}{\ubaraccent{r}}
8507
8508 \DeclareUnicodeCharacter{1E60}{\dotaccent{S}}
8509 \DeclareUnicodeCharacter{1E61}{\dotaccent{s}}
8510 \DeclareUnicodeCharacter{1E62}{\udotaccent{S}}
8511 \DeclareUnicodeCharacter{1E63}{\udotaccent{s}}
8512 \DeclareUnicodeCharacter{1E6A}{\dotaccent{T}}
8513 \DeclareUnicodeCharacter{1E6B}{\dotaccent{t}}
8514 \DeclareUnicodeCharacter{1E6C}{\udotaccent{T}}
8515 \DeclareUnicodeCharacter{1E6D}{\udotaccent{t}}
8516 \DeclareUnicodeCharacter{1E6E}{\ubaraccent{T}}
8517 \DeclareUnicodeCharacter{1E6F}{\ubaraccent{t}}
8518
8519 \DeclareUnicodeCharacter{1E7C}{\~V}
8520 \DeclareUnicodeCharacter{1E7D}{\~v}
8521 \DeclareUnicodeCharacter{1E7E}{\udotaccent{V}}
8522 \DeclareUnicodeCharacter{1E7F}{\udotaccent{v}}
8523
8524 \DeclareUnicodeCharacter{1E80}{\`W}
8525 \DeclareUnicodeCharacter{1E81}{\`w}
8526 \DeclareUnicodeCharacter{1E82}{\'W}
8527 \DeclareUnicodeCharacter{1E83}{\'w}
8528 \DeclareUnicodeCharacter{1E84}{\"W}
8529 \DeclareUnicodeCharacter{1E85}{\"w}
8530 \DeclareUnicodeCharacter{1E86}{\dotaccent{W}}
8531 \DeclareUnicodeCharacter{1E87}{\dotaccent{w}}
8532 \DeclareUnicodeCharacter{1E88}{\udotaccent{W}}
8533 \DeclareUnicodeCharacter{1E89}{\udotaccent{w}}
8534 \DeclareUnicodeCharacter{1E8A}{\dotaccent{X}}
8535 \DeclareUnicodeCharacter{1E8B}{\dotaccent{x}}
8536 \DeclareUnicodeCharacter{1E8C}{\"X}
8537 \DeclareUnicodeCharacter{1E8D}{\"x}
8538 \DeclareUnicodeCharacter{1E8E}{\dotaccent{Y}}
8539 \DeclareUnicodeCharacter{1E8F}{\dotaccent{y}}
8540
8541 \DeclareUnicodeCharacter{1E90}{\^Z}
8542 \DeclareUnicodeCharacter{1E91}{\^z}
8543 \DeclareUnicodeCharacter{1E92}{\udotaccent{Z}}
8544 \DeclareUnicodeCharacter{1E93}{\udotaccent{z}}
8545 \DeclareUnicodeCharacter{1E94}{\ubaraccent{Z}}
8546 \DeclareUnicodeCharacter{1E95}{\ubaraccent{z}}
8547 \DeclareUnicodeCharacter{1E96}{\ubaraccent{h}}
8548 \DeclareUnicodeCharacter{1E97}{\"t}
8549 \DeclareUnicodeCharacter{1E98}{\ringaccent{w}}
8550 \DeclareUnicodeCharacter{1E99}{\ringaccent{y}}
8551
8552 \DeclareUnicodeCharacter{1EA0}{\udotaccent{A}}
8553 \DeclareUnicodeCharacter{1EA1}{\udotaccent{a}}
8554
8555 \DeclareUnicodeCharacter{1EB8}{\udotaccent{E}}
8556 \DeclareUnicodeCharacter{1EB9}{\udotaccent{e}}
8557 \DeclareUnicodeCharacter{1EBC}{\~E}
8558 \DeclareUnicodeCharacter{1EBD}{\~e}
8559
8560 \DeclareUnicodeCharacter{1ECA}{\udotaccent{I}}
8561 \DeclareUnicodeCharacter{1ECB}{\udotaccent{i}}
8562 \DeclareUnicodeCharacter{1ECC}{\udotaccent{O}}
8563 \DeclareUnicodeCharacter{1ECD}{\udotaccent{o}}
8564
8565 \DeclareUnicodeCharacter{1EE4}{\udotaccent{U}}
8566 \DeclareUnicodeCharacter{1EE5}{\udotaccent{u}}
8567
8568 \DeclareUnicodeCharacter{1EF2}{\`Y}
8569 \DeclareUnicodeCharacter{1EF3}{\`y}
8570 \DeclareUnicodeCharacter{1EF4}{\udotaccent{Y}}
8571
8572 \DeclareUnicodeCharacter{1EF8}{\~Y}
8573 \DeclareUnicodeCharacter{1EF9}{\~y}
8574
8575 \DeclareUnicodeCharacter{2013}{--}
8576 \DeclareUnicodeCharacter{2014}{---}
8577 \DeclareUnicodeCharacter{2018}{\quoteleft}
8578 \DeclareUnicodeCharacter{2019}{\quoteright}
8579 \DeclareUnicodeCharacter{201A}{\quotesinglbase}
8580 \DeclareUnicodeCharacter{201C}{\quotedblleft}
8581 \DeclareUnicodeCharacter{201D}{\quotedblright}
8582 \DeclareUnicodeCharacter{201E}{\quotedblbase}
8583 \DeclareUnicodeCharacter{2022}{\bullet}
8584 \DeclareUnicodeCharacter{2026}{\dots}
8585 \DeclareUnicodeCharacter{2039}{\guilsinglleft}
8586 \DeclareUnicodeCharacter{203A}{\guilsinglright}
8587 \DeclareUnicodeCharacter{20AC}{\euro}
8588
8589 \DeclareUnicodeCharacter{2192}{\expansion}
8590 \DeclareUnicodeCharacter{21D2}{\result}
8591
8592 \DeclareUnicodeCharacter{2212}{\minus}
8593 \DeclareUnicodeCharacter{2217}{\point}
8594 \DeclareUnicodeCharacter{2261}{\equiv}
8595 }% end of \utfeightchardefs
8596
8597
8598 % US-ASCII character definitions.
8599 \def\asciichardefs{% nothing need be done
8600 \relax
8601 }
8602
8603 % Make non-ASCII characters printable again for compatibility with
8604 % existing Texinfo documents that may use them, even without declaring a
8605 % document encoding.
8606 %
8607 \setnonasciicharscatcode \other
8608
8609
8610 \message{formatting,}
8611
5686 \newdimen\defaultparindent \defaultparindent = 15pt 8612 \newdimen\defaultparindent \defaultparindent = 15pt
5687 8613
5688 \chapheadingskip = 15pt plus 4pt minus 2pt 8614 \chapheadingskip = 15pt plus 4pt minus 2pt
5689 \secheadingskip = 12pt plus 3pt minus 2pt 8615 \secheadingskip = 12pt plus 3pt minus 2pt
5690 \subsecheadingskip = 9pt plus 2pt minus 2pt 8616 \subsecheadingskip = 9pt plus 2pt minus 2pt
5693 \vbadness = 10000 8619 \vbadness = 10000
5694 8620
5695 % Don't be so finicky about underfull hboxes, either. 8621 % Don't be so finicky about underfull hboxes, either.
5696 \hbadness = 2000 8622 \hbadness = 2000
5697 8623
5698 % Following George Bush, just get rid of widows and orphans. 8624 % Following George Bush, get rid of widows and orphans.
5699 \widowpenalty=10000 8625 \widowpenalty=10000
5700 \clubpenalty=10000 8626 \clubpenalty=10000
5701 8627
5702 % Use TeX 3.0's \emergencystretch to help line breaking, but if we're 8628 % Use TeX 3.0's \emergencystretch to help line breaking, but if we're
5703 % using an old version of TeX, don't do anything. We want the amount of 8629 % using an old version of TeX, don't do anything. We want the amount of
5711 \else 8637 \else
5712 \emergencystretch = .15\hsize 8638 \emergencystretch = .15\hsize
5713 \fi 8639 \fi
5714 } 8640 }
5715 8641
5716 % Parameters in order: 1) textheight; 2) textwidth; 3) voffset; 8642 % Parameters in order: 1) textheight; 2) textwidth;
5717 % 4) hoffset; 5) binding offset; 6) topskip. Then whoever calls us can 8643 % 3) voffset; 4) hoffset; 5) binding offset; 6) topskip;
5718 % set \parskip and call \setleading for \baselineskip. 8644 % 7) physical page height; 8) physical page width.
5719 % 8645 %
5720 \def\internalpagesizes#1#2#3#4#5#6{% 8646 % We also call \setleading{\textleading}, so the caller should define
8647 % \textleading. The caller should also set \parskip.
8648 %
8649 \def\internalpagesizes#1#2#3#4#5#6#7#8{%
5721 \voffset = #3\relax 8650 \voffset = #3\relax
5722 \topskip = #6\relax 8651 \topskip = #6\relax
5723 \splittopskip = \topskip 8652 \splittopskip = \topskip
5724 % 8653 %
5725 \vsize = #1\relax 8654 \vsize = #1\relax
5734 \pagewidth = \hsize 8663 \pagewidth = \hsize
5735 % 8664 %
5736 \normaloffset = #4\relax 8665 \normaloffset = #4\relax
5737 \bindingoffset = #5\relax 8666 \bindingoffset = #5\relax
5738 % 8667 %
8668 \ifpdf
8669 \pdfpageheight #7\relax
8670 \pdfpagewidth #8\relax
8671 % if we don't reset these, they will remain at "1 true in" of
8672 % whatever layout pdftex was dumped with.
8673 \pdfhorigin = 1 true in
8674 \pdfvorigin = 1 true in
8675 \fi
8676 %
8677 \setleading{\textleading}
8678 %
5739 \parindent = \defaultparindent 8679 \parindent = \defaultparindent
5740 \setemergencystretch 8680 \setemergencystretch
5741 } 8681 }
5742 8682
5743 % @letterpaper (the default). 8683 % @letterpaper (the default).
5744 \def\letterpaper{{\globaldefs = 1 8684 \def\letterpaper{{\globaldefs = 1
5745 \parskip = 3pt plus 2pt minus 1pt 8685 \parskip = 3pt plus 2pt minus 1pt
5746 \setleading{13.2pt}% 8686 \textleading = 13.2pt
5747 % 8687 %
5748 % If page is nothing but text, make it come out even. 8688 % If page is nothing but text, make it come out even.
5749 \internalpagesizes{46\baselineskip}{6in}{\voffset}{.25in}{\bindingoffset}{36pt}% 8689 \internalpagesizes{607.2pt}{6in}% that's 46 lines
8690 {\voffset}{.25in}%
8691 {\bindingoffset}{36pt}%
8692 {11in}{8.5in}%
5750 }} 8693 }}
5751 8694
5752 % Use @smallbook to reset parameters for 7x9.5 (or so) format. 8695 % Use @smallbook to reset parameters for 7x9.25 trim size.
5753 \def\smallbook{{\globaldefs = 1 8696 \def\smallbook{{\globaldefs = 1
5754 \parskip = 2pt plus 1pt 8697 \parskip = 2pt plus 1pt
5755 \setleading{12pt}% 8698 \textleading = 12pt
5756 % 8699 %
5757 \internalpagesizes{7.5in}{5.in}{\voffset}{.25in}{\bindingoffset}{16pt}% 8700 \internalpagesizes{7.5in}{5in}%
8701 {-.2in}{0in}%
8702 {\bindingoffset}{16pt}%
8703 {9.25in}{7in}%
5758 % 8704 %
5759 \lispnarrowing = 0.3in 8705 \lispnarrowing = 0.3in
5760 \tolerance = 700 8706 \tolerance = 700
5761 \hfuzz = 1pt 8707 \hfuzz = 1pt
5762 \contentsrightmargin = 0pt 8708 \contentsrightmargin = 0pt
5763 \deftypemargin = 0pt
5764 \defbodyindent = .5cm 8709 \defbodyindent = .5cm
5765 % 8710 }}
5766 \let\smalldisplay = \smalldisplayx 8711
5767 \let\smallexample = \smalllispx 8712 % Use @smallerbook to reset parameters for 6x9 trim size.
5768 \let\smallformat = \smallformatx 8713 % (Just testing, parameters still in flux.)
5769 \let\smalllisp = \smalllispx 8714 \def\smallerbook{{\globaldefs = 1
8715 \parskip = 1.5pt plus 1pt
8716 \textleading = 12pt
8717 %
8718 \internalpagesizes{7.4in}{4.8in}%
8719 {-.2in}{-.4in}%
8720 {0pt}{14pt}%
8721 {9in}{6in}%
8722 %
8723 \lispnarrowing = 0.25in
8724 \tolerance = 700
8725 \hfuzz = 1pt
8726 \contentsrightmargin = 0pt
8727 \defbodyindent = .4cm
5770 }} 8728 }}
5771 8729
5772 % Use @afourpaper to print on European A4 paper. 8730 % Use @afourpaper to print on European A4 paper.
5773 \def\afourpaper{{\globaldefs = 1 8731 \def\afourpaper{{\globaldefs = 1
5774 \setleading{12pt}%
5775 \parskip = 3pt plus 2pt minus 1pt 8732 \parskip = 3pt plus 2pt minus 1pt
5776 % 8733 \textleading = 13.2pt
5777 \internalpagesizes{53\baselineskip}{160mm}{\voffset}{4mm}{\bindingoffset}{44pt}% 8734 %
8735 % Double-side printing via postscript on Laserjet 4050
8736 % prints double-sided nicely when \bindingoffset=10mm and \hoffset=-6mm.
8737 % To change the settings for a different printer or situation, adjust
8738 % \normaloffset until the front-side and back-side texts align. Then
8739 % do the same for \bindingoffset. You can set these for testing in
8740 % your texinfo source file like this:
8741 % @tex
8742 % \global\normaloffset = -6mm
8743 % \global\bindingoffset = 10mm
8744 % @end tex
8745 \internalpagesizes{673.2pt}{160mm}% that's 51 lines
8746 {\voffset}{\hoffset}%
8747 {\bindingoffset}{44pt}%
8748 {297mm}{210mm}%
5778 % 8749 %
5779 \tolerance = 700 8750 \tolerance = 700
5780 \hfuzz = 1pt 8751 \hfuzz = 1pt
8752 \contentsrightmargin = 0pt
8753 \defbodyindent = 5mm
5781 }} 8754 }}
5782 8755
5783 % A specific text layout, 24x15cm overall, intended for A4 paper. Top margin 8756 % Use @afivepaper to print on European A5 paper.
5784 % 29mm, hence bottom margin 28mm, nominal side margin 3cm. 8757 % From romildo@urano.iceb.ufop.br, 2 July 2000.
8758 % He also recommends making @example and @lisp be small.
8759 \def\afivepaper{{\globaldefs = 1
8760 \parskip = 2pt plus 1pt minus 0.1pt
8761 \textleading = 12.5pt
8762 %
8763 \internalpagesizes{160mm}{120mm}%
8764 {\voffset}{\hoffset}%
8765 {\bindingoffset}{8pt}%
8766 {210mm}{148mm}%
8767 %
8768 \lispnarrowing = 0.2in
8769 \tolerance = 800
8770 \hfuzz = 1.2pt
8771 \contentsrightmargin = 0pt
8772 \defbodyindent = 2mm
8773 \tableindent = 12mm
8774 }}
8775
8776 % A specific text layout, 24x15cm overall, intended for A4 paper.
5785 \def\afourlatex{{\globaldefs = 1 8777 \def\afourlatex{{\globaldefs = 1
5786 \setleading{13.6pt}%
5787 %
5788 \afourpaper 8778 \afourpaper
5789 \internalpagesizes{237mm}{150mm}{3.6mm}{3.6mm}{3mm}{7mm}% 8779 \internalpagesizes{237mm}{150mm}%
5790 % 8780 {\voffset}{4.6mm}%
8781 {\bindingoffset}{7mm}%
8782 {297mm}{210mm}%
8783 %
8784 % Must explicitly reset to 0 because we call \afourpaper.
5791 \globaldefs = 0 8785 \globaldefs = 0
5792 }} 8786 }}
5793 8787
5794 % Use @afourwide to print on European A4 paper in wide format. 8788 % Use @afourwide to print on A4 paper in landscape format.
5795 \def\afourwide{% 8789 \def\afourwide{{\globaldefs = 1
5796 \afourpaper 8790 \afourpaper
5797 \internalpagesizes{9.5in}{6.5in}{\hoffset}{\normaloffset}{\bindingoffset}{7mm}% 8791 \internalpagesizes{241mm}{165mm}%
5798 % 8792 {\voffset}{-2.95mm}%
8793 {\bindingoffset}{7mm}%
8794 {297mm}{210mm}%
5799 \globaldefs = 0 8795 \globaldefs = 0
5800 } 8796 }}
5801 8797
5802 % @pagesizes TEXTHEIGHT[,TEXTWIDTH] 8798 % @pagesizes TEXTHEIGHT[,TEXTWIDTH]
5803 % Perhaps we should allow setting the margins, \topskip, \parskip, 8799 % Perhaps we should allow setting the margins, \topskip, \parskip,
5804 % and/or leading, also. Or perhaps we should compute them somehow. 8800 % and/or leading, also. Or perhaps we should compute them somehow.
5805 % 8801 %
5806 \def\pagesizes{\parsearg\pagesizesxxx} 8802 \parseargdef\pagesizes{\pagesizesyyy #1,,\finish}
5807 \def\pagesizesxxx#1{\pagesizesyyy #1,,\finish}
5808 \def\pagesizesyyy#1,#2,#3\finish{{% 8803 \def\pagesizesyyy#1,#2,#3\finish{{%
5809 \setbox0 = \hbox{\ignorespaces #2}\ifdim\wd0 > 0pt \hsize=#2\relax \fi 8804 \setbox0 = \hbox{\ignorespaces #2}\ifdim\wd0 > 0pt \hsize=#2\relax \fi
5810 \globaldefs = 1 8805 \globaldefs = 1
5811 % 8806 %
5812 \parskip = 3pt plus 2pt minus 1pt 8807 \parskip = 3pt plus 2pt minus 1pt
5813 \setleading{13.2pt}% 8808 \setleading{\textleading}%
5814 % 8809 %
5815 \internalpagesizes{#1}{\hsize}{\voffset}{\normaloffset}{\bindingoffset}{44pt}% 8810 \dimen0 = #1\relax
8811 \advance\dimen0 by \voffset
8812 %
8813 \dimen2 = \hsize
8814 \advance\dimen2 by \normaloffset
8815 %
8816 \internalpagesizes{#1}{\hsize}%
8817 {\voffset}{\normaloffset}%
8818 {\bindingoffset}{44pt}%
8819 {\dimen0}{\dimen2}%
5816 }} 8820 }}
5817 8821
5818 % Set default to letter. 8822 % Set default to letter.
5819 % 8823 %
5820 \letterpaper 8824 \letterpaper
5838 \def\normalunderscore{_} 8842 \def\normalunderscore{_}
5839 \def\normalverticalbar{|} 8843 \def\normalverticalbar{|}
5840 \def\normalless{<} 8844 \def\normalless{<}
5841 \def\normalgreater{>} 8845 \def\normalgreater{>}
5842 \def\normalplus{+} 8846 \def\normalplus{+}
5843 \def\normaldollar{$} 8847 \def\normaldollar{$}%$ font-lock fix
5844 8848
5845 % This macro is used to make a character print one way in ttfont 8849 % This macro is used to make a character print one way in \tt
5846 % where it can probably just be output, and another way in other fonts, 8850 % (where it can probably be output as-is), and another way in other fonts,
5847 % where something hairier probably needs to be done. 8851 % where something hairier probably needs to be done.
5848 % 8852 %
5849 % #1 is what to print if we are indeed using \tt; #2 is what to print 8853 % #1 is what to print if we are indeed using \tt; #2 is what to print
5850 % otherwise. Since all the Computer Modern typewriter fonts have zero 8854 % otherwise. Since all the Computer Modern typewriter fonts have zero
5851 % interword stretch (and shrink), and it is reasonable to expect all 8855 % interword stretch (and shrink), and it is reasonable to expect all
5873 \catcode`\^=\active 8877 \catcode`\^=\active
5874 \def^{{\tt \hat}} 8878 \def^{{\tt \hat}}
5875 8879
5876 \catcode`\_=\active 8880 \catcode`\_=\active
5877 \def_{\ifusingtt\normalunderscore\_} 8881 \def_{\ifusingtt\normalunderscore\_}
8882 \let\realunder=_
5878 % Subroutine for the previous macro. 8883 % Subroutine for the previous macro.
5879 \def\_{\leavevmode \kern.06em \vbox{\hrule width.3em height.1ex}} 8884 \def\_{\leavevmode \kern.07em \vbox{\hrule width.3em height.1ex}\kern .07em }
5880 8885
5881 \catcode`\|=\active 8886 \catcode`\|=\active
5882 \def|{{\tt\char124}} 8887 \def|{{\tt\char124}}
5883 \chardef \less=`\< 8888 \chardef \less=`\<
5884 \catcode`\<=\active 8889 \catcode`\<=\active
5887 \catcode`\>=\active 8892 \catcode`\>=\active
5888 \def>{{\tt \gtr}} 8893 \def>{{\tt \gtr}}
5889 \catcode`\+=\active 8894 \catcode`\+=\active
5890 \def+{{\tt \char 43}} 8895 \def+{{\tt \char 43}}
5891 \catcode`\$=\active 8896 \catcode`\$=\active
5892 \def${\ifusingit{{\sl\$}}\normaldollar} 8897 \def${\ifusingit{{\sl\$}}\normaldollar}%$ font-lock fix
5893 %\catcode 27=\active
5894 %\def^^[{$\diamondsuit$}
5895
5896 % Set up an active definition for =, but don't enable it most of the time.
5897 {\catcode`\==\active
5898 \global\def={{\tt \char 61}}}
5899
5900 \catcode`+=\active
5901 \catcode`\_=\active
5902 8898
5903 % If a .fmt file is being used, characters that might appear in a file 8899 % If a .fmt file is being used, characters that might appear in a file
5904 % name cannot be active until we have parsed the command line. 8900 % name cannot be active until we have parsed the command line.
5905 % So turn them off again, and have \everyjob (or @setfilename) turn them on. 8901 % So turn them off again, and have \everyjob (or @setfilename) turn them on.
5906 % \otherifyactive is called near the end of this file. 8902 % \otherifyactive is called near the end of this file.
5907 \def\otherifyactive{\catcode`+=\other \catcode`\_=\other} 8903 \def\otherifyactive{\catcode`+=\other \catcode`\_=\other}
5908 8904
8905 % Used sometimes to turn off (effectively) the active characters even after
8906 % parsing them.
8907 \def\turnoffactive{%
8908 \normalturnoffactive
8909 \otherbackslash
8910 }
8911
5909 \catcode`\@=0 8912 \catcode`\@=0
5910 8913
5911 % \rawbackslashxx output one backslash character in current font 8914 % \backslashcurfont outputs one backslash character in current font,
5912 \global\chardef\rawbackslashxx=`\\ 8915 % as in \char`\\.
5913 %{\catcode`\\=\other 8916 \global\chardef\backslashcurfont=`\\
5914 %@gdef@rawbackslashxx{\}} 8917 \global\let\rawbackslashxx=\backslashcurfont % let existing .??s files work
5915 8918
5916 % \rawbackslash redefines \ as input to do \rawbackslashxx. 8919 % \realbackslash is an actual character `\' with catcode other, and
5917 {\catcode`\\=\active 8920 % \doublebackslash is two of them (for the pdf outlines).
5918 @gdef@rawbackslash{@let\=@rawbackslashxx }} 8921 {\catcode`\\=\other @gdef@realbackslash{\} @gdef@doublebackslash{\\}}
5919 8922
5920 % \normalbackslash outputs one backslash in fixed width font. 8923 % In texinfo, backslash is an active character; it prints the backslash
5921 \def\normalbackslash{{\tt\rawbackslashxx}} 8924 % in fixed width font.
5922
5923 % \catcode 17=0 % Define control-q
5924 \catcode`\\=\active 8925 \catcode`\\=\active
5925 8926 @def@normalbackslash{{@tt@backslashcurfont}}
5926 % Used sometimes to turn off (effectively) the active characters 8927 % On startup, @fixbackslash assigns:
5927 % even after parsing them. 8928 % @let \ = @normalbackslash
5928 @def@turnoffactive{@let"=@normaldoublequote 8929
5929 @let\=@realbackslash 8930 % \rawbackslash defines an active \ to do \backslashcurfont.
5930 @let~=@normaltilde 8931 % \otherbackslash defines an active \ to be a literal `\' character with
5931 @let^=@normalcaret 8932 % catcode other.
5932 @let_=@normalunderscore 8933 @gdef@rawbackslash{@let\=@backslashcurfont}
5933 @let|=@normalverticalbar 8934 @gdef@otherbackslash{@let\=@realbackslash}
5934 @let<=@normalless 8935
5935 @let>=@normalgreater 8936 % Same as @turnoffactive except outputs \ as {\tt\char`\\} instead of
5936 @let+=@normalplus 8937 % the literal character `\'.
5937 @let$=@normaldollar} 8938 %
5938 8939 @def@normalturnoffactive{%
5939 @def@normalturnoffactive{@let"=@normaldoublequote 8940 @let\=@normalbackslash
5940 @let\=@normalbackslash 8941 @let"=@normaldoublequote
5941 @let~=@normaltilde 8942 @let~=@normaltilde
5942 @let^=@normalcaret 8943 @let^=@normalcaret
5943 @let_=@normalunderscore 8944 @let_=@normalunderscore
5944 @let|=@normalverticalbar 8945 @let|=@normalverticalbar
5945 @let<=@normalless 8946 @let<=@normalless
5946 @let>=@normalgreater 8947 @let>=@normalgreater
5947 @let+=@normalplus 8948 @let+=@normalplus
5948 @let$=@normaldollar} 8949 @let$=@normaldollar %$ font-lock fix
8950 @unsepspaces
8951 }
5949 8952
5950 % Make _ and + \other characters, temporarily. 8953 % Make _ and + \other characters, temporarily.
5951 % This is canceled by @fixbackslash. 8954 % This is canceled by @fixbackslash.
5952 @otherifyactive 8955 @otherifyactive
5953 8956
5957 % 8960 %
5958 @gdef@eatinput input texinfo{@fixbackslash} 8961 @gdef@eatinput input texinfo{@fixbackslash}
5959 @global@let\ = @eatinput 8962 @global@let\ = @eatinput
5960 8963
5961 % On the other hand, perhaps the file did not have a `\input texinfo'. Then 8964 % On the other hand, perhaps the file did not have a `\input texinfo'. Then
5962 % the first `\{ in the file would cause an error. This macro tries to fix 8965 % the first `\' in the file would cause an error. This macro tries to fix
5963 % that, assuming it is called before the first `\' could plausibly occur. 8966 % that, assuming it is called before the first `\' could plausibly occur.
5964 % Also back turn on active characters that might appear in the input 8967 % Also turn back on active characters that might appear in the input
5965 % file name, in case not using a pre-dumped format. 8968 % file name, in case not using a pre-dumped format.
5966 % 8969 %
5967 @gdef@fixbackslash{% 8970 @gdef@fixbackslash{%
5968 @ifx\@eatinput @let\ = @normalbackslash @fi 8971 @ifx\@eatinput @let\ = @normalbackslash @fi
5969 @catcode`+=@active 8972 @catcode`+=@active
5971 } 8974 }
5972 8975
5973 % Say @foo, not \foo, in error messages. 8976 % Say @foo, not \foo, in error messages.
5974 @escapechar = `@@ 8977 @escapechar = `@@
5975 8978
5976 % These look ok in all fonts, so just make them not special. 8979 % These look ok in all fonts, so just make them not special.
5977 @catcode`@& = @other 8980 @catcode`@& = @other
5978 @catcode`@# = @other 8981 @catcode`@# = @other
5979 @catcode`@% = @other 8982 @catcode`@% = @other
5980
5981 @c Set initial fonts.
5982 @textfonts
5983 @rm
5984 8983
5985 8984
5986 @c Local variables: 8985 @c Local variables:
5987 @c eval: (add-hook 'write-file-hooks 'time-stamp) 8986 @c eval: (add-hook 'write-file-hooks 'time-stamp)
5988 @c page-delimiter: "^\\\\message" 8987 @c page-delimiter: "^\\\\message"
5989 @c time-stamp-start: "def\\\\texinfoversion{" 8988 @c time-stamp-start: "def\\\\texinfoversion{"
5990 @c time-stamp-format: "%:y-%02m-%02d.%02H" 8989 @c time-stamp-format: "%:y-%02m-%02d.%02H"
5991 @c time-stamp-end: "}" 8990 @c time-stamp-end: "}"
5992 @c End: 8991 @c End:
8992
8993 @c vim:sw=2:
8994
8995 @ignore
8996 arch-tag: e1b36e32-c96e-4135-a41a-0b2efa2ea115
8997 @end ignore