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

   1 <?xml version="1.0" encoding="UTF-8" standalone="no"?>
   2 <!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.5. Documentation Authoring</title><link rel="stylesheet" type="text/css" href="stylesheet.css" /><link rev="made" href="pgsql-docs@lists.postgresql.org" /><meta name="generator" content="DocBook XSL Stylesheets Vsnapshot" /><link rel="prev" href="docguide-build-meson.html" title="J.4. Building the Documentation with Meson" /><link rel="next" href="docguide-style.html" title="J.6. Style Guide" /></head><body id="docContent" class="container-fluid col-10"><div class="navheader"><table width="100%" summary="Navigation header"><tr><th colspan="5" align="center">J.5. Documentation Authoring</th></tr><tr><td width="10%" align="left"><a accesskey="p" href="docguide-build-meson.html" title="J.4. Building the Documentation with Meson">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 18.0 Documentation">Home</a></td><td width="10%" align="right"> <a accesskey="n" href="docguide-style.html" title="J.6. Style Guide">Next</a></td></tr></table><hr /></div><div class="sect1" id="DOCGUIDE-AUTHORING"><div class="titlepage"><div><div><h2 class="title" style="clear: both">J.5. Documentation Authoring <a href="#DOCGUIDE-AUTHORING" class="id_link">#</a></h2></div></div></div><div class="toc"><dl class="toc"><dt><span class="sect2"><a href="docguide-authoring.html#DOCGUIDE-AUTHORING-EMACS">J.5.1. Emacs</a></span></dt></dl></div><p>
   3     The documentation sources are most conveniently modified with an editor
   4     that has a mode for editing XML, and even more so if it has some awareness
   5     of XML schema languages so that it can know about
   6     <span class="productname">DocBook</span> syntax specifically.
   7    </p><p>
   8     Note that for historical reasons the documentation source files are named
   9     with an extension <code class="filename">.sgml</code> even though they are now XML
  10     files.  So you might need to adjust your editor configuration to set the
  11     correct mode.
  12    </p><div class="sect2" id="DOCGUIDE-AUTHORING-EMACS"><div class="titlepage"><div><div><h3 class="title">J.5.1. Emacs <a href="#DOCGUIDE-AUTHORING-EMACS" class="id_link">#</a></h3></div></div></div><p>
  13      <span class="productname">nXML Mode</span>, which ships with
  14      <span class="productname">Emacs</span>, is the most common mode for editing
  15      <acronym class="acronym">XML</acronym> documents with <span class="productname">Emacs</span>.
  16      It will allow you to use <span class="application">Emacs</span> to insert tags
  17      and check markup consistency, and it supports
  18      <span class="productname">DocBook</span> out of the box.  Check the <a class="ulink" href="https://www.gnu.org/software/emacs/manual/html_mono/nxml-mode.html" target="_top">
  19      nXML manual</a> for detailed documentation.
  20     </p><p>
  21      <code class="filename">src/tools/editors/emacs.samples</code> contains
  22      recommended settings for this mode.
  23     </p></div></div><div class="navfooter"><hr /><table width="100%" summary="Navigation footer"><tr><td width="40%" align="left"><a accesskey="p" href="docguide-build-meson.html" title="J.4. Building the Documentation with Meson">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.6. Style Guide">Next</a></td></tr><tr><td width="40%" align="left" valign="top">J.4. Building the Documentation with Meson </td><td width="20%" align="center"><a accesskey="h" href="index.html" title="PostgreSQL 18.0 Documentation">Home</a></td><td width="40%" align="right" valign="top"> J.6. Style Guide</td></tr></table></div></body></html>