site-lisp/psgml/README.psgml

   1 This is the READ ME file for psgml.el version 1.2.5.       -*- text -*-
   2
   3 This is a stable release of PSGML. Release 1.2.5 fixes some bugs:
   4   - no longer hardcodes the validation command in XML mode, new
   5   variable sgml-xml-validate-command.
   6   - sgml-edit-attributes no longer write protects the "#DEFAULT" text.
   7   - more multibyte fixes
   8   - explicitly creates C-c C-f and C-c C-u as prefix keys
   9
  10
  11 PSGML is a major mode for editing SGML and XML documents. It works
  12 with GNU Emacs 19.34, 20.7, 21.1, 21.2. This version has not been
  13 tested with XEmacs.
  14
  15 PSGML contains a simple SGML parser and can work with any DTD.
  16 Functions provided includes menus and commands for inserting tags with
  17 only the contextually valid tags, identification of structural errors,
  18 editing of attribute values in a separate window with information
  19 about types and defaults, and structure based editing.
  20
  21 To install PSGML you first need to uncompress and unpack the source
  22 archive.  This is done with the `gunzip' and `tar' commands.
  23
  24      gunzip psgml-1.2.5.tar.gz; tar xf psgml-1.2.5.tar
  25
  26 This should create a subdirectory to the current directory with the
  27 source code. This directory contains a `configure' command (see the file
  28 INSTALL for more information about configure).  You can use the
  29 `configure' command to configure the package or you can load the file
  30 `psgml-maint' and execute the `psgml-compile-files' command.
  31
  32 Place the `*.el' and the `*.elc' files in a directory where Emacs can
  33 find it (i.e. one of the directories in the `load-path' variable, you
  34 can add a directory to this variable in your `.emacs'.)
  35
  36 If you use the `configure' approach, compile psgml with `make' and the
  37 you can run `make install' to install it in the system library
  38 `site-lisp'. The location of `site-lisp' is figured out by
  39 `configure', but you can change it in the `Makefile'.
  40
  41 Put the following line in your .emacs:
  42
  43      (autoload 'sgml-mode "psgml" "Major mode to edit SGML files." t)
  44      (autoload 'xml-mode "psgml" "Major mode to edit XML files." t)
  45
  46 You may also want to set up search paths for external entities,
  47 See the section Entity manager in the psgml.info manual.
  48
  49 The `psgml.info' is the documentation for PSGML in the info format.  You
  50 can read this with the Emacs command `C-u C-h i'.  You can also install
  51 the file in your systems info directory and edit the `dir' file to
  52 include `psgml.info' in the menu.
  53
  54 The info file `psgml.info' is created from the texinfo file
  55 `psgml.texi'.  The texinfo file can also be used to create a hard copy
  56 of the documentation.  To do this you need the TeX program and a copy of
  57 `texinfo.tex'.