From 293913568e6a7a86fd1479e1cff8e2ecb58d6568 Mon Sep 17 00:00:00 2001 From: Daniel Baumann Date: Sat, 13 Apr 2024 15:44:03 +0200 Subject: Adding upstream version 16.2. Signed-off-by: Daniel Baumann --- doc/src/sgml/html/docguide-authoring.html | 23 +++++++++++++++++++++++ 1 file changed, 23 insertions(+) create mode 100644 doc/src/sgml/html/docguide-authoring.html (limited to 'doc/src/sgml/html/docguide-authoring.html') 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 @@ + +J.5. Documentation Authoring
J.5. Documentation Authoring
Prev UpAppendix J. DocumentationHome Next

J.5. Documentation Authoring #

J.5.1. Emacs

+ 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 + DocBook syntax specifically. +

+ Note that for historical reasons the documentation source files are named + with an extension .sgml even though they are now XML + files. So you might need to adjust your editor configuration to set the + correct mode. +

J.5.1. Emacs #

+ nXML Mode, which ships with + Emacs, is the most common mode for editing + XML documents with Emacs. + It will allow you to use Emacs to insert tags + and check markup consistency, and it supports + DocBook out of the box. Check the + nXML manual for detailed documentation. +

+ src/tools/editors/emacs.samples contains + recommended settings for this mode. +

Prev Up Next
J.4. Building the Documentation with Meson Home J.6. Style Guide
\ No newline at end of file -- cgit v1.2.3