| Server IP : 172.67.134.114 / Your IP : 162.159.115.41 Web Server : Apache/2.4.37 System : Linux almalinux.duckdns.org 4.18.0-553.111.1.el8_10.x86_64 #1 SMP Sun Mar 8 20:06:07 EDT 2026 x86_64 User : ricodeal ( 1046) PHP Version : 7.4.33 Disable Function : NONE MySQL : OFF | cURL : ON | WGET : ON | Perl : ON | Python : ON | Sudo : ON | Pkexec : ON Directory : /usr/share/doc/postgresql-docs/html/ |
Upload File : |
<?xml version="1.0" encoding="UTF-8" standalone="no"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"><html xmlns="http://www.w3.org/1999/xhtml"><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /><title>J.4. Documentation Authoring</title><link rel="stylesheet" type="text/css" href="stylesheet.css" /><link rev="made" href="[email protected]" /><meta name="generator" content="DocBook XSL Stylesheets Vsnapshot" /><link rel="prev" href="docguide-build.html" title="J.3. Building The Documentation" /><link rel="next" href="docguide-style.html" title="J.5. Style Guide" /></head><body><div xmlns="http://www.w3.org/TR/xhtml1/transitional" class="navheader"><table width="100%" summary="Navigation header"><tr><th colspan="5" align="center">J.4. Documentation Authoring</th></tr><tr><td width="10%" align="left"><a accesskey="p" href="docguide-build.html" title="J.3. Building The Documentation">Prev</a> </td><td width="10%" align="left"><a accesskey="u" href="docguide.html" title="Appendix J. Documentation">Up</a></td><th width="60%" align="center">Appendix J. Documentation</th><td width="10%" align="right"><a accesskey="h" href="index.html" title="PostgreSQL 10.23 Documentation">Home</a></td><td width="10%" align="right"> <a accesskey="n" href="docguide-style.html" title="J.5. Style Guide">Next</a></td></tr></table><hr></hr></div><div class="sect1" id="DOCGUIDE-AUTHORING"><div class="titlepage"><div><div><h2 class="title" style="clear: both">J.4. Documentation Authoring</h2></div></div></div><div class="toc"><dl class="toc"><dt><span class="sect2"><a href="docguide-authoring.html#id-1.11.11.7.3">J.4.1. Emacs/PSGML</a></span></dt><dt><span class="sect2"><a href="docguide-authoring.html#id-1.11.11.7.4">J.4.2. Other Emacs Modes</a></span></dt></dl></div><p> <acronym class="acronym">SGML</acronym> and <span class="productname">DocBook</span> do
not suffer from an oversupply of open-source authoring tools. The
most common tool set is the
<span class="productname">Emacs</span>/<span class="productname">XEmacs</span>
editor with appropriate editing mode. On some systems
these tools are provided in a typical full installation.
</p><div class="sect2" id="id-1.11.11.7.3"><div class="titlepage"><div><div><h3 class="title">J.4.1. Emacs/PSGML</h3></div></div></div><p> <span class="productname">PSGML</span> is the most common and most
powerful mode for editing <acronym class="acronym">SGML</acronym> documents.
When properly configured, it will allow you to use
<span class="application">Emacs</span> to insert tags and check markup
consistency. You could use it for <acronym class="acronym">HTML</acronym> as
well. Check the <a class="ulink" href="http://www.lysator.liu.se/projects/about_psgml.html" target="_top"> PSGML web site</a> for downloads, installation instructions, and
detailed documentation.
</p><p> There is one important thing to note with
<span class="productname">PSGML</span>: its author assumed that your
main <acronym class="acronym">SGML</acronym> <acronym class="acronym">DTD</acronym> directory
would be <code class="filename">/usr/local/lib/sgml</code>. If, as in the
examples in this chapter, you use
<code class="filename">/usr/local/share/sgml</code>, you have to
compensate for this, either by setting
<code class="envar">SGML_CATALOG_FILES</code> environment variable, or you
can customize your <span class="productname">PSGML</span> installation
(its manual tells you how).
</p><p> Put the following in your <code class="filename">~/.emacs</code>
environment file (adjusting the path names to be appropriate for
your system):
</p><pre class="programlisting">; ********** for SGML mode (psgml)
(setq sgml-omittag t)
(setq sgml-shorttag t)
(setq sgml-minimize-attributes nil)
(setq sgml-always-quote-attributes t)
(setq sgml-indent-step 1)
(setq sgml-indent-data t)
(setq sgml-parent-document nil)
(setq sgml-exposed-tags nil)
(setq sgml-catalog-files '("/usr/local/share/sgml/catalog"))
(autoload 'sgml-mode "psgml" "Major mode to edit SGML files." t )</pre><p>
and in the same file add an entry for <acronym class="acronym">SGML</acronym>
into the (existing) definition for
<code class="varname">auto-mode-alist</code>:
</p><pre class="programlisting">(setq
auto-mode-alist
'(("\\.sgml$" . sgml-mode)
))</pre><p>
</p><p> You might find that when using <span class="productname">PSGML</span>, a
comfortable way of working with these separate files of book
parts is to insert a proper <code class="literal">DOCTYPE</code>
declaration while you're editing them. If you are working on
this source, for instance, it is an appendix chapter, so you
would specify the document as an <span class="quote">“<span class="quote">appendix</span>”</span> instance
of a DocBook document by making the first line look like this:
</p><pre class="programlisting"><!DOCTYPE appendix PUBLIC "-//OASIS//DTD DocBook V4.2//EN"></pre><p>
This means that anything and everything that reads
<acronym class="acronym">SGML</acronym> will get it right, and I can verify the
document with <code class="command">nsgmls -s docguide.sgml</code>. (But
you need to take out that line before building the entire
documentation set.)
</p></div><div class="sect2" id="id-1.11.11.7.4"><div class="titlepage"><div><div><h3 class="title">J.4.2. Other Emacs Modes</h3></div></div></div><p> <span class="productname">GNU Emacs</span> ships with a different
<acronym class="acronym">SGML</acronym> mode, which is not quite as powerful as
<span class="productname">PSGML</span>, but it's less confusing and
lighter weight. Also, it offers syntax highlighting (font lock),
which can be very helpful.
<code class="filename">src/tools/editors/emacs.samples</code> contains
sample settings for this mode.
</p><p> Norm Walsh offers a
<a class="ulink" href="http://nwalsh.com/emacs/docbookide/index.html" target="_top">major mode</a>
specifically for DocBook which also has font-lock and a number of features to
reduce typing.
</p></div></div><div xmlns="http://www.w3.org/TR/xhtml1/transitional" class="navfooter"><hr></hr><table width="100%" summary="Navigation footer"><tr><td width="40%" align="left"><a accesskey="p" href="docguide-build.html" title="J.3. Building The Documentation">Prev</a> </td><td width="20%" align="center"><a accesskey="u" href="docguide.html" title="Appendix J. Documentation">Up</a></td><td width="40%" align="right"> <a accesskey="n" href="docguide-style.html" title="J.5. Style Guide">Next</a></td></tr><tr><td width="40%" align="left" valign="top">J.3. Building The Documentation </td><td width="20%" align="center"><a accesskey="h" href="index.html" title="PostgreSQL 10.23 Documentation">Home</a></td><td width="40%" align="right" valign="top"> J.5. Style Guide</td></tr></table></div></body></html>