diff options
| author |   Ulrich Müller <ulm@gentoo.org> | 2024-10-24 18:54:32 +0200 |
|---|---|---|
| committer | Ulrich Müller <ulm@gentoo.org> | 2024-11-09 07:56:28 +0100 |
| commit | 906455c6a2b0f0dfd12efc1e44d51f2d469c3442 (patch) | |
| tree | 2e9680016bf33c0f10d1ed61b066664a290ff953 /appendices | |
| parent | devbook.xsl: Test for include instead of contentsTree in dropdown menu (diff) | |
| download | devmanual-906455c6a2b0f0dfd12efc1e44d51f2d469c3442.tar.gz devmanual-906455c6a2b0f0dfd12efc1e44d51f2d469c3442.tar.bz2 devmanual-906455c6a2b0f0dfd12efc1e44d51f2d469c3442.zip | |
Rename the document element from "guide" to "devbook"
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 <ulm@gentoo.org>
Diffstat (limited to 'appendices')
| -rw-r--r-- | appendices/common-problems/text.xml | 4 | ||||
| -rw-r--r-- | appendices/contributing/text.xml | 4 | ||||
| -rw-r--r-- | appendices/contributors/text.xml | 4 | ||||
| -rw-r--r-- | appendices/devbook-guide/text.xml | 14 | ||||
| -rw-r--r-- | appendices/editor-configuration/emacs/text.xml | 4 | ||||
| -rw-r--r-- | appendices/editor-configuration/text.xml | 4 | ||||
| -rw-r--r-- | appendices/editor-configuration/vim/text.xml | 4 | ||||
| -rw-r--r-- | appendices/editor-configuration/xemacs/text.xml | 4 | ||||
| -rw-r--r-- | appendices/further-reading/text.xml | 4 | ||||
| -rw-r--r-- | appendices/text.xml | 4 | ||||
| -rw-r--r-- | appendices/todo-list/text.xml | 4 |
11 files changed, 27 insertions, 27 deletions
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 @@ <?xml version="1.0" encoding="UTF-8"?> -<guide self="appendices/common-problems/"> +<devbook self="appendices/common-problems/"> <chapter> <title>Common problems</title> <body> @@ -195,4 +195,4 @@ by tricking the build system into using a safer location. See </body> </section> </chapter> -</guide> +</devbook> 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 @@ <?xml version="1.0" encoding="UTF-8"?> -<guide self="appendices/contributing/"> +<devbook self="appendices/contributing/"> <chapter> <title>Contributing to this document</title> @@ -144,4 +144,4 @@ amount of depth. </body> </section> </chapter> -</guide> +</devbook> 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 @@ <?xml version="1.0" encoding="UTF-8"?> -<guide self="appendices/contributors/"> +<devbook self="appendices/contributors/"> <chapter> <title>Contributions</title> <body> @@ -133,4 +133,4 @@ This page lists the contributions to the Gentoo Development Guide: </body> </chapter> -</guide> +</devbook> 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 @@ <?xml version="1.0" encoding="UTF-8"?> -<guide self="appendices/devbook-guide/"> +<devbook self="appendices/devbook-guide/"> <chapter> <title>Gentoo DevBook XML guide</title> @@ -34,18 +34,18 @@ used in a DevBook XML document: <codesample lang="sgml" caption="The preamble of 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> </codesample> <p> On the first lines, we see the XML declaration that identifies this as an XML -document. Next, there's a <c><guide></c> tag <d/> the entire document is -enclosed within a <c><guide> </guide></c> pair. Its <c>self</c> +document. Next, there's a <c><devbook></c> tag <d/> the entire document is +enclosed within a <c><devbook> </devbook></c> pair. Its <c>self</c> attribute must point to the relative path of the document from the root node; in the example above the path is <c>appendices/devbook-guide/</c>. An exception -is the root node itself, which has <c><guide root="true"></c> instead. +is the root node itself, which has <c><devbook root="true"></c> instead. </p> <p> @@ -60,7 +60,7 @@ All elements must be closed of course, so the document ends with: <codesample lang="sgml"> </chapter> -</guide> +</devbook> </codesample> </body> @@ -714,4 +714,4 @@ possible. In other words, the </subsection> </section> </chapter> -</guide> +</devbook> 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 @@ <?xml version="1.0" encoding="UTF-8"?> -<guide self="appendices/editor-configuration/emacs/"> +<devbook self="appendices/editor-configuration/emacs/"> <chapter> <title>Configuring GNU Emacs</title> @@ -106,4 +106,4 @@ for each document type. </section> </chapter> -</guide> +</devbook> 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 @@ <?xml version="1.0" encoding="UTF-8"?> -<guide self="appendices/editor-configuration/"> +<devbook self="appendices/editor-configuration/"> <chapter> <title>Editor configuration</title> <body> @@ -23,4 +23,4 @@ with ebuilds. <include href="emacs/"/> <include href="xemacs/"/> -</guide> +</devbook> 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 @@ <?xml version="1.0" encoding="UTF-8"?> -<guide self="appendices/editor-configuration/vim/"> +<devbook self="appendices/editor-configuration/vim/"> <chapter> <title>Configuring <c>vim</c> and <c>gvim</c></title> <body> @@ -22,4 +22,4 @@ of interest. The ! is required to replace spaces with tabs. </body> </chapter> -</guide> +</devbook> 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 @@ <?xml version="1.0" encoding="UTF-8"?> -<guide self="appendices/editor-configuration/xemacs/"> +<devbook self="appendices/editor-configuration/xemacs/"> <chapter> <title>Configuring XEmacs for UTF-8</title> <body> @@ -41,4 +41,4 @@ status line. </body> </chapter> -</guide> +</devbook> 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 @@ <?xml version="1.0" encoding="UTF-8"?> -<guide self="appendices/further-reading/"> +<devbook self="appendices/further-reading/"> <chapter> <title>Further reading</title> <body> @@ -57,5 +57,5 @@ recommendations, not padding designed to make this document look important. </body> </section> </chapter> -</guide> +</devbook> 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 @@ <?xml version="1.0" encoding="UTF-8"?> -<guide self="appendices/"> +<devbook self="appendices/"> <chapter> <title>Appendices</title> @@ -25,4 +25,4 @@ This section incorporates various auxiliary documents which may be useful as a r <include href="contributors/"/> <include href="todo-list/"/> -</guide> +</devbook> 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 @@ <?xml version="1.0" encoding="UTF-8"?> -<guide self="appendices/todo-list/"> +<devbook self="appendices/todo-list/"> <chapter> <title>TODO list</title> <body> @@ -10,4 +10,4 @@ This TODO list is automatically generated from the <c><todo></c> directive <contentsTree root="" extraction="todo"/> </body> </chapter> -</guide> +</devbook> |