home *** CD-ROM | disk | FTP | other *** search
/ GEMini Atari / GEMini_Atari_CD-ROM_Walnut_Creek_December_1993.iso / files / gnu / tinfo210 / new_feat < prev    next >
Text File  |  1991-09-26  |  8KB  |  279 lines
  1. Texinfo 2.10
  2. ************
  3.  
  4. The second edition of the Texinfo manual is now released in a package
  5. with the second version of the various Texinfo support files,
  6. including `texinfo.el', `texnfo-upd.el', and `makeinfo.c'.  The new
  7. manual is considerably larger than the previous one.
  8.  
  9. The Texinfo 2 package is temporary; after a period of testing, the new
  10. documentation and software will be merged into the Emacs distribution.
  11.  
  12. Here is a brief description of the new Texinfo mode commands 
  13. and the newly described @-commands:
  14.  
  15. New Texinfo Mode Commands
  16. =========================
  17.  
  18. Texinfo mode provides commands and features especially designed for
  19. working with Texinfo files.  More than 20 new commands have been
  20. added, including commands for automatically creating and updating
  21. nodes and menus, a tedious task when done by hand.
  22.  
  23. The keybindings are intended to be somewhat mnemonic.
  24.  
  25. Update everything
  26. -----------------
  27.  
  28. The `texinfo-master-menu' command is the primary command:
  29.  
  30.      C-c C-u m       Create or update a master menu.
  31.                      With an argument, first create or
  32.                      update all nodes and regular menus.
  33.  
  34. Update Pointers
  35. ---------------
  36.  
  37. Create or update `Next', `Previous', and `Up' node pointers.
  38.  
  39.      C-c C-u C-n     Update a node.
  40.      C-c C-u C-e     Update every node in the buffer.
  41.  
  42. Update Menus
  43. ------------
  44.  
  45. Create or update menus.
  46.  
  47.      C-c C-u C-m     Make or update a menu.
  48.  
  49.      C-c C-u C-a     Make or update all the menus
  50.                      in a buffer; with an argument, 
  51.                      first update all the nodes.
  52.  
  53. Format for Info
  54. ---------------
  55.  
  56. Provide keybindings both for the Info formatting commands that are
  57. written in Emacs Lisp and for `makeinfo' which is written in C.
  58.  
  59. Use the Emacs lisp `texinfo-format...' commands:
  60.  
  61.      C-c C-e C-r     Format the region.
  62.      C-c C-e C-b     Format the buffer.
  63.  
  64. Use `makeinfo':
  65.  
  66.      C-c C-m C-r     Format the region.
  67.      C-c C-m C-b     Format the buffer.
  68.      C-c C-m C-l     Recenter the `makeinfo' output buffer.
  69.      C-c C-m C-k     Kill the `makeinfo' formatting job.
  70.  
  71. Typeset and Print
  72. -----------------
  73.  
  74. Typeset and print Texinfo documents from within Emacs.
  75.  
  76.      C-c C-t C-r     Run TeX on the region.
  77.      C-c C-t C-b     Run TeX on the buffer.
  78.      C-c C-t C-i     Run `texindex'.
  79.      C-c C-t C-p     Print the DVI file.
  80.      C-c C-t C-q     Show the print queue.
  81.      C-c C-t C-d     Delete a job from the print queue.
  82.      C-c C-t C-k     Kill the current TeX formatting job.
  83.      C-c C-t C-x     Quit a currently stopped TeX formatting job.
  84.      C-c C-t C-l     Recenter the output buffer.
  85.  
  86. Other Updating Commands
  87. -----------------------
  88.  
  89. The `other updating commands' do not have standard keybindings because
  90. they are less frequently used.
  91.  
  92.      M-x texinfo-insert-node-lines
  93.                      Insert missing node lines using 
  94.                      section titles as node names.
  95.  
  96.      M-x texinfo-multiple-files-update
  97.                      Update a multi-file document.
  98.  
  99.      M-x texinfo-indent-menu-description
  100.                      Indent descriptions in menus.
  101.  
  102.      M-x texinfo-sequential-update-node
  103.                      Insert node pointers in strict sequence.
  104.  
  105. Newly Described Texinfo @-Commands
  106. ==================================
  107.  
  108. The second edition of the Texinfo manual describes more than 50
  109. commands that were not described in the first edition.  A third or so
  110. of these commands existed in Texinfo but were not documented in the
  111. manual; the others are new.  Here is a listing, with brief
  112. descriptions of them:
  113.  
  114.  
  115. Commands for creating your own index and for merging two indices:
  116.  
  117. `@defindex INDEX-NAME'
  118.      Define a new index and its indexing command.  Print entries in a
  119.      roman font.  Also, the `@defcodeindex' command, which prints
  120.      entries in an `@code' font.
  121.  
  122. `@synindex FROM-INDEX INTO-INDEX'
  123.      Merge the index named in the first argument into the index named
  124.      in the second argument.  Sets FROM-INDEX in the same (roman) font
  125.      as INTO-INDEX.  Also, the `@syncodeindex' command, which prints
  126.      the entries from the first index in `@code' font.
  127.  
  128.  
  129. Many commands to help you describe functions, variables, macros,
  130. commands, user options, special forms and other such artifacts in a
  131. uniform format.
  132.  
  133. `@deffn CATEGORY NAME ARGUMENTS...'
  134.      Format a description for functions, interactive commands, and
  135.      similar entities that may take arguments.  Takes as arguments the
  136.      category of entity being described, the name of this particular
  137.      entity, and its arguments, if any.
  138.  
  139. `@defvr, @defop, ...'
  140.      15 other related commands.
  141.  
  142.  
  143. Special symbols to indicate the results of evaluation or an expansion,
  144. printed output, an error message, equivalence of expressions, and the
  145. location of point.
  146.  
  147. `@equiv{}'
  148.      Indicate the exact equivalence of two forms; special glyph: `=='.
  149.  
  150. `@error{}'
  151.      Indicate that the following text is an error message: `error-->'.
  152.  
  153. `@expansion{}'
  154.      Indicate the result of a macro expansion; special glyph: `==>'.
  155.  
  156. `@point{}'
  157.      Indicate the position of point; special glyph: `-!-'.
  158.  
  159. `@print{}'
  160.      Indicate printed output; special glyph: `-|'.
  161.  
  162. `@result{}'
  163.      Indicate the result of an expression; special glyph: `=>'.
  164.  
  165.  
  166. Commands to customize headings:
  167.  
  168. `@headings ON-OFF-SINGLE-DOUBLE'
  169.      Turn headings on or off, or specify single-sided or double-sided
  170.      headings for printing.
  171.  
  172. `@evenfooting [LEFT] @| [CENTER] @| [RIGHT]'
  173.      Specify footings for even-numbered (left-hand) pages.  Not
  174.      relevant to Info.
  175.  
  176. `@evenheading, @everyheading, @oddheading, ...'
  177.      Five other related commands.
  178.  
  179. `@thischapter'
  180.      In a heading or footing, stands for the number and name of the
  181.      current chapter, in the format `Chapter 1: First Chapter'.
  182.  
  183. `@thischaptername, @thisfile, @thistitle, @thispage'
  184.      Related commands.
  185.  
  186.  
  187. Commands for formatting text:
  188.  
  189. `@cartouche'   
  190.      Draw rounded box surrounding text (not in Info).
  191.  
  192. `@exdent LINE-OF-TEXT'
  193.      Remove any indentation a line might have.
  194.  
  195. `@flushleft'
  196.      Left justify every line but leave the right end ragged.  Leave
  197.      font as is.
  198.  
  199. `@flushright'
  200.      Right justify every line but leave the left end ragged.  Leave
  201.      font as is.
  202.  
  203. `@format'
  204.      Like `@example' or `@display', but do not narrow the margins or
  205.      select the fixed-width font.
  206.  
  207. `@ftable FORMATTING-COMMAND'
  208.      Begin a two-column table, using `@item' for each entry.
  209.      Automatically enter each of the items in the first column into
  210.      the index of functions.  The same as `@table', except for
  211.      indexing.
  212.  
  213. `@lisp'
  214.      Indent text, do not fill, select fixed-width font.
  215.  
  216. `@smallexample'
  217.      Indent text, do not fill, select fixed-width font.  In
  218.      `@smallbook' format, print text in a smaller font than with the
  219.      `@example' environment.  Also, the `@smalllisp' command.
  220.  
  221.  
  222. Produce unnumbered headings that do not appear in a table of contents.
  223.  
  224. `@heading TITLE'
  225.      Print an unnumbered section-like heading in the text, but not in
  226.      the table of contents of a printed manual.
  227.  
  228. `@chapheading, @majorheading'
  229. `@subheading, @subsubheading'
  230.      Related commands.
  231.  
  232.  
  233. Font commands:
  234.  
  235. `@r{TEXT}'
  236.      Print TEXT in roman font.  No effect in Info.
  237.  
  238. `@sc{TEXT}'
  239.      Set TEXT in the printed output in THE SMALL CAPS FONT and set
  240.      text in the Info file in uppercase letters.
  241.  
  242.  
  243. Miscellaneous:
  244.  
  245. `@author AUTHOR'
  246.      Typeset author's name flushleft and underline it.
  247.  
  248. `@finalout'
  249.      Prevent TeX from printing large black warning rectangles beside
  250.      over-wide lines.
  251.  
  252. `@footnotestyle STYLE'
  253.      Specify footnote style, end or separate.
  254.  
  255. `@dmn{DIMENSION}'
  256.      Format a dimension.
  257.  
  258. `@minus{}'
  259.      Generate a minus sign.
  260.  
  261. `@paragraphindent INDENT'
  262.      Specify paragraph indentation, asis or a number.
  263.  
  264. `@ref{NODE-NAME, [ENTRY], [TOPIC], [INFO-FILE], [MANUAL]}'
  265.      Make a reference.  In the printed manual, the reference does not
  266.      start with a `See'.
  267.  
  268. `@title TITLE'
  269.      Alternative format for a title page.  In the printed manual, set
  270.      a title flush to the left-hand side of the page in a larger than
  271.      normal font and underline it with a black rule.  Also,
  272.      `@subtitle' command.
  273.                
  274. `@subtitle SUBTITLE'
  275.      Subtitle in the alternative title page format.
  276.  
  277. `@today{}'
  278.      Insert the current date.
  279.