begriffs open source - ai-pg/blob - full-docs/txt/docguide-authoring.txt

   1
   2 J.5. Documentation Authoring #
   3
   4    J.5.1. Emacs
   5
   6    The documentation sources are most conveniently modified with an editor
   7    that has a mode for editing XML, and even more so if it has some
   8    awareness of XML schema languages so that it can know about DocBook
   9    syntax specifically.
  10
  11    Note that for historical reasons the documentation source files are
  12    named with an extension .sgml even though they are now XML files. So
  13    you might need to adjust your editor configuration to set the correct
  14    mode.
  15
  16 J.5.1. Emacs #
  17
  18    nXML Mode, which ships with Emacs, is the most common mode for editing
  19    XML documents with Emacs. It will allow you to use Emacs to insert tags
  20    and check markup consistency, and it supports DocBook out of the box.
  21    Check the nXML manual for detailed documentation.
  22
  23    src/tools/editors/emacs.samples contains recommended settings for this
  24    mode.