diff options
| author | Daniel Baumann <daniel.baumann@progress-linux.org> | 2024-04-13 13:44:03 +0000 |
|---|---|---|
| committer | Daniel Baumann <daniel.baumann@progress-linux.org> | 2024-04-13 13:44:03 +0000 |
| commit | 293913568e6a7a86fd1479e1cff8e2ecb58d6568 (patch) | |
| tree | fc3b469a3ec5ab71b36ea97cc7aaddb838423a0c /doc/src/sgml/html/docguide-authoring.html | |
| parent | Initial commit. (diff) | |
| download | postgresql-16-293913568e6a7a86fd1479e1cff8e2ecb58d6568.tar.xz postgresql-16-293913568e6a7a86fd1479e1cff8e2ecb58d6568.zip | |
Adding upstream version 16.2.upstream/16.2
Signed-off-by: Daniel Baumann <daniel.baumann@progress-linux.org>
Diffstat (limited to 'doc/src/sgml/html/docguide-authoring.html')
| -rw-r--r-- | doc/src/sgml/html/docguide-authoring.html | 23 |
1 files changed, 23 insertions, 0 deletions
diff --git a/doc/src/sgml/html/docguide-authoring.html b/doc/src/sgml/html/docguide-authoring.html new file mode 100644 index 0000000..8e43908 --- /dev/null +++ b/doc/src/sgml/html/docguide-authoring.html @@ -0,0 +1,23 @@ +<?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.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 16.2 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> + The documentation sources are most conveniently modified with an editor + that has a mode for editing XML, and even more so if it has some awareness + of XML schema languages so that it can know about + <span class="productname">DocBook</span> syntax specifically. + </p><p> + Note that for historical reasons the documentation source files are named + with an extension <code class="filename">.sgml</code> even though they are now XML + files. So you might need to adjust your editor configuration to set the + correct mode. + </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> + <span class="productname">nXML Mode</span>, which ships with + <span class="productname">Emacs</span>, is the most common mode for editing + <acronym class="acronym">XML</acronym> documents with <span class="productname">Emacs</span>. + It will allow you to use <span class="application">Emacs</span> to insert tags + and check markup consistency, and it supports + <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"> + nXML manual</a> for detailed documentation. + </p><p> + <code class="filename">src/tools/editors/emacs.samples</code> contains + recommended settings for this mode. + </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 16.2 Documentation">Home</a></td><td width="40%" align="right" valign="top"> J.6. Style Guide</td></tr></table></div></body></html>
\ No newline at end of file |