Common problems

From 906455c6a2b0f0dfd12efc1e44d51f2d469c3442 Mon Sep 17 00:00:00 2001 From: Ulrich Müller Date: Thu, 24 Oct 2024 18:54:32 +0200 Subject: Rename the document element from "guide" to "devbook" MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit The "guide" document element is ambiguous with the previously used GuideXML format. Now that DevBook XML has a schema, this confuses Emacs nXML mode (which uses the document element to locate a schema), e.g. when visiting old GuideXML documentation files. Signed-off-by: Ulrich Müller --- appendices/common-problems/text.xml | 4 ++-- appendices/contributing/text.xml | 4 ++-- appendices/contributors/text.xml | 4 ++-- appendices/devbook-guide/text.xml | 14 +++++++------- appendices/editor-configuration/emacs/text.xml | 4 ++-- appendices/editor-configuration/text.xml | 4 ++-- appendices/editor-configuration/vim/text.xml | 4 ++-- appendices/editor-configuration/xemacs/text.xml | 4 ++-- appendices/further-reading/text.xml | 4 ++-- appendices/text.xml | 4 ++-- appendices/todo-list/text.xml | 4 ++-- 11 files changed, 27 insertions(+), 27 deletions(-) (limited to 'appendices') diff --git a/appendices/common-problems/text.xml b/appendices/common-problems/text.xml index 6ebc098..f8fdad1 100644 --- a/appendices/common-problems/text.xml +++ b/appendices/common-problems/text.xml @@ -1,5 +1,5 @@ - + Common problems @@ -195,4 +195,4 @@ by tricking the build system into using a safer location. See - + diff --git a/appendices/contributing/text.xml b/appendices/contributing/text.xml index 2704463..fdcaa90 100644 --- a/appendices/contributing/text.xml +++ b/appendices/contributing/text.xml @@ -1,5 +1,5 @@ - + Contributing to this document @@ -144,4 +144,4 @@ amount of depth. - + diff --git a/appendices/contributors/text.xml b/appendices/contributors/text.xml index 91f3902..702f9af 100644 --- a/appendices/contributors/text.xml +++ b/appendices/contributors/text.xml @@ -1,5 +1,5 @@ - + Contributions @@ -133,4 +133,4 @@ This page lists the contributions to the Gentoo Development Guide: - + diff --git a/appendices/devbook-guide/text.xml b/appendices/devbook-guide/text.xml index 4fc23cc..ca0dfae 100644 --- a/appendices/devbook-guide/text.xml +++ b/appendices/devbook-guide/text.xml @@ -1,5 +1,5 @@ - + Gentoo DevBook XML guide @@ -34,18 +34,18 @@ used in a DevBook XML document: <?xml version="1.0" encoding="UTF-8"?> -<guide self="appendices/devbook-guide/"> +<devbook self="appendices/devbook-guide/"> <chapter> <title>Gentoo DevBook XML guide</title>

On the first lines, we see the XML declaration that identifies this as an XML -document. Next, there's a <guide> tag the entire document is -enclosed within a <guide> </guide> pair. Its self +document. Next, there's a <devbook> tag the entire document is +enclosed within a <devbook> </devbook> pair. Its self attribute must point to the relative path of the document from the root node; in the example above the path is appendices/devbook-guide/. An exception -is the root node itself, which has <guide root="true"> instead. +is the root node itself, which has <devbook root="true"> instead.

@@ -60,7 +60,7 @@ All elements must be closed of course, so the document ends with: </chapter> -</guide> +</devbook> @@ -714,4 +714,4 @@ possible. In other words, the - + diff --git a/appendices/editor-configuration/emacs/text.xml b/appendices/editor-configuration/emacs/text.xml index df3b94b..206f438 100644 --- a/appendices/editor-configuration/emacs/text.xml +++ b/appendices/editor-configuration/emacs/text.xml @@ -1,5 +1,5 @@ - + Configuring GNU Emacs @@ -106,4 +106,4 @@ for each document type. - + diff --git a/appendices/editor-configuration/text.xml b/appendices/editor-configuration/text.xml index 7b50b48..5ceaf86 100644 --- a/appendices/editor-configuration/text.xml +++ b/appendices/editor-configuration/text.xml @@ -1,5 +1,5 @@ - + Editor configuration @@ -23,4 +23,4 @@ with ebuilds. - + diff --git a/appendices/editor-configuration/vim/text.xml b/appendices/editor-configuration/vim/text.xml index ffcf686..0e6088b 100644 --- a/appendices/editor-configuration/vim/text.xml +++ b/appendices/editor-configuration/vim/text.xml @@ -1,5 +1,5 @@ - + Configuring <c>vim</c> and <c>gvim</c> @@ -22,4 +22,4 @@ of interest. The ! is required to replace spaces with tabs. - + diff --git a/appendices/editor-configuration/xemacs/text.xml b/appendices/editor-configuration/xemacs/text.xml index 4b18da1..bddce1c 100644 --- a/appendices/editor-configuration/xemacs/text.xml +++ b/appendices/editor-configuration/xemacs/text.xml @@ -1,5 +1,5 @@ - + Configuring XEmacs for UTF-8 @@ -41,4 +41,4 @@ status line. - + diff --git a/appendices/further-reading/text.xml b/appendices/further-reading/text.xml index 95eb812..3a68ef6 100644 --- a/appendices/further-reading/text.xml +++ b/appendices/further-reading/text.xml @@ -1,5 +1,5 @@ - + Further reading @@ -57,5 +57,5 @@ recommendations, not padding designed to make this document look important. - + diff --git a/appendices/text.xml b/appendices/text.xml index effc5b5..e59fe05 100644 --- a/appendices/text.xml +++ b/appendices/text.xml @@ -1,5 +1,5 @@ - + Appendices @@ -25,4 +25,4 @@ This section incorporates various auxiliary documents which may be useful as a r - + diff --git a/appendices/todo-list/text.xml b/appendices/todo-list/text.xml index c6db2a8..767e457 100644 --- a/appendices/todo-list/text.xml +++ b/appendices/todo-list/text.xml @@ -1,5 +1,5 @@ - + TODO list @@ -10,4 +10,4 @@ This TODO list is automatically generated from the <todo> directive - + -- cgit v1.2.3-65-gdbad