| blob | 951ac11fcfa79783f7ffa36810cb81c1ce341e23 |
1 % texinfo.tex -- TeX macros to handle Texinfo files.
2 %
3 % Load plain if necessary, i.e., if running under initex.
5 %
7 %
8 % Copyright 1985, 1986, 1988, 1990-2021 Free Software Foundation, Inc.
9 %
10 % This texinfo.tex file is free software: you can redistribute it and/or
11 % modify it under the terms of the GNU General Public License as
12 % published by the Free Software Foundation, either version 3 of the
13 % License, or (at your option) any later version.
14 %
15 % This texinfo.tex file is distributed in the hope that it will be
16 % useful, but WITHOUT ANY WARRANTY; without even the implied warranty
17 % of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
18 % General Public License for more details.
19 %
20 % You should have received a copy of the GNU General Public License
21 % along with this program. If not, see <https://www.gnu.org/licenses/>.
22 %
23 % As a special exception, when this file is read by TeX when processing
24 % a Texinfo source document, you may use the result without
25 % restriction. This Exception is an additional permission under section 7
26 % of the GNU General Public License, version 3 ("GPLv3").
27 %
28 % Please try the latest version of texinfo.tex before submitting bug
29 % reports; you can get the latest version from:
30 % https://ftp.gnu.org/gnu/texinfo/ (the Texinfo release area), or
31 % https://ftpmirror.gnu.org/texinfo/ (same, via a mirror), or
32 % https://www.gnu.org/software/texinfo/ (the Texinfo home page)
33 % The texinfo.tex in any given distribution could well be out
34 % of date, so if that's what you're using, please check.
35 %
36 % Send bug reports to bug-texinfo@gnu.org. Please include a
37 % complete document in each bug report with which we can reproduce the
38 % problem. Patches are, of course, greatly appreciated.
39 %
40 % To process a Texinfo manual with TeX, it's most reliable to use the
41 % texi2dvi shell script that comes with the distribution. For a simple
42 % manual foo.texi, however, you can get away with this:
43 % tex foo.texi
44 % texindex foo.??
45 % tex foo.texi
46 % tex foo.texi
47 % dvips foo.dvi -o # or whatever; this makes foo.ps.
48 % The extra TeX runs get the cross-reference information correct.
49 % Sometimes one run after texindex suffices, and sometimes you need more
50 % than two; texi2dvi does it as many times as necessary.
51 %
52 % It is possible to adapt texinfo.tex for other languages, to some
53 % extent. You can get the existing language-specific files from the
54 % full Texinfo distribution.
55 %
56 % The GNU Texinfo home page is https://www.gnu.org/software/texinfo.
61 % If in a .fmt file, print the version number
62 % and turn on active characters that we couldn't do earlier because
63 % they might have appeared in the input file name.
67 % LaTeX's \typeout. This ensures that the messages it is used for
68 % are identical in format to the corresponding ones from latex/pdflatex.
73 % We never want plain's \outer definition of \+ in Texinfo.
74 % For @tex, we can use \tabalign.
77 % Save some plain tex macros whose names we will redefine.
81 \let\ptexcomma=\,
82 \let\ptexdot=\.
86 \let\ptexexclam=\!
88 \let\ptexgtr=>
89 \let\ptexhat=^
94 \let\ptexless=<
95 \let\ptexnewwrite\newwrite
97 \let\ptexplus=+
100 \let\ptexslash=\/
102 \let\ptexstar=\*
108 % If this character appears in an error message or help string, it
109 % starts a new line in the output.
110 \newlinechar = `^^J
112 % Use TeX 3.0's \inputlineno to get the line number, for better error
113 % messages, but if we're using an old version of TeX, don't do anything.
114 %
115 \ifx\inputlineno\thisisundefined
117 \else
119 \fi
121 % Set up fixed words for English if not already set.
130 \ifx\putwordInstanceVariableof\undefined \gdef\putwordInstanceVariableof{Instance Variable of}\fi
142 %
155 %
162 % Give the space character the catcode for a space.
165 % Likewise for ^^M, the end of line character.
168 \chardef\dashChar = `\-
169 \chardef\slashChar = `\/
172 % Ignore a token.
173 %
176 % The following is used inside several \edef's.
179 % Hyphenation fixes.
181 Flor-i-da Ghost-script Ghost-view Mac-OS Post-Script
182 ap-pen-dix bit-map bit-maps
183 data-base data-bases eshell fall-ing half-way long-est man-u-script
184 man-u-scripts mini-buf-fer mini-buf-fers over-view par-a-digm
185 par-a-digms rath-er rec-tan-gu-lar ro-bot-ics se-vere-ly set-up spa-ces
186 spell-ing spell-ings
187 stand-alone strong-est time-stamp time-stamps which-ever white-space
188 wide-spread wrap-around
189 }
191 % Sometimes it is convenient to have everything in the transcript file
192 % and nothing on the terminal. We don't just call \tracingall here,
193 % since that produces some useless output on the terminal. We also make
194 % some effort to order the tracing commands to reduce output in the log
195 % file; cf. trace.sty in LaTeX.
196 %
199 \tracingstats2
200 \tracingpages1
202 \tracingparagraphs1
203 \tracingoutput1
204 \tracingmacros2
205 \tracingrestores1
206 \showboxbreadth\maxdimen \showboxdepth\maxdimen
208 \tracingscantokens1
209 \tracingifs1
210 \tracinggroups1
211 \tracingnesting2
212 \tracingassigns1
213 \fi
215 \errorcontextlines16
218 % @errormsg{MSG}. Do the index-like expansions on MSG, but if things
219 % aren't perfect, it's not the end of the world, being an error message,
220 % after all.
221 %
225 % add check for \lastpenalty to plain's definitions. If the last thing
226 % we did was a \nobreak, we don't want to insert more space.
227 %
235 %\f Output routine
236 %
238 % For a final copy, take out the rectangles
239 % that mark overfull boxes (in case you have decided
240 % that the text looks ok even though it passes the margin).
241 %
247 % Output a mark which sets \thischapter, \thissection and \thiscolor.
248 % We dump everything together because we only have one kind of mark.
249 % This works because we only use \botmark / \topmark, not \firstmark.
250 %
251 % A mark contains a subexpression of the \ifcase ... \fi construct.
252 % \get*marks macros below extract the needed part using \ifcase.
253 %
254 % Another complication is to let the user choose whether \thischapter
255 % (\thissection) refers to the chapter (section) in effect at the top
256 % of a page, or that at the bottom of a page.
258 % \domark is called twice inside \chapmacro, to add one
259 % mark before the section break, and one after.
260 % In the second call \prevchapterdefs is the same as \currentchapterdefs,
261 % and \prevsectiondefs is the same as \currentsectiondefs.
262 % Then if the page is not broken at the mark, some of the previous
263 % section appears on the page, and we can get the name of this section
264 % from \firstmark for @everyheadingmarks top.
265 % @everyheadingmarks bottom uses \botmark.
266 %
267 % See page 260 of The TeXbook.
279 }
281 % \gettopheadingmarks, \getbottomheadingmarks,
282 % \getcolormarks - extract needed part of mark.
283 %
284 % \topmark doesn't work for the very first chapter (after the title
285 % page or the contents), so we use \firstmark there -- this gets us
286 % the mark with the chapter defs, unless the user sneaks in, e.g.,
287 % @setcolor (or @url, or @link, etc.) between @contents and the very
288 % first @chapter.
290 \ifcase0\the\savedtopmark\fi
291 \ifx\thischapter\empty \ifcase0\firstmark\fi \fi
292 }
296 % Avoid "undefined control sequence" errors.
304 % Margin to add to right of even pages, to left of odd pages.
305 \newdimen\bindingoffset
306 \newdimen\normaloffset
307 \newdimen\txipagewidth \newdimen\txipageheight
309 % Main output routine.
310 %
312 \newtoks\defaultoutput
316 \newbox\headlinebox
317 \newbox\footlinebox
319 % When outputting the double column layout for indices, an output routine
320 % is run several times, which hides the original value of \topmark. This
321 % can lead to a page heading being output and duplicating the chapter heading
322 % of the index. Hence, save the contents of \topmark at the beginning of
323 % the output routine. The saved contents are valid until we actually
324 % \shipout a page.
325 %
326 % (We used to run a short output routine to actually set \topmark and
327 % \firstmark to the right values, but if this was called with an empty page
328 % containing whatsits for writing index entries, the whatsits would be thrown
329 % away and the index auxiliary file would remain empty.)
330 %
331 \newtoks\savedtopmark
332 \newif\iftopmarksaved
333 \topmarksavedtrue
335 \iftopmarksaved\else
337 \global\topmarksavedtrue
338 \fi
339 }
341 % \onepageout takes a vbox as an argument.
342 % \shipout a vbox for a single page, adding an optional header, footer
343 % and footnote. This also causes index entries for this page to be written
344 % to the auxiliary files.
345 %
348 %
351 %
352 \checkchapterpage
353 %
354 % Retrieve the information for the headings from the marks in the page,
355 % and call Plain TeX's \makeheadline and \makefootline, which use the
356 % values in \headline and \footline.
357 %
358 % Common context changes for both heading and footing.
359 % Do this outside of the \shipout so @code etc. will be expanded in
360 % the headline as they should be, not taken literally (outputting ''code).
362 %
363 \ifodd\pageno \getoddheadingmarks \else \getevenheadingmarks \fi
365 \ifodd\pageno \getoddfootingmarks \else \getevenfootingmarks \fi
367 %
369 % Set context for writing to auxiliary files like index files.
370 % Have to do this stuff outside the \shipout because we want it to
371 % take effect in \write's, yet the group defined by the \vbox ends
372 % before the \shipout runs.
373 %
375 \turnoffactive
377 % Do this early so pdf references go to the beginning of the page.
379 %
380 \unvbox\headlinebox
383 % Only leave this space if the footline is nonempty.
384 % (We lessened \vsize for it in \oddfootingyyy.)
385 % The \baselineskip=24pt in plain's \makefootline has no effect.
387 \unvbox\footlinebox
388 \fi
389 %
392 \global\topmarksavedfalse
393 \advancepageno
395 }
399 % Main part of page, including any footnotes
403 % marginal hacks, juha@viisa.uucp (Juha Takala)
407 \ifvoid\footins\else\vskip\skip\footins\footnoterule \unvbox\footins\fi
409 }
411 % Check if we are on the first page of a chapter. Used for printing headings.
412 \newif\ifchapterpage
414 % Get the chapter that was current at the end of the last page
415 \ifcase1\the\savedtopmark\fi
416 \let\prevchaptername\thischaptername
417 %
418 \ifodd\pageno \getoddheadingmarks \else \getevenheadingmarks \fi
419 \let\curchaptername\thischaptername
420 %
421 \ifx\curchaptername\prevchaptername
422 \chapterpagefalse
423 \else
424 \chapterpagetrue
425 \fi
426 }
428 % Argument parsing
430 % Parse an argument, then pass it to #1. The argument is the rest of
431 % the input line (except we remove a trailing comment). #1 should be a
432 % macro which expects an ordinary undelimited TeX argument.
433 % For example, \def\foo{\parsearg\fooxxx}.
434 %
438 \begingroup
439 \obeylines
440 \spaceisspace
443 }
450 }
452 % First remove any @comment, then any @c comment. Pass the result on to
453 % \argcheckspaces.
457 % Each occurrence of `\^^M' or `<space>\^^M' is replaced by a single space.
458 %
459 % \argremovec might leave us with trailing space, e.g.,
460 % @end itemize @c foo
461 % This space token undergoes the same procedure and is eventually removed
462 % by \finishparsearg.
463 %
468 \ifx\temp\empty
469 % Do not use \next, perhaps the caller of \parsearg uses it; reuse \temp:
470 \let\temp\finishparsearg
471 \else
472 \let\temp\argcheckspaces
473 \fi
474 % Put the space token in:
476 }
478 % If a _delimited_ argument is enclosed in braces, they get stripped; so
479 % to get _exactly_ the rest of the line, we had to prevent such situation.
480 % We prepended an \empty token at the very beginning and we expand it now,
481 % just before passing the control to \argtorun.
482 % (Similarly, we have to think about #3 of \argcheckspacesY above: it is
483 % either the null string, or it ends with \^^M---thus there is no danger
484 % that a pair of braces would be stripped.
485 %
486 % But first, we have to remove the trailing space token.
487 %
491 % \parseargdef - define a command taking an argument on the line
492 %
493 % \parseargdef\foo{...}
494 % is roughly equivalent to
495 % \def\foo{\parsearg\Xfoo}
496 % \def\Xfoo#1{...}
499 }
503 }
505 % Several utility definitions with active space:
506 {
507 \obeyspaces
510 % Make each space character in the input produce a normal interword
511 % space in the output. Don't allow a line break at this space, as this
512 % is used only in environments like @example, where each line of input
513 % should produce a line of output anyway.
514 %
517 % If an index command is used in an @example environment, any spaces
518 % therein should become regular spaces in the raw index file, not the
519 % expansion of \tie (\leavevmode \penalty \@M \ ).
521 }
526 % Define the framework for environments in texinfo.tex. It's used like this:
527 %
528 % \envdef\foo{...}
529 % \def\Efoo{...}
530 %
531 % It's the responsibility of \envdef to insert \begingroup before the
532 % actual body; @end closes the group after calling \Efoo. \envdef also
533 % defines \thisenv, so the current environment is known; @end checks
534 % whether the environment name matches. The \checkenv macro can also be
535 % used to check whether the current environment is the one expected.
536 %
537 % Non-false conditionals (@iftex, @ifset) don't fit into this, so they
538 % are not treated as environments; they don't open a group. (The
539 % implementation of @end takes care not to call \endgroup in this
540 % special case.)
543 % At run-time, environments start with this:
545 % initialize
546 \let\thisenv\empty
548 % ... but they get defined via ``\envdef\foo{...}'':
552 % Check whether we're in the right environment:
555 \ifx\thisenv\temp
556 \else
557 \badenverr
558 \fi
559 }
561 % Environment mismatch, #1 expected:
566 }
569 outside of any environment%
570 \else
572 \fi
573 }
576 % @end foo calls \checkenv and executes the definition of \Efoo.
579 \else
580 % The general wording of \badenverr may not be ideal.
583 \endgroup
584 \fi
585 }
590 % Be sure we're in horizontal mode when doing a tie, since we make space
591 % equivalent to this in @example-like environments. Otherwise, a space
592 % at the beginning of a line will start with \penalty -- and
593 % since \penalty is valid in vertical mode, we'd end up putting the
594 % penalty on the vertical list instead of in the new paragraph.
596 % Avoid using \@M directly, because that causes trouble
597 % if the definition is written into an index file.
598 \global\let\tiepenalty = \@M
600 }
602 % @: forces normal size whitespace following.
605 % @* forces a line break.
608 % @/ allows a line break.
611 % @. is an end-of-sentence period.
614 % @! is an end-of-sentence bang.
617 % @? is an end-of-sentence query.
620 % @frenchspacing on|off says whether to put extra space after punctuation.
621 %
624 %
627 \ifx\temp\onword \plainfrenchspacing
628 \else\ifx\temp\offword \plainnonfrenchspacing
629 \else
632 \fi\fi
633 }
635 % @w prevents a word break. Without the \leavevmode, @w at the
636 % beginning of a paragraph, when TeX is still in vertical mode, would
637 % produce a whole line of output instead of starting the paragraph.
640 % @group ... @end group forces ... to be all on one page, by enclosing
641 % it in a TeX vbox. We use \vtop instead of \vbox to construct the box
642 % to keep its height that of a normal line. According to the rules for
643 % \topskip (p.114 of the TeXbook), the glue inserted is
644 % max (\topskip - \ht (first item), 0). If that height is large,
645 % therefore, no glue is inserted, and the space between the headline and
646 % the text is small, which looks bad.
647 %
648 % Another complication is that the group might be very large. This can
649 % cause the glue on the previous page to be unduly stretched, because it
650 % does not have much material. In this case, it's better to add an
651 % explicit \vfill so that the extra space is at the bottom. The
652 % threshold for doing this is if the group is more than \vfilllimit
653 % percent of a page (\vfilllimit can be changed inside of @tex).
654 %
655 \newbox\groupbox
657 %
662 \fi
663 \startsavinginserts
664 %
666 % Do @comment since we are called inside an environment such as
667 % @example, where each end-of-line in the input causes an
668 % end-of-line in the output. We don't want the end-of-line after
669 % the `@group' to put extra space in the output. Since @group
670 % should appear on a line by itself (according to the Texinfo
671 % manual), we don't worry about eating any user text.
672 \comment
673 }
674 %
675 % The \vtop produces a box with normal height and large depth; thus, TeX puts
676 % \baselineskip glue before it, and (when the next line of text is done)
677 % \lineskip glue after it. Thus, space below is not quite equal to space
678 % above. But it's pretty close.
680 % To get correct interline space between the last line of the group
681 % and the first line afterwards, we have to propagate \prevdepth.
685 \addgroupbox
687 \checkinserts
688 }
691 % \dimen0 is the vertical size of the group's box.
693 % \dimen2 is how much space is left on the page (more or less).
695 % if the group doesn't fit on the current page, and it's a big big
696 % group, force a page break.
699 \page
700 \fi
701 \fi
702 \box\groupbox
703 }
705 %
706 % TeX puts in an \escapechar (i.e., `@') at the beginning of the help
707 % message, so this ends up printing `@group can only ...'.
708 %
710 group can only be used in environments such as @example,^^J%
711 where each line of input produces a line of output.}
713 % @need space-in-mils
714 % forces a page break if there is not space-in-mils remaining.
719 % Ensure vertical mode, so we don't make a big box in the middle of a
720 % paragraph.
721 \par
722 %
723 % If the @need value is less than one line space, it's useless.
728 %
729 % Do a \strut just to make the height of this box be normal, so the
730 % normal leading is inserted relative to the preceding line.
731 % And a page break here is fine.
733 %
734 % TeX does not even consider page breaks if a penalty added to the
735 % main vertical list is 10000 or more. But in order to see if the
736 % empty box we just added fits on the page, we must make it consider
737 % page breaks. On the other hand, we don't want to actually break the
738 % page after the empty box. So we use a penalty of 9999.
739 %
740 % There is an extremely small chance that TeX will actually break the
741 % page at this \penalty, if there are no other feasible breakpoints in
742 % sight. (If the user is using lots of big @group commands, which
743 % almost-but-not-quite fill up a page, TeX will have a hard time doing
744 % good page breaking, for example.) However, I could not construct an
745 % example where a page broke at this \penalty; if it happens in a real
746 % document, then we can reconsider our strategy.
747 \penalty9999
748 %
749 % Back up by the size of the box, whether we did a page break or not.
751 %
752 % Do not allow a page break right after this kern.
753 \nobreak
754 \fi
755 }
757 % @br forces paragraph break (and is undocumented).
761 % @page forces the start of a new page.
762 %
765 % @exdent text....
766 % outputs text on separate line in roman font, starting at standard page margin
768 % This records the amount of indent in the innermost environment.
769 % That's how much \exdent should take out.
770 \newskip\exdentamount
772 % This defn is used inside fill environments such as @defun.
775 % This defn is used inside nofill environments such as @example.
779 % @inmargin{WHICH}{TEXT} puts TEXT in the WHICH margin next to the current
780 % paragraph. For more general purposes, use the \margin insertion
781 % class. WHICH is `l' or `r'. Not documented, written for gawk manual.
782 %
785 %
787 \nobreak
791 \vss
792 % if you have multiple lines of stuff to put here, you'll need to
793 % make the vbox yourself of the appropriate size.
796 \else
798 \fi
799 \null
801 }}
804 %
805 % @inmargin{TEXT [, RIGHT-TEXT]}
806 % (if RIGHT-TEXT is given, use TEXT for left page, RIGHT-TEXT for right;
807 % else use TEXT for both).
808 %
815 \else
818 \fi
819 %
820 \ifodd\pageno
822 \else
824 \fi
825 \temp
826 }
828 % @include FILE -- \input text of FILE.
829 %
832 \pushthisfilestack
840 %
841 % This trickery is to read FILE outside of a group, in case it makes
842 % definitions, etc.
843 \expandafter
845 \popthisfilestack
846 }
859 }
862 \expandafter\pushthisfilestackX\popthisfilestack\StackTerm
863 }
865 \expandafter\pushthisfilestackY\thisfile\StackTerm
866 }
869 }
873 the stack of filenames is empty.}}
874 %
877 % @center line
878 % outputs that line, centered.
879 %
881 \ifhmode
882 \let\centersub\centerH
883 \else
884 \let\centersub\centerV
885 \fi
888 }
890 \hfil\break
894 \break
895 }}
896 %
897 \newcount\centerpenalty
899 % The idea here is the same as in \startdefun, \cartouche, etc.: if
900 % @center is the first thing after a section heading, we need to wipe
901 % out the negative parskip inserted by \sectionheading, but still
902 % prevent a page break here.
907 }
909 % @sp n outputs n lines of vertical space
910 %
913 % @comment ...line which is ignored...
914 % @c is the same as @comment
915 % @ignore ... @end ignore is another way to write a comment
922 %
923 \let\comment\c
925 % @paragraphindent NCHARS
926 % We'll use ems for NCHARS, close enough.
927 % NCHARS can also be the word `asis' or `none'.
928 % We cannot feasibly implement @paragraphindent asis, though.
929 %
932 %
935 \ifx\temp\asisword
936 \else
937 \ifx\temp\noneword
939 \else
941 \fi
942 \fi
944 }
946 % @exampleindent NCHARS
947 % We'll use ems for NCHARS like @paragraphindent.
948 % It seems @exampleindent asis isn't necessary, but
949 % I preserve it to make it similar to @paragraphindent.
952 \ifx\temp\asisword
953 \else
954 \ifx\temp\noneword
956 \else
958 \fi
959 \fi
960 }
962 % @firstparagraphindent WORD
963 % If WORD is `none', then suppress indentation of the first paragraph
964 % after a section heading. If WORD is `insert', then do indent at such
965 % paragraphs.
966 %
967 % The paragraph indentation is suppressed or not by calling
968 % \suppressfirstparagraphindent, which the sectioning commands do.
969 % We switch the definition of this back and forth according to WORD.
970 % By default, we suppress indentation.
971 %
974 %
977 \ifx\temp\noneword
979 \else\ifx\temp\insertword
981 \else
984 \fi\fi
985 }
987 % Here is how we actually suppress indentation. Redefine \everypar to
988 % \kern backwards by \parindent, and then reset itself to empty.
989 %
990 % We also make \indent itself not actually do anything until the next
991 % paragraph.
992 %
997 }
998 %
1003 }
1005 % leave vertical mode without cancelling any first paragraph indent
1009 \ptexnoindent
1011 }
1014 % @refill is a no-op.
1017 % @setfilename INFO-FILENAME - ignored
1020 % @bye.
1025 % adobe `portable' document format
1026 \newcount\tempnum
1027 \newcount\lnkcount
1028 \newtoks\filename
1029 \newcount\filenamelength
1030 \newcount\pgn
1031 \newtoks\toksA
1032 \newtoks\toksB
1033 \newtoks\toksC
1034 \newtoks\toksD
1035 \newbox\boxA
1036 \newbox\boxB
1037 \newcount\countA
1038 \newif\ifpdf
1039 \newif\ifpdfmakepagedest
1041 %
1042 % For LuaTeX
1043 %
1045 \newif\iftxiuseunicodedestname
1048 \ifx\luatexversion\thisisundefined
1049 \else
1050 % Use Unicode destination names
1051 \txiuseunicodedestnametrue
1052 % Escape PDF strings with converting UTF-16 from UTF-8
1053 \begingroup
1064 else
1075 end
1076 end
1077 end
1078 }
1079 \endgroup
1081 % Escape PDF strings without converting
1082 \begingroup
1089 c))
1090 else
1092 end
1093 end
1094 end
1095 }
1096 % The -2 in the arguments here gives all the input to TeX catcode 12
1097 % (other) or 10 (space), preventing undefined control sequence errors. See
1098 % https://lists.gnu.org/archive/html/bug-texinfo/2019-08/msg00031.html
1099 %
1100 \endgroup
1103 % For LuaTeX >= 0.85
1105 \let\pdfoutput\outputmode
1109 \let\pdfximage\saveimageresource
1110 \let\pdfrefximage\useimageresource
1111 \let\pdflastximage\lastsavedimageresourceindex
1118 \let\pdfpagewidth\pagewidth
1119 \let\pdfpageheight\pageheight
1122 \fi
1123 \fi
1125 % when pdftex is run in dvi mode, \pdfoutput is defined (so \pdfoutput=1
1126 % can be set). So we test for \relax and 0 as well as being undefined.
1127 \ifx\pdfoutput\thisisundefined
1128 \else
1129 \ifx\pdfoutput\relax
1130 \else
1131 \ifcase\pdfoutput
1132 \else
1133 \pdftrue
1134 \fi
1135 \fi
1136 \fi
1138 \newif\ifpdforxetex
1139 \pdforxetexfalse
1140 \ifpdf
1141 \pdforxetextrue
1142 \fi
1143 \ifx\XeTeXrevision\thisisundefined\else
1144 \pdforxetextrue
1145 \fi
1148 % Output page labels information.
1149 % See PDF reference v.1.7 p.594, section 8.3.1.
1150 \ifpdf
1155 %
1156 % Page label ranges must be increasing. Remove any duplicates.
1157 % (There is a slight chance of this being wrong if e.g. there is
1158 % a @contents but no @titlepage, etc.)
1159 %
1162 \else
1164 \fi
1165 %
1168 \else
1170 \fi
1171 }
1172 \else
1173 \let\pagelabels\relax
1174 \fi
1179 \ifpdf
1180 \let\ptxadvancepageno\advancepageno
1183 }
1184 \fi
1187 % PDF uses PostScript string constants for the names of xref targets,
1188 % for display in the outlines, and in other places. Thus, we have to
1189 % double any backslashes. Otherwise, a name like "\node" will be
1190 % interpreted as a newline (\n), followed by o, d, e. Not good.
1191 %
1192 % See http://www.ntg.nl/pipermail/ntg-pdftex/2004-July/000654.html and
1193 % related messages. The final outcome is that it is up to the TeX user
1194 % to double the backslashes and otherwise make the string valid, so
1195 % that's what we do. pdftex 1.30.0 (ca.2005) introduced a primitive to
1196 % do this reliably, so we use it.
1198 % #1 is a control sequence in which to do the replacements,
1199 % which we \xdef.
1201 \ifx\pdfescapestring\thisisundefined
1202 % No primitive available; should we give a warning or log?
1203 % Many times it won't matter.
1205 \else
1206 % The expandable \pdfescapestring primitive escapes parentheses,
1207 % backslashes, and other special chars.
1209 \fi
1210 }
1212 \ifx\pdfescapestrutfsixteen\thisisundefined
1213 % No UTF-16 converting macro available.
1215 \else
1217 \fi
1218 }
1221 with PDF output, and none of those formats could be found. (.eps cannot
1222 be supported due to the design of the PDF format; use regular TeX (DVI
1223 output) for that.)}
1225 \ifpdf
1226 %
1227 % Color manipulation macros using ideas from pdfcolor.tex,
1228 % except using rgb instead of cmyk; the latter is said to render as a
1229 % very dark gray on-screen and a very dark halftone in print, instead
1230 % of actual black. The dark red here is dark enough to print on paper as
1231 % nearly black, but still distinguishable for online viewing. We use
1232 % black by default, though.
1235 %
1236 % rg sets the color for filling (usual text, etc.);
1237 % RG sets the color for stroking (thin rules, e.g., normal _'s).
1239 %
1240 % Set color, and create a mark which defines \thiscolor accordingly,
1241 % so that \makeheadline knows which color to restore.
1244 \domark
1246 }
1247 %
1252 %
1254 \baselineskip24pt
1256 }
1257 %
1263 % Extract \thiscolor definition from the marks.
1264 \getcolormarks
1265 % Typeset the headline with \maincolor, then restore the color.
1268 \vss
1270 \nointerlineskip
1271 }
1272 %
1273 %
1275 %
1276 % #1 is image name, #2 width (might be empty/whitespace), #3 height (ditto).
1280 %
1281 % pdftex (and the PDF format) support .pdf, .png, .jpg (among
1282 % others). Let's try in that order, PDF first since if
1283 % someone has a scalable image, presumably better to use that than a
1284 % bitmap.
1286 \begingroup
1296 \fi
1298 \fi
1300 \fi
1302 \fi
1304 \fi
1306 \fi
1308 \endgroup
1309 %
1310 % without \immediate, ancient pdftex seg faults when the same image is
1311 % included twice. (Version 3.14159-pre-1.0-unofficial-20010704.)
1313 \immediate\pdfimage
1314 \else
1315 \immediate\pdfximage
1316 \fi
1321 \else
1323 \fi
1325 \pdfrefximage \pdflastximage
1327 %
1329 % We have to set dummies so commands such as @code, and characters
1330 % such as \, aren't expanded when present in a section title.
1331 \indexnofonts
1332 \makevalueexpandable
1333 \turnoffactive
1334 \iftxiuseunicodedestname
1335 \ifx \declaredencoding \latone
1336 % Pass through Latin-1 characters.
1337 % LuaTeX with byte wise I/O converts Latin-1 characters to Unicode.
1338 \else
1339 \ifx \declaredencoding \utfeight
1340 % Pass through Unicode characters.
1341 \else
1342 % Use ASCII approximations in destination names.
1343 \passthroughcharsfalse
1344 \fi
1345 \fi
1346 \else
1347 % Use ASCII approximations in destination names.
1348 \passthroughcharsfalse
1349 \fi
1351 \txiescapepdf\pdfdestname
1352 }}
1353 %
1355 \indexnofonts
1356 \makevalueexpandable
1357 \turnoffactive
1358 \ifx \declaredencoding \latone
1359 % The PDF format can use an extended form of Latin-1 in bookmark
1360 % strings. See Appendix D of the PDF Reference, Sixth Edition, for
1361 % the "PDFDocEncoding".
1362 \passthroughcharstrue
1363 % Pass through Latin-1 characters.
1364 % LuaTeX: Convert to Unicode
1365 % pdfTeX: Use Latin-1 as PDFDocEncoding
1367 \else
1368 \ifx \declaredencoding \utfeight
1369 \ifx\luatexversion\thisisundefined
1370 % For pdfTeX with UTF-8.
1371 % TODO: the PDF format can use UTF-16 in bookmark strings,
1372 % but the code for this isn't done yet.
1373 % Use ASCII approximations.
1374 \passthroughcharsfalse
1376 \else
1377 % For LuaTeX with UTF-8.
1378 % Pass through Unicode characters for title texts.
1379 \passthroughcharstrue
1381 \fi
1382 \else
1383 % For non-Latin-1 or non-UTF-8 encodings.
1384 % Use ASCII approximations.
1385 \passthroughcharsfalse
1387 \fi
1388 \fi
1389 % LuaTeX: Convert to UTF-16
1390 % pdfTeX: Use Latin-1 as PDFDocEncoding
1391 \txiescapepdfutfsixteen\pdfoutlinetext
1392 }}
1393 %
1397 }
1398 %
1399 % used to mark target names; must be expandable.
1401 %
1402 % by default, use black for everything.
1406 %
1407 % Adding outlines to PDF; macros for calculating structure of outlines
1408 % come from Petr Olsak
1414 %
1415 % #1 is the section text, which is what will be displayed in the
1416 % outline by the pdf viewer. #2 is the pdf expression for the number
1417 % of subentries (or empty, for subsubsections). #3 is the node text,
1418 % which might be empty if this toc entry had no corresponding node.
1419 % #4 is the page number
1420 %
1422 % Generate a link to the node text if that exists; else, use the
1423 % page number. We could generate a destination for the section
1424 % text in the case where a section has no node, but it doesn't
1425 % seem worth the trouble, since most documents are normally structured.
1428 \ifx\pdfdestname\empty
1430 \fi
1431 %
1433 }
1434 %
1436 \begingroup
1437 % Read toc silently, to get counts of subentries for \pdfoutline.
1459 %
1460 % use \def rather than \let here because we redefine \chapentry et
1461 % al. a second time, below.
1471 %
1472 % Read toc second time, this time actually producing the outlines.
1473 % The `-' means take the \expnumber as the absolute number of
1474 % subentries, which we calculated on our first read of the .toc above.
1475 %
1476 % We use the node names as the destinations.
1477 %
1478 % Currently we prefix the section name with the section number
1479 % for chapter and appendix headings only in order to avoid too much
1480 % horizontal space being required in the PDF viewer.
1491 %
1492 % PDF outlines are displayed using system fonts, instead of
1493 % document fonts. Therefore we cannot use special characters,
1494 % since the encoding is unknown. For example, the eogonek from
1495 % Latin 2 (0xea) gets translated to a | character. Info from
1496 % Staszek Wawrykiewicz, 19 Jan 2004 04:09:24 +0100.
1497 %
1498 % TODO this right, we have to translate 8-bit characters to
1499 % their "best" equivalent, based on the @documentencoding. Too
1500 % much work for too little return. Just use the ASCII equivalents
1501 % we use for the index sort strings.
1502 %
1503 \indexnofonts
1504 \setupdatafile
1505 % We can have normal brace characters in the PDF outlines, unlike
1506 % Texinfo index files. So set that up.
1510 \input \tocreadfilename
1511 \endgroup
1512 }
1517 ]
1518 %
1520 \ifx\PP\D\let\nextsp\relax
1521 \else\let\nextsp\skipspaces
1524 \fi
1528 % If we don't expand the argument now, \skipspaces will get
1529 % snagged on things like "@value{foo}".
1532 }
1534 \let \startlink \pdfannotlink
1535 \else
1536 \let \startlink \pdfstartlink
1537 \fi
1538 % make a live url in pdf output.
1540 \begingroup
1541 % it seems we really need yet another set of dummies; have not
1542 % tried to figure out what each command should do in the context
1543 % of @url. for now, just make @/ a no-op, that's the only one
1544 % people have actually reported a problem with.
1545 %
1546 \normalturnoffactive
1549 \makevalueexpandable
1550 % do we want to go so far as to use \indexnofonts instead of just
1551 % special-casing \var here?
1553 %
1558 % \pdfgettoks - Surround page numbers in #1 with @pdflink. #1 may
1559 % be a simple number, or a list of numbers in the case of an index
1560 % entry.
1567 \ifx\first0\adn0
1568 \else\ifx\first1\adn1 \else\ifx\first2\adn2 \else\ifx\first3\adn3
1569 \else\ifx\first4\adn4 \else\ifx\first5\adn5 \else\ifx\first6\adn6
1570 \else\ifx\first7\adn7 \else\ifx\first8\adn8 \else\ifx\first9\adn9
1571 \else
1577 \fi
1578 \fi\fi\fi\fi\fi\fi\fi\fi\fi\fi
1586 \else
1587 % non-pdf mode
1596 %
1597 % For XeTeX
1598 %
1599 \ifx\XeTeXrevision\thisisundefined
1600 \else
1601 %
1602 % XeTeX version check
1603 %
1605 % TeX Live 2016 contains XeTeX 0.99996 and xdvipdfmx 20160307.
1606 % It can use the `dvipdfmx:config' special (from TeX Live SVN r40941).
1607 % For avoiding PDF destination name replacement, we use this special
1608 % instead of xdvipdfmx's command line option `-C 0x0010'.
1610 % XeTeX 0.99995+ comes with xdvipdfmx 20160307+.
1611 % It can handle Unicode destination names for PDF.
1612 \txiuseunicodedestnametrue
1613 \else
1614 % XeTeX < 0.99996 (TeX Live < 2016) cannot use the
1615 % `dvipdfmx:config' special.
1616 % So for avoiding PDF destination name replacement,
1617 % xdvipdfmx's command line option `-C 0x0010' is necessary.
1618 %
1619 % XeTeX < 0.99995 can not handle Unicode destination names for PDF
1620 % because xdvipdfmx 20150315 has a UTF-16 conversion issue.
1621 % It is fixed by xdvipdfmx 20160106 (TeX Live SVN r39753).
1622 \txiuseunicodedestnamefalse
1623 \fi
1624 %
1625 % Color support
1626 %
1629 %
1631 %
1632 % Set color, and create a mark which defines \thiscolor accordingly,
1633 % so that \makeheadline knows which color to restore.
1636 \domark
1638 }
1639 %
1644 %
1646 \baselineskip24pt
1648 }
1649 %
1655 % Extract \thiscolor definition from the marks.
1656 \getcolormarks
1657 % Typeset the headline with \maincolor, then restore the color.
1660 \vss
1662 \nointerlineskip
1663 }
1664 %
1665 % PDF outline support
1666 %
1667 % Emulate pdfTeX primitive
1670 }
1671 %
1673 % We have to set dummies so commands such as @code, and characters
1674 % such as \, aren't expanded when present in a section title.
1675 \indexnofonts
1676 \makevalueexpandable
1677 \turnoffactive
1678 \iftxiuseunicodedestname
1679 % Pass through Unicode characters.
1680 \else
1681 % Use ASCII approximations in destination names.
1682 \passthroughcharsfalse
1683 \fi
1685 \txiescapepdf\pdfdestname
1686 }}
1687 %
1689 \turnoffactive
1690 % Always use Unicode characters in title texts.
1692 % For XeTeX, xdvipdfmx converts to UTF-16.
1693 % So we do not convert.
1694 \txiescapepdf\pdfoutlinetext
1695 }}
1696 %
1700 }
1701 %
1702 % by default, use black for everything.
1706 %
1710 \ifx\pdfdestname\empty
1712 \fi
1713 %
1716 }
1717 %
1719 \begingroup
1720 %
1721 % For XeTeX, counts of subentries are not necessary.
1722 % Therefore, we read toc only once.
1723 %
1724 % We use node names as destinations.
1725 %
1726 % Currently we prefix the section name with the section number
1727 % for chapter and appendix headings only in order to avoid too much
1728 % horizontal space being required in the PDF viewer.
1738 %
1748 %
1749 % For XeTeX, xdvipdfmx converts strings to UTF-16.
1750 % Therefore, the encoding and the language may not be considered.
1751 %
1752 \indexnofonts
1753 \setupdatafile
1754 % We can have normal brace characters in the PDF outlines, unlike
1755 % Texinfo index files. So set that up.
1759 \input \tocreadfilename
1760 \endgroup
1761 }
1766 ]
1769 % ``\special{pdf:tounicode ...}'' is not necessary
1770 % because xdvipdfmx converts strings from UTF-8 to UTF-16 without it.
1771 % However, due to a UTF-16 conversion issue of xdvipdfmx 20150315,
1772 % ``\special{pdf:dest ...}'' cannot handle non-ASCII strings.
1773 % It is fixed by xdvipdfmx 20160106 (TeX Live SVN r39753).
1774 %
1776 \ifx\PP\D\let\nextsp\relax
1777 \else\let\nextsp\skipspaces
1780 \fi
1784 % If we don't expand the argument now, \skipspaces will get
1785 % snagged on things like "@value{foo}".
1788 }
1789 % make a live url in pdf output.
1791 \begingroup
1792 % it seems we really need yet another set of dummies; have not
1793 % tried to figure out what each command should do in the context
1794 % of @url. for now, just make @/ a no-op, that's the only one
1795 % people have actually reported a problem with.
1796 %
1797 \normalturnoffactive
1800 \makevalueexpandable
1801 % do we want to go so far as to use \indexnofonts instead of just
1802 % special-casing \var here?
1804 %
1816 \ifx\first0\adn0
1817 \else\ifx\first1\adn1 \else\ifx\first2\adn2 \else\ifx\first3\adn3
1818 \else\ifx\first4\adn4 \else\ifx\first5\adn5 \else\ifx\first6\adn6
1819 \else\ifx\first7\adn7 \else\ifx\first8\adn8 \else\ifx\first9\adn9
1820 \else
1826 \fi
1827 \fi\fi\fi\fi\fi\fi\fi\fi\fi\fi
1836 %
1837 %
1838 % @image support
1839 %
1840 % #1 is image name, #2 width (might be empty/whitespace), #3 height (ditto).
1844 %
1845 % XeTeX (and the PDF format) supports .pdf, .png, .jpg (among
1846 % others). Let's try in that order, PDF first since if
1847 % someone has a scalable image, presumably better to use that than a
1848 % bitmap.
1850 \begingroup
1859 \fi
1861 \fi
1863 \fi
1865 \fi
1867 \fi
1869 \fi
1871 \endgroup
1872 %
1873 % Putting an \hbox around the image can prevent an over-long line
1874 % after the image.
1875 \hbox\bgroup
1877 \ifx\xeteximgext\xetexpdfext
1879 \else
1881 \ifx\xeteximgext\xetexpdfext
1883 \else
1885 \fi
1886 \fi
1889 \egroup
1890 }
1891 \fi
1894 %
1897 % Set the baselineskip to #1, and the lineskip and strut size
1898 % correspondingly. There is no deep meaning behind these magic numbers
1899 % used as factors; they just match (closely enough) what Knuth defined.
1900 %
1904 %
1905 % can get a sort of poor man's double spacing by redefining this.
1907 %
1908 \newdimen\textleading
1913 \normalbaselines
1916 depth \strutdepthpercent \baselineskip
1918 }
1920 % PDF CMaps. See also LaTeX's t1.cmap.
1921 %
1922 % do nothing with this by default.
1927 % if we are producing pdf, and we have \pdffontattr, then define cmaps.
1928 % (\pdffontattr was introduced many years ago, but people still run
1929 % older pdftex's; it's easy to conditionalize, so we do.)
1930 \ifpdf \ifx\pdffontattr\thisisundefined \else
1931 \begingroup
1934 %%DocumentNeededResources: ProcSet (CIDInit)
1935 %%IncludeResource: ProcSet (CIDInit)
1936 %%BeginResource: CMap (TeX-OT1-0)
1937 %%Title: (TeX-OT1-0 TeX OT1 0)
1938 %%Version: 1.000
1939 %%EndComments
1940 /CIDInit /ProcSet findresource begin
1941 12 dict begin
1942 begincmap
1943 /CIDSystemInfo
1944 << /Registry (TeX)
1945 /Ordering (OT1)
1946 /Supplement 0
1947 >> def
1948 /CMapName /TeX-OT1-0 def
1949 /CMapType 2 def
1950 1 begincodespacerange
1952 endcodespacerange
1953 8 beginbfrange
1962 endbfrange
1963 40 beginbfchar
2004 endbfchar
2005 endcmap
2006 CMapName currentdict /CMap defineresource pop
2007 end
2008 end
2009 %%EndResource
2010 %%EOF
2015 %
2016 % \cmapOT1IT
2017 \begingroup
2020 %%DocumentNeededResources: ProcSet (CIDInit)
2021 %%IncludeResource: ProcSet (CIDInit)
2022 %%BeginResource: CMap (TeX-OT1IT-0)
2023 %%Title: (TeX-OT1IT-0 TeX OT1IT 0)
2024 %%Version: 1.000
2025 %%EndComments
2026 /CIDInit /ProcSet findresource begin
2027 12 dict begin
2028 begincmap
2029 /CIDSystemInfo
2030 << /Registry (TeX)
2031 /Ordering (OT1IT)
2032 /Supplement 0
2033 >> def
2034 /CMapName /TeX-OT1IT-0 def
2035 /CMapType 2 def
2036 1 begincodespacerange
2038 endcodespacerange
2039 8 beginbfrange
2048 endbfrange
2049 42 beginbfchar
2092 endbfchar
2093 endcmap
2094 CMapName currentdict /CMap defineresource pop
2095 end
2096 end
2097 %%EndResource
2098 %%EOF
2103 %
2104 % \cmapOT1TT
2105 \begingroup
2108 %%DocumentNeededResources: ProcSet (CIDInit)
2109 %%IncludeResource: ProcSet (CIDInit)
2110 %%BeginResource: CMap (TeX-OT1TT-0)
2111 %%Title: (TeX-OT1TT-0 TeX OT1TT 0)
2112 %%Version: 1.000
2113 %%EndComments
2114 /CIDInit /ProcSet findresource begin
2115 12 dict begin
2116 begincmap
2117 /CIDSystemInfo
2118 << /Registry (TeX)
2119 /Ordering (OT1TT)
2120 /Supplement 0
2121 >> def
2122 /CMapName /TeX-OT1TT-0 def
2123 /CMapType 2 def
2124 1 begincodespacerange
2126 endcodespacerange
2127 5 beginbfrange
2133 endbfrange
2134 32 beginbfchar
2167 endbfchar
2168 endcmap
2169 CMapName currentdict /CMap defineresource pop
2170 end
2171 end
2172 %%EndResource
2173 %%EOF
2178 \fi\fi
2181 % Set the font macro #1 to the font named \fontprefix#2.
2182 % #3 is the font's design size, #4 is a scale factor, #5 is the CMap
2183 % encoding (only OT1, OT1IT and OT1TT are allowed, or empty to omit).
2184 % Example:
2185 % #1 = \textrm
2186 % #2 = \rmshape
2187 % #3 = 10
2188 % #4 = \mainmagstep
2189 % #5 = OT1
2190 %
2194 }
2195 % This is what gets called when #5 of \setfont is empty.
2196 \let\cmap\gobble
2197 %
2198 % (end of cmaps)
2200 % Use cm as the default font prefix.
2201 % To specify the font prefix, you must define \fontprefix
2202 % before you read in texinfo.tex.
2203 \ifx\fontprefix\thisisundefined
2205 \fi
2206 % Support font families that don't use the same naming scheme as CM.
2223 % Definitions for a main text size of 11pt. (The default in Texinfo.)
2224 %
2226 % Text fonts (11.2pt, magstep1).
2241 % A few fonts for @defun names and args.
2249 % Fonts for indices, footnotes, small examples (9pt).
2259 \font\smalli=cmmi9
2260 \font\smallsy=cmsy9
2263 % Fonts for small examples (8pt).
2273 \font\smalleri=cmmi8
2274 \font\smallersy=cmsy8
2277 % Fonts for math mode superscripts (7pt).
2287 \font\seveni=cmmi7
2288 \font\sevensy=cmsy7
2291 % Fonts for title page (20.4pt):
2305 % Chapter (and unnumbered) fonts (17.28pt).
2319 % Section fonts (14.4pt).
2328 \let\secbf\secrm
2334 % Subsection fonts (13.15pt).
2342 \let\ssecbf\ssecrm
2348 % Reduced fonts for @acronym in text (10pt).
2358 \font\reducedi=cmmi10
2359 \font\reducedsy=cmsy10
2364 \rm
2368 % Definitions to make the main text be 10pt Computer Modern, with
2369 % section, chapter, etc., sizes following suit. This is for the GNU
2370 % Press printing of the Emacs 22 manual. Maybe other manuals in the
2371 % future. Used with @smallbook, which sets the leading to 12pt.
2372 %
2374 % Text fonts (10pt).
2389 % A few fonts for @defun names and args.
2397 % Fonts for indices, footnotes, small examples (9pt).
2407 \font\smalli=cmmi9
2408 \font\smallsy=cmsy9
2411 % Fonts for small examples (8pt).
2421 \font\smalleri=cmmi8
2422 \font\smallersy=cmsy8
2425 % Fonts for math mode superscripts (7pt).
2435 \font\seveni=cmmi7
2436 \font\sevensy=cmsy7
2439 % Fonts for title page (20.4pt):
2453 % Chapter fonts (14.4pt).
2461 \let\chapbf\chaprm
2467 % Section fonts (12pt).
2475 \let\secbf\secrm
2477 \font\seci=cmmi12
2481 % Subsection fonts (10pt).
2489 \let\ssecbf\ssecrm
2491 \font\sseci=cmmi10
2492 \font\ssecsy=cmsy10
2495 % Reduced fonts for @acronym in text (9pt).
2505 \font\reducedi=cmmi9
2506 \font\reducedsy=cmsy9
2512 \rm
2515 % Fonts for short table of contents.
2522 % We provide the user-level command
2523 % @fonttextsize 10
2524 % (or 11) to redefine the text font size. pt is assumed.
2525 %
2529 %
2532 %\wlog{doing @fonttextsize \textsizearg}%
2533 %
2534 % Set \globaldefs so that documents can use this inside @tex, since
2535 % makeinfo 4.8 does not support it, but we need it nonetheless.
2536 %
2538 \ifx\textsizearg\xword \definetextfontsizex
2539 \else \ifx\textsizearg\xiword \definetextfontsizexi
2540 \else
2543 \fi\fi
2544 \endgroup
2545 }
2547 %
2548 % Change the current font style to #1, remembering it in \curfontstyle.
2549 % For now, we do not accumulate font styles: @b{@i{foo}} prints foo in
2550 % italics, not bold italics.
2551 %
2555 }
2563 % Texinfo sort of supports the sans serif font style, which plain TeX does not.
2564 % So we set up a \sf.
2565 \newfam\sffam
2568 % We don't need math for this font style.
2572 % In order for the font changes to affect most math symbols and letters,
2573 % we have to define the \textfont of the standard families.
2574 % We don't bother to reset \scriptscriptfont; awaiting user need.
2575 %
2580 %
2581 % Fonts for superscript. Note that the 7pt fonts are used regardless
2582 % of the current font size.
2587 }
2589 %
2591 % The font-changing commands (all called \...fonts) redefine the meanings
2592 % of \STYLEfont, instead of just \STYLE. We do this because \STYLE needs
2593 % to also set the current \fam for math mode. Our \STYLE (e.g., \rm)
2594 % commands hardwire \STYLEfont to set the current font.
2595 %
2596 % The fonts used for \ifont are for "math italics" (\itfont is for italics
2597 % in regular text). \syfont is also used in math mode only.
2598 %
2599 % Each font-changing command also sets the names \lsize (one size lower)
2600 % and \lllsize (three sizes lower). These relative commands are used
2601 % in, e.g., the LaTeX logo and acronyms.
2602 %
2603 % This all needs generalizing, badly.
2604 %
2617 }
2619 \newif\ifrmisbold
2621 % Select smaller font size with the current style. Used to change font size
2622 % in, e.g., the LaTeX logo and acronyms. If we are using bold fonts for
2623 % normal roman text, also use bold fonts for roman text in the smaller size.
2626 \ifrmisbold
2627 \let\rmfont\bffont
2628 \fi
2629 \csname\curfontstyle\endcsname
2634 \ifrmisbold
2635 \let\rmfont\bffont
2636 \fi
2637 \csname\curfontstyle\endcsname
2646 \resetmathfonts
2648 }}
2663 % Define these just so they can be easily changed for other fonts.
2667 % Set the fonts to use with the @small... environments.
2670 % About \smallexamplefonts. If we use \smallfonts (9pt), @smallexample
2671 % can fit this many characters:
2672 % 8.5x11=86 smallbook=72 a4=90 a5=69
2673 % If we use \scriptfonts (8pt), then we can fit this many characters:
2674 % 8.5x11=90+ smallbook=80 a4=90+ a5=77
2675 % For me, subjectively, the few extra characters that fit aren't worth
2676 % the additional smallness of 8pt. So I'm making the default 9pt.
2677 %
2678 % By the way, for comparison, here's what fits with @example (10pt):
2679 % 8.5x11=71 smallbook=60 a4=75 a5=58
2680 % --karl, 24jan03.
2682 % Set up the default fonts, so we can use them for creating boxes.
2683 %
2684 \definetextfontsizexi
2687 % Check if we are currently using a typewriter font. Since all the
2688 % Computer Modern typewriter fonts have zero interword stretch (and
2689 % shrink), and it is reasonable to expect all typewriter fonts to have
2690 % this property, we can check that font parameter.
2691 %
2694 {
2700 }
2702 % Allow an option to not use regular directed right quote/apostrophe
2703 % (char 0x27), but instead the undirected quote from cmtt (char 0x0d).
2704 % The undirected quote is ugly, so don't make it the default, but it
2705 % works for pasting with more pdf viewers (at least evince), the
2706 % lilypond developers report. xpdf does work with the regular 0x27.
2707 %
2709 \ifmonospace
2712 '%
2715 \else
2716 '%
2717 \fi
2718 }
2719 %
2720 % and a similar option for the left quote char vs. a grave accent.
2721 % Modern fonts display ASCII 0x60 as a grave accent, so some people like
2722 % the code environments to do likewise.
2723 %
2725 \ifmonospace
2728 % [Knuth] pp. 380,381,391
2729 % \relax disables Spanish ligatures ?` and !` of \tt font.
2733 \else
2735 \fi
2736 }
2738 % Commands to set the quote options.
2739 %
2742 \ifx\temp\onword
2744 = t%
2745 \else\ifx\temp\offword
2747 = \relax
2748 \else
2751 \fi\fi
2752 }
2753 %
2756 \ifx\temp\onword
2758 = t%
2759 \else\ifx\temp\offword
2761 = \relax
2762 \else
2765 \fi\fi
2766 }
2768 % [Knuth] pp. 380,381,391, disable Spanish ligatures ?` and !` of \tt font.
2771 % Count depth in font-changes, for error checks
2774 % Font commands.
2776 % #1 is the font command (\sl or \it), #2 is the text to slant.
2777 % If we are in a monospaced environment, however, 1) always use \ttsl,
2778 % and 2) do not add an italic correction.
2780 \ifusingtt
2783 \next
2784 }
2788 % Output an italic correction unless \next (presumed to be the following
2789 % character) is such as not to need one.
2796 \else\ptexslash
2797 \fi\fi\fi\fi\fi
2798 \aftersmartic
2799 }
2801 % Unconditional use \ttsl, and no ic. @var is set to this for defuns.
2804 % @cite is like \smartslanted except unconditionally use \sl. We never want
2805 % ttsl for book titles, do we?
2813 }
2820 % Explicit font changes: @r, @sc, undocumented @ii.
2825 % @b, explicit bold. Also @strong.
2829 % @sansserif, explicit sans.
2832 % We can't just use \exhyphenpenalty, because that only has effect at
2833 % the end of a paragraph. Restore normal hyphenation at the end of the
2834 % group within which \nohyphenation is presumably called.
2835 %
2839 % Set sfcode to normal for the chars that usually have another value.
2840 % Can't use plain's \frenchspacing because it uses the `\x notation, and
2841 % sometimes \x has an active definition that messes things up.
2842 %
2848 }
2853 }
2857 % @t, explicit typewriter.
2860 \null
2861 }
2863 % @samp.
2866 % @indicateurl is \samp, that is, with quotes.
2869 % @code (and similar) prints in typewriter, but with spaces the same
2870 % size as normal in the surrounding text, without hyphenation, etc.
2871 % This is a subroutine for that.
2874 % Change normal interword space to be same as for the current font.
2876 %
2877 % Switch to typewriter.
2878 \tt
2879 %
2880 % But `\ ' produces the large typewriter interword space.
2882 %
2883 % Turn off hyphenation.
2884 \nohyphenation
2885 %
2886 \plainfrenchspacing
2890 }
2892 % We *must* turn on hyphenation at `-' and `_' in @code.
2893 % (But see \codedashfinish below.)
2894 % Otherwise, it is too hard to avoid overfull hboxes
2895 % in the Emacs manual, the Library manual, etc.
2896 %
2897 % Unfortunately, TeX uses one parameter (\hyphenchar) to control
2898 % both hyphenation at - and hyphenation within words.
2899 % We must therefore turn them both off (\tclose does that)
2900 % and arrange explicitly to hyphenate at a dash. -- rms.
2901 {
2905 %
2907 \setcodequotes
2909 \ifallowcodebreaks
2911 \let_\codeunder
2912 \else
2914 \let_\realunder
2915 \fi
2916 % Given -foo (with a single dash), we do not want to allow a break
2917 % after the hyphen.
2919 %
2920 \codex
2921 }
2922 %
2926 %
2927 % Now, output a discretionary to allow a line break, unless
2928 % (a) the next character is a -, or
2929 % (b) the preceding character is a -.
2930 % E.g., given --posix, we do not want to allow a break after either -.
2931 % Given --foo-bar, we do want to allow a break between the - and the b.
2932 \ifx\next\codedash \else
2933 \ifx\codedashprev\codedash
2935 \fi
2936 % we need the space after the = for the case when \next itself is a
2937 % space token; it would get swallowed otherwise. As in @code{- a}.
2939 }
2940 }
2942 %
2946 % this is all so @math{@code{var_name}+1} can work. In math mode, _
2947 % is "active" (mathcode"8000) and \normalunderscore (or \char95, etc.)
2948 % will therefore expand the active definition of _, which is us
2949 % (inside @code that is), therefore an endless loop.
2952 \else\normalunderscore \fi
2955 }
2957 % An additional complication: the above will allow breaks after, e.g.,
2958 % each of the four underscores in __typeof__. This is bad.
2959 % @allowcodebreaks provides a document-level way to turn breaking at -
2960 % and _ on and off.
2961 %
2962 \newif\ifallowcodebreaks \allowcodebreakstrue
2969 \ifx\txiarg\keywordtrue
2970 \allowcodebreakstrue
2971 \else\ifx\txiarg\keywordfalse
2972 \allowcodebreaksfalse
2973 \else
2976 \fi\fi
2977 }
2979 % For @command, @env, @file, @option quotes seem unnecessary,
2980 % so use \code rather than \samp.
2986 % @uref (abbreviation for `urlref') aka @url takes an optional
2987 % (comma-separated) second argument specifying the text to display and
2988 % an optional third arg as text to display instead of (rather than in
2989 % addition to) the url itself. First (mandatory) arg is the url.
2991 % TeX-only option to allow changing PDF output to show only the second
2992 % arg (if given), and not the url (which is then just the link target).
2993 \newif\ifurefurlonlylink
2995 % The default \pretolerance setting stops the penalty inserted in
2996 % \urefallowbreak being a discouragement to line breaking. Set it to
2997 % a negative value for this paragraph only. Hopefully this does not
2998 % conflict with redefinitions of \par done elsewhere.
3002 }
3004 % The main macro is \urefbreak, which allows breaking at expected
3005 % places within the url.
3008 %
3011 \unsepspaces
3016 \else
3019 \ifpdf
3020 % For pdfTeX and LuaTeX
3021 \ifurefurlonlylink
3022 % PDF plus option to not display url, show just arg
3023 \unhbox0
3024 \else
3025 % PDF, normally display both arg and url for consistency,
3026 % visibility, if the pdf is eventually used to print, etc.
3028 \fi
3029 \else
3030 \ifx\XeTeXrevision\thisisundefined
3032 \else
3033 % For XeTeX
3034 \ifurefurlonlylink
3035 % PDF plus option to not display url, show just arg
3036 \unhbox0
3037 \else
3038 % PDF, normally display both arg and url for consistency,
3039 % visibility, if the pdf is eventually used to print, etc.
3041 \fi
3042 \fi
3043 \fi
3044 \else
3046 \fi
3047 \fi
3048 \endlink
3051 % Allow line breaks around only a few characters (only).
3056 }
3057 {
3058 \urefcatcodes
3059 %
3061 \setcodequotes
3062 \urefcatcodes
3068 \codex
3069 }
3070 %
3071 % By default, they are just regular characters.
3077 }
3084 {
3087 \urefprebreak \slashChar
3088 % Allow line break only after the final / in a sequence of
3089 % slashes, to avoid line break between the slashes in http://.
3091 }
3092 }
3094 % By default we'll break after the special characters, but some people like to
3095 % break before the special chars, so allow that. Also allow no breaking at
3096 % all, for manual control.
3097 %
3100 \ifx\txiarg\wordnone
3102 \else\ifx\txiarg\wordbefore
3104 \else\ifx\txiarg\wordafter
3106 \else
3109 \fi\fi\fi
3110 }
3115 % Allow a ragged right output to aid breaking long URL's. There can
3116 % be a break at the \allowbreak with no extra glue (if the existing stretch in
3117 % the line is sufficient), a break at the \penalty with extra glue added
3118 % at the end of the line, or no break at all here.
3119 % Changing the value of the penalty and/or the amount of stretch affects how
3120 % preferable one choice is over the other.
3122 \penalty0\relax
3124 \penalty1000\relax
3126 }
3128 \urefbreakstyle after
3130 % @url synonym for @uref, since that's how everyone uses it.
3131 %
3134 % rms does not like angle brackets --karl, 17may97.
3135 % So now @email is just like @uref, unless we are pdf.
3136 %
3137 %\def\email#1{\angleleft{\tt #1}\angleright}
3138 \ifpdforxetex
3141 \unsepspaces
3145 \endlink
3147 \else
3149 \fi
3151 % @kbdinputstyle -- arg is `distinct' (@kbd uses slanted tty font always),
3152 % `example' (@kbd uses ttsl only inside of @example and friends),
3153 % or `code' (@kbd uses normal tty font always).
3156 \ifx\txiarg\worddistinct
3158 \else\ifx\txiarg\wordexample
3160 \else\ifx\txiarg\wordcode
3162 \else
3165 \fi\fi\fi
3166 }
3171 % Default is `distinct'.
3172 \kbdinputstyle distinct
3174 % @kbd is like @code, except that if the argument is just one @key command,
3175 % then @kbd has no effect.
3184 }
3186 % definition of @key that produces a lozenge. Doesn't adjust to text size.
3187 %\setfont\keyrm\rmshape{8}{1000}{OT1}
3188 %\font\keysy=cmsy9
3189 %\def\key#1{{\keyrm\textfont2=\keysy \leavevmode\hbox{%
3190 % \raise0.4pt\hbox{\angleleft}\kern-.08em\vtop{%
3191 % \vbox{\hrule\kern-0.4pt
3192 % \hbox{\raise0.4pt\hbox{\vphantom{\angleleft}}#1}}%
3193 % \kern-0.4pt\hrule}%
3194 % \kern-.06em\raise0.4pt\hbox{\angleright}}}}
3196 % definition of @key with no lozenge.
3197 %
3200 % @clicksequence{File @click{} Open ...}
3203 % @clickstyle @arrow (by default)
3207 % Typeset a dimension, e.g., `in' or `pt'. The only reason for the
3208 % argument is to make the input look right: @dmn{pt} instead of @dmn{}pt.
3209 %
3212 % @acronym for "FBI", "NATO", and the like.
3213 % We print this one point size smaller, since it's intended for
3214 % all-uppercase.
3215 %
3220 \ifx\temp\empty \else
3222 \fi
3224 }
3226 % @abbr for "Comput. J." and the like.
3227 % No font change, but don't do end-of-sentence spacing.
3228 %
3233 \ifx\temp\empty \else
3235 \fi
3237 }
3239 % @asis just yields its argument. Used with @table, for example.
3240 %
3243 % @math outputs its argument in math mode.
3244 %
3245 % One complication: _ usually means subscripts, but it could also mean
3246 % an actual _ character, as in @math{@var{some_variable} + 1}. So make
3247 % _ active, and distinguish by seeing if the current family is \slfam,
3248 % which is what @var uses.
3249 {
3254 }
3255 }
3256 % Another complication: we want \\ (and @\) to output a math (or tt) \.
3257 % FYI, plain.tex uses \\ as a temporary control sequence (for no
3258 % particular reason), but this is not advertised and we don't care.
3259 %
3260 % The \mathchar is class=0=ordinary, family=7=ttfam, position=5C=\.
3262 %
3265 \tex
3266 \mathunderscore
3268 \mathactive
3269 % make the texinfo accent commands work in math mode
3279 % have to provide another name for sup operator
3281 $\expandafter\finishmath\fi
3282 }
3285 % Some active characters (such as <) are spaced differently in math.
3286 % We have to reset their definitions in case the @math was an argument
3287 % to a command which sets the catcodes (such as @item or @section).
3288 %
3289 {
3301 }
3302 }
3304 % for @sub and @sup, if in math mode, just do a normal sub/superscript.
3305 % If in text, use math to place as sub/superscript, but switch
3306 % into text mode, with smaller fonts. This is a different font than the
3307 % one used for real math sub/superscripts (8pt vs. 7pt), but let's not
3308 % fix it (significant additions to font machinery) until someone notices.
3309 %
3312 %
3316 % provide this command from LaTeX as it is very common
3319 % @displaymath.
3320 % \globaldefs is needed to recognize the end lines in \tex and
3321 % \end tex. Set \thisenv as @end displaymath is seen before @end tex.
3328 $$%
3329 }
3335 \end tex
3336 }}
3339 % @inlinefmt{FMTNAME,PROCESSED-TEXT} and @inlineraw{FMTNAME,RAW-TEXT}.
3340 % Ignore unless FMTNAME == tex; then it is like @iftex and @tex,
3341 % except specified as a normal braced arg, so no newlines to worry about.
3342 %
3344 %
3349 }
3350 %
3351 % @inlinefmtifelse{FMTNAME,THEN-TEXT,ELSE-TEXT} expands THEN-TEXT if
3352 % FMTNAME is tex, else ELSE-TEXT.
3357 }
3358 %
3359 % For raw, must switch into @tex before parsing the argument, to avoid
3360 % setting catcodes prematurely. Doing it this way means that, for
3361 % example, @inlineraw{html, foo{bar} gets a parse error instead of being
3362 % ignored. But this isn't important because if people want a literal
3363 % *right* brace they would have to use a command anyway, so they may as
3364 % well use a command to get a left brace too. We could re-use the
3365 % delimiter character idea from \verb, but it seems like overkill.
3366 %
3373 }
3375 % @inlineifset{VAR, TEXT} expands TEXT if VAR is @set.
3376 %
3382 }
3384 % @inlineifclear{VAR, TEXT} expands TEXT if VAR is not @set.
3385 %
3390 }
3394 % and logos.
3396 % @@ prints an @, as does @atchar{}.
3398 \let\atchar=\@
3400 % @{ @} @lbracechar{} @rbracechar{} all generate brace characters.
3406 % @comma{} to avoid , parsing problems.
3407 \let\comma = ,
3409 % Accents: @, @dotaccent @ringaccent @ubaraccent @udotaccent
3410 % Others are defined by plain TeX: @` @' @" @^ @~ @= @u @v @H.
3418 % Other special characters: @questiondown @exclamdown @ordf @ordm
3419 % Plain TeX defines: @AA @AE @O @OE @L (plus lowercase versions) @ss.
3425 % Dotless i and dotless j, used for accents.
3430 \ifx\temp\imacro \ifmmode\imath \else\ptexi \fi
3431 \else\ifx\temp\jmacro \ifmmode\jmath \else\j \fi
3433 \fi\fi
3434 }
3436 % The \TeX{} logo, as in plain, but resetting the spacing so that a
3437 % period following counts as ending a sentence. (Idea found in latex.)
3438 %
3441 % @LaTeX{} logo. Not quite the same results as the definition in
3442 % latex.ltx, since we use a different font for the raised A; it's most
3443 % convenient for us to use an explicitly smaller font, rather than using
3444 % the \scriptstyle font (since we don't reset \scriptstyle and
3445 % \scriptscriptstyle).
3446 %
3451 \ifx\textnominalsize\xwordpt
3452 % for 10pt running text, lllsize (8pt) is too small for the A in LaTeX.
3453 % Revert to plain's \scriptsize, which is 7pt.
3455 \else
3456 % For 11pt, we can use our lllsize.
3458 \fi
3460 \vss
3463 \TeX
3464 }
3466 % Some math mode symbols. Define \ensuremath to switch into math mode
3467 % unless we are already there. Expansion tricks may not be needed here,
3468 % but safer, and can't hurt.
3471 %
3477 % @dots{} outputs an ellipsis using the current font.
3478 % We do .5em per period so that it has the same spacing in the cm
3479 % typewriter fonts as three actual period characters; on the other hand,
3480 % in other typewriter fonts three periods are wider than 1.5em. So do
3481 % whichever is larger.
3482 %
3484 \leavevmode
3488 \else
3490 \fi
3497 }
3499 % @enddots{} is an end-of-sentence ellipsis.
3500 %
3502 \dots
3504 }
3506 % @point{}, @result{}, @expansion{}, @print{}, @equiv{}.
3507 %
3508 % Since these characters are used in examples, they should be an even number of
3509 % \tt widths. Each \tt character is 1en, so two makes it 1em.
3510 %
3518 % The @error{} command.
3519 % Adapted from the TeXbook's \boxit.
3520 %
3521 \newbox\errorbox
3522 %
3525 % The text. (`r' is open on the right, `e' somewhat less so on the left.)
3527 %
3538 %
3541 % @pounds{} is a sterling sign, which Knuth put in the CM italic font.
3542 %
3545 % @euro{} comes from a separate font, depending on the current style.
3546 % We use the free feym* fonts from the eurosym package by Henrik
3547 % Theiling, which support regular, slanted, bold and bold slanted (and
3548 % "outlined" (blackboard board, sort of) versions, which we don't need).
3549 % It is available from http://www.ctan.org/tex-archive/fonts/eurosym.
3550 %
3551 % Although only regular is the truly official Euro symbol, we ignore
3552 % that. The Euro is designed to be slightly taller than the regular
3553 % font height.
3554 %
3555 % feymr - regular
3556 % feymo - slanted
3557 % feybr - bold
3558 % feybo - bold slanted
3559 %
3560 % There is no good (free) typewriter version, to my knowledge.
3561 % A feymr10 euro is ~7.3pt wide, while a normal cmtt10 char is ~5.25pt wide.
3562 % Hmm.
3563 %
3564 % Also doesn't work in math. Do we need to do math with euro symbols?
3565 % Hope not.
3566 %
3567 %
3570 % We set the font at each command, rather than predefining it in
3571 % \textfonts and the other font-switching commands, so that
3572 % installations which never need the symbol don't have to have the
3573 % font installed.
3574 %
3575 % There is only one designed size (nominal 10pt), so we always scale
3576 % that to the current nominal size.
3577 %
3578 % By the way, simply using "at 1em" works for cmr10 and the like, but
3579 % does not work for cmbx10 and other extended/shrunken fonts.
3580 %
3582 %
3583 \ifx\curfontstyle\bfstylename
3584 % bold:
3586 \else
3587 % regular:
3589 \fi
3590 \thiseurofont
3591 }
3593 % Glyphs from the EC fonts. We don't use \let for the aliases, because
3594 % sometimes we redefine the original macro, and the alias should reflect
3595 % the redefinition.
3596 %
3597 % Use LaTeX names for the Icelandic letters.
3602 %
3611 %
3614 %
3615 % This positioning is not perfect (see the ogonek LaTeX package), but
3616 % we have the precomposed glyphs for the most common cases. We put the
3617 % tests to use those glyphs in the single \ogonek macro so we have fewer
3618 % dummy definitions to worry about for index entries, etc.
3619 %
3620 % ogonek is also used with other letters in Lithuanian (IOU), but using
3621 % the precomposed glyphs for those is not so easy since they aren't in
3622 % the same EC font.
3625 \ifx\temp\macrocharA\Aogonek
3626 \else\ifx\temp\macrochara\aogonek
3627 \else\ifx\temp\macrocharE\Eogonek
3628 \else\ifx\temp\macrochare\eogonek
3629 \else
3633 \fi
3634 \fi\fi\fi\fi
3636 }
3641 %
3642 % Use the European Computer Modern fonts (cm-super in outline format)
3643 % for non-CM glyphs. That is ec* for regular text and tc* for the text
3644 % companion symbols (LaTeX TS1 encoding). Both are part of the ec
3645 % package and follow the same conventions.
3646 %
3649 %
3651 % We can't distinguish serif/sans and italic/slanted, but this
3652 % is used for crude hacks anyway (like adding French and German
3653 % quotes to documents typeset with CM, where we lose kerning), so
3654 % hopefully nobody will notice/care.
3657 \ifmonospace
3658 % typewriter:
3660 \else
3661 \ifx\curfontstyle\bfstylename
3662 % bold:
3664 \else
3665 % regular:
3667 \fi
3668 \fi
3669 \thisecfont
3670 }
3672 % @registeredsymbol - R in a circle. The font for the R should really
3673 % be smaller yet, but lllsize is the best we can do for now.
3674 % Adapted from the plain.tex definition of \copyright.
3675 %
3680 }
3682 % @textdegree - the normal degrees sign.
3683 %
3686 % Laurent Siebenmann reports \Orb undefined with:
3687 % Textures 1.7.7 (preloaded format=plain 93.10.14) (68K) 16 APR 2004 02:38
3688 % so we'll define it if necessary.
3689 %
3690 \ifx\Orb\thisisundefined
3692 \fi
3694 % Quotes.
3695 \chardef\quoteleft=`\`
3696 \chardef\quoteright=`\'
3698 % only change font for tt for correct kerning and to avoid using
3699 % \ecfont unless necessary.
3702 }
3706 }
3714 % First the title page. Must do @settitle before @titlepage.
3715 \newif\ifseenauthor
3716 \newif\iffinishedtitlepage
3718 % @setcontentsaftertitlepage used to do an implicit @contents or
3719 % @shortcontents after @end titlepage, but it is now obsolete.
3722 command; move your @contents command if you want the contents
3726 command; move your @shortcontents and @contents commands if you
3734 % Open one extra group, as we want to close it in the middle of \Etitlepage.
3735 \begingroup
3737 % Leave some space at the very top of the page.
3738 \vglue\titlepagetopglue
3739 % No rule at page bottom unless we print one at the top with @title.
3740 \finishedtitlepagetrue
3741 %
3742 % Most title ``pages'' are actually two pages long, with space
3743 % at the top of the second. We don't want the ragged left on the second.
3746 \iffinishedtitlepage\else
3747 \finishtitlepage
3748 \fi
3750 \page
3751 \null
3753 }
3756 \iffinishedtitlepage\else
3757 \finishtitlepage
3758 \fi
3759 % It is important to do the page break before ending the group,
3760 % because the headline and footline are only empty inside the group.
3761 % If we use the new definition of \page, we always get a blank page
3762 % after the title page, which we certainly don't want.
3763 \oldpage
3764 \endgroup
3765 %
3766 % Need this before the \...aftertitlepage checks so that if they are
3767 % in effect the toc pages will come out with page numbers.
3768 \HEADINGSon
3769 }
3773 \vskip\titlepagebottomglue
3774 \finishedtitlepagetrue
3775 }
3777 % Settings used for typesetting titles: no hyphenation, no indentation,
3778 % don't worry much about spacing, ragged right. This should be used
3779 % inside a \vbox, and fonts need to be set appropriately first. \par should
3780 % be specified before the end of the \vbox, since a vbox is a group.
3781 %
3783 \rm
3787 \ptexraggedright
3788 }
3790 % Macros to be used within @titlepage:
3796 \checkenv\titlepage
3798 % print a rule at the page bottom also.
3799 \finishedtitlepagefalse
3801 }
3804 \checkenv\titlepage
3806 }
3808 % @author should come last, but may come many times.
3809 % It can also be used inside @quotation.
3810 %
3813 \ifx\thisenv\temp
3815 \else
3816 \checkenv\titlepage
3819 \fi
3820 }
3823 % Set up page headings and footings.
3834 % Now make \makeheadline and \makefootline in Plain TeX use those variables
3836 \ifchapterpage
3837 \ifodd\pageno\the\oddchapheadline\else\the\evenchapheadline\fi
3838 \else
3839 \ifodd\pageno\the\oddheadline\else\the\evenheadline\fi
3846 % Commands to set those variables.
3847 % For example, this is what @headings on does
3848 % @evenheading @thistitle|@thispage|@thischapter
3849 % @oddheading @thischapter|@thispage|@thistitle
3850 % @evenfooting @thisfile||
3851 % @oddfooting ||@thisfile
3877 %
3878 % Leave some space for the footline. Hopefully ok to assume
3879 % @evenfooting will not be used by itself.
3882 }
3886 % @evenheadingmarks top \thischapter <- chapter at the top of a page
3887 % @evenheadingmarks bottom \thischapter <- chapter at the bottom of a page
3888 %
3889 % The same set of arguments for:
3890 %
3891 % @oddheadingmarks
3892 % @evenfootingmarks
3893 % @oddfootingmarks
3894 % @everyheadingmarks
3895 % @everyfootingmarks
3897 % These define \getoddheadingmarks, \getevenheadingmarks,
3898 % \getoddfootingmarks, and \getevenfootingmarks, each to one of
3899 % \gettopheadingmarks, \getbottomheadingmarks.
3900 %
3909 % #1 = even/odd, #2 = heading/footing, #3 = top/bottom.
3913 }
3915 \everyheadingmarks bottom
3916 \everyfootingmarks bottom
3918 % @headings double turns headings on for double-sided printing.
3919 % @headings single turns headings on for single-sided printing.
3920 % @headings off turns them off.
3921 % @headings on same as @headings double, retained for compatibility.
3922 % @headings after turns on double-sided headings after this page.
3923 % @headings doubleafter turns on double-sided headings after this page.
3924 % @headings singleafter turns on single-sided headings after this page.
3925 % By default, they are off at the start of a document,
3926 % and turned `on' after @end titlepage.
3933 }
3938 % When we turn headings on, set the page number to 1.
3942 }
3944 % For double-sided printing, put current file name in lower left corner,
3945 % chapter name on inside top of right hand pages, document
3946 % title on inside top of left hand pages, and page numbers on outside top
3947 % edge of all pages.
3949 \pageone
3950 \HEADINGSdoublex
3951 }
3954 % For single-sided printing, chapter title goes across top left of page,
3955 % page number on top right.
3957 \pageone
3958 \HEADINGSsinglex
3959 }
3972 }
3983 }
3985 % for @setchapternewpage off
3987 \pageone
3995 }
3997 % Subroutines used in generating headings
3998 % This produces Day Month Year style of output.
3999 % Only define if not already defined, in case a txi-??.tex file has set
4000 % up a different format (e.g., txi-cs.tex does this).
4001 \ifx\today\thisisundefined
4003 \number\day\space
4004 \ifcase\month
4005 \or\putwordMJan\or\putwordMFeb\or\putwordMMar\or\putwordMApr
4006 \or\putwordMMay\or\putwordMJun\or\putwordMJul\or\putwordMAug
4007 \or\putwordMSep\or\putwordMOct\or\putwordMNov\or\putwordMDec
4008 \fi
4010 \fi
4012 % @settitle line... specifies the title of the document, for headings.
4013 % It generates no output of its own.
4019 % Tables -- @table, @ftable, @vtable, @item(x).
4021 % default indentation of table text
4023 % default indentation of @itemize and @enumerate text
4025 % margin between end of table item and start of table text.
4028 % used internally for \itemindent minus \itemmargin
4029 \newdimen\itemmax
4031 % Note @table, @ftable, and @vtable define @item, @itemx, etc., with
4032 % these defs.
4033 % They also define \itemindex
4034 % to index the item name in whatever manner is desired (perhaps none).
4036 \newif\ifitemxneedsnegativevskip
4049 %
4050 % If the item text does not fit in the space we have, put it on a line
4051 % by itself, and do not allow a page break either before or after that
4052 % line. We do not start a paragraph here because then if the next
4053 % command is, e.g., @kindex, the whatsit would get put into the
4054 % horizontal list on a line by itself, resulting in extra blank space.
4056 %
4057 % Make this a paragraph so we get the \parskip glue and wrapping,
4058 % but leave it ragged-right.
4059 \begingroup
4063 \leavevmode\unhbox0\par
4064 \endgroup
4065 %
4066 % We're going to be starting a paragraph, but we don't want the
4067 % \parskip glue -- logically it's part of the @item we just started.
4069 %
4070 % Stop a page break at the \parskip glue coming up. However, if
4071 % what follows is an environment such as @example, there will be no
4072 % \parskip glue; then the negative vskip we just inserted would
4073 % cause the example and the item to crash together. So we use this
4074 % bizarre value of 10001 as a signal to \aboveenvbreak to insert
4075 % \parskip glue after all. Section titles are handled this way also.
4076 %
4078 \endgroup
4079 \itemxneedsnegativevskipfalse
4080 \else
4081 % The item text fits into the space. Start a paragraph, so that the
4082 % following text (if any) will end up on the same line.
4083 \noindent
4084 % Do this with kerns and \unhbox so that if there is a footnote in
4085 % the item text, it can migrate to the main vertical list and
4086 % eventually be printed.
4089 \unhbox0
4090 \nobreak\kern\dimen0
4091 \endgroup
4092 \itemxneedsnegativevskiptrue
4093 \fi
4094 }
4099 % @table, @ftable, @vtable.
4101 \let\itemindex\gobble
4103 }
4107 }
4111 }
4114 \endgroup
4118 \else
4119 \let\next\tablex
4120 \fi
4121 \next
4122 }
4125 \parsearg\tabley
4126 }
4129 \makevalueexpandable
4131 \expandafter
4133 }
4135 \aboveenvbreak
4148 }
4150 \let\Eftable\Etable
4151 \let\Evtable\Etable
4152 \let\Eitemize\Etable
4153 \let\Eenumerate\Etable
4155 % This is the counter used by @enumerate, which is really @itemize
4157 \newcount \itemno
4162 \aboveenvbreak
4170 %
4171 % Try typesetting the item mark so that if the document erroneously says
4172 % something like @itemize @samp (intending @table), there's an error
4173 % right away at the @itemize. It's not the best error message in the
4174 % world, but it's better than leaving it to the @item. This means if
4175 % the user wants an empty mark, they have to say @w{} not just @w.
4178 %
4179 % @itemize with no arg is equivalent to @itemize @bullet.
4181 %
4183 }
4185 % Definition of @item while inside @itemize and @enumerate.
4186 %
4191 % If the document has an @itemize directly after a section title, a
4192 % \nobreak will be last on the list, and \sectionheading will have
4193 % done a \vskip-\parskip. In that case, we don't want to zero
4194 % parskip, or the item text will crash with the heading. On the
4195 % other hand, when there is normal text preceding the item (as there
4196 % usually is), we do want to zero parskip, or there would be too much
4197 % space. In that case, we won't have a \nobreak before. At least
4198 % that's the theory.
4200 \noindent
4202 %
4203 \ifinner\else
4205 \fi
4206 % We can be in inner vertical mode in a footnote, although an
4207 % @itemize looks awful there.
4209 \flushcr
4210 }
4212 % \splitoff TOKENS\endmark defines \first to be the first token in
4213 % TOKENS, and \rest to be the remainder.
4214 %
4217 % Allow an optional argument of an uppercase letter, lowercase letter,
4218 % or number, to specify the first label in the enumerated list. No
4219 % argument is the same as `1'.
4220 %
4223 % If we were given no argument, pretend we were given `1'.
4226 %
4227 % Detect if the argument is a single token. If so, it might be a
4228 % letter. Otherwise, the only valid thing it can be is a number.
4229 % (We will always have one token, because of the test we just made.
4230 % This is a good thing, since \splitoff doesn't work given nothing at
4231 % all -- the first parameter is undelimited.)
4232 \expandafter\splitoff\thearg\endmark
4233 \ifx\rest\empty
4234 % Only one token in the argument. It could still be anything.
4235 % A ``lowercase letter'' is one whose \lccode is nonzero.
4236 % An ``uppercase letter'' is one whose \lccode is both nonzero, and
4237 % not equal to itself.
4238 % Otherwise, we assume it's a number.
4239 %
4240 % We need the \relax at the end of the \ifnum lines to stop TeX from
4241 % continuing to look for a <number>.
4242 %
4245 \else
4246 % It's a letter.
4249 \else
4251 \fi
4252 \fi
4253 \else
4254 % Multiple tokens in the argument. We hope it's a number.
4255 \numericenumerate
4256 \fi
4257 }
4259 % An @enumerate whose labels are integers. The starting integer is
4260 % given in \thearg.
4261 %
4265 }
4267 % The starting (lowercase) letter is in \thearg.
4271 % Be sure we're not beyond the end of the alphabet.
4275 \fi
4276 \char\lccode\itemno
4278 }
4280 % The starting (uppercase) letter is in \thearg.
4284 % Be sure we're not beyond the end of the alphabet.
4287 alphabet}
4288 \fi
4289 \char\uccode\itemno
4291 }
4293 % Call \doitemize, adding a period to the first argument and supplying the
4294 % common last two arguments. Also subtract one from the initial value in
4295 % \itemno, since @item increments \itemno.
4296 %
4300 }
4303 % @multitable macros
4305 % Macros used to set up halign preamble:
4306 %
4307 \let\endsetuptable\relax
4309 \let\columnfractions\relax
4311 \newif\ifsetpercent
4313 % #1 is the @columnfraction, usually a decimal number like .5, but might
4314 % be just 1. We just use it, whatever it is.
4315 %
4319 \setuptable
4320 }
4322 \newcount\colcount
4325 \ifx\firstarg\xendsetuptable
4327 \else
4328 \ifx\firstarg\xcolumnfractions
4329 \global\setpercenttrue
4330 \else
4331 \ifsetpercent
4332 \let\go\pickupwholefraction
4333 \else
4336 % separator; typically that is always in the input, anyway.
4338 \fi
4339 \fi
4340 \ifx\go\pickupwholefraction
4341 % Put the argument back for the \pickupwholefraction call, so
4342 % we'll always have a period there to be parsed.
4344 \else
4347 \fi
4348 \go
4349 }
4351 % @headitem starts a heading row, which we typeset in bold. Assignments
4352 % have to be global since we are inside the implicit group of an
4353 % alignment entry. \everycr below resets \everytab so we don't have to
4354 % undo it ourselves.
4357 \checkenv\multitable
4358 \crcr
4363 %
4364 % default for tables with no headings.
4366 %
4370 %
4372 \vskip\parskip
4373 \startsavinginserts
4374 %
4375 % @item within a multitable starts a normal row.
4376 % We use \def instead of \let so that if one of the multitable entries
4377 % contains an @itemize, we don't choke on the \item (seen as \crcr aka
4378 % \endtemplate) expanding \doitemize.
4380 %
4387 %
4392 %
4393 % Check for saved footnotes, etc.:
4394 \checkinserts
4395 %
4396 % Perhaps a \nobreak, then reset:
4397 \headitemcrhook
4401 %
4402 \parsearg\domultitable
4403 }
4405 % To parse everything between @multitable and @item:
4407 %
4408 % This preamble sets up a generic column definition, which will
4409 % be used as many times as user calls for columns.
4410 % \vtop will set a single line and will also let text wrap and
4411 % continue for many paragraphs if desired.
4414 \strut
4417 % Find the correct column width
4419 %
4423 \else
4424 % In order to keep entries from bumping into each other.
4426 \ifsetpercent \else
4427 % If a template has been used
4429 \fi
4430 \fi
4433 }
4435 \crcr
4437 \global\setpercentfalse
4438 }
4443 % @iftex, @ifnotdocbook, @ifnothtml, @ifnotinfo, @ifnotplaintext,
4444 % @ifnotxml always succeed. They currently do nothing; we don't
4445 % attempt to check whether the conditionals are properly nested. But we
4446 % have to remember that they are conditionals, so that @end doesn't
4447 % attempt to close an environment group.
4448 %
4452 }
4460 % Ignore @ignore, @ifhtml, @ifinfo, and the like.
4461 %
4476 % Ignore text until a line `@end #1', keeping track of nested conditionals.
4477 %
4478 % A count to remember the depth of nesting.
4479 \newcount\doignorecount
4482 % Scan in ``verbatim'' mode:
4483 \obeylines
4487 %
4488 % Make sure that spaces turn into tokens that match what \doignoretext wants.
4489 \spaceisspace
4490 %
4491 % Count number of #1's that we've seen.
4493 %
4494 % Swallow text until we reach the matching `@end #1'.
4496 }
4500 %
4502 % #1 contains the command name as a string, e.g., `ifinfo'.
4503 %
4504 % Define a command to find the next `@end #1'.
4507 %
4508 % And this command to find another #1 command, at the beginning of a
4509 % line. (Otherwise, we would consider a line `@c @ifset', for
4510 % example, to count as an @ifset for nesting.)
4512 %
4513 % And now expand that command.
4516 }
4521 \let\next\doignoretextzzz
4525 % If we're here, #1 ends with ^^M\ifinfo (for example).
4526 \fi
4528 }
4530 % We have to swallow the remaining "\_STOP_".
4531 %
4534 \let\next\enddoignore
4538 \fi
4539 \next
4540 }
4542 % Finish off ignored text.
4544 % Ignore anything after the last `@end #1'; this matters in verbatim
4545 % environments, where otherwise the newline after an ignored conditional
4546 % would result in a blank line in the output.
4548 }
4551 % @set VAR sets the variable VAR to an empty value.
4552 % @set VAR REST-OF-LINE sets VAR to the value REST-OF-LINE.
4553 %
4554 % Since we want to separate VAR from REST-OF-LINE (which might be
4555 % empty), we can't just use \parsearg; we have to insert a space of our
4556 % own to delimit the rest of the line, and then take it out again if we
4557 % didn't need it.
4558 % We rely on the fact that \parsearg sets \catcode`\ =10.
4559 %
4563 \makevalueexpandable
4566 \ifx\temp\empty
4568 \else
4570 \fi
4572 }
4573 % Remove the trailing space \setxxx inserted.
4576 % @clear VAR clears (i.e., unsets) the variable VAR.
4577 %
4580 \makevalueexpandable
4583 }
4585 % @value{foo} gets the text saved in variable foo.
4588 {
4590 %
4593 % We don't want these characters active, ...
4595 % ..., but we might end up with active ones in the argument if
4596 % we're called from @code, as @code{@value{foo-bar_}}, though.
4597 % So \let them to their normal equivalents.
4599 }
4600 }
4606 \else
4608 \fi
4609 }
4611 % Like \expandablevalue, but completely expandable (the \message in the
4612 % definition above operates at the execution level of TeX). Used when
4613 % writing to auxiliary files, due to the expansion that \write does.
4614 % If flag is undefined, pass through an unexpanded @value command: maybe it
4615 % will be set by the time it is read back in.
4616 %
4617 % NB flag names containing - or _ may not work here.
4621 \else
4623 \fi
4624 }
4626 % Used for @value's in index entries to form the sort key: expand the @value
4627 % if possible, otherwise sort late.
4630 ZZZZZZZ%
4631 \else
4633 \fi
4634 }
4636 % @ifset VAR ... @end ifset reads the `...' iff VAR has been defined
4637 % with @set.
4638 %
4639 % To get the special treatment we need for `@end ifset,' we call
4640 % \makecond and then redefine.
4641 %
4646 \makevalueexpandable
4650 \fi
4651 \expandafter
4653 }
4656 % @ifclear VAR ... @end executes the `...' iff VAR has never been
4657 % defined with @set, or has been undefined with @clear.
4658 %
4659 % The `\else' inside the `\doifset' parameter is a trick to reuse the
4660 % above code: if the variable is not set, do nothing, if it is set,
4661 % then redefine \next to \ifclearfail.
4662 %
4667 % @ifcommandisdefined CMD ... @end executes the `...' if CMD (written
4668 % without the @) is in fact defined. We can only feasibly check at the
4669 % TeX level, so something like `mathcode' is going to considered
4670 % defined even though it is not a Texinfo command.
4671 %
4674 %
4676 \makevalueexpandable
4680 \fi
4681 \expandafter
4683 }
4686 % @ifcommandnotdefined CMD ... handled similar to @ifclear above.
4692 % Set the `txicommandconditionals' variable, so documents have a way to
4693 % test if the @ifcommand...defined conditionals are available.
4694 \set txicommandconditionals
4696 % @dircategory CATEGORY -- specify a category of the dir file
4697 % which this file should belong to. Ignore this in TeX.
4700 % @defininfoenclose.
4705 % Index generation facilities
4707 % Define \newwrite to be identical to plain tex's \newwrite
4708 % except not \outer, so it can be used within macros and \if's.
4711 % \newindex {foo} defines an index named IX.
4712 % It automatically defines \IXindex such that
4713 % \IXindex ...rest of line... puts an entry in the index IX.
4714 % It also defines \IXindfile to be the number of the output channel for
4715 % the file that accumulates this index. The file's extension is IX.
4716 % The name of an index should be no more than 2 characters long
4717 % for the sake of vms.
4718 %
4723 }
4725 % @defindex foo == \newindex{foo}
4726 %
4729 % Define @defcodeindex, like @defindex except put all entries in @code.
4730 %
4732 %
4737 }
4739 % The default indices:
4748 % @synindex foo bar makes index foo feed into index bar.
4749 % Do this instead of @defindex foo if you don't want it as a separate index.
4750 %
4751 % @syncodeindex foo bar similar, but put all entries made for index foo
4752 % inside @code.
4753 %
4757 % #1 is \doindex or \docodeindex, #2 the index getting redefined (foo),
4758 % #3 the target index (bar).
4761 % redefine \fooindfile:
4764 % redefine \fooindex:
4766 }
4768 % Define \doindex, the driver for all index macros.
4769 % Argument #1 is generated by the calling \fooindex macro,
4770 % and it is the two-letter name of the index.
4775 % like the previous two, but they put @code around the argument.
4779 \f
4780 % Used for the aux, toc and index files to prevent expansion of Texinfo
4781 % commands.
4782 %
4789 %
4790 % Do the redefinitions.
4791 \definedummies
4792 \otherbackslash
4793 }
4795 % \definedummyword defines \#1 as \string\#1\space, thus effectively
4796 % preventing its expansion. This is used only for control words,
4797 % not control letters, because the \space would be incorrect for
4798 % control characters, but is needed to separate the control word
4799 % from whatever follows.
4800 %
4801 % These can be used both for control words that take an argument and
4802 % those that do not. If it is followed by {arg} in the input, then
4803 % that will dutifully get written to the index (or wherever).
4804 %
4805 % For control letters, we have \definedummyletter, which omits the
4806 % space.
4807 %
4810 \let\definedummyaccent\definedummyletter
4812 % Called from \atdummies to prevent the expansion of commands.
4813 %
4815 %
4816 \let\commondummyword\definedummyword
4817 \let\commondummyletter\definedummyletter
4818 \let\commondummyaccent\definedummyaccent
4819 \commondummiesnofonts
4820 %
4823 %
4824 % Non-English letters.
4825 \definedummyword\AA
4826 \definedummyword\AE
4827 \definedummyword\DH
4828 \definedummyword\L
4829 \definedummyword\O
4830 \definedummyword\OE
4831 \definedummyword\TH
4832 \definedummyword\aa
4833 \definedummyword\ae
4834 \definedummyword\dh
4835 \definedummyword\exclamdown
4836 \definedummyword\l
4837 \definedummyword\o
4838 \definedummyword\oe
4839 \definedummyword\ordf
4840 \definedummyword\ordm
4841 \definedummyword\questiondown
4842 \definedummyword\ss
4843 \definedummyword\th
4844 %
4845 % Although these internal commands shouldn't show up, sometimes they do.
4846 \definedummyword\bf
4847 \definedummyword\gtr
4848 \definedummyword\hat
4849 \definedummyword\less
4850 \definedummyword\sf
4851 \definedummyword\sl
4852 \definedummyword\tclose
4853 \definedummyword\tt
4854 %
4855 \definedummyword\LaTeX
4856 \definedummyword\TeX
4857 %
4858 % Assorted special characters.
4859 \definedummyword\ampchar
4860 \definedummyword\atchar
4861 \definedummyword\arrow
4862 \definedummyword\backslashchar
4863 \definedummyword\bullet
4864 \definedummyword\comma
4865 \definedummyword\copyright
4866 \definedummyword\registeredsymbol
4867 \definedummyword\dots
4868 \definedummyword\enddots
4869 \definedummyword\entrybreak
4870 \definedummyword\equiv
4871 \definedummyword\error
4872 \definedummyword\euro
4873 \definedummyword\expansion
4874 \definedummyword\geq
4875 \definedummyword\guillemetleft
4876 \definedummyword\guillemetright
4877 \definedummyword\guilsinglleft
4878 \definedummyword\guilsinglright
4879 \definedummyword\lbracechar
4880 \definedummyword\leq
4881 \definedummyword\mathopsup
4882 \definedummyword\minus
4883 \definedummyword\ogonek
4884 \definedummyword\pounds
4885 \definedummyword\point
4886 \definedummyword\print
4887 \definedummyword\quotedblbase
4888 \definedummyword\quotedblleft
4889 \definedummyword\quotedblright
4890 \definedummyword\quoteleft
4891 \definedummyword\quoteright
4892 \definedummyword\quotesinglbase
4893 \definedummyword\rbracechar
4894 \definedummyword\result
4895 \definedummyword\sub
4896 \definedummyword\sup
4897 \definedummyword\textdegree
4898 %
4899 \definedummyword\subentry
4900 %
4901 % We want to disable all macros so that they are not expanded by \write.
4902 \macrolist
4903 \let\value\dummyvalue
4904 %
4905 \normalturnoffactive
4906 }
4908 % \commondummiesnofonts: common to \definedummies and \indexnofonts.
4909 % Define \commondummyletter, \commondummyaccent and \commondummyword before
4910 % using. Used for accents, font commands, and various control letters.
4911 %
4913 % Control letters and accents.
4927 \commondummyword\u
4928 \commondummyword\v
4929 \commondummyword\H
4930 \commondummyword\dotaccent
4931 \commondummyword\ogonek
4932 \commondummyword\ringaccent
4933 \commondummyword\tieaccent
4934 \commondummyword\ubaraccent
4935 \commondummyword\udotaccent
4936 \commondummyword\dotless
4937 %
4938 % Texinfo font commands.
4939 \commondummyword\b
4940 \commondummyword\i
4941 \commondummyword\r
4942 \commondummyword\sansserif
4943 \commondummyword\sc
4944 \commondummyword\slanted
4945 \commondummyword\t
4946 %
4947 % Commands that take arguments.
4948 \commondummyword\abbr
4949 \commondummyword\acronym
4950 \commondummyword\anchor
4951 \commondummyword\cite
4952 \commondummyword\code
4953 \commondummyword\command
4954 \commondummyword\dfn
4955 \commondummyword\dmn
4956 \commondummyword\email
4957 \commondummyword\emph
4958 \commondummyword\env
4959 \commondummyword\file
4960 \commondummyword\image
4961 \commondummyword\indicateurl
4962 \commondummyword\inforef
4963 \commondummyword\kbd
4964 \commondummyword\key
4965 \commondummyword\math
4966 \commondummyword\option
4967 \commondummyword\pxref
4968 \commondummyword\ref
4969 \commondummyword\samp
4970 \commondummyword\strong
4971 \commondummyword\tie
4972 \commondummyword\U
4973 \commondummyword\uref
4974 \commondummyword\url
4975 \commondummyword\var
4976 \commondummyword\verb
4977 \commondummyword\w
4978 \commondummyword\xref
4979 }
4981 \let\indexlbrace\relax
4982 \let\indexrbrace\relax
4983 \let\indexatchar\relax
4984 \let\indexbackslash\relax
4989 }
4991 {
4997 % @set txiindexlquoteignore makes us ignore left quotes in the sort term.
4998 % (Introduced for FSFS 2nd ed.)
5000 \fi
5001 %
5003 \backslashdisappear
5004 \fi
5005 %
5008 \fi
5011 \fi
5014 \fi
5015 }
5020 }
5021 }
5024 % \indexnofonts is used when outputting the strings to sort the index
5025 % by, and when constructing control sequence names. It eliminates all
5026 % control sequences and just writes whatever the best ASCII sort string
5027 % would be for a given command (usually its argument).
5028 %
5030 % Accent commands should become @asis.
5032 % We can just ignore other control letters.
5034 % All control words become @asis by default; overrides below.
5035 \let\commondummyword\commondummyaccent
5036 \commondummiesnofonts
5037 %
5038 % Don't no-op \tt, since it isn't a user-level command
5039 % and is used in the definitions of the active chars like <, >, |, etc.
5040 % Likewise with the other plain tex font commands.
5041 %\let\tt=\asis
5042 %
5047 %
5052 %
5053 % Non-English letters.
5073 %
5074 \let\do\indexnofontsdef
5075 %
5078 %
5079 % Assorted special characters.
5112 %
5113 % We need to get rid of all macros, leaving only the arguments (if present).
5114 % Of course this is not nearly correct, but it is the best we can do for now.
5115 % makeinfo does not expand macros in the argument to @deffn, which ends up
5116 % writing an index entry, and texindex isn't prepared for an index sort entry
5117 % that starts with \.
5118 %
5119 % Since macro invocations are followed by braces, we can just redefine them
5120 % to take a single TeX argument. The case of a macro invocation that
5121 % goes to end-of-line is not handled.
5122 %
5123 \macrolist
5124 \let\value\indexnofontsvalue
5125 }
5127 % Give the control sequence a definition that removes the {} that follows
5128 % its use, e.g. @AA{} -> AA
5131 \f
5134 % #1 is the index name, #2 is the entry text.
5136 \iflinks
5138 %
5141 %
5143 \safewhatsit\doindwrite
5145 \fi
5146 }
5148 % Same as \doind, but for code indices
5150 \iflinks
5152 %
5155 %
5157 \safewhatsit\docindwrite
5159 \fi
5160 }
5162 % Check if an index file has been opened, and if not, open it.
5167 % A .fls suffix would conflict with the file extension for the output
5168 % of -recorder, so use .f1s instead.
5170 % Open the file
5172 % Using \immediate above here prevents an object entering into the current
5173 % box, which could confound checks such as those in \safewhatsit for
5174 % preceding skips.
5179 % Definition for writing index entry sort key.
5180 {
5183 \begingroup
5184 \indexnonalnumreappear
5188 }
5192 }
5195 }
5197 % The default definitions
5204 % Given index entry text like "aaa @subentry bbb @sortas{ZZZ}":
5205 % * Set \bracedtext to "{aaa}{bbb}"
5206 % * Set \fullindexsortkey to "aaa @subentry ZZZ"
5207 % * If @seealso occurs, set \pagenumbertext
5208 %
5216 }
5218 % append the results from the next segment
5221 \ifx\segment\isfinish
5222 \else
5223 %
5224 % Fully expand the segment, throwing away any @sortas directives, and
5225 % trim spaces.
5228 \ifincodeindex
5230 \fi
5231 %
5233 %
5234 % Get the string to sort by. Process the segment with all
5235 % font commands turned off.
5236 \bgroup
5237 \let\sortas\indexwritesortas
5238 \let\seealso\indexwriteseealso
5239 \let\seeentry\indexwriteseeentry
5240 \indexnofonts
5241 % The braces around the commands are recognized by texindex.
5250 %
5251 \let\indexsortkey\empty
5252 \global\let\pagenumbertext\empty
5253 % Execute the segment and throw away the typeset output. This executes
5254 % any @sortas or @seealso commands in this segment.
5257 \indexnonalnumdisappear
5263 %
5264 % Append to \fullindexsortkey.
5267 \tmp
5268 \egroup
5270 %
5271 \expandafter\doindexsegment
5272 \fi
5273 }
5277 \let\subentry\relax
5279 % Use \ instead of @ in index files. To support old texi2dvi and texindex.
5280 % This works without changing the escape character used in the toc or aux
5281 % files because the index entries are fully expanded here, and \string uses
5282 % the current value of \escapechar.
5285 % Use \ in index files by default. texi2dvi didn't support @ as the escape
5286 % character (as it checked for "\entry" in the files, and not "@entry"). When
5287 % the new version of texi2dvi has had a chance to become more prevalent, then
5288 % the escape character can change back to @ again. This should be an easy
5289 % change to make now because both @ and \ are only used as escape characters in
5290 % index files, never standing for themselves.
5291 %
5292 \set txiindexescapeisbackslash
5294 % Write the entry in \indextext to the index file.
5295 %
5297 \newif\ifincodeindex
5302 \maybemarginindex
5303 %
5304 \atdummies
5305 %
5307 \escapeisbackslash
5308 \fi
5309 %
5310 % For texindex which always views { and } as separators.
5314 %
5315 % Split the entry into primary entry and any subentries, and get the index
5316 % sort key.
5317 \splitindexentry\indextext
5318 %
5319 % Set up the complete index entry, with both the sort key and
5320 % the original text, including any font commands. We write
5321 % three arguments to \entry to the .?? file (four in the
5322 % subentry case), texindex reduces to two when writing the .??s
5323 % sorted result.
5324 %
5331 \temp
5332 }
5334 % Put the index entry in the margin if desired (undocumented).
5336 \ifx\SETmarginindex\relax\else
5338 \fi
5339 }
5343 % Take care of unwanted page breaks/skips around a whatsit:
5344 %
5345 % If a skip is the last thing on the list now, preserve it
5346 % by backing up by \lastskip, doing the \write, then inserting
5347 % the skip again. Otherwise, the whatsit generated by the
5348 % \write or \pdfdest will make \lastskip zero. The result is that
5349 % sequences like this:
5350 % @end defun
5351 % @tindex whatever
5352 % @defun ...
5353 % will have extra space inserted, because the \medbreak in the
5354 % start of the @defun won't see the skip inserted by the @end of
5355 % the previous defun.
5356 %
5357 % But don't do any of this if we're not in vertical mode. We
5358 % don't want to do a \vskip and prematurely end a paragraph.
5359 %
5360 % Avoid page breaks due to these extra skips, too.
5361 %
5362 % But wait, there is a catch there:
5363 % We'll have to check whether \lastskip is zero skip. \ifdim is not
5364 % sufficient for this purpose, as it ignores stretch and shrink parts
5365 % of the skip. The only way seems to be to check the textual
5366 % representation of the skip.
5367 %
5368 % The following is almost like \def\zeroskipmacro{0.0pt} except that
5369 % the ``p'' and ``t'' characters have catcode \other, not 11 (letter).
5370 %
5372 %
5373 \newskip\whatsitskip
5374 \newcount\whatsitpenalty
5375 %
5376 % ..., ready, GO:
5377 %
5380 \else
5381 % \lastskip and \lastpenalty cannot both be nonzero simultaneously.
5385 %
5386 % If \lastskip is nonzero, that means the last item was a
5387 % skip. And since a skip is discardable, that means this
5388 % -\whatsitskip glue we're inserting is preceded by a
5389 % non-discardable item, therefore it is not a potential
5390 % breakpoint, therefore no \nobreak needed.
5391 \ifx\lastskipmacro\zeroskipmacro
5392 \else
5394 \fi
5395 %
5397 %
5398 \ifx\lastskipmacro\zeroskipmacro
5399 % If \lastskip was zero, perhaps the last item was a penalty, and
5400 % perhaps it was >=10000, e.g., a \nobreak. In that case, we want
5401 % to re-insert the same penalty (values >10000 are used for various
5402 % signals); since we just inserted a non-discardable item, any
5403 % following glue (such as a \parskip) would be a breakpoint. For example:
5404 % @deffn deffn-whatever
5405 % @vindex index-whatever
5406 % Description.
5407 % would allow a break between the index-whatever whatsit
5408 % and the "Description." paragraph.
5410 \else
5411 % On the other hand, if we had a nonzero \lastskip,
5412 % this make-up glue would be preceded by a non-discardable item
5413 % (the whatsit from the \write), so we must insert a \nobreak.
5414 \nobreak\vskip\whatsitskip
5415 \fi
5418 % The index entry written in the file actually looks like
5419 % \entry {sortstring}{page}{topic}
5420 % or
5421 % \entry {sortstring}{page}{topic}{subtopic}
5422 % The texindex program reads in these files and writes files
5423 % containing these kinds of lines:
5424 % \initial {c}
5425 % before the first topic whose initial is c
5426 % \entry {topic}{pagelist}
5427 % for a topic that is used without subtopics
5428 % \primary {topic}
5429 % \entry {topic}{}
5430 % for the beginning of a topic that is used with subtopics
5431 % \secondary {subtopic}{pagelist}
5432 % for each subtopic.
5433 % \secondary {subtopic}{}
5434 % for a subtopic with sub-subtopics
5435 % \tertiary {subtopic}{subsubtopic}{pagelist}
5436 % for each sub-subtopic.
5438 % Define the user-accessible indexing commands
5439 % @findex, @vindex, @kindex, @cindex.
5448 % Define the macros used in formatting output of the sorted index material.
5450 % @printindex causes a particular index (the ??s file) to get printed.
5451 % It does not print any chapter heading (usually an @unnumbered).
5452 %
5455 %
5456 \smallfonts \rm
5458 \plainfrenchspacing
5460 %
5461 % See comment in \requireopenindexfile.
5463 %
5464 % See if the index file exists and is nonempty.
5467 % \enddoublecolumns gets confused if there is no text in the index,
5468 % and it loses the chapter title and the aux file entries for the
5469 % index. The easiest way to prevent this problem is to make sure
5470 % there is some text.
5471 \putwordIndexNonexistent
5473 \else
5474 % If the index file exists but is empty, then \openin leaves \ifeof
5475 % false. We have to make TeX try to read something from the file, so
5476 % it can discover if there is anything in it.
5479 \putwordIndexIsEmpty
5480 \else
5482 \fi
5483 \fi
5487 % If the index file starts with a backslash, forgo reading the index
5488 % file altogether. If somebody upgrades texinfo.tex they may still have
5489 % old index files using \ as the escape character. Reading this would
5490 % at best lead to typesetting garbage, at worst a TeX syntax error.
5496 ERROR: A sorted index file in an obsolete format was skipped.
5497 To fix this problem, please upgrade your version of 'texi2dvi'
5498 or 'texi2pdf' to that at <https://ftp.gnu.org/gnu/texinfo>.
5499 If you are using an old version of 'texindex' (part of the Texinfo
5500 distribution), you may also need to upgrade to a newer version (at least 6.0).
5501 You may be able to typeset the index if you run
5503 You could also try setting the 'txiindexescapeisbackslash' flag by
5504 running a command like
5505 'texi2dvi -t "@set txiindexescapeisbackslash" \jobname.texi'. If you do
5506 this, Texinfo will try to use index files in the old format.
5507 If you continue to have problems, deleting the index files and starting again
5510 \else
5511 (Skipped sorted index file in obsolete format)
5512 \fi
5513 \else
5514 \begindoublecolumns
5516 \enddoublecolumns
5517 \fi
5518 \else
5519 \begindoublecolumns
5521 %
5522 % Make @ an escape character to give macros a chance to work. This
5523 % should work because we (hopefully) don't otherwise use @ in index files.
5524 %\catcode`\@=12\relax
5527 \enddoublecolumns
5528 \fi
5529 }
5531 % These macros are used by the sorted index file itself.
5532 % Change them to control the appearance of the index.
5538 % special control sequences used in the index sort key
5543 %
5544 % Some changes for non-alphabetic characters. Using the glyphs from the
5545 % math fonts looks more consistent than the typewriter font used elsewhere
5546 % for these characters.
5548 %
5549 % In case @\ is used for backslash
5551 % Can't get bold backslash so don't use bold forward slash
5563 }}
5566 \bgroup
5567 \initialglyphs
5568 \initialx
5569 }
5572 % Remove any glue we may have, we'll be inserting our own.
5573 \removelastskip
5574 %
5575 % We like breaks before the index initials, so insert a bonus.
5576 % The glue before the bonus allows a little bit of space at the
5577 % bottom of a column to reduce an increase in inter-line spacing.
5578 \nobreak
5582 %
5583 % Typeset the initial. Making this add up to a whole number of
5584 % baselineskips increases the chance of the dots lining up from column
5585 % to column. It still won't often be perfect, because of the stretch
5586 % we need before each entry, but it's better.
5587 %
5588 % No shrink because it confuses \balancecolumns.
5591 % \secfonts is inside the argument of \leftline so that the change of
5592 % \baselineskip will not affect any glue inserted before the vbox that
5593 % \leftline creates.
5594 % Do our best not to break after the initial.
5595 \nobreak
5598 }
5600 \newdimen\entryrightmargin
5603 % \entry typesets a paragraph consisting of the text (#1), dot leaders, and
5604 % then page number (#2) flushed to the right margin. It is used for index
5605 % and table of contents entries. The paragraph is indented by \leftskip.
5606 %
5608 \begingroup
5609 %
5610 % Start a new paragraph if necessary, so our assignments below can't
5611 % affect previous text.
5612 \par
5613 %
5614 % No extra space above this paragraph.
5616 %
5617 % When reading the text of entry, convert explicit line breaks
5618 % from @* into spaces. The user might give these in long section
5619 % titles, for instance.
5622 %
5623 % Swallow the left brace of the text (first parameter):
5624 \afterassignment\doentry
5625 \let\temp =
5626 }
5629 % Save the text of the entry
5632 \noindent
5633 \aftergroup\finishentry
5634 % And now comes the text of the entry.
5635 % Not absorbing as a macro argument reduces the chance of problems
5636 % with catcodes occurring.
5637 }
5643 \unhbox\boxA
5644 % #1 is the page number.
5645 %
5646 % Get the width of the page numbers, and only use
5647 % leaders if they are present.
5651 \else
5652 %
5654 %
5655 \ifpdforxetex
5657 \hskip\skip\thinshrinkable\the\toksA
5658 \else
5660 \fi
5661 \fi
5664 \noindent\unhbox\boxA\par
5665 \nobreak
5666 \else\bgroup
5667 % We want the text of the entries to be aligned to the left, and the
5668 % page numbers to be aligned to the right.
5669 %
5675 % Cause last line, which could consist of page numbers on their own
5676 % if the list of page numbers is long, to be aligned to the right.
5678 %
5680 % Determine how far we can stretch into the margin.
5681 % This allows, e.g., "Appendix H GNU Free Documentation License" to
5682 % fit on one line in @letterpaper format.
5685 \else
5687 \fi
5689 %
5696 % Try to split the text roughly evenly. \dimen@ will be the length of
5697 % the first line.
5701 % If the entry is too long (for example, if it needs more than
5702 % two lines), use all the space in the first line.
5704 \fi
5708 % Ideally we'd add a finite glue at the end of the first line only,
5709 % instead of using \parshape with explicit line lengths, but TeX
5710 % doesn't seem to provide a way to do such a thing.
5711 %
5712 % Indent all lines but the first one.
5715 \fi\fi
5717 \unhbox\boxA
5718 %
5719 % Do not prefer a separate line ending with a hyphen to fewer lines.
5721 %
5722 % Word spacing - no stretch
5724 %
5727 %
5730 \fi
5731 \endgroup
5732 }}
5734 \newskip\thinshrinkable
5737 % Like plain.tex's \dotfill, except uses up at least 1 em.
5738 % The filll stretch here overpowers both the fil and fill stretch to push
5739 % the page number to the right.
5750 \bgroup
5753 \egroup
5754 }
5756 % Define two-column mode, which we use to typeset indexes.
5757 % Adapted from the TeXbook, page 416, which is to say,
5758 % the manmac.tex format used to print the TeXbook itself.
5761 \newbox\partialpage
5762 \newdimen\doublecolumnhsize
5765 % If not much space left on page, start a new page.
5767 %
5768 % Grab any single-column material above us.
5770 \savetopmark
5771 %
5773 % Unvbox the main output page.
5774 \unvbox\PAGE
5779 %
5780 % Use the double-column output routine for subsequent pages.
5782 %
5783 % Change the page size parameters. We could do this once outside this
5784 % routine, in each of @smallbook, @afourpaper, and the default 8.5x11
5785 % format, but then we repeat the same computation. Repeating a couple
5786 % of assignments once per index is clearly meaningless for the
5787 % execution time, so we may as well do it in one place.
5788 %
5789 % First we halve the line length, less a little for the gutter between
5790 % the columns. We compute the gutter based on the line length, so it
5791 % changes automatically with the paper format. The magic constant
5792 % below is chosen so that the gutter has the same value (well, +-<1pt)
5793 % as it did when we hard-coded it.
5794 %
5795 % We put the result in a separate register, \doublecolumhsize, so we
5796 % can restore it in \pagesofar, after \hsize itself has (potentially)
5797 % been clobbered.
5798 %
5803 %
5804 % Get the available space for the double columns -- the normal
5805 % (undoubled) page height minus any material left over from the
5806 % previous page.
5809 %
5810 % For the benefit of balancing columns
5812 }
5814 % The double-column output routine for all double-column pages except
5815 % the last, which is done by \balancecolumns.
5816 %
5818 %
5819 \savetopmark
5823 %
5824 % box0 will be the left-hand column, box2 the right.
5828 \unvbox\PAGE
5829 \penalty\outputpenalty
5830 }
5831 %
5832 % Re-output the contents of the output page -- any previous material,
5833 % followed by the two boxes we just split, in box0 and box2.
5835 \unvbox\partialpage
5836 %
5840 }
5843 % Finished with double columns.
5845 % The following penalty ensures that the page builder is exercised
5846 % _before_ we change the output routine. This is necessary in the
5847 % following situation:
5848 %
5849 % The last section of the index consists only of a single entry.
5850 % Before this section, \pagetotal is less than \pagegoal, so no
5851 % break occurs before the last section starts. However, the last
5852 % section, consisting of \initial and the single \entry, does not
5853 % fit on the page and has to be broken off. Without the following
5854 % penalty the page builder will not be exercised until \eject
5855 % below, and by that time we'll already have changed the output
5856 % routine to the \balancecolumns version, so the next-to-last
5857 % double-column page will be processed with \balancecolumns, which
5858 % is wrong: The two columns will go to the main vertical list, with
5859 % the broken-off section in the recent contributions. As soon as
5860 % the output routine finishes, TeX starts reconsidering the page
5861 % break. The two columns and the broken-off section both fit on the
5862 % page, because the two columns now take up only half of the page
5863 % goal. When TeX sees \eject from below which follows the final
5864 % section, it invokes the new output routine that we've set after
5865 % \balancecolumns below; \onepageout will try to fit the two columns
5866 % and the final section into the vbox of \txipageheight (see
5867 % \pagebody), causing an overfull box.
5868 %
5869 % Note that glue won't work here, because glue does not exercise the
5870 % page builder, unlike penalties (see The TeXbook, pp. 280-281).
5871 \penalty0
5872 %
5874 % Split the last of the double-column material.
5875 \savetopmark
5876 \balancecolumns
5880 % Having called \balancecolumns once, we do not
5881 % want to call it again. Therefore, reset \output to its normal
5882 % definition right away.
5884 %
5886 % Leave the double-column material on the current page, no automatic
5887 % page break.
5888 \box\balancedcolumns
5889 %
5890 % \pagegoal was set to the doubled \vsize above, since we restarted
5891 % the current page. We're now back to normal single-column
5892 % typesetting, so reset \pagegoal to the normal \vsize.
5895 \else
5896 % We had some left-over material. This might happen when \doublecolumnout
5897 % is called in \balancecolumns. Try again.
5898 \expandafter\enddoublecolumns
5899 \fi
5900 }
5901 \newbox\balancedcolumns
5903 %
5904 % Only called for the last of the double column material. \doublecolumnout
5905 % does the others.
5910 % Don't split a short final column in two.
5913 \else
5914 % double the leading vertical space
5920 % Loop until left column is at least as high as the right column.
5923 \loop
5928 \repeat
5930 % Now the left column is in box 1, and the right column in box 3.
5931 %
5932 % Check whether the left column has come out higher than the page itself.
5933 % (Note that we have doubled \vsize for the double columns, so
5934 % the actual height of the page is 0.5\vsize).
5936 % It appears that we have been called upon to balance too much material.
5937 % Output some of it with \doublecolumnout, leaving the rest on the page.
5939 \doublecolumnout
5940 \else
5941 % Compare the heights of the two columns.
5943 % Column heights are too different, so don't make their bottoms
5944 % flush with each other.
5947 \else
5948 % Make column bottoms flush with each other.
5951 \fi
5953 \fi
5954 \fi
5955 %
5956 }
5961 % Chapters, sections, etc.
5963 % Let's start with @part.
5966 \chapoddpage
5967 \null
5969 \begingroup
5974 % This outputs a mark at the end of the page that clears \thischapter
5975 % and \thissection, as is done in \startcontents.
5976 \let\pchapsepmacro\relax
5978 \chapoddpage
5979 \endgroup
5980 }
5982 % \unnumberedno is an oxymoron. But we count the unnumbered
5983 % sections so that we can refer to them unambiguously in the pdf
5984 % outlines by their "section number". We avoid collisions with chapter
5985 % numbers by starting them at 10000. (If a document ever has 10000
5986 % chapters, we're in trouble anyway, I'm sure.)
5988 \newcount\chapno
5993 % This counter is funny since it counts through charcodes of letters A, B, ...
5994 \newcount\appendixno \appendixno = `\@
5995 %
5996 % \def\appendixletter{\char\the\appendixno}
5997 % We do the following ugly conditional instead of the above simple
5998 % construct for the sake of pdftex, which needs the actual
5999 % letter in the expansion, not just typeset.
6000 %
6028 % The \the is necessary, despite appearances, because \appendixletter is
6029 % expanded while writing the .toc file. \char\appendixno is not
6030 % expandable, thus it is written literally, thus all appendixes come out
6031 % with the same letter (or @) in the toc without it.
6032 \else\char\the\appendixno
6033 \fi\fi\fi\fi\fi\fi\fi\fi\fi\fi\fi\fi\fi
6036 % Each @chapter defines these (using marks) as the number+name, number
6037 % and name of the chapter. Page headings and footings can use
6038 % these. @section does likewise.
6049 % @raisesections: treat @section as chapter, @subsection as section, etc.
6052 % @lowersections: treat @chapter as section, @section as subsection, etc.
6055 % we only have subsub.
6057 %
6058 % A numbered section within an unnumbered changes to unnumbered too.
6059 % To achieve this, remember the "biggest" unnum. sec. we are currently in:
6061 %
6062 % Trace whether the current chapter is an appendix or not:
6063 % \chapheadtype is "N" or "A", unnumbered chapters are ignored.
6066 % Choose a heading macro
6067 % #1 is heading type
6068 % #2 is heading level
6069 % #3 is text for heading
6071 % Compute the abs. sec. level:
6074 % Make sure \absseclevel doesn't fall outside the range:
6077 \else
6080 \fi
6081 \fi
6082 % The heading type:
6087 \fi
6088 \else
6089 % Check for appendix sections:
6092 \else
6095 \fi\fi
6096 \fi
6097 % Check for numbered within unnumbered:
6100 \else
6102 \fi
6103 \fi
6104 % Now print the heading:
6106 \ifcase\absseclevel
6111 \fi
6112 \else
6114 \ifcase\absseclevel
6119 \fi
6120 \else
6121 \ifcase\absseclevel
6126 \fi
6127 \fi
6128 \fi
6129 \suppressfirstparagraphindent
6130 }
6132 % an interface:
6137 % @chapter, @appendix, @unnumbered. Increment top-level counter, reset
6138 % all lower-level sectioning counters to zero.
6139 %
6140 % Also set \chaplevelprefix, which we prepend to @float sequence numbers
6141 % (e.g., figures), q.v. By default (before any chapter), that is empty.
6143 %
6146 % section resetting is \global in case the chapter is in a group, such
6147 % as an @include file.
6150 %
6151 % Used for \float.
6153 \resetallfloatnos
6154 %
6155 % \putwordChapter can contain complex things in translations.
6158 %
6159 % Write the actual heading.
6161 %
6162 % So @section and the like are numbered underneath this chapter.
6166 }
6169 %
6174 \resetallfloatnos
6175 %
6176 % \putwordAppendix can contain complex things in translations.
6179 %
6181 %
6185 }
6187 % normally unnmhead0 calls unnumberedzzz:
6192 %
6193 % Since an unnumbered has no number, no prefix for figures.
6195 \resetallfloatnos
6196 %
6197 % This used to be simply \message{#1}, but TeX fully expands the
6198 % argument to \message. Therefore, if #1 contained @-commands, TeX
6199 % expanded them. For example, in `@unnumbered The @cite{Book}', TeX
6200 % expanded @cite (which turns out to cause errors because \cite is meant
6201 % to be executed, not expanded).
6202 %
6203 % Anyway, we don't want the fully-expanded definition of @cite to appear
6204 % as a result of the \message, we just want `@cite' itself. We use
6205 % \the<toks register> to achieve this: TeX expands \the<toks> only once,
6206 % simply yielding the contents of <toks register>. (We also do this for
6207 % the toc entries.)
6210 %
6212 %
6216 }
6218 % @centerchap is like @unnumbered, but the heading is centered.
6223 }
6225 % @top is like @unnumbered.
6226 \let\top\unnumbered
6228 % Sections.
6229 %
6234 }
6236 % normally calls appendixsectionzzz:
6241 }
6242 \let\appendixsec\appendixsection
6244 % normally calls unnumberedseczzz:
6249 }
6251 % Subsections.
6252 %
6253 % normally calls numberedsubseczzz:
6258 }
6260 % normally calls appendixsubseczzz:
6266 }
6268 % normally calls unnumberedsubseczzz:
6274 }
6276 % Subsubsections.
6277 %
6278 % normally numberedsubsubseczzz:
6284 }
6286 % normally appendixsubsubseczzz:
6292 }
6294 % normally unnumberedsubsubseczzz:
6300 }
6302 % These macros control what the section commands do, according
6303 % to what kind of chapter we are in (ordinary, appendix, or unnumbered).
6304 % Define them by default for a numbered chapter.
6309 % Define @majorheading, @heading and @subheading
6313 \parsearg\chapheadingzzz
6314 }
6319 \nobreak\bigskip \nobreak
6320 \suppressfirstparagraphindent
6321 }
6323 % @heading, @subheading, @subsubheading.
6331 % These macros generate a chapter, section, etc. heading only
6332 % (including whitespace, linebreaking, etc. around it),
6333 % given all the information in convenient, parsed form.
6335 % Args are the skip and penalty (usually negative)
6338 % Parameter controlling skip before chapter headings (if needed)
6339 \newskip\chapheadingskip
6341 % Define plain chapter starts, and page on/off switching for it.
6344 % Start a new page
6347 % \chapoddpage - start on an odd page for a new chapter
6348 % Because \domark is called before \chapoddpage, the filler page will
6349 % get the headings for the next chapter, which is wrong. But we don't
6350 % care -- we just disable all headings on the filler page.
6352 \chappager
6353 \ifodd\pageno \else
6354 \begingroup
6355 \headingsoff
6356 \null
6357 \chappager
6358 \endgroup
6359 \fi
6360 }
6379 \CHAPPAGon
6381 % \chapmacro - Chapter opening.
6382 %
6383 % #1 is the text, #2 is the section type (Ynumbered, Ynothing,
6384 % Yappendix, Yomitfromtoc), #3 the chapter number.
6385 % Not used for @heading series.
6386 %
6387 % To test against our argument.
6391 %
6393 \expandafter\ifx\thisenv\titlepage\else
6395 \fi
6396 % Insert the first mark before the heading break (see notes for \domark).
6401 %
6403 \ifx\temptype\Ynothingkeyword
6406 \else\ifx\temptype\Yomitfromtockeyword
6409 \else\ifx\temptype\Yappendixkeyword
6414 % \noexpand\putwordAppendix avoids expanding indigestible
6415 % commands in some of the translations.
6417 \noexpand\thischapternum:
6420 \else
6425 % \noexpand\putwordChapter avoids expanding indigestible
6426 % commands in some of the translations.
6428 \noexpand\thischapternum:
6431 \fi\fi\fi
6432 %
6433 % Output the mark. Pass it through \safewhatsit, to take care of
6434 % the preceding space.
6435 \safewhatsit\domark
6436 %
6437 % Insert the chapter heading break.
6438 \pchapsepmacro
6439 %
6440 % Now the second mark, after the heading break. No break points
6441 % between here and the heading.
6444 \domark
6445 %
6447 \chapfonts \rm
6449 %
6450 % Have to define \currentsection before calling \donoderef, because the
6451 % xref code eventually uses it. On the other hand, it has to be called
6452 % after \pchapsepmacro, or the headline will change too soon.
6454 %
6455 % Only insert the separating space if we have a chapter/appendix
6456 % number, and don't print the unnumbered ``number''.
6457 \ifx\temptype\Ynothingkeyword
6460 \else\ifx\temptype\Yomitfromtockeyword
6463 \else\ifx\temptype\Yappendixkeyword
6466 \else
6469 \fi\fi\fi
6470 %
6471 % Write the toc entry for this chapter. Must come before the
6472 % \donoderef, because we include the current node name in the toc
6473 % entry, and \donoderef resets it to empty.
6475 %
6476 % For pdftex, we have to write out the node definition (aka, make
6477 % the pdfdest) after any page break, but before the actual text has
6478 % been typeset. If the destination for the pdf outline is after the
6479 % text, then jumping from the outline may wind up with the text not
6480 % being visible, for instance under high magnification.
6482 %
6483 % Typeset the actual heading.
6489 \nobreak
6490 }
6492 % @centerchap -- centered and unnumbered.
6498 }
6501 % Section titles. These macros combine the section number parts and
6502 % call the generic \sectionheading to do the printing.
6503 %
6504 \newskip\secheadingskip
6507 % Subsection titles.
6508 \newskip\subsecheadingskip
6511 % Subsubsection titles.
6516 % Print any size, any type, section title.
6517 %
6518 % #1 is the text of the title,
6519 % #2 is the section level (sec/subsec/subsubsec),
6520 % #3 is the section type (Ynumbered, Ynothing, Yappendix, Yomitfromtoc),
6521 % #4 is the section number.
6522 %
6524 %
6529 %
6530 % It is ok for the @heading series commands to appear inside an
6531 % environment (it's been historically allowed, though the logic is
6532 % dubious), but not the others.
6533 \ifx\temptype\Yomitfromtockeyword\else
6535 \fi
6537 %
6538 % Switch to the right set of fonts.
6540 %
6541 % Insert first mark before the heading break (see notes for \domark).
6543 \ifx\temptype\Ynothingkeyword
6544 \ifx\sectionlevel\seckeyword
6547 \fi
6548 \else\ifx\temptype\Yomitfromtockeyword
6549 % Don't redefine \thissection.
6550 \else\ifx\temptype\Yappendixkeyword
6551 \ifx\sectionlevel\seckeyword
6556 % \noexpand\putwordSection avoids expanding indigestible
6557 % commands in some of the translations.
6559 \noexpand\thissectionnum:
6562 \fi
6563 \else
6564 \ifx\sectionlevel\seckeyword
6569 % \noexpand\putwordSection avoids expanding indigestible
6570 % commands in some of the translations.
6572 \noexpand\thissectionnum:
6575 \fi
6576 \fi\fi\fi
6577 %
6578 % Go into vertical mode. Usually we'll already be there, but we
6579 % don't want the following whatsit to end up in a preceding paragraph
6580 % if the document didn't happen to have a blank line.
6581 \par
6582 %
6583 % Output the mark. Pass it through \safewhatsit, to take care of
6584 % the preceding space.
6585 \safewhatsit\domark
6586 %
6587 % Insert space above the heading.
6589 %
6590 % Now the second mark, after the heading break. No break points
6591 % between here and the heading.
6593 \domark
6594 %
6595 % Only insert the space after the number if we have a section number.
6596 \ifx\temptype\Ynothingkeyword
6600 \else\ifx\temptype\Yomitfromtockeyword
6601 % for @headings -- no section number, don't include in toc,
6602 % and don't redefine \currentsection.
6606 \else\ifx\temptype\Yappendixkeyword
6610 \else
6614 \fi\fi\fi
6615 %
6616 % Write the toc entry (before \donoderef). See comments in \chapmacro.
6618 %
6619 % Write the node reference (= pdf destination for pdftex).
6620 % Again, see comments in \chapmacro.
6622 %
6623 % Interline glue will be inserted when the vbox is completed.
6624 % That glue will be a valid breakpoint for the page, since it'll be
6625 % preceded by a whatsit (usually from the \donoderef, or from the
6626 % \writetocentry if there was no node). We don't want to allow that
6627 % break, since then the whatsits could end up on page n while the
6628 % section is on page n+1, thus toc/etc. are wrong. Debian bug 276000.
6629 \nobreak
6630 %
6631 % Output the actual section heading.
6636 % Add extra space after the heading -- half of whatever came above it.
6637 % Don't allow stretch, though.
6639 %
6640 % Do not let the kern be a potential breakpoint, as it would be if it
6641 % was followed by glue.
6642 \nobreak
6643 %
6644 % We'll almost certainly start a paragraph next, so don't let that
6645 % glue accumulate. (Not a breakpoint because it's preceded by a
6646 % discardable item.) However, when a paragraph is not started next
6647 % (\startdefun, \cartouche, \center, etc.), this needs to be wiped out
6648 % or the negative glue will cause weirdly wrong output, typically
6649 % obscuring the section heading with something else.
6651 %
6652 % This is so the last item on the main vertical list is a known
6653 % \penalty > 10000, so \startdefun, etc., can recognize the situation
6654 % and do the needful.
6656 }
6660 % Table of contents.
6661 \newwrite\tocfile
6663 % Write an entry to the toc file, opening it if necessary.
6664 % Called from @chapter, etc.
6665 %
6666 % Example usage: \writetocentry{sec}{Section Name}{\the\chapno.\the\secno}
6667 % We append the current node name (if any) and page number as additional
6668 % arguments for the \{chap,sec,...}entry macros which will eventually
6669 % read this. The node name is used in the pdf outlines as the
6670 % destination to jump to.
6671 %
6672 % We open the .toc file for writing here instead of at @setfilename (or
6673 % any other fixed time) so that @contents can be anywhere in the document.
6674 % But if #1 is `omit', then we don't do anything. This is used for the
6675 % table of contents chapter openings themselves.
6676 %
6677 \newif\iftocfileopened
6679 %
6682 \ifx\writetoctype\omitkeyword \else
6683 \iftocfileopened\else
6685 \global\tocfileopenedtrue
6686 \fi
6687 %
6688 \iflinks
6692 \temp
6694 \fi
6695 \fi
6696 %
6697 % Tell \shipout to create a pdf destination on each page, if we're
6698 % writing pdf. These are used in the table of contents. We can't
6699 % just write one on every page because the title pages are numbered
6700 % 1 and 2 (the page numbers aren't printed), and so are the first
6701 % two pages of the document. Thus, we'd have two destinations named
6702 % `1', and two named `2'.
6703 \ifpdforxetex
6704 \global\pdfmakepagedesttrue
6705 \fi
6706 }
6709 % These characters do not print properly in the Computer Modern roman
6710 % fonts, so we must take special care. This is more or less redundant
6711 % with the Texinfo input format setup at the end of this file.
6712 %
6723 }
6726 % Read the toc file, which is essentially Texinfo input.
6728 \setupdatafile
6729 \activecatcodes
6730 \input \tocreadfilename
6731 }
6734 \newcount\savepageno
6737 % Prepare to read what we've written to \tocfile.
6738 %
6740 % If @setchapternewpage on, and @headings double, the contents should
6741 % start on an odd page, unlike chapters.
6742 \contentsalignmacro
6743 \immediate\closeout\tocfile
6744 %
6745 % Don't need to put `Contents' or `Short Contents' in the headline.
6746 % It is abundantly clear what they are.
6748 %
6753 %
6754 % Roman numerals for page numbers.
6757 % Record where the Roman numerals started.
6759 }
6761 % redefined for the two-volume lispref. We always output on
6762 % \jobname.toc even if this is redefined.
6763 %
6766 % Normal (long) toc.
6767 %
6772 \readtocfile
6773 \fi
6774 \vfill \eject
6777 \pdfmakeoutlines
6778 \fi
6780 \endgroup
6781 \contentsendroman
6782 }
6784 % And just the chapters.
6787 %
6792 % We want a true roman here for the page numbers.
6793 \secfonts
6796 \rm
6810 \readtocfile
6811 \fi
6813 \vfill \eject
6815 \endgroup
6816 \contentsendroman
6817 }
6820 % Get ready to use Arabic numerals again
6824 %
6825 % If \romancount > \arabiccount, the contents are at the end of the
6826 % document. Otherwise, advance where the Arabic numerals start for
6827 % the page numbers.
6829 }
6831 % Typeset the label for a chapter or appendix for the short contents.
6832 % The arg is, e.g., `A' for an appendix, or `3' for a chapter.
6833 %
6835 % This space should be enough, since a single number is .5em, and the
6836 % widest letter (M) is 1em, at least in the Computer Modern fonts.
6837 % But use \hss just in case.
6838 % (This space doesn't include the extra space that gets added after
6839 % the label; that gets put in by \shortchapentry above.)
6840 %
6841 % We'd like to right-justify chapter numbers, but that looks strange
6842 % with appendix letters. And right-justifying numbers and
6843 % left-justifying letters looks strange when there is less than 10
6844 % chapters. Have to read the whole toc once to know how many chapters
6845 % there are before deciding ...
6847 }
6849 % These macros generate individual entries in the table of contents.
6850 % The first argument is the chapter or section name.
6851 % The last argument is the page number.
6852 % The arguments in between are the chapter number, section number, ...
6854 % Parts, in the main contents. Replace the part number, which doesn't
6855 % exist, with an empty box. Let's hope all the numbers have the same width.
6856 % Also ignore the page number, which is conventionally not printed.
6859 % Add stretch and a bonus for breaking the page before the part heading.
6860 % This reduces the chance of the page being broken immediately after the
6861 % part heading, before a following chapter heading.
6866 }
6867 %
6868 % Parts, in the short toc.
6873 }
6875 % Chapters, in the main contents.
6878 % Chapters, in the short toc.
6879 % See comments in \dochapentry re vbox and related settings.
6882 }
6884 % Appendices, in the main contents.
6885 % Need the word Appendix, and a fixed-size box.
6886 %
6888 % We use M since it's probably the widest letter.
6891 %
6894 % Unnumbered chapters.
6898 % Sections.
6903 % Subsections.
6908 % And subsubsections.
6913 % This parameter controls the indentation of the various levels.
6914 % Same as \defaultparindent.
6917 % Now for the actual typesetting. In all these, #1 is the text and #2 is the
6918 % page number.
6919 %
6920 % If the toc has to be broken over pages, we want it to be at chapters
6921 % if at all possible; hence the \penalty.
6924 \begingroup
6925 % Move the page numbers slightly to the right
6927 \chapentryfonts
6929 \endgroup
6931 }
6948 % We use the same \entry macro as for the index entries.
6951 % Space between chapter (or whatever) number and the title.
6964 % @foo ... @end foo.
6966 % @tex ... @end tex escapes into raw TeX temporarily.
6967 % One exception: @ is still an escape character, so that @end tex works.
6968 % But \@ or @@ will get a plain @ character.
6971 \setregularquotes
6983 %
6984 % ' is active in math mode (mathcode"8000). So reset it, and all our
6985 % other math active characters (just in case), to plain's definitions.
6986 \mathactive
6987 %
6988 % Inverse of the list at the beginning of the file.
7006 %\let\sup=\ptexsup % do not redefine, we want @sup to work in math mode
7010 %
7014 }
7015 % There is no need to define \Etex.
7017 % Define @lisp ... @end lisp.
7018 % @lisp environment forms a group so it can rebind things,
7019 % including the definition of @end lisp (which normally is erroneous).
7021 % Amount to narrow the margins by for @lisp.
7024 % This is the definition that ^^M gets inside @lisp, @example, and other
7025 % such environments. \null is better than a space, since it doesn't
7026 % have any width.
7029 % This space is always present above and below environments.
7032 % Make spacing and below environment symmetrical. We use \parskip here
7033 % to help in doing that, since in @example-like environments \parskip
7034 % is reset to zero; thus the \afterenvbreak inserts no space -- but the
7035 % start of the next paragraph will insert \parskip.
7036 %
7038 % =10000 instead of <10000 because of a special case in \itemzzz and
7039 % \sectionheading, q.v.
7042 \endgraf
7044 \removelastskip
7046 % Penalize breaking before the environment, because preceding text
7047 % often leads into it.
7048 \penalty100
7049 \fi
7050 \vskip\envskipamount
7051 \fi
7052 \fi
7053 }}
7056 % =10000 instead of <10000 because of a special case in \itemzzz and
7057 % \sectionheading, q.v.
7060 \endgraf
7062 \removelastskip
7063 % it's not a good place to break if the last penalty was \nobreak
7064 % or better ...
7066 \vskip\envskipamount
7067 \fi
7068 \fi
7069 }}
7071 % \nonarrowing is a flag. If "set", @lisp etc don't narrow margins; it will
7072 % also clear it, so that its embedded environments do the narrowing again.
7075 % @cartouche ... @end cartouche: draw rectangle w/rounded corners around
7076 % environment contents.
7078 %
7089 %
7090 \newskip\lskip\newskip\rskip
7092 % only require the font if @cartouche is actually used
7096 }
7097 \newdimen\circthick
7098 \newdimen\cartouter\newdimen\cartinner
7099 \newskip\normbskip\newskip\normpskip\newskip\normlskip
7103 \cartouchefontdefs
7105 \startsavinginserts
7112 % side, and for 6pt waste from
7113 % each corner char, and rule thickness
7115 %
7116 % If this cartouche directly follows a sectioning command, we need the
7117 % \parskip glue (backspaced over by default) or the cartouche can
7118 % collide with the section heading.
7120 %
7123 \carttop
7124 \hbox\bgroup
7125 \hskip\lskip
7126 \vrule\kern3pt
7127 \vbox\bgroup
7128 \kern3pt
7135 }
7137 \ifhmode\par\fi
7138 \kern3pt
7139 \egroup
7140 \kern3pt\vrule
7141 \hskip\rskip
7142 \egroup
7143 \cartbot
7144 \egroup
7145 \addgroupbox
7146 \checkinserts
7147 }
7150 % This macro is called at the beginning of all the @example variants,
7151 % inside a group.
7152 \newdimen\nonfillparindent
7154 \aboveenvbreak
7160 % Turn off paragraph indentation but redefine \indent to emulate
7161 % the normal \indent.
7164 \let\indent\nonfillindent
7165 %
7167 \ifx\nonarrowing\relax
7170 \else
7172 \fi
7174 }
7176 \begingroup
7177 \obeyspaces
7178 % We want to swallow spaces (but not other tokens) after the fake
7179 % @indent in our nonfill-environments, where spaces are normally
7180 % active and set to @tie, resulting in them not being ignored after
7181 % @indent.
7190 \endgroup
7194 % If you want all examples etc. small: @set dispenvsize small.
7195 % If you want even small examples the full size: @set dispenvsize nosmall.
7196 % This affects the following displayed environments:
7197 % @example, @display, @format, @lisp, @verbatim
7198 %
7201 \let\SETdispenvsize\relax
7203 \ifx\SETdispenvsize\smallword
7204 % end paragraph for sake of leading, in case document has no blank
7205 % line. This is redundant with what happens in \aboveenvbreak, but
7206 % we need to do it before changing the fonts, and it's inconvenient
7207 % to change the fonts afterward.
7209 \smallexamplefonts \rm
7210 \fi
7211 }
7213 \ifx\SETdispenvsize\nosmallword
7214 \else
7216 \smallexamplefonts \rm
7217 \fi
7218 }
7220 % We often define two environments, @foo and @smallfoo.
7221 % Let's do it in one command. #1 is the env name, #2 the definition.
7227 }
7229 % Define two environment synonyms (#1 and #2) for an environment.
7233 }
7234 %
7235 % @lisp: indented, narrowed, typewriter font;
7236 % @example: same as @lisp.
7237 %
7238 % @smallexample and @smalllisp: use smaller fonts.
7239 % Originally contributed by Pavel@xerox.
7240 %
7242 \nonfillstart
7243 \tt\setcodequotes
7245 \parsearg\gobble
7246 }
7247 % @display/@smalldisplay: same as @lisp except keep current font.
7248 %
7250 \nonfillstart
7251 \gobble
7252 }
7254 % @format/@smallformat: same as @display except don't narrow margins.
7255 %
7258 \nonfillstart
7259 \gobble
7260 }
7262 % @flushleft: same as @format, but doesn't obey \SETdispenvsize.
7265 \nonfillstart
7266 \gobble
7267 }
7270 % @flushright.
7271 %
7274 \nonfillstart
7276 \gobble
7277 }
7281 % @raggedright does more-or-less normal line breaking but no right
7282 % justification. From plain.tex.
7285 }
7286 \let\Eraggedright\par
7292 % badness reporting.
7293 }
7294 \let\Eraggedleft\par
7300 % badness reporting.
7301 }
7302 \let\Eraggedcenter\par
7305 % @quotation does normal linebreaking (hence we can't use \nonfillstart)
7306 % and narrows the margins. We keep \parskip nonzero in general, since
7307 % we're doing normal filling. So, when using \aboveenvbreak and
7308 % \afterenvbreak, temporarily make \parskip 0.
7309 %
7311 %
7314 \ifx\nonarrowing\relax
7316 \fi
7317 \parsearg\quotationlabel
7318 }
7320 % We have retained a nonzero parskip for the environment, since we're
7321 % doing normal filling.
7322 %
7324 \par
7325 \ifx\quotationauthor\thisisundefined\else
7326 % indent a bit.
7328 \fi
7330 }
7333 % If we're given an argument, typeset it in bold with a colon after.
7336 \ifx\temp\empty \else
7338 \fi
7339 }
7341 % @indentedblock is like @quotation, but indents only on the left and
7342 % has no optional argument.
7343 %
7345 %
7349 %
7350 % @cartouche defines \nonarrowing to inhibit narrowing at next level down.
7351 \ifx\nonarrowing\relax
7354 \else
7356 \fi
7357 }
7359 % Keep a nonzero parskip for the environment, since we're doing normal filling.
7360 %
7362 \par
7364 }
7368 % LaTeX-like @verbatim...@end verbatim and @verb{<char>...<char>}
7369 % If we want to allow any <char> as delimiter,
7370 % we need the curly braces so that makeinfo sees the @verb command, eg:
7371 % `@verbx...x' would look like the '@verbx' command. --janneke@gnu.org
7372 %
7373 % [Knuth]: Donald Ervin Knuth, 1996. The TeXbook.
7374 %
7375 % [Knuth] p.344; only we need to do the other characters Texinfo sets
7376 % active too. Otherwise, they get lost as the first character on a
7377 % verbatim line.
7382 % Don't do the quotes -- if we do, @set txicodequoteundirected and
7383 % @set txicodequotebacktick will not have effect on @verb and
7384 % @verbatim, and ?` and !` ligatures won't get disabled.
7385 %\do\`\do\'%
7386 }
7387 %
7388 % [Knuth] p. 380
7391 %
7392 % Setup for the @verb command.
7393 %
7394 % Eight spaces for a tab
7395 \begingroup
7398 \endgroup
7399 %
7403 \setcodequotes
7404 \tabeightspaces
7405 % Respect line breaks,
7406 % print special symbols as themselves, and
7407 % make each space count
7408 % must do in this order:
7409 \obeylines \uncatcodespecials \sepspaces
7410 }
7412 % Setup for the @verbatim environment
7413 %
7414 % Real tab expansion.
7416 %
7417 % We typeset each line of the verbatim in an \hbox, so we can handle
7418 % tabs.
7419 \newbox\verbbox
7421 %
7422 \begingroup
7432 \leavevmode\box\verbbox \starttabbox
7434 }
7435 \endgroup
7437 % start the verbatim environment.
7440 \nonfillstart
7443 \tabexpand
7444 \setcodequotes
7445 % Respect line breaks,
7446 % print special symbols as themselves, and
7447 % make each space count.
7448 % Must do in this order:
7449 \obeylines \uncatcodespecials \sepspaces
7450 }
7452 % Do the @verb magic: verbatim text is quoted by unique
7453 % delimiter characters. Before first delimiter expect a
7454 % right brace, after last delimiter expect closing brace:
7455 %
7456 % \def\doverb'{'<char>#1<char>'}'{#1}
7457 %
7458 % [Knuth] p. 382; only eat outer {}
7459 \begingroup
7462 \endgroup
7463 %
7465 %
7466 %
7467 % Do the @verbatim magic: define the macro \doverbatim so that
7468 % the (first) argument ends when '@end verbatim' is reached, ie:
7469 %
7470 % \def\doverbatim#1@end verbatim{#1}
7471 %
7472 % For Texinfo it's a lot easier than for LaTeX,
7473 % because texinfo's \verbatim doesn't stop at '\end{verbatim}':
7474 % we need not redefine '\', '{' and '}'.
7475 %
7476 % Inspired by LaTeX's verbatim command set [latex.ltx]
7477 %
7478 \begingroup
7481 % ignore everything up to the first ^^M, that's the newline at the end
7482 % of the @verbatim input line itself. Otherwise we get an extra blank
7483 % line in the output.
7486 % We really want {...\end verbatim} in the body of the macro, but
7487 % without the active space; thus we have to use \xdef and \gobble.
7488 % The \egroup ends the \verbbox started at the end of the last line in
7489 % the block.
7490 \endgroup
7491 %
7493 \setnormaldispenv\setupverbatim\doverbatim
7494 }
7498 % @verbatiminclude FILE - insert text of file in verbatim environment.
7499 %
7501 %
7504 \makevalueexpandable
7505 \setupverbatim
7510 \expandafter
7512 \afterenvbreak
7514 }
7516 % @copying ... @end copying.
7517 % Save the text away for @insertcopying later.
7518 %
7519 % We save the uninterpreted tokens, rather than creating a box.
7520 % Saving the text in a box would be much easier, but then all the
7521 % typesetting commands (@smallbook, font changes, etc.) have to be done
7522 % beforehand -- and a) we want @copying to be done first in the source
7523 % file; b) letting users define the frontmatter in as flexible order as
7524 % possible is desirable.
7525 %
7528 %
7530 \begingroup
7532 \scanexp\copyingtext
7533 \endgroup
7534 }
7538 % @defun etc.
7543 \newcount\defunpenalty
7545 % Start the processing of @deffn:
7548 \medbreak
7550 % following @def command, see below.
7551 \else
7552 % If there are two @def commands in a row, we'll have a \nobreak,
7553 % which is there to keep the function description together with its
7554 % header. But if there's nothing but headers, we need to allow a
7555 % break somewhere. Check specifically for penalty 10002, inserted
7556 % by \printdefunline, instead of 10000, since the sectioning
7557 % commands also insert a nobreak penalty, and we don't want to allow
7558 % a break between a section heading and a defun.
7559 %
7560 % As a further refinement, we avoid "club" headers by signalling
7561 % with penalty of 10003 after the very first @deffn in the
7562 % sequence (see above), and penalty of 10002 after any following
7563 % @def command.
7565 %
7566 % Similarly, after a section heading, do not allow a break.
7567 % But do insert the glue.
7569 \fi
7570 %
7574 }
7577 % First, check whether we are in the right environment:
7579 %
7580 % As above, allow line break if we have multiple x headers in a row.
7581 % It's not a great place, though.
7583 %
7584 % And now, it's time to reuse the body of the original defun:
7586 }
7589 % \printdefunline \deffnheader{text}
7590 %
7592 \begingroup
7593 \plainfrenchspacing
7594 % call \deffnheader:
7596 % common ending:
7599 \endgraf
7602 % Some of the @defun-type tags do not enable magic parentheses,
7603 % rendering the following check redundant. But we don't optimize.
7604 \checkparencounts
7605 \endgroup
7606 }
7610 % \makedefun{deffn} creates \deffn, \deffnx and \Edeffn;
7611 % the only thing remaining is to define \deffnheader.
7612 %
7617 \temp
7618 }
7620 % \domakedefun \deffn \deffnx \deffnheader { (defn. of \deffnheader) }
7621 %
7622 % Define \deffn and \deffnx, without parameters.
7623 % \deffnheader has to be defined explicitly.
7624 %
7627 \startdefun
7633 }
7638 % @deftypefnnewline on|off says whether the return type of typed functions
7639 % are printed on their own line. This affects @deftypefn, @deftypefun,
7640 % @deftypeop, and @deftypemethod.
7641 %
7644 \ifx\temp\onword
7646 = \empty
7647 \else\ifx\temp\offword
7649 = \relax
7650 \else
7654 \fi\fi
7655 }
7657 % \dosubind {index}{topic}{subtopic}
7658 %
7659 % If SUBTOPIC is present, precede it with a space, and call \doind.
7660 % (At some time during the 20th century, this made a two-level entry in an
7661 % index such as the operation index. Nobody seemed to notice the change in
7662 % behaviour though.)
7665 \ifx\thirdarg\empty
7667 \else
7669 \fi
7670 }
7672 % Untyped functions:
7674 % @deffn category name args
7677 % @deffn category class name args
7680 % \defopon {category on}class name args
7683 % \deffngeneral {subind}category name args
7684 %
7688 }
7690 % Typed functions:
7692 % @deftypefn category type name args
7695 % @deftypeop category class type name args
7698 % \deftypeopon {category on}class type name args
7701 % \deftypefngeneral {subind}category type name args
7702 %
7705 \doingtypefntrue
7707 }
7709 % Typed variables:
7711 % @deftypevr category type var args
7714 % @deftypecv category class type var args
7717 % \deftypecvof {category of}class type var args
7720 % \deftypecvgeneral {subind}category type var args
7721 %
7725 }
7727 % Untyped variables:
7729 % @defvr category var args
7732 % @defcv category class var args
7735 % \defcvof {category of}class var args
7738 % Types:
7740 % @deftp category name args
7744 }
7746 % Remaining @defun-like shortcuts:
7759 % \defname, which formats the name of the @def (not the args).
7760 % #1 is the category, such as "Function".
7761 % #2 is the return type, if any.
7762 % #3 is the function name.
7763 %
7764 % We are followed by (but not passed) the arguments, if any.
7765 %
7767 \par
7768 % Get the values of \leftskip and \rightskip as they were outside the @def...
7770 %
7771 % Determine if we are typesetting the return type of a typed function
7772 % on a line by itself.
7773 \rettypeownlinefalse
7775 % then check user option for putting return type on its own line:
7777 \rettypeownlinetrue
7778 \fi
7779 \fi
7780 %
7781 % How we'll format the category name. Putting it in brackets helps
7782 % distinguish it from the body text that may end up on the next line
7783 % just below it.
7786 %
7787 % Figure out line sizes for the paragraph shape. We'll always have at
7788 % least two.
7790 %
7791 % The first line needs space for \box0; but if \rightskip is nonzero,
7792 % we need only space for the part of \box0 which exceeds it:
7794 %
7795 % If doing a return type on its own line, we'll have another line.
7796 \ifrettypeownline
7799 \else
7801 \fi
7802 %
7803 % The continuations:
7805 %
7806 % The final paragraph shape:
7808 %
7809 % Put the category name at the right margin.
7810 \noindent
7813 % \hsize has to be shortened this way:
7814 \kern\leftskip
7815 % Intentionally do not respect \rightskip, since we need the space.
7817 %
7818 % Allow all lines to be underfull without complaint:
7822 % defun fonts. We use typewriter by default (used to be bold) because:
7823 % . we're printing identifiers, they should be in tt in principle.
7824 % . in languages with many accents, such as Czech or French, it's
7825 % common to leave accents off identifiers. The result looks ok in
7826 % tt, but exceedingly strange in rm.
7827 % . we don't want -- and --- to be treated as ligatures.
7828 % . this still does not fix the ?` and !` ligatures, but so far no
7829 % one has made identifiers using them :).
7830 \df \tt
7832 \ifx\temp\empty\else
7834 \ifrettypeownline
7835 % put return type on its own line; prohibit line break following:
7837 \else
7839 \fi
7844 %
7845 \boldbrax
7846 % arguments will be output next, if any.
7847 }
7849 % Print arguments in slanted roman (not ttsl), inconsistently with using
7850 % tt for the name. This is because literal text is sometimes needed in
7851 % the argument list (groff manual), and ttsl and tt are not very
7852 % distinguishable. Prevent hyphenation at `-' chars.
7853 %
7855 % use sl by default (not ttsl),
7856 % tt for the names.
7858 %
7859 % On the other hand, if an argument has two dashes (for instance), we
7860 % want a way to get ttsl. We used to recommend @var for that, so
7861 % leave the code in, but it's strange for @var to lead to typewriter.
7862 % Nowadays we recommend @code, since the difference between a ttsl hyphen
7863 % and a tt hyphen is pretty tiny. @code also disables ?` !`.
7867 }
7869 % We want ()&[] to print specially on the defun line.
7870 %
7875 }
7877 % Make control sequences which act like normal parenthesis chars.
7880 % Be sure that we always have a definition for `(', etc. For example,
7881 % if the fn name has parens in it, \boldbrax will not be in effect yet,
7882 % so TeX would otherwise complain about undefined control sequence.
7883 {
7884 \activeparens
7887 \global\let& = \&
7891 }
7892 \let\ampchar\&
7894 \newcount\parencount
7896 % If we encounter &foo, then turn on ()-hacking afterwards
7897 \newif\ifampseen
7901 \ifampseen
7902 % At the first level, print parens in roman,
7903 % otherwise use the default font.
7905 \else
7906 % The \sf parens (in \boldbrax) actually are a little bolder than
7907 % the contained text. This is especially needed for [ and ] .
7908 \sf
7909 \fi
7910 }
7912 \ifampseen
7915 \fi
7916 \fi
7917 }
7923 \infirstlevel \bfafterword
7924 }
7927 \infirstlevel \sl
7929 }
7931 \newcount\brackcount
7935 }
7939 }
7944 }
7945 % these should not use \errmessage; the glibc manual, at least, actually
7946 % has such constructs (when documenting function pointers).
7950 }
7954 }
7958 % @macro.
7960 % To do this right we need a feature of e-TeX, \scantokens,
7961 % which we arrange to emulate with a temporary file in ordinary TeX.
7962 \ifx\eTeXversion\thisisundefined
7963 \newwrite\macscribble
7968 \immediate\closeout\macscribble
7969 \input \jobname.tmp
7970 }
7971 \fi
7975 % Used at the time of macro expansion.
7976 % Argument is macro body with arguments substituted
7978 \newlinechar`\^^M
7979 % expand the expansion of \eatleadingcr twice to maybe remove a leading
7980 % newline (and \else and \fi tokens), then call \eatspaces on the result.
7985 %
7986 % Process the macro body under the current catcode regime.
7988 %
7989 % The \comment is to remove the \newlinechar added by \scantokens, and
7990 % can be noticed by \parsearg. Note \c isn't used because this means cedilla
7991 % in math mode.
7992 }
7994 % Used for copying and captions
7997 }
8003 % List of all defined macros in the form
8004 % \commondummyword\macro1\commondummyword\macro2...
8005 % Currently is also contains all @aliases; the list can be split
8006 % if there is a need.
8009 % Add the macro to \macrolist
8014 }
8016 % Utility routines.
8017 % This does \let #1 = #2, with \csnames; that is,
8018 % \let \csname#1\endcsname = \csname#2\endcsname
8019 % (except of course we have to play expansion games).
8020 %
8022 \expandafter\let
8025 }
8027 % Trim leading and trailing spaces off a string.
8028 % Concepts from aro-bend problem 15 (see CTAN).
8035 }
8039 % Warning: this won't work for a delimited argument
8040 % or for an empty argument
8042 % Trim a single trailing ^^M off a string.
8047 }
8049 % Macro bodies are absorbed as an argument in a context where
8050 % all characters are catcode 10, 11 or 12, except \ which is active
8051 % (as in normal texinfo). It is necessary to change the definition of \
8052 % to recognize macro arguments; this is the job of \mbodybackslash.
8053 %
8054 % Non-ASCII encodings make 8-bit characters active, so un-activate
8055 % them to avoid their expansion. Must do this non-globally, to
8056 % confine the change to the current group.
8057 %
8058 % It's necessary to have hard CRs when the macro is executed. This is
8059 % done by making ^^M (\endlinechar) catcode 12 when reading the macro
8060 % body, and then making it the \newlinechar in \scanmacro.
8061 %
8071 \passthroughcharstrue
8072 }
8075 \scanctxt
8079 }
8082 \scanctxt
8088 \usembodybackslash
8089 }
8091 % Used when scanning braced macro arguments. Note, however, that catcode
8092 % changes here are ineffectual if the macro invocation was nested inside
8093 % an argument to another Texinfo command.
8095 \scanctxt
8100 }
8103 \scanctxt
8107 }
8109 % \mbodybackslash is the definition of \ in @macro bodies.
8110 % It maps \foo\ => \csname macarg.foo\endcsname => #N
8111 % where N is the macro parameter number.
8112 % We define \csname macarg.\endcsname to be \realbackslash, so
8113 % \\ in macro replacement text gets you a backslash.
8114 %
8118 }
8130 \else
8133 \ifx\eTeXversion\thisisundefined
8136 \fi
8137 \fi
8138 \fi
8141 \else
8142 \expandafter\ifx\csname \the\macname\endcsname \relax
8147 \fi
8148 \begingroup \macrobodyctxt
8149 \ifrecursive \expandafter\parsermacbody
8150 \else \expandafter\parsemacbody
8157 % Remove the macro name from \macrolist:
8158 \begingroup
8160 \let\commondummyword\unmacrodo
8162 \endgroup
8163 \else
8165 \fi
8166 }
8168 % Called by \do from \dounmacro on each macro. The idea is to omit any
8169 % macro definitions that have been changed to \relax.
8170 %
8173 % remove this
8174 \else
8176 \fi
8177 }
8179 % \getargs -- Parse the arguments to a @macro line. Set \macname to
8180 % the name of the macro, and \argl to the braced argument list.
8185 % This made use of the feature that if the last token of a
8186 % <parameter list> is #, then the preceding argument is delimited by
8187 % an opening brace, and that opening brace is not consumed.
8189 % Parse the optional {params} list to @macro or @rmacro.
8190 % Set \paramno to the number of arguments,
8191 % and \paramlist to a parameter text for the macro (e.g. #1,#2,#3 for a
8192 % three-param macro.) Define \macarg.BLAH for each BLAH in the params
8193 % list to some hook where the argument is to be expanded. If there are
8194 % less than 10 arguments that hook is to be replaced by ##N where N
8195 % is the position in that list, that is to say the macro arguments are to be
8196 % defined `a la TeX in the macro body.
8197 %
8198 % That gets used by \mbodybackslash (above).
8199 %
8200 % If there are 10 or more arguments, a different technique is used: see
8201 % \parsemmanyargdef.
8202 %
8205 \let\hash\relax
8206 % \hash is redefined to `#' later to get it into definitions
8207 \let\xeatspaces\relax
8208 \let\xempty\relax
8211 \paramno0\relax
8213 \fi
8214 }
8223 % the \xempty{} is to give \eatleadingcr an argument in the case of an
8224 % empty macro argument.
8226 % \parsemacbody, \parsermacbody
8227 %
8228 % Read recursive and nonrecursive macro bodies. (They're different since
8229 % rec and nonrec macros end differently.)
8230 %
8231 % We are in \macrobodyctxt, and the \xdef causes backslashshes in the macro
8232 % body to be transformed.
8233 % Set \macrobody to the body of the macro, and call \defmacro.
8234 %
8240 % Make @ a letter, so that we can make private-to-Texinfo macro names.
8244 %%%%%%%%%%%%%% Code for > 10 arguments only %%%%%%%%%%%%%%%%%%
8246 % If there are 10 or more arguments, a different technique is used, where the
8247 % hook remains in the body, and when macro is to be expanded the body is
8248 % processed again to replace the arguments.
8249 %
8250 % In that case, the hook is \the\toks N-1, and we simply set \toks N-1 to the
8251 % argument N value and then \edef the body (nothing else will expand because of
8252 % the catcode regime under which the body was input).
8253 %
8254 % If you compile with TeX (not eTeX), and you have macros with 10 or more
8255 % arguments, no macro can have more than 256 arguments (else error).
8256 %
8257 % In case that there are 10 or more arguments we parse again the arguments
8258 % list to set new definitions for the \macarg.BLAH macros corresponding to
8259 % each BLAH argument. It was anyhow needed to parse already once this list
8260 % in order to count the arguments, and as macros with at most 9 arguments
8261 % are by far more frequent than macro with 10 or more arguments, defining
8262 % twice the \macarg.BLAH macros does not cost too much processing power.
8265 \else
8268 \expandafter\def\expandafter\tempa
8270 % Note that we need some extra \noexpand\noexpand, this is because we
8271 % don't want \the to be expanded in the \parsermacbody as it uses an
8272 % \xdef .
8273 \expandafter\edef\tempa
8284 % This macro is expanded during the Texinfo macro expansion, not during its
8285 % definition. It gets all the arguments' values and assigns them to macros
8286 % macarg.ARGNAME
8287 %
8288 % #1 is the macro name
8289 % #2 is the list of argument names
8290 % #3 is the list of argument values
8296 \begingroup
8297 \macroargctxt
8301 \setemptyargvalues@
8302 \else
8303 \getargvals@@
8304 \fi
8305 }
8307 \ifx\paramlist\nilm@
8308 % Some sanity check needed here that \argvaluelist is also empty.
8309 \ifx\argvaluelist\nillm@
8310 \else
8313 \fi
8314 \let\next\macargexpandinbody@
8315 \else
8316 \ifx\argvaluelist\nillm@
8317 % No more arguments values passed to macro. Set remaining named-arg
8318 % macros to empty.
8319 \let\next\setemptyargvalues@
8320 \else
8321 % pop current arg name into \@tempb
8324 % pop current argument value into \@tempc
8327 % Here \@tempb is the current arg name and \@tempc is the current arg value.
8328 % First place the new argument macro definition into \@tempd
8335 \let\next\getargvals@@
8336 \fi
8337 \fi
8338 \next
8339 }
8342 \expandafter\expandafter\expandafter\def
8346 }
8348 % Replace arguments by their values in the macro body, and place the result
8349 % in macro \@tempa.
8350 %
8352 % To do this we use the property that token registers that are \the'ed
8353 % within an \edef expand only once. So we are going to place all argument
8354 % values into respective token registers.
8355 %
8356 % First we save the token context, and initialize argument numbering.
8357 \begingroup
8358 \paramno0\relax
8359 % Then, for each argument number #N, we place the corresponding argument
8360 % value into a new token list register \toks#N
8362 % Then, we expand the body so that argument are replaced by their
8363 % values. The trick for values not to be expanded themselves is that they
8364 % are within tokens and that tokens expand only once in an \edef .
8366 % Now we restore the token stack pointer to free the token list registers
8367 % which we have used, but we make sure that expanded body is saved after
8368 % group.
8369 \expandafter
8370 \endgroup
8372 }
8374 % Define the named-macro outside of this group and then close this group.
8375 %
8377 \expandafter
8378 \endgroup
8379 \macargdeflist@
8380 % First the replace in body the macro arguments by their values, the result
8381 % is in \@tempa .
8382 \macvalstoargs@
8383 % Then we point at the \norecurse or \gobble (for recursive) macro value
8384 % with \@tempb .
8386 % Depending on whether it is recursive or not, we need some tailing
8387 % \egroup .
8390 \else
8392 \fi
8393 % And now we do the real job:
8395 \@tempd
8396 }
8400 \else
8401 \let\next\putargsintokens@
8402 % First we allocate the new token list register, and give it a temporary
8403 % alias \@tempb .
8405 % Then we place the argument value into that token list register.
8409 \fi
8410 \next
8411 }
8413 % Trailing missing arguments are set to empty.
8414 %
8416 \ifx\paramlist\nilm@
8417 \let\next\macargexpandinbody@
8418 \else
8420 \let\next\setemptyargvalues@
8421 \fi
8422 \next
8423 }
8430 }
8432 % #1 is the element target macro
8433 % #2 is the list macro
8434 % #3,#4\endargs@ is the list value
8438 }
8442 }
8445 %%%%%%%%%%%%%% End of code for > 10 arguments %%%%%%%%%%%%%%%%%%
8448 % This defines a Texinfo @macro or @rmacro, called by \parsemacbody.
8449 % \macrobody has the body of the macro in it, with placeholders for
8450 % its parameters, looking like "\xeatspaces{\hash 1}".
8451 % \paramno is the number of parameters
8452 % \paramlist is a TeX parameter text, e.g. "#1,#2,#3,"
8453 % There are four cases: macros of zero, one, up to nine, and many arguments.
8454 % \xdef is used so that macro definitions will survive the file
8455 % they're defined in: @include reads the file inside a group.
8456 %
8461 % This removes the pair of braces around the argument. We don't
8462 % use \eatspaces, because this can cause ends of lines to be lost
8463 % when the argument to \eatspaces is read, leading to line-based
8464 % commands like "@itemize" not being read correctly.
8465 \else
8467 \fi
8468 \ifcase\paramno
8469 % 0
8471 \bgroup
8472 \noexpand\spaceisspace
8473 \noexpand\endlineisspace
8477 \egroup
8481 \bgroup
8482 \noexpand\braceorline
8485 \egroup
8490 % @MACNAME sets the context for reading the macro argument
8491 % @MACNAME@@ gets the argument, processes backslashes and appends a
8492 % comma.
8493 % @MACNAME@@@ removes braces surrounding the argument list.
8494 % @MACNAME@@@@ scans the macro body with arguments substituted.
8496 \bgroup
8499 \noexpand\expandafter
8502 \noexpand\passargtomacro
8506 \expandafter\expandafter
8507 \expandafter\xdef
8508 \expandafter\expandafter
8517 \fi
8525 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
8526 %
8531 % \passargtomacro#1#2 -
8532 % Call #1 with a list of tokens #2, with any doubled backslashes in #2
8533 % compressed to one.
8534 %
8535 % This implementation works by expansion, and not execution (so we cannot use
8536 % \def or similar). This reduces the risk of this failing in contexts where
8537 % complete expansion is done with no execution (for example, in writing out to
8538 % an auxiliary file for an index entry).
8539 %
8540 % State is kept in the input stream: the argument passed to
8541 % @look_ahead, @gobble_and_check_finish and @add_segment is
8542 %
8543 % THE_MACRO ARG_RESULT ! {PENDING_BS} NEXT_TOKEN (... rest of input)
8544 %
8545 % where:
8546 % THE_MACRO - name of the macro we want to call
8547 % ARG_RESULT - argument list we build to pass to that macro
8548 % PENDING_BS - either a backslash or nothing
8549 % NEXT_TOKEN - used to look ahead in the input stream to see what's coming next
8553 }
8556 % #1 - THE_MACRO ARG_RESULT
8557 % #2 - PENDING_BS
8558 % #3 - NEXT_TOKEN
8559 % #4 used to look ahead
8560 %
8561 % If the next token is not a backslash, process the rest of the argument;
8562 % otherwise, remove the next token.
8564 @ifx#4\%
8565 @expandafter@gobble_and_check_finish
8566 @else
8567 @expandafter@add_segment
8569 }
8571 % #1 - THE_MACRO ARG_RESULT
8572 % #2 - PENDING_BS
8573 % #3 - NEXT_TOKEN
8574 % #4 should be a backslash, which is gobbled.
8575 % #5 looks ahead
8576 %
8577 % Double backslash found. Add a single backslash, and look ahead.
8580 }
8584 % #1 - THE_MACRO ARG_RESULT
8585 % #2 - PENDING_BS
8586 % #3 - NEXT_TOKEN
8587 % #4 is input stream until next backslash
8588 %
8589 % Input stream is either at the start of the argument, or just after a
8590 % backslash sequence, either a lone backslash, or a doubled backslash.
8591 % NEXT_TOKEN contains the first token in the input stream: if it is \finish,
8592 % finish; otherwise, append to ARG_RESULT the segment of the argument up until
8593 % the next backslash. PENDING_BACKSLASH contains a backslash to represent
8594 % a backslash just before the start of the input stream that has not been
8595 % added to ARG_RESULT.
8597 @ifx#3@_finish
8599 @else
8600 % append the pending backslash to the result, followed by the next segment
8602 % this @fi is discarded by @look_ahead.
8603 % we can't get rid of it with \expandafter because we don't know how
8604 % long #4 is.
8605 }
8607 % #1 - THE_MACRO
8608 % #2 - ARG_RESULT
8609 % #3 discards the res of the conditional in @add_segment, and @is_fi ends the
8610 % conditional.
8613 }
8614 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
8616 % \braceorline MAC is used for a one-argument macro MAC. It checks
8617 % whether the next non-whitespace character is a {. It sets the context
8618 % for reading the argument (slightly different in the two cases). Then,
8619 % to read the argument, in the whole-line case, it then calls the regular
8620 % \parsearg MAC; in the lbrace case, it calls \passargtomacro MAC.
8621 %
8624 \ifx\nchar\bgroup
8625 \macroargctxt
8626 \expandafter\passargtomacro
8627 \else
8628 \macrolineargctxt\expandafter\parsearg
8632 % @alias.
8633 % We need some trickery to remove the optional spaces around the equal
8634 % sign. Make them active and then expand them all to nothing.
8635 %
8644 \next
8645 }
8650 \newwrite\auxfile
8654 % @inforef is relatively simple.
8660 % @node's only job in TeX is to define \lastnode, which is used in
8661 % cross-references. The @node line might or might not have commas, and
8662 % might or might not have spaces before the first comma, like:
8663 % @node foo , bar , ...
8664 % We don't want such trailing spaces in the node name.
8665 %
8667 %
8668 % also remove a trailing comma, in case of something like this:
8669 % @node Help-Cross, , , Cross-refs
8673 % Used so that the @top node doesn't have to be wrapped in an @ifnottex
8674 % conditional.
8675 % \doignore goes to more effort to skip nested conditionals but we don't need
8676 % that here.
8678 \ifx\lastnode\wordTop
8679 \expandafter\ignorenode\fi
8680 }
8683 % Until the next @node or @bye command, divert output to a box that is not
8684 % output.
8686 \ignorenodebye
8687 }
8692 % The redefinition of \bye here is because it is declared \outer
8696 % Write a cross-reference definition for the current node. #1 is the
8697 % type (Ynumbered, Yappendix, Ynothing).
8698 %
8700 \ifx\lastnode\empty\else
8703 \fi
8704 }
8706 % @anchor{NAME} -- define xref target at arbitrary point.
8707 %
8708 \newcount\savesfregister
8709 %
8714 % \setref{NAME}{SNT} defines a cross-reference point NAME (a node or an
8715 % anchor), which consists of three parts:
8716 % 1) NAME-title - the current sectioning name taken from \currentsection,
8717 % or the anchor name.
8718 % 2) NAME-snt - section number and type, passed as the SNT arg, or
8719 % empty for anchors.
8720 % 3) NAME-pg - the page number.
8721 %
8722 % This is called from \donoderef, \anchor, and \dofloat. In the case of
8723 % floats, there is an additional part, which is not written here:
8724 % 4) NAME-lof - the text as it should appear in a @listoffloats.
8725 %
8728 \iflinks
8730 \requireauxfile
8732 % match definition in \xrdef, \refx, \xrefX.
8743 \fi
8744 }
8746 % @xrefautosectiontitle on|off says whether @section(ing) names are used
8747 % automatically in xrefs, if the third arg is not explicitly specified.
8748 % This was provided as a "secret" @set xref-automatic-section-title
8749 % variable, now it's official.
8750 %
8753 \ifx\temp\onword
8755 = \empty
8756 \else\ifx\temp\offword
8758 = \relax
8759 \else
8763 \fi\fi
8764 }
8766 % \f
8767 % @xref, @pxref, and @ref generate cross-references. For \xrefX, #1 is
8768 % the node name, #2 the name of the Info cross-reference, #3 the printed
8769 % node name, #4 the name of the Info file, #5 the name of the printed
8770 % manual. All but the node name can be omitted.
8771 %
8778 %
8779 \newbox\toprefbox
8780 \newbox\printedrefnamebox
8781 \newbox\infofilenamebox
8782 \newbox\printedmanualbox
8783 %
8785 \unsepspaces
8786 %
8787 % Get args without leading/trailing spaces.
8790 %
8793 %
8796 %
8797 % If the printed reference name (arg #3) was not explicitly given in
8798 % the @xref, figure out what we want to use.
8800 % No printed node name was explicitly given.
8802 % Not auto section-title: use node name inside the square brackets.
8804 \else
8805 % Auto section-title: use chapter/section title inside
8806 % the square brackets if we have it.
8808 % It is in another manual, so we don't have it; use node name.
8810 \else
8811 \ifhavexrefs
8812 % We (should) know the real title if we have the xref values.
8814 \else
8815 % Otherwise just copy the Info node name.
8818 \fi
8819 \fi
8820 \fi
8821 %
8822 % Make link in pdf output.
8823 \ifpdf
8824 % For pdfTeX and LuaTeX
8826 \makevalueexpandable
8827 \turnoffactive
8828 % This expands tokens, so do it after making catcode changes, so _
8829 % etc. don't get their TeX definitions. This ignores all spaces in
8830 % #4, including (wrongly) those in the middle of the filename.
8832 %
8833 % This (wrongly) does not take account of leading or trailing
8834 % spaces in #1, which should be ignored.
8836 %
8837 \ifx\pdfdestname\empty
8839 \fi
8840 %
8841 \leavevmode
8845 \else
8847 \fi
8850 \else
8851 \ifx\XeTeXrevision\thisisundefined
8852 \else
8853 % For XeTeX
8855 \makevalueexpandable
8856 \turnoffactive
8857 % This expands tokens, so do it after making catcode changes, so _
8858 % etc. don't get their TeX definitions. This ignores all spaces in
8859 % #4, including (wrongly) those in the middle of the filename.
8861 %
8862 % This (wrongly) does not take account of leading or trailing
8863 % spaces in #1, which should be ignored.
8865 %
8866 \ifx\pdfdestname\empty
8868 \fi
8869 %
8870 \leavevmode
8872 % With default settings,
8873 % XeTeX (xdvipdfmx) replaces link destination names with integers.
8874 % In this case, the replaced destination names of
8875 % remote PDFs are no longer known. In order to avoid a replacement,
8876 % you can use xdvipdfmx's command line option `-C 0x0010'.
8877 % If you use XeTeX 0.99996+ (TeX Live 2016+),
8878 % this command line option is no longer necessary
8879 % because we can use the `dvipdfmx:config' special.
8882 \else
8885 \fi
8888 \fi
8889 \fi
8891 % Have to otherify everything special to allow the \csname to
8892 % include an _ in the xref name, etc.
8893 \indexnofonts
8894 \turnoffactive
8896 \expandafter\global\expandafter\let\expandafter\Xthisreftitle
8899 %
8900 % Float references are printed completely differently: "Figure 1.2"
8901 % instead of "[somenode], p.3". \iffloat distinguishes them by
8902 % \Xthisreftitle being set to a magic string.
8903 \iffloat\Xthisreftitle
8904 % If the user specified the print name (third arg) to the ref,
8905 % print it instead of our usual "Figure 1.2".
8908 \else
8909 \printedrefname
8910 \fi
8911 %
8912 % If the user also gave the printed manual name (fifth arg), append
8913 % "in MANUALNAME".
8916 \fi
8917 \else
8918 % node/anchor (non-float) references.
8919 %
8920 % If we use \unhbox to print the node names, TeX does not insert
8921 % empty discretionaries after hyphens, which means that it will not
8922 % find a line break at a hyphen in a node names. Since some manuals
8923 % are best written with fairly long node names, containing hyphens,
8924 % this is a loss. Therefore, we give the text of the node name
8925 % again, so it is as if TeX is seeing it for the first time.
8926 %
8928 % Cross-manual reference with a printed manual name.
8929 %
8931 %
8933 % Cross-manual reference with only an info filename (arg 4), no
8934 % printed manual name (arg 5). This is essentially the same as
8935 % the case above; we output the filename, since we have nothing else.
8936 %
8938 %
8939 \else
8940 % Reference within this manual.
8941 %
8942 % Only output a following space if the -snt ref is nonempty, as the ref
8943 % will be empty for @unnumbered and @anchor.
8946 %
8947 % output the `[mynode]' via the macro below so it can be overridden.
8948 \xrefprintnodename\printedrefname
8949 %
8951 % But we always want a comma and a space:
8952 ,\space
8953 %
8954 % output the `page 3'.
8956 % Add a , if xref followed by a space
8961 \else\ifx\
8964 \fi\fi\fi\fi\fi\fi
8965 \fi
8966 \fi\fi
8967 \fi
8968 \endlink
8971 % Output a cross-manual xref to #1. Used just above (twice).
8972 %
8973 % Only include the text "Section ``foo'' in" if the foo is neither
8974 % missing or Top. Thus, @xref{,,,foo,The Foo Manual} outputs simply
8975 % "see The Foo Manual", the idea being to refer to the whole manual.
8976 %
8977 % But, this being TeX, we can't easily compare our node name against the
8978 % string "Top" while ignoring the possible spaces before and after in
8979 % the input. By adding the arbitrary 7sp below, we make it much less
8980 % likely that a real node name would have the same width as "Top" (e.g.,
8981 % in a monospaced font). Hopefully it will never happen in practice.
8982 %
8983 % For the same basic reason, we retypeset the "Top" at every
8984 % reference, since the current font is indeterminate.
8985 %
8992 \fi
8993 \fi
8995 }
8997 % This macro is called from \xrefX for the `[nodename]' part of xref
8998 % output. It's a separate macro only so it can be changed more easily,
8999 % since square brackets don't work well in some documents. Particularly
9000 % one that Bob is working on :).
9001 %
9004 % Things referred to by \setref.
9005 %
9015 \else
9017 \fi\fi\fi
9018 }
9026 \else
9027 \putwordSection@tie
9029 \fi\fi\fi
9030 }
9032 % \refx{NAME} - reference a cross-reference string named NAME.
9034 \requireauxfile
9036 \indexnofonts
9037 \turnoffactive
9039 \expandafter\global\expandafter\let\expandafter\thisrefX
9042 \ifx\thisrefX\relax
9043 % If not defined, say something at least.
9045 \iflinks
9046 \ifhavexrefs
9049 \else
9050 \ifwarnedxrefs\else
9051 \global\warnedxrefstrue
9053 \fi
9054 \fi
9055 \fi
9056 \else
9057 % It's defined, so just use it.
9058 \thisrefX
9059 \fi
9060 }
9062 % This is the macro invoked by entries in the aux file. Define a control
9063 % sequence for a cross-reference target (we prepend XR to the control sequence
9064 % name to avoid collisions). The value is the page number. If this is a float
9065 % type, we have more work to do.
9066 %
9069 % \turnoffactive stops 8-bit characters being changed to commands
9070 % like @'e. \refx does the same to retrieve the value in the definition.
9071 \indexnofonts
9072 \turnoffactive
9076 %
9077 \bgroup
9079 \egroup
9080 % We put the \gdef inside a group to avoid the definitions building up on
9081 % TeX's save stack, which can cause it to run out of space for aux files with
9082 % thousands of lines. \gdef doesn't use the save stack, but \csname does
9083 % when it defines an unknown control sequence as \relax.
9084 %
9085 % Was that xref control sequence that we just defined for a float?
9087 % it was a float, and we have the (safe) float type in \iffloattype.
9088 \expandafter\let\expandafter\floatlist
9090 %
9091 % Is this the first time we've seen this float type?
9092 \expandafter\ifx\floatlist\relax
9094 \else
9095 % had it before, so preserve previous elements in list.
9097 \fi
9098 %
9099 % Remember this xref in the control sequence \floatlistFLOATTYPE,
9100 % for later use in \listoffloats.
9103 \fi
9104 }
9106 % If working on a large document in chapters, it is convenient to
9107 % be able to disable indexing, cross-referencing, and contents, for test runs.
9108 % This is done with @novalidate at the beginning of the file.
9109 %
9113 % Used when writing to the aux file, or when using data from it.
9115 \iflinks
9116 \tryauxfile
9117 % Open the new aux file. TeX will close it automatically at exit.
9119 \fi
9121 }
9123 % Read the last existing aux file, if any. No error if none exists.
9124 %
9129 \global\havexrefstrue
9130 \fi
9132 }
9163 %
9164 % Special characters. Should be turned off anyway, but...
9178 %
9180 %
9181 % @ is our escape character in .aux files, and we need braces.
9185 }
9188 \begingroup
9189 \setupdatafile
9195 % including footnotes.
9197 \newcount \footnoteno
9199 % The trailing space in the following definition for supereject is
9200 % vital for proper filling; pages come out unaligned when you do a
9201 % pagealignmacro call if that space before the closing brace is
9202 % removed. (Generally, numeric constants should always be followed by a
9203 % space to prevent strange expansion errors.)
9206 % @footnotestyle is meaningful for Info output only.
9210 %
9211 % Auto-number footnotes. Otherwise like plain.
9213 \global\advance\footnoteno by \@ne
9215 %
9216 % In case the footnote comes at the end of a sentence, preserve the
9217 % extra spacing after we do the footnote number.
9220 %
9221 % Remove inadvertent blank space before typesetting the footnote number.
9222 \unskip
9223 \thisfootno\@sf
9224 \dofootnote
9227 % Don't bother with the trickery in plain.tex to not require the
9228 % footnote text as a parameter. Our footnotes don't need to be so general.
9229 %
9230 % Oh yes, they do; otherwise, @ifset (and anything else that uses
9231 % \parseargline) fails inside footnotes because the tokens are fixed when
9232 % the footnote is read. --karl, 16nov96.
9233 %
9235 \insert\footins\bgroup
9236 %
9237 % Nested footnotes are not supported in TeX, that would take a lot
9238 % more work. (\startsavinginserts does not suffice.)
9240 %
9241 % We want to typeset this text as a normal paragraph, even if the
9242 % footnote reference occurs in (for example) a display environment.
9243 % So reset some parameters.
9245 \interlinepenalty\interfootnotelinepenalty
9247 \splitmaxdepth\dp\strutbox
9248 \floatingpenalty\@MM
9249 \leftskip\z@skip
9250 \rightskip\z@skip
9251 \spaceskip\z@skip
9252 \xspaceskip\z@skip
9253 \parindent\defaultparindent
9254 %
9255 \smallfonts \rm
9256 %
9257 % Because we use hanging indentation in footnotes, a @noindent appears
9258 % to exdent this text, so make it be a no-op. makeinfo does not use
9259 % hanging indentation so @noindent can still be needed within footnote
9260 % text after an @example or the like (not that this is good style).
9262 %
9263 % Hang the footnote text off the number. Use \everypar in case the
9264 % footnote extends for more than one paragraph.
9267 %
9268 % Don't crash into the line above the footnote text. Since this
9269 % expands into a box, it must come within the paragraph, lest it
9270 % provide a place where TeX can split the footnote.
9271 \footstrut
9272 %
9273 % Invoke rest of plain TeX footnote routine.
9274 \futurelet\next\fo@t
9275 }
9281 even though they work in makeinfo; sorry}
9282 }
9287 }
9289 % In case a @footnote appears in a vbox, save the footnote text and create
9290 % the real \insert just after the vbox finished. Otherwise, the insertion
9291 % would be lost.
9292 % Similarly, if a @footnote appears inside an alignment, save the footnote
9293 % text to a box and make the \insert when a row of the table is finished.
9294 % And the same can be done for other insert classes. --kasal, 16nov03.
9295 %
9296 % Replace the \insert primitive by a cheating macro.
9297 % Deeper inside, just make sure that the saved insertions are not spilled
9298 % out prematurely.
9299 %
9301 \ifx \insert\ptexinsert
9302 \let\insert\saveinsert
9303 \else
9304 \let\checkinserts\relax
9305 \fi
9306 }
9308 % This \insert replacement works for both \insert\footins{foo} and
9309 % \insert\footins\bgroup foo\egroup, but it doesn't work for \insert27{foo}.
9310 %
9313 \afterassignment\next
9314 % swallow the left brace
9315 \let\temp =
9316 }
9325 }
9327 % eat @SAVE -- beware, all of them have catcode \other:
9328 {
9331 }
9333 % initialization:
9336 \next
9337 }
9342 }
9344 % initialize:
9345 \let\checkinserts\empty
9346 \newsaveins\footins
9347 \newsaveins\margin
9350 % @image. We use the macros from epsf.tex to support this.
9351 % If epsf.tex is not installed and @image is used, we complain.
9352 %
9353 % Check for and read epsf.tex up front. If we read it only at @image
9354 % time, we might be inside a group, and then its definitions would get
9355 % undone and the next image would fail.
9358 % Do not bother showing banner with epsf.tex v2.7k (available in
9359 % doc/epsf.tex and on ctan).
9361 \input epsf.tex
9362 \fi
9364 %
9365 % We will only complain once about lack of epsf.tex.
9366 \newif\ifwarnednoepsf
9368 work. It is also included in the Texinfo distribution, or you can get
9369 it from https://ctan.org/texarchive/macros/texinfo/texinfo/doc/epsf.tex.}
9370 %
9372 \ifx\epsfbox\thisisundefined
9373 \ifwarnednoepsf \else
9376 \global\warnednoepsftrue
9377 \fi
9378 \else
9380 \fi
9381 }
9382 %
9383 % Arguments to @image:
9384 % #1 is (mandatory) image filename; we tack on .eps extension.
9385 % #2 is (optional) width, #3 is (optional) height.
9386 % #4 is (ignored optional) html alt text.
9387 % #5 is (ignored optional) extension.
9388 % #6 is just the usual extra ignored arg for parsing stuff.
9389 \newif\ifimagevmode
9393 \makevalueexpandable
9394 % If the image is by itself, center it.
9395 \ifvmode
9396 \imagevmodetrue
9397 \else \ifx\centersub\centerV
9398 % for @center @image, we need a vbox so we can have our vertical space
9399 \imagevmodetrue
9401 \fi\fi
9402 %
9403 \ifimagevmode
9404 \medskip
9405 % Usually we'll have text after the image which will insert
9406 % \parskip glue, so insert it here too to equalize the space
9407 % above and below.
9408 \nobreak\vskip\parskip
9409 \nobreak
9410 \fi
9411 %
9412 % Leave vertical mode so that indentation from an enclosing
9413 % environment such as @quotation is respected.
9414 % However, if we're at the top level, we don't want the
9415 % normal paragraph indentation.
9416 % On the other hand, if we are in the case of @center @image, we don't
9417 % want to start a paragraph, which will create a hsize-width box and
9418 % eradicate the centering.
9419 \ifx\centersub\centerV \else \imageindent \fi
9420 %
9421 % Output the image.
9422 \ifpdf
9423 % For pdfTeX and LuaTeX <= 0.80
9425 \else
9426 \ifx\XeTeXrevision\thisisundefined
9427 % For epsf.tex
9428 % \epsfbox itself resets \epsf?size at each figure.
9434 \else
9435 % For XeTeX
9437 \fi
9438 \fi
9439 %
9440 \ifimagevmode
9442 \fi
9443 \ifx\centersub\centerV \egroup \fi
9447 % @float FLOATTYPE,LABEL,LOC ... @end float for displayed figures, tables,
9448 % etc. We don't actually implement floating yet, we always include the
9449 % float "here". But it seemed the best name for the future.
9450 %
9453 % There may be a space before second and/or third parameter; delete it.
9456 % #1 is the optional FLOATTYPE, the text label for this float, typically
9457 % "Figure", "Table", "Example", etc. Can't contain commas. If omitted,
9458 % this float will not be numbered and cannot be referred to.
9459 %
9460 % #2 is the optional xref label. Also must be present for the float to
9461 % be referable.
9462 %
9463 % #3 is the optional positioning argument; for now, it is ignored. It
9464 % will somehow specify the positions allowed to float to (here, top, bottom).
9465 %
9466 % We keep a separate counter for each FLOATTYPE, which we reset at each
9467 % chapter-level command.
9469 %
9473 %
9474 % don't lose footnotes inside @float.
9475 %
9476 % BEWARE: when the floats start float, we have to issue warning whenever an
9477 % insert appears inside a float which could possibly float. --kasal, 26may04
9478 %
9479 \startsavinginserts
9480 %
9481 % We can't be used inside a paragraph.
9482 \par
9483 %
9484 \vtop\bgroup
9488 %
9489 \ifx\floattype\empty
9491 \else
9493 % the floattype might have accents or other special characters,
9494 % but we need to use it in a control sequence name.
9495 \indexnofonts
9496 \turnoffactive
9499 \fi
9500 %
9501 % If label is given but no type, we handle that as the empty type.
9502 \ifx\floatlabel\empty \else
9503 % We want each FLOATTYPE to be numbered separately (Figure 1,
9504 % Table 1, Figure 2, ...). (And if no label, no number.)
9505 %
9508 %
9510 % This magic value for \currentsection is output by \setref as the
9511 % XREFLABEL-title value. \xrefX uses it to distinguish float
9512 % labels (which have a completely different output format) from
9513 % node and anchor labels. And \xrdef uses it to construct the
9514 % lists of floats.
9515 %
9519 \fi
9520 %
9521 % start with \parskip glue, I guess.
9522 \vskip\parskip
9523 %
9524 % Don't suppress indentation if a float happens to start a section.
9525 \restorefirstparagraphindent
9526 }
9528 % we have these possibilities:
9529 % @float Foo,lbl & @caption{Cap}: Foo 1.1: Cap
9530 % @float Foo,lbl & no caption: Foo 1.1
9531 % @float Foo & @caption{Cap}: Foo: Cap
9532 % @float Foo & no caption: Foo
9533 % @float ,lbl & Caption{Cap}: 1.1: Cap
9534 % @float ,lbl & no caption: 1.1
9535 % @float & @caption{Cap}: Cap
9536 % @float & no caption:
9537 %
9540 %
9541 % In all cases, if we have a float type, it comes first.
9543 %
9544 % If we have an xref label, the number comes next.
9545 \ifx\floatlabel\empty \else
9548 \fi
9549 % the number.
9551 \fi
9552 %
9553 % Start the printed caption with what we've constructed in
9554 % \floatident, but keep it separate; we need \floatident again.
9556 %
9557 \ifx\thiscaption\empty \else
9558 \ifx\floatident\empty \else
9560 \fi
9561 %
9562 % caption text.
9564 \fi
9565 %
9566 % If we have anything to print, print it, with space before.
9567 % Eventually this needs to become an \insert.
9568 \ifx\captionline\empty \else
9570 \captionline
9571 %
9572 % Space below caption.
9573 \vskip\parskip
9574 \fi
9575 %
9576 % If have an xref label, write the list of floats info. Do this
9577 % after the caption, to avoid chance of it being a breakpoint.
9578 \ifx\floatlabel\empty \else
9579 % Write the text that goes in the lof to the aux file as
9580 % \floatlabel-lof. Besides \floatident, we include the short
9581 % caption if specified, else the full caption if specified, else nothing.
9583 \requireauxfile
9584 \atdummies
9585 %
9586 \ifx\thisshortcaption\empty
9588 \else
9590 \fi
9594 \fi
9596 %
9597 \checkinserts
9598 }
9600 % Append the tokens #2 to the definition of macro #1, not expanding either.
9601 %
9604 }
9606 % @caption, @shortcaption
9607 %
9613 % The parameter is the control sequence identifying the counter we are
9614 % going to use. Create it if it doesn't exist and assign it to \floatno.
9617 % Haven't seen this figure type before.
9619 %
9620 % Remember to reset this floatno at the next chap.
9621 \expandafter\gdef\expandafter\resetallfloatnos
9623 \fi
9625 }
9627 % \setref calls this to get the XREFLABEL-snt value. We want an @xref
9628 % to the FLOATLABEL to expand to "Figure 3.1". We call \setref when we
9629 % first read the @float command.
9630 %
9633 % Magic string used for the XREFLABEL-title value, so \xrefX can
9634 % distinguish floats from other xref types.
9637 % #1 is the control sequence we are passed; we expand into a conditional
9638 % which is true if #1 represents a float ref. That is, the magic
9639 % \currentsection value which we \setref above.
9640 %
9642 %
9643 % #1 is (maybe) the \floatmagic string. If so, #2 will be the
9644 % (safe) float type for this float. We set \iffloattype to #2.
9645 %
9649 \ifx\temp\floatmagic
9650 }
9652 % @listoffloats FLOATTYPE - print a list of floats like a table of contents.
9653 %
9657 % the floattype might have accents or other special characters,
9658 % but we need to use it in a control sequence name.
9659 \indexnofonts
9660 \turnoffactive
9663 %
9664 % \xrdef saves the floats as a \do-list in \floatlistSAFEFLOATTYPE.
9666 \ifhavexrefs
9667 % if the user said @listoffloats foo but never @float foo.
9669 \fi
9670 \else
9671 \begingroup
9675 \endgroup
9676 \fi
9677 }
9679 % This is called on each entry in a list of floats. We're passed the
9680 % xref label, in the form LABEL-title, which is how we save it in the
9681 % aux file. We strip off the -title and look up \XRLABEL-lof, which
9682 % has the text we're supposed to typeset here.
9683 %
9684 % Figures without xref labels will not be included in the list (since
9685 % they won't appear in the aux file).
9686 %
9689 % Can't fully expand XR#1-lof because it can contain anything. Just
9690 % pass the control sequence. On the other hand, XR#1-pg is just the
9691 % page number, and we want to fully expand that so we can get a link
9692 % in pdf output.
9694 %
9695 % use the same \entry macro we use to generate the TOC and index.
9697 \writeentry
9698 }}
9703 % For single-language documents, @documentlanguage is usually given very
9704 % early, just after @documentencoding. Single argument is the language
9705 % (de) or locale (de_DE) abbreviation.
9706 %
9707 {
9712 % Read the file by the name they passed if it exists.
9717 \else
9720 \fi
9723 }
9724 %
9725 % If they passed de_DE, and txi-de_DE.tex doesn't exist,
9726 % try txi-de.tex.
9727 %
9733 \else
9736 \fi
9738 }
9740 %
9742 is empty. Maybe you need to install it? Putting it in the current
9743 directory should work if nowhere else does.}
9745 % This macro is called from txi-??.tex files; the first argument is the
9746 % \language name to set (without the "\lang@" prefix), the second and
9747 % third args are \{left,right}hyphenmin.
9748 %
9749 % The language names to pass are determined when the format is built.
9750 % See the etex.log file created at that time, e.g.,
9751 % /usr/local/texlive/2008/texmf-var/web2c/pdftex/etex.log.
9752 %
9753 % With TeX Live 2008, etex now includes hyphenation patterns for all
9754 % available languages. This means we can support hyphenation in
9755 % Texinfo, at least to some extent. (This still doesn't solve the
9756 % accented characters problem.)
9757 %
9760 % do not set the language if the name is undefined in the current TeX.
9763 \else
9765 \fi
9766 % but there is no harm in adjusting the hyphenmin values regardless.
9769 }
9771 % XeTeX and LuaTeX can handle Unicode natively.
9772 % Their default I/O uses UTF-8 sequences instead of a byte-wise operation.
9773 % Other TeX engines' I/O (pdfTeX, etc.) is byte-wise.
9774 %
9775 \newif\iftxinativeunicodecapable
9776 \newif\iftxiusebytewiseio
9778 \ifx\XeTeXrevision\thisisundefined
9779 \ifx\luatexversion\thisisundefined
9780 \txinativeunicodecapablefalse
9781 \txiusebytewiseiotrue
9782 \else
9783 \txinativeunicodecapabletrue
9784 \txiusebytewiseiofalse
9785 \fi
9786 \else
9787 \txinativeunicodecapabletrue
9788 \txiusebytewiseiofalse
9789 \fi
9791 % Set I/O by bytes instead of UTF-8 sequence for XeTeX and LuaTex
9792 % for non-UTF-8 (byte-wise) encodings.
9793 %
9795 \ifx\XeTeXrevision\thisisundefined
9796 \else
9799 % Unfortunately, there seems to be no corresponding XeTeX command for
9800 % output encoding. This is a problem for auxiliary index and TOC files.
9801 % The only solution would be perhaps to write out @U{...} sequences in
9802 % place of non-ASCII characters.
9803 \fi
9805 \ifx\luatexversion\thisisundefined
9806 \else
9811 end
9815 end
9823 end
9824 return line_out
9825 end
9828 }
9829 \fi
9831 \txiusebytewiseiotrue
9832 }
9835 % Helpers for encodings.
9836 % Set the catcode of characters 128 through 255 to the specified number.
9837 %
9843 \repeat
9844 }
9851 \repeat
9852 }
9854 % @documentencoding sets the definition of non-ASCII characters
9855 % according to the specified encoding.
9856 %
9859 %
9860 % Encoding being declared for the document.
9862 %
9863 % Supported encodings: names converted to tokens in order to be able
9864 % to compare them with \ifx.
9870 %
9871 \ifx \declaredencoding \ascii
9872 \asciichardefs
9873 %
9874 \else \ifx \declaredencoding \lattwo
9875 \iftxinativeunicodecapable
9876 \setbytewiseio
9877 \fi
9878 \setnonasciicharscatcode\active
9879 \lattwochardefs
9880 %
9881 \else \ifx \declaredencoding \latone
9882 \iftxinativeunicodecapable
9883 \setbytewiseio
9884 \fi
9885 \setnonasciicharscatcode\active
9886 \latonechardefs
9887 %
9888 \else \ifx \declaredencoding \latnine
9889 \iftxinativeunicodecapable
9890 \setbytewiseio
9891 \fi
9892 \setnonasciicharscatcode\active
9893 \latninechardefs
9894 %
9895 \else \ifx \declaredencoding \utfeight
9896 \iftxinativeunicodecapable
9897 % For native Unicode handling (XeTeX and LuaTeX)
9898 \nativeunicodechardefs
9899 \else
9900 % For treating UTF-8 as byte sequences (TeX, eTeX and pdfTeX)
9901 \setnonasciicharscatcode\active
9902 % since we already invoked \utfeightchardefs at the top level
9903 % (below), do not re-invoke it, otherwise our check for duplicated
9904 % definitions gets triggered. Making non-ascii chars active is
9905 % sufficient.
9906 \fi
9907 %
9908 \else
9910 %
9916 %
9917 \ifx\XeTeXrevision\thisisundefined
9918 \else
9919 \ifx \declaredencoding \utfeight
9920 \else
9921 \ifx \declaredencoding \ascii
9922 \else
9925 \fi
9926 \fi
9927 \fi
9928 }
9930 % emacs-page
9931 % A message to be logged when using a character that isn't available
9932 % the default font encoding (OT1).
9933 %
9936 % Take account of \c (plain) vs. \, (Texinfo) difference.
9939 % First, make active non-ASCII characters in order for them to be
9940 % correctly categorized when TeX reads the replacement text of
9941 % macros containing the character definitions.
9942 \setnonasciicharscatcode\active
9943 %
9947 \ifpassthroughchars
9949 \else
9951 \fi
9952 }}
9954 % Latin1 (ISO-8859-1) character definitions.
9972 %
9989 %
10006 %
10023 %
10040 %
10057 }
10059 % Latin9 (ISO-8859-15) encoding character definitions.
10061 % Encoding is almost identical to Latin1.
10062 \latonechardefs
10063 %
10072 }
10074 % Latin2 (ISO-8859-2) character definitions.
10092 %
10109 %
10126 %
10143 %
10160 %
10177 }
10179 % UTF-8 character definitions.
10180 %
10181 % This code to support UTF-8 is based on LaTeX's utf8.def, with some
10182 % changes for Texinfo conventions. It is included here under the GPL by
10183 % permission from Frank Mittelbach and the LaTeX team.
10184 %
10185 \newcount\countUTFx
10186 \newcount\countUTFy
10187 \newcount\countUTFz
10191 %
10194 %
10201 \else
10203 \fi
10204 }
10206 % Give non-ASCII bytes the active definitions for processing UTF-8 sequences
10207 \begingroup
10212 % Loop from \countUTFx to \countUTFy, performing \UTFviiiTmp
10213 % substituting ~ and $ with a character token of that value.
10215 \global\catcode\countUTFx\active
10221 \expandafter\UTFviiiLoop
10224 % For bytes other than the first in a UTF-8 sequence. Not expected to
10225 % be expanded except when writing to auxiliary files.
10227 \countUTFy = "C2
10231 \UTFviiiLoop
10233 \countUTFx = "C2
10234 \countUTFy = "E0
10239 \UTFviiiLoop
10241 \countUTFx = "E0
10242 \countUTFy = "F0
10247 \UTFviiiLoop
10249 \countUTFx = "F0
10250 \countUTFy = "F4
10256 \UTFviiiLoop
10257 \endgroup
10261 % @U{xxxx} to produce U+xxxx, if we support it.
10264 \iftxinativeunicodecapable
10265 % All Unicode characters can be used if native Unicode handling is
10266 % active. However, if the font does not have the glyph,
10267 % letters are missing.
10268 \begingroup
10271 \endgroup
10272 \else
10275 \fi
10276 \else
10278 \fi
10279 }
10281 % These macros are used here to construct the name of a control
10282 % sequence to be defined.
10290 % For UTF-8 byte sequences (TeX, e-TeX and pdfTeX),
10291 % provide a definition macro to replace a Unicode character;
10292 % this gets used by the @U command
10293 %
10294 \begingroup
10304 \begingroup
10305 \parseXMLCharref
10307 % Give \u8:... its definition. The sequence of seven \expandafter's
10308 % expands after the \gdef three times, e.g.
10309 %
10310 % 1. \UTFviiTwoOctetsName B1 B2
10311 % 2. \csname u8:B1 \string B2 \endcsname
10312 % 3. \u8: B1 B2 (a single control sequence token)
10313 %
10314 \expandafter\expandafter
10315 \expandafter\expandafter
10316 \expandafter\expandafter
10318 %
10321 \fi
10322 %
10323 % define an additional control sequence for this code point.
10326 %
10327 % Given the value in \countUTFz as a Unicode code point, set \UTFviiiTmp
10328 % to the corresponding UTF-8 sequence.
10340 \else
10345 \fi\fi\fi
10346 }
10348 % Extract a byte from the end of the UTF-8 representation of \countUTFx.
10349 % It must be a non-initial byte in the sequence.
10350 % Change \uccode of #1 for it to be used in \parseUTFviiiB as one
10351 % of the bytes.
10358 % \countUTFz is now \countUTFx with the last 5 bits cleared. Subtract
10359 % in order to get the last five bits.
10362 % Convert this to the byte in the UTF-8 sequence.
10367 % Used to put a UTF-8 byte sequence into \UTFviiiTmp
10368 % #1 is the increment for \countUTFz to yield a the first byte of the UTF-8
10369 % sequence.
10370 % #2 is one of the \UTFviii*OctetsName macros.
10371 % #3 is always a full stop (.)
10372 % #4 is a template for the other bytes in the sequence. The values for these
10373 % bytes is substituted in here with \uppercase using the \uccode's.
10378 \endgroup
10380 % For native Unicode handling (XeTeX and LuaTeX),
10381 % provide a definition macro that sets a catcode to `other' non-globally
10382 %
10385 }
10387 % https://en.wikipedia.org/wiki/Plane_(Unicode)#Basic_M
10388 % U+0000..U+007F = https://en.wikipedia.org/wiki/Basic_Latin_(Unicode_block)
10389 % U+0080..U+00FF = https://en.wikipedia.org/wiki/Latin-1_Supplement_(Unicode_block)
10390 % U+0100..U+017F = https://en.wikipedia.org/wiki/Latin_Extended-A
10391 % U+0180..U+024F = https://en.wikipedia.org/wiki/Latin_Extended-B
10392 %
10393 % Many of our renditions are less than wonderful, and all the missing
10394 % characters are available somewhere. Loading the necessary fonts
10395 % awaits user request. We can't truly support Unicode without
10396 % reimplementing everything that's been done in LaTeX for many years,
10397 % plus probably using luatex or xetex, and who knows what else.
10398 % We won't be doing that here in this simple file. But we can try to at
10399 % least make most of the characters not bomb out.
10400 %
10418 %
10435 %
10452 %
10469 %
10486 %
10503 %
10520 %
10537 %
10554 %
10571 %
10588 %
10605 %
10622 %
10639 %
10652 %
10658 %
10665 %
10678 %
10681 %
10688 %
10692 %
10694 %
10696 %
10697 % Greek letters upper case
10715 %\DeclareUnicodeCharacter{03A2}{} % none - corresponds to final sigma
10723 %
10724 % Vowels with accents
10731 %
10732 % Standalone accent
10734 %
10735 % Greek letters lower case
10761 %
10762 % More Greek vowels with accents
10768 %
10769 % Variant Greek letters
10773 %
10786 %
10789 %
10798 %
10811 %
10822 %
10833 %
10844 %
10849 %
10866 %
10877 %
10880 %
10885 %
10890 %
10893 %
10897 %
10900 %
10901 % Punctuation
10917 %
10919 %
10922 %
10923 % Mathematical symbols
10938 %
11030 %
11060 %
11065 % UTF-8 byte sequence (pdfTeX) definitions (replacing and @U command)
11066 % It makes the setting that replace UTF-8 byte sequence.
11068 \let\DeclareUnicodeCharacter\DeclareUnicodeCharacterUTFviii
11069 \unicodechardefs
11070 }
11072 % Whether the active definitions of non-ASCII characters expand to
11073 % non-active tokens with the same character code. This is used to
11074 % write characters literally, instead of using active definitions for
11075 % printing the correct glyphs.
11076 \newif\ifpassthroughchars
11077 \passthroughcharsfalse
11079 % For native Unicode handling (XeTeX and LuaTeX),
11080 % provide a definition macro to replace/pass-through a Unicode character
11081 %
11085 \begingroup
11088 \ifpassthroughchars
11090 \else
11092 \fi
11093 }
11094 \endgroup
11095 }
11096 \begingroup
11100 \endgroup
11101 }
11103 % Native Unicode handling (XeTeX and LuaTeX) character replacing definition.
11104 % It activates the setting that replaces Unicode characters.
11106 \let\DeclareUnicodeCharacter\DeclareUnicodeCharacterNative
11107 \unicodechardefs
11108 }
11110 % For native Unicode handling (XeTeX and LuaTeX),
11111 % make the character token expand
11112 % to the sequences given in \unicodechardefs for printing.
11116 }
11118 % @U command definitions for native Unicode handling (XeTeX and LuaTeX).
11120 \let\DeclareUnicodeCharacter\DeclareUnicodeCharacterNativeAtU
11121 \unicodechardefs
11122 }
11124 % US-ASCII character definitions.
11126 \relax
11127 }
11129 % Define all Unicode characters we know about. This makes UTF-8 the default
11130 % input encoding and allows @U to work.
11131 \iftxinativeunicodecapable
11132 \nativeunicodechardefsatu
11133 \else
11134 \utfeightchardefs
11135 \fi
11145 % Prevent underfull vbox error messages.
11148 % Don't be very finicky about underfull hboxes, either.
11151 % Following George Bush, get rid of widows and orphans.
11155 % Use TeX 3.0's \emergencystretch to help line breaking, but if we're
11156 % using an old version of TeX, don't do anything. We want the amount of
11157 % stretch added to depend on the line length, hence the dependence on
11158 % \hsize. We call this whenever the paper size is set.
11159 %
11161 \ifx\emergencystretch\thisisundefined
11162 % Allow us to assign to \emergencystretch anyway.
11164 \else
11166 \fi
11167 }
11169 % Parameters in order: 1) textheight; 2) textwidth;
11170 % 3) voffset; 4) hoffset; 5) binding offset; 6) topskip;
11171 % 7) physical page height; 8) physical page width.
11172 %
11173 % We also call \setleading{\textleading}, so the caller should define
11174 % \textleading. The caller should also set \parskip.
11175 %
11180 %
11186 %
11191 %
11194 %
11195 \ifpdf
11198 % if we don't reset these, they will remain at "1 true in" of
11199 % whatever layout pdftex was dumped with.
11202 \else
11203 \ifx\XeTeXrevision\thisisundefined
11205 \else
11208 % XeTeX does not have \pdfhorigin and \pdfvorigin.
11209 \fi
11210 \fi
11211 %
11213 %
11215 \setemergencystretch
11216 }
11218 % @letterpaper (the default).
11222 %
11223 % If page is nothing but text, make it come out even.
11228 }}
11230 % Use @smallbook to reset parameters for 7x9.25 trim size.
11234 %
11239 %
11244 }}
11246 % Use @afourpaper to print on European A4 paper.
11250 %
11251 % Double-side printing via postscript on Laserjet 4050
11252 % prints double-sided nicely when \bindingoffset=10mm and \hoffset=-6mm.
11253 % To change the settings for a different printer or situation, adjust
11254 % \normaloffset until the front-side and back-side texts align. Then
11255 % do the same for \bindingoffset. You can set these for testing in
11256 % your texinfo source file like this:
11257 % @tex
11258 % \global\normaloffset = -6mm
11259 % \global\bindingoffset = 10mm
11260 % @end tex
11265 %
11269 }}
11271 % Use @afivepaper to print on European A5 paper.
11272 % From romildo@urano.iceb.ufop.br, 2 July 2000.
11273 % He also recommends making @example and @lisp be small.
11277 %
11282 %
11288 }}
11290 % A specific text layout, 24x15cm overall, intended for A4 paper.
11292 \afourpaper
11297 %
11298 % Must explicitly reset to 0 because we call \afourpaper.
11300 }}
11302 % Use @afourwide to print on A4 paper in landscape format.
11304 \afourpaper
11310 }}
11313 \afourpaper
11321 }}
11324 % @pagesizes TEXTHEIGHT[,TEXTWIDTH]
11325 % Perhaps we should allow setting the margins, \topskip, \parskip,
11326 % and/or leading, also. Or perhaps we should compute them somehow.
11327 %
11332 %
11335 %
11338 % and 1.5in to include heading, footing and
11339 % bottom margin
11340 %
11343 %
11348 }}
11350 % Set default to letter.
11351 %
11352 \letterpaper
11354 % Default value of \hfuzz, for suppressing warnings about overfull hboxes.
11362 % DEL is a comment character, in case @c does not suffice.
11365 % Define macros to output various characters with catcode for normal text.
11376 % This macro is used to make a character print one way in \tt
11377 % (where it can probably be output as-is), and another way in other fonts,
11378 % where something hairier probably needs to be done.
11379 %
11380 % #1 is what to print if we are indeed using \tt; #2 is what to print
11381 % otherwise. Since all the Computer Modern typewriter fonts have zero
11382 % interword stretch (and shrink), and it is reasonable to expect all
11383 % typewriter fonts to have this, we can check that font parameter.
11384 %
11387 % Same as above, but check for italic font. Actually this also catches
11388 % non-italic slanted fonts since it is impossible to distinguish them from
11389 % italic fonts. But since this is only used by $ and it uses \sl anyway
11390 % this is not a problem.
11393 % Set catcodes for Texinfo file
11395 % Active characters for printing the wanted glyph.
11396 % Most of these we simply print from the \tt font, but for some, we can
11397 % use math or other variants that look better in normal text.
11398 %
11403 \chardef\hatchar=`\^
11409 \let\realunder=_
11413 \chardef \less=`\<
11415 \chardef \gtr=`\>
11422 % used for headline/footline in the output routine, in case the page
11423 % breaks in the middle of an @tex block.
11429 \setregularquotes
11432 % in principle, all other definitions in \tex have to be undone too.
11433 }
11435 % Used sometimes to turn off (effectively) the active characters even after
11436 % parsing them.
11438 \normalturnoffactive
11439 \otherbackslash
11440 }
11444 % \backslashcurfont outputs one backslash character in current font,
11445 % as in \char`\\.
11446 \global\chardef\backslashcurfont=`\\
11448 % \realbackslash is an actual character `\' with catcode other.
11451 % In Texinfo, backslash is an active character; it prints the backslash
11452 % in fixed width font.
11455 % Print a typewriter backslash. For math mode, we can't simply use
11456 % \backslashcurfont: the story here is that in math mode, the \char
11457 % of \backslashcurfont ends up printing the roman \ from the math symbol
11458 % font (because \char in math mode uses the \mathcode, and plain.tex
11459 % sets \mathcode`\\="026E). Hence we use an explicit \mathchar,
11460 % which is the decimal equivalent of "715c (class 7, e.g., use \fam;
11461 % ignored family value; char position "5C). We can't use " for the
11462 % usual hex value because it has already been made active.
11465 @let@backslashchar = @ttbackslash % @backslashchar{} is for user documents.
11467 % \otherbackslash defines an active \ to be a literal `\' character with
11468 % catcode other.
11471 % Same as @turnoffactive except outputs \ as {\tt\char`\\} instead of
11472 % the literal character `\'.
11473 %
11474 {@catcode`- = @active
11476 @passthroughcharstrue
11477 @let-=@normaldash
11478 @let"=@normaldoublequote
11479 @let$=@normaldollar %$ font-lock fix
11480 @let+=@normalplus
11481 @let<=@normalless
11482 @let>=@normalgreater
11483 @let^=@normalcaret
11484 @let_=@normalunderscore
11485 @let|=@normalverticalbar
11486 @let~=@normaltilde
11487 @let\=@ttbackslash
11488 @setregularquotes
11489 @unsepspaces
11490 }
11491 }
11493 % If a .fmt file is being used, characters that might appear in a file
11494 % name cannot be active until we have parsed the command line.
11495 % So turn them off again, and have @fixbackslash turn them back on.
11496 @catcode`+=@other @catcode`@_=@other
11498 % \enablebackslashhack - allow file to begin `\input texinfo'
11499 %
11500 % If a .fmt file is being used, we don't want the `\input texinfo' to show up.
11501 % That is what \eatinput is for; after that, the `\' should revert to printing
11502 % a backslash.
11503 % If the file did not have a `\input texinfo', then it is turned off after
11504 % the first line; otherwise the first `\' in the file would cause an error.
11505 % This is used on the very last line of this file, texinfo.tex.
11506 % We also use @c to call @fixbackslash, in case ends of lines are hidden.
11507 {
11508 @catcode`@^=7
11510 @global@let\ = @eatinput%
11513 % Definition for the newline at the end of this file.
11515 % Definition for a newline in the main Texinfo file.
11517 % In case the first line has a whole-line command on it
11518 @let@originalparsearg@parsearg
11520 }}
11525 % Emergency active definition of newline, in case an active newline token
11526 % appears by mistake.
11530 @par%
11531 %<warning: active newline>@par%
11532 }}}
11536 @ifx\@eatinput @let\ = @ttbackslash @fi
11538 @enableemergencynewline
11539 @let@c=@comment
11540 @let@parsearg@originalparsearg
11541 % Also turn back on active characters that might appear in the input
11542 % file name, in case not using a pre-dumped format.
11543 @catcode`+=@active
11544 @catcode`@_=@active
11545 %
11546 % If texinfo.cnf is present on the system, read it.
11547 % Useful for site-wide @afourpaper, etc. This macro, @fixbackslash, gets
11548 % called at the beginning of every Texinfo file. Not opening texinfo.cnf
11549 % directly in this file, texinfo.tex, makes it possible to make a format
11550 % file for Texinfo.
11551 %
11552 @openin 1 texinfo.cnf
11553 @ifeof 1 @else @input texinfo.cnf @fi
11554 @closein 1
11555 }
11558 % Say @foo, not \foo, in error messages.
11559 @escapechar = `@@
11561 % These (along with & and #) are made active for url-breaking, so need
11562 % active definitions as the normal characters.
11567 % These look ok in all fonts, so just make them not special.
11568 % @hashchar{} gets its own user-level command, because of #line.
11571 @catcode`@% = @other @def@normalpercent{%}
11573 @let @hashchar = @normalhash
11575 @c Finally, make ` and ' active, so that txicodequoteundirected and
11577 @c don't make ` and ' active, @code will not get them as active chars.
11578 @c Do this last of all since we use ` in the previous @catcode assignments.
11579 @catcode`@'=@active
11580 @catcode`@`=@active
11581 @setregularquotes
11583 @c Local variables:
11584 @c eval: (add-hook 'before-save-hook 'time-stamp nil t)
11586 @c page-delimiter: "^\\\\message\\|emacs-page"
11587 @c End:
11589 @c vim:sw=2:
11591 @enablebackslashhack