home *** CD-ROM | disk | FTP | other *** search
/ InfoMagic Source Code 1993 July / THE_SOURCE_CODE_CD_ROM.iso / languages / elisp / packages / LaTeXinfo.shar.2 / README < prev    next >
Encoding:
Text File  |  1990-07-22  |  2.6 KB  |  64 lines
  1. This is version 1.2 of the LaTeXinfo documentation, and is for Version 18
  2. of GNU Emacs.
  3.  
  4. Documentation for GNU utilities and libraries is usually written in a
  5. format called "TeXinfo".  This document describes an enhancement
  6. of this format which can be used with LaTeX instead of TeX.
  7.  
  8. LaTeXinfo offers a number of advantages over TeXinfo:
  9.  
  10.      
  11.   1. The point size or layout style of a document can be changed easily using
  12.      as can the `documentstyle' (article, report, book, twoside, ...).
  13.      
  14.   2. LaTeX has better error checking than TeX files, especially in
  15.      begin/end environments.  In addition, the LaTeX error messages are more
  16.      informative.  This makes it considerably easier to make extensions and
  17.      enhancements (read hacks).
  18.      
  19.   3. LaTeX delimits its arguments with braces, so it's easier to tell where
  20.      a LaTeXinfo command starts, and where it ends.
  21.      
  22.   4. Any LaTeX commands not understood by the on-line manual generator
  23.      (`latexinfo.el') are simply ignored.  This means that you are free to add
  24.      a considerable number of LaTeX commands to make you manual look pretty,
  25.      as long as you don't care that there will be no action taken by the 
  26.      Info formatting program.
  27.      
  28.   5. It is easy to add your own extensions to the on-line manual generator
  29.      by making GNU Emacs handlers for your LaTeX extensions.  This is
  30.      the Emacs counterpart to the `documentstyle' options.  LaTeXinfo looks
  31.      in a specified directory for GNU Elisp code that corresponds to each
  32.      style file.  This makes it easy to modularize you style files.
  33.      
  34.   6. LaTeX has many advantages over TeX, such as being able to
  35.      incorporate the BibTeX bibliography formatting program, and is much more
  36.      widely used than either Scribe or plain TeX.
  37.      
  38.  
  39. To install:
  40.  
  41. 1)    edit the file .login to set the LATEXINFO environment variable to 
  42.     point to this directory.
  43. 2)    edit your .cshrc to include a command to source this .login file
  44.     each time you log in.
  45. 3)    source this .login file now so that you can proceed.
  46. 4)    edit the file manual/Makefile to set 
  47.     the name of your DVI to PS filter, and
  48.     the name of your GNU Emacs.
  49. 5)    type make to make the manual and compile the .el files
  50. 6)    move a copy of the files manual/latexinfo.info* to the info
  51.     directory of the GNU Emacs distribution, and edit the dir
  52.     file in that directory to include lines like
  53.  
  54. * LaTeXinfo: (latexinfo.info).   With one source file, make either a printed 
  55.                         manual using LaTeX or an Info file.
  56.  
  57. 7)    include a copy of the .emacs file in your ~/.emacs.
  58. 8)    print a copy of the manual/latexinfo.dvi file and enjoy.
  59.  
  60.  
  61. Please report any errors to mike@ists.ists.ca
  62.  
  63. Mike Clarkson
  64.