home *** CD-ROM | disk | FTP | other *** search
/ Fresh Fish 5 / FreshFish_July-August1994.bin / bbs / gnu / texinfo-3.1-bin.lha / info / texi.info-7 (.txt) < prev    next >
GNU Info File  |  1994-07-11  |  51KB  |  950 lines
  1. This is Info file texi.info, produced by Makeinfo-1.55 from the input
  2. file texi.texi.
  3.    This file documents Texinfo, a documentation system that uses a
  4. single source file to produce both on-line information and a printed
  5. manual.
  6.    Copyright (C) 1988, 1990, 1991, 1992, 1993 Free Software Foundation,
  7.    This is the second edition of the Texinfo documentation,
  8. and is consistent with version 2 of `texinfo.tex'.
  9.    Permission is granted to make and distribute verbatim copies of this
  10. manual provided the copyright notice and this permission notice are
  11. preserved on all copies.
  12.    Permission is granted to copy and distribute modified versions of
  13. this manual under the conditions for verbatim copying, provided that
  14. the entire resulting derived work is distributed under the terms of a
  15. permission notice identical to this one.
  16.    Permission is granted to copy and distribute translations of this
  17. manual into another language, under the above conditions for modified
  18. versions, except that this permission notice may be stated in a
  19. translation approved by the Free Software Foundation.
  20. File: texi.info,  Node: Footnotes,  Next: Conditionals,  Prev: Definition Commands,  Up: Top
  21. Footnotes
  22. *********
  23.    A "footnote" is for a reference that documents or elucidates the
  24. primary text.(1)
  25.    In Texinfo, footnotes are created with the `@footnote' command.
  26. This command is followed immediately by a left brace, then by the text
  27. of the footnote, and then by a terminating right brace.  The template
  28.      @footnote{TEXT}
  29.    Footnotes may be of any length, but are usually short.
  30.    For example, this clause is followed by a sample footnote(2); in the
  31. Texinfo source, it looks like this:
  32.      ...a sample footnote @footnote{Here is the sample
  33.      footnote.}; in the Texinfo source...
  34.    In a printed manual or book, the reference mark for a footnote is a
  35. small, superscripted number; the text of the footnote is written at the
  36. bottom of the page, below a horizontal line.
  37.    In Info, the reference mark for a footnote is a pair of parentheses
  38. with the footnote number between them, like this: `(1)'.
  39.    Info has two footnote styles, which determine where the text of the
  40. footnote is located:
  41.    * In the `End' node style, all the footnotes for a single node are
  42.      placed at the end of that node.  The footnotes are separated from
  43.      the rest of the node by a line of dashes with the word `Footnotes'
  44.      within it.  Each footnote begins with an `(N)' reference mark.
  45.      Here is an example of a single footnote in the end of node style:
  46.            --------- Footnotes ---------
  47.           
  48.           (1)  Here is a sample footnote.
  49.    * In the `Separate' node style, all the footnotes for a single node
  50.      are placed in an automatically constructed node of their own.  In
  51.      this style, a "footnote reference" follows each `(N)' reference
  52.      mark in the body of the node.  The footnote reference is actually
  53.      a cross reference which you use to reach the footnote node.
  54.      The name of the node containing the footnotes is constructed by
  55.      appending `-Footnotes' to the name of the node that contains the
  56.      footnotes. (Consequently, the footnotes' node for the `Footnotes'
  57.      node is `Footnotes-Footnotes'!)  The footnotes' node has an `Up'
  58.      node pointer that leads back to its parent node.
  59.      Here is how the first footnote in this manual looks after being
  60.      formatted for Info in the separate node style:
  61.           File: texinfo.info  Node: Overview-Footnotes, Up: Overview
  62.           
  63.           (1) Note that the first syllable of "Texinfo" is
  64.           pronounced like "speck", not "hex". ...
  65.    A Texinfo file may be formatted into an Info file with either
  66. footnote style.
  67.    Use the `@footnotestyle' command to specify an Info file's footnote
  68. style.  Write this command at the beginning of a line followed by an
  69. argument, either `end' for the end node style or `separate' for the
  70. separate node style.
  71.    For example,
  72.      @footnotestyle end
  73.      @footnotestyle separate
  74.    Write an `@footnotestyle' command before or shortly after the
  75. end-of-header line at the beginning of a Texinfo file.  (If you include
  76. the `@footnotestyle' command between the start-of-header and
  77. end-of-header lines, the region formatting commands will format
  78. footnotes as specified.)
  79.    If you do not specify a footnote style, the formatting commands use
  80. their default style.  Currently, `makeinfo' uses the `end' style, while
  81. `texinfo-format-buffer' and `texinfo-format-region' use the `separate'
  82. style.
  83.    This chapter contains two footnotes.
  84.    ---------- Footnotes ----------
  85.    (1)  A footnote should complement or expand upon the primary text,
  86. but a reader should not need to read a footnote to understand the
  87. primary text.  For a thorough discussion of footnotes, see `The Chicago
  88. Manual of Style', which is published by the University of Chicago Press.
  89.    (2)  Here is the sample footnote.
  90. File: texi.info,  Node: Conditionals,  Next: Format/Print Hardcopy,  Prev: Footnotes,  Up: Top
  91. Conditionally Visible Text
  92. **************************
  93.    Sometimes it is good to use different text for a printed manual and
  94. its corresponding Info file.  In this case, you can use the
  95. "conditional commands" to specify which text is for the printed manual
  96. and which is for the Info file.
  97. * Menu:
  98. * Conditional Commands::        How to specify text for Info or TeX.
  99. * Using Ordinary TeX Commands::  You can use any and all TeX commands.
  100. * set clear value::             How to designate which text to format (for
  101.                                   both Info and TeX); and how to set a
  102.                                   flag to a string that you can insert.
  103. File: texi.info,  Node: Conditional Commands,  Next: Using Ordinary TeX Commands,  Up: Conditionals
  104. Using `@ifinfo' and `@iftex'
  105. ============================
  106.    `@ifinfo' begins segments of text that should be ignored by TeX when
  107. it typesets the printed manual.  The segment of text appears only in
  108. the Info file.  The `@ifinfo' command should appear on a line by
  109. itself;  end the Info-only text with a line containing `@end ifinfo' by
  110. itself.  At the beginning of a Texinfo file, the Info permissions are
  111. contained within a region marked by `@ifinfo' and `@end ifinfo'. (*Note
  112. Info Summary and Permissions::.)
  113.    The `@iftex' and `@end iftex' commands are similar to the `@ifinfo'
  114. and `@end ifinfo' commands, except that they specify text that will
  115. appear in the printed manual but not in the Info file.
  116.    For example,
  117.      @iftex
  118.      This text will appear only in the printed manual.
  119.      @end iftex
  120.      
  121.      @ifinfo
  122.      However, this text will appear only in Info.
  123.      @end ifinfo
  124. The preceding example produces the following line:
  125.    However, this text will appear only in Info.
  126. Note how you only see one of the two lines, depending on whether you
  127. are reading the Info version or the printed version of this manual.
  128.    The `@titlepage' command is a special variant of `@iftex' that is
  129. used for making the title and copyright pages of the printed manual.
  130. (*Note `@titlepage': titlepage.)
  131. File: texi.info,  Node: Using Ordinary TeX Commands,  Next: set clear value,  Prev: Conditional Commands,  Up: Conditionals
  132. Using Ordinary TeX Commands
  133. ===========================
  134.    Inside a region delineated by `@iftex' and `@end iftex', you can
  135. embed some PlainTeX commands.  Info will ignore these commands since
  136. they are only in that part of the file which is seen by TeX.  You can
  137. write the TeX commands as you would write them in a normal TeX file,
  138. except that you must replace the `\' used by TeX with an `@'.  For
  139. example, in the `@titlepage' section of a Texinfo file, you can use the
  140. TeX command `@vskip' to format the copyright page.  (The `@titlepage'
  141. command causes Info to ignore the region automatically, as it does with
  142. the `@iftex' command.)
  143.    However, many features of PlainTeX will not work, as they are
  144. overridden by features of Texinfo.
  145.    You can enter PlainTeX completely, and use `\' in the TeX commands,
  146. by delineating a region with the `@tex' and `@end tex' commands.  (The
  147. `@tex' command also causes Info to ignore the region, like the `@iftex'
  148. command.)
  149.    For example, here is a mathematical expression written in Pl