home *** CD-ROM | disk | FTP | other *** search
/ Fresh Fish 8 / FreshFishVol8-CD1.bin / gnu / info / texi.info-3 (.txt) < prev    next >
GNU Info File  |  1994-12-22  |  50KB  |  936 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: titlepage,  Next: titlefont center sp,  Up: Titlepage & Copyright Page
  21. `@titlepage'
  22. ------------
  23.    Start the material for the title page and following copyright page
  24. with `@titlepage' on a line by itself and end it with `@end titlepage'
  25. on a line by itself.
  26.    The `@end titlepage' command starts a new page and turns on page
  27. numbering. (*Note Page Headings: Headings, for details about how to
  28. generate of page headings.)  All the material that you want to appear
  29. on unnumbered pages should be put between the `@titlepage' and `@end
  30. titlepage' commands.  By using the `@page' command you can force a page
  31. break within the region delineated by the `@titlepage' and `@end
  32. titlepage' commands and thereby create more than one unnumbered page.
  33. This is how the copyright page is produced.  (The `@titlepage' command
  34. might perhaps have been better named the `@titleandadditionalpages'
  35. command, but that would have been rather long!)
  36.    When you write a manual about a computer program, you should write
  37. the version of the program to which the manual applies on the title
  38. page.  If the manual changes more frequently than the program or is
  39. independent of it, you should also include an edition number(1) for the
  40. manual.  This helps readers keep track of which manual is for which
  41. version of the program.  (The `Top' node should also contain this
  42. information; see *Note `@top': makeinfo top.)
  43.    Texinfo provides two methods for creating a title page.  One method
  44. uses the `@titlefont', `@sp', and `@center' commands to generate a
  45. title page in which the words on the page are centered.
  46.    The second method uses the `@title', `@subtitle', and `@author'
  47. commands to create a title page with black rules under the title and
  48. author lines and the subtitle text set flush to the right hand side of
  49. the page.  With this method, you do not specify any of the actual
  50. formatting of the title page.  You specify the text you want, and
  51. Texinfo does the formatting.  You may use either method.
  52.    ---------- Footnotes ----------
  53.    (1)  We have found that it is helpful to refer to versions of
  54. manuals as `editions' and versions of programs as `versions';
  55. otherwise, we find we are liable to confuse each other in conversation
  56. by referring to both the documentation and the software with the same
  57. words.
  58. File: texi.info,  Node: titlefont center sp,  Next: title subtitle author,  Prev: titlepage,  Up: Titlepage & Copyright Page
  59. `@titlefont', `@center', and `@sp'
  60. ----------------------------------
  61.    You can use the `@titlefont', `@sp', and `@center' commands to
  62. create a title page for a printed document.  (This is the first of the
  63. two methods for creating a title page in Texinfo.)
  64.    Use the `@titlefont' command to select a large font suitable for the
  65. title itself.
  66.    For example:
  67.      @titlefont{Texinfo}
  68.    Use the `@center' command at the beginning of a line to center the
  69. remaining text on that line.  Thus,
  70.      @center @titlefont{Texinfo}
  71. centers the title, which in this example is "Texinfo" printed in the
  72. title font.
  73.    Use the `@sp' command to insert vertical space.  For example:
  74.      @sp 2
  75. This inserts two blank lines on the printed page.  (*Note `@sp': sp,
  76. for more information about the `@sp' command.)
  77.    A template for this method looks like this:
  78.      @titlepage
  79.      @sp 10
  80.      @center @titlefont{NAME-OF-MANUAL-WHEN-PRINTED}
  81.      @sp 2
  82.      @center SUBTITLE-IF-ANY
  83.      @sp 2
  84.      @center AUTHOR
  85.      ...
  86.      @end titlepage
  87.    The spacing of the example fits an 8 1/2 by 11 inch manual.
  88. File: texi.info,  Node: title subtitle author,  Next: Copyright & Permissions,  Prev: titlefont center sp,  Up: Titlepage & Copyright Page
  89. `@title', `@subtitle', and `@author'
  90. ------------------------------------
  91.    You can use the `@title', `@subtitle', and `@author' commands to
  92. create a title page in which the vertical and horizontal spacing is
  93. done for you automatically.  This contrasts with the method described in
  94. the previous section, in which the `@sp' command is needed to adjust
  95. vertical spacing.
  96.    Write the `@title', `@subtitle', or `@author' commands at the
  97. beginning of a line followed by the title, subtitle, or author.
  98.    The `@title' command produces a line in which the title is set flush
  99. to the left-hand side of the page in a larger than normal font.  The
  100. title is underlined with a black rule.
  101.    The `@subtitle' command sets subtitles in a normal-sized font flush
  102. to the right-hand side of the page.
  103.    The `@author' command sets the names of the author or authors in a
  104. middle-sized font flush to the left-hand side of the page on a line
  105. near the bottom of the title page.  The names are underlined with a
  106. black rule that is thinner than the rule that underlines the title.
  107. (The black rule only occurs if the `@author' command line is followed
  108. by an `@page' command line.)
  109.    There are two ways to use the `@author' command: you can write the
  110. name or names on the remaining part of the line that starts with an
  111. `@author' command:
  112.      @author by Jane Smith and John Doe
  113. or you can write the names one above each other by using two (or more)
  114. `@author' commands:
  115.      @author Jane Smith
  116.      @author John Doe
  117. (Only the bottom name is underlined with a black rule.)
  118.    A template for this method looks like this:
  119.      @titlepage
  120.      @title NAME-OF-MANUAL-WHEN-PRINTED
  121.      @subtitle SUBTITLE-IF-ANY
  122.      @subtitle SECOND-SUBTITLE
  123.      @author AUTHOR
  124.      @page
  125.      ...
  126.      @end titlepage
  127. Contrast this form with the form of a title page written using the
  128. `@sp', `@center', and `@titlefont' commands:
  129.      @titlepage
  130.      @sp 10
  131.      @center @titlefont{Name of Manual When Printed}
  132.      @sp 2
  133.      @center Subtitle, If Any
  134.      @sp 1
  135.      @center Second subtitle
  136.      @sp 2
  137.      @center Author
  138.      @page
  139.      ...
  140.      @end titlepage
  141. File: texi.info,  Node: Copyright & Permissions,  Next: end titlepage,  Prev: title subtitle author,  Up: Titlepage & Copyright Page
  142. Copyright Page and Permissions
  143. ------------------------------
  144.    By international treaty, the copyright notice for a book should be
  145. either on the title page or on the back of the title page.  The
  146. copyright notice should include the year followed by the name of the
  147. organization or person who owns the copyright.
  148.    When the copyright notice is on the back of the title page, that page
  149. is customarily not numbered.  Therefore, in Texinfo, the information on
  150. the copyright page should be within `@titlepage' and `@end titlepage'
  151. commands.
  152.    Use the `@page' command to cause a page break.  To push the
  153. copyright notice and the other text on the copyright page towards the
  154. bottom of the page, you can write a somewhat mysterious line after the
  155. `@page' command that reads like this:
  156.      @vskip 0pt plus 1filll
  157. This is a TeX command that is not supported by the Info formatting
  158. commands.  The `@vskip' command inserts whitespace.  The `0pt plus
  159. 1filll' means to put in zero points of mandatory whitespace, and as
  160. much optional whitespace as needed to push the following text to the
  161. bottom of the page.  Note the use of three `l's in the word `filll';
  162. this is the correct usage in TeX.
  163.    In a print