Index: openacs-4/packages/acs-core-docs/www/psgml-mode.html =================================================================== RCS file: /usr/local/cvsroot/openacs-4/packages/acs-core-docs/www/psgml-mode.html,v diff -u -r1.48.2.13 -r1.48.2.14 --- openacs-4/packages/acs-core-docs/www/psgml-mode.html 19 Nov 2016 09:21:54 -0000 1.48.2.13 +++ openacs-4/packages/acs-core-docs/www/psgml-mode.html 6 Jan 2017 09:18:42 -0000 1.48.2.14 @@ -10,9 +10,9 @@ tag automatically.

Where to get it

Most newer emacsen come with PSGML mode preinstalled. You can find out whether your emacs has it with the locate-library command. In Emacs, type M-x locate-library and enter psgml. Emacs will tell -you if it found it or not.

If you don't have PSGML preinstalled in your Emacs, there are two +you if it found it or not.

If you don't have PSGML preinstalled in your Emacs, there are two things you can do:

  1. On Linux: Get the -psgml rpm from RedHat's +psgml rpm from RedHat's docbook-tools and install it as usual.

  2. On other systems: Get the tarball from the PSGML Website. Unpack it and follow the install instructions.

Using CATALOG files

The easiest way to teach PSGML mode about a DTD is by adding it to your own CATALOG. Here is an example of how you can set that up for the @@ -27,9 +27,9 @@ CATALOG "docbook-xml/docbook.cat"

in it. By maintaining your own CATALOG, it is easy to add more -DTD's without changing your emacs settings. (How about that HTML 4.01 DTD you +DTD's without changing your emacs settings. (How about that HTML 4.01 DTD you always wanted to get from W3C ? The -DTD is in the zip archives and tarballs available on the site.)

That's it. Now you are ready to tell emacs all about PSGML mode and +DTD is in the zip archives and tarballs available on the site.)

That's it. Now you are ready to tell emacs all about PSGML mode and that funky CATALOG

What to tell emacs

If you installed PSGML mode in a non-standard location, e.g., somewhere in your home directory, you need to add this to the load-path by adding this line to your .emacs file:

@@ -79,8 +79,8 @@
    
 

Which says that the parent of this document can be found in the file top.xml, that the element in the parent that will enclose the -current document is a book and that the current file's topmost +current document is a book and that the current file's topmost element is a sect1.

How to use it

Of course, you should read the emacs texinfo pages that come with PSGML mode from start to finish. Barring that, here are some handy commands:

KeyCommand
C-c C-eInsert an element. Uses completion and only lets you insert elements that -are valid
C-c C-aEdit attributes of enclosing element.
C-c C-x C-iShow information about the document's DTD.
C-c C-x C-eDescribe element. Shows for one element which elements can be parents, +are valid
C-c C-aEdit attributes of enclosing element.
C-c C-x C-iShow information about the document's DTD.
C-c C-x C-eDescribe element. Shows for one element which elements can be parents, what its contents can be and lists its attributes.

Further reading

Start with the the section called “OpenACS Documentation Guide”

($Id$)