From: "Ulrich Müller" <ulm@gentoo.org>
To: gentoo-commits@lists.gentoo.org
Subject: [gentoo-commits] proj/devmanual:master commit in: appendices/devbook-guide/
Date: Wed, 15 Jan 2020 21:30:00 +0000 (UTC) [thread overview]
Message-ID: <1579123727.710b619980ed23811cbc0841466b9502a2c92278.ulm@gentoo> (raw)
commit: 710b619980ed23811cbc0841466b9502a2c92278
Author: Ulrich Müller <ulm <AT> gentoo <DOT> org>
AuthorDate: Wed Jan 15 21:09:28 2020 +0000
Commit: Ulrich Müller <ulm <AT> gentoo <DOT> org>
CommitDate: Wed Jan 15 21:28:47 2020 +0000
URL: https://gitweb.gentoo.org/proj/devmanual.git/commit/?id=710b6199
devbook-guide: Rename from "GuideXML guide" to "DevBook XML guide".
Signed-off-by: Ulrich Müller <ulm <AT> gentoo.org>
appendices/devbook-guide/text.xml | 34 +++++++++++++++++-----------------
1 file changed, 17 insertions(+), 17 deletions(-)
diff --git a/appendices/devbook-guide/text.xml b/appendices/devbook-guide/text.xml
index 1e73104..35ecace 100644
--- a/appendices/devbook-guide/text.xml
+++ b/appendices/devbook-guide/text.xml
@@ -1,16 +1,16 @@
<?xml version="1.0" encoding="UTF-8"?>
<guide self="appendices/devbook-guide/">
<chapter>
-<title>Gentoo GuideXML Guide</title>
+<title>Gentoo DevBook XML Guide</title>
<section>
-<title>GuideXML basics</title>
+<title>DevBook XML basics</title>
<subsection>
-<title>GuideXML design goals</title>
+<title>DevBook XML design goals</title>
<body>
<p>
-The guideXML syntax is lightweight yet expressive, so that it is easy to
+The DevBook XML syntax is lightweight yet expressive, so that it is easy to
learn yet also provides all the features we need for the creation of web
documentation. The number of tags is kept to a minimum <d/> just those we need.
This makes it easy to transform guide into other formats, such as DocBook
@@ -18,7 +18,7 @@ XML/SGML or web-ready HTML.
</p>
<p>
-The goal is to make it easy to <e>create</e> and <e>transform</e> guideXML
+The goal is to make it easy to <e>create</e> and <e>transform</e> DevBook XML
documents.
</p>
@@ -27,21 +27,21 @@ documents.
</section>
<section>
-<title>GuideXML</title>
+<title>Devbook XML</title>
<subsection>
<title>Basic structure</title>
<body>
<p>
-Let's start learning the GuideXML syntax. We'll start with the the initial
-tags used in a GuideXML document:
+Let's start learning the DevBook XML syntax. We'll start with the initial tags
+used in a DevBook XML document:
</p>
-<codesample lang="sgml"><!-- The initial part of a guide XML document -->
+<codesample lang="sgml"><!-- The initial part of a DevBook XML document -->
<?xml version="1.0" encoding="UTF-8"?>
<guide self="appendices/devbook-guide/">
<chapter>
-<title>Gentoo GuideXML Guide</title>
+<title>Gentoo DevBook XML Guide</title>
</codesample>
<p>
@@ -88,7 +88,7 @@ title. Here's an example section with a single subsection, consisting of a
paragraph:
</p>
-<codesample lang="sgml"><!-- Minimal guide example -->
+<codesample lang="sgml"><!-- Minimal DevBook example -->
<section>
<title>This is my section</title>
<subsection>
@@ -408,8 +408,8 @@ for adding images without captions, borders, etc.
<body>
<p>
-GuideXML supports a simplified table syntax similar to that of HTML. To start a
-table, use a <c><table></c> tag. Start a row with a <c><tr></c>
+DevBook XML supports a simplified table syntax similar to that of HTML. To start
+a table, use a <c><table></c> tag. Start a row with a <c><tr></c>
tag. However, for inserting actual table data, we <e>don't</e> support the HTML
<td> tag; instead, use the <c><th></c> if you are inserting a
header, and <c><ti></c> if you are inserting a normal informational
@@ -495,7 +495,7 @@ admonitions. A definition list comprises:
<body>
<p>
-GuideXML makes it really easy to reference other parts of the document using
+DevBook XML makes it really easy to reference other parts of the document using
hyperlinks. You can create a link pointing to another chapter, like
<uri link="::ebuild-writing/file-format/">Ebuild File Format</uri>, by typing
<c><uri link="::ebuild-writing/file-format/">Ebuild File
@@ -544,8 +544,8 @@ Both sections are described next.
<body>
<p>
-<b>Newlines</b> must be placed immediately after <e>every</e>
-GuideXML-tag (both opening as closing), except for:
+<b>Newlines</b> must be placed immediately after <e>every</e> DevBook XML tag
+(both opening as closing), except for:
<c><version></c>, <c><date></c>, <c><title></c>,
<c><th></c>, <c><ti></c>,
<c><li></c>, <c><i></c>, <c><e></c>,
@@ -577,7 +577,7 @@ parent XML-tags are <c><tr></c> (from <c><table></c>),
<c><ul></c>, <c><ol></c> and <c><dl></c>. If indentation
is used, it <e>must</e> be two spaces for each indentation. That means
<e>no tabs</e> and <e>not</e> more spaces. Besides, tabs are not allowed in
-GuideXML documents.
+DevBook XML documents.
</p>
<p>
next reply other threads:[~2020-01-15 21:30 UTC|newest]
Thread overview: 30+ messages / expand[flat|nested] mbox.gz Atom feed top
2020-01-15 21:30 Ulrich Müller [this message]
-- strict thread matches above, loose matches on Subject: below --
2024-10-31 18:59 [gentoo-commits] proj/devmanual:master commit in: appendices/devbook-guide/ Ulrich Müller
2024-10-25 11:21 Ulrich Müller
2024-05-08 5:57 Ulrich Müller
2023-11-05 16:48 Ulrich Müller
2023-11-05 16:45 Ulrich Müller
2023-10-05 20:29 Ulrich Müller
2022-02-16 18:56 Ulrich Müller
2021-07-31 17:59 Ulrich Müller
2021-03-19 19:23 Ulrich Müller
2021-03-19 19:23 Ulrich Müller
2021-03-19 19:22 Ulrich Müller
2021-03-12 19:32 Ulrich Müller
2021-03-11 11:24 Ulrich Müller
2020-12-14 19:35 Ulrich Müller
2020-08-21 16:53 Ulrich Müller
2020-03-06 16:30 Ulrich Müller
2020-03-06 16:30 Ulrich Müller
2020-03-01 12:32 Ulrich Müller
2020-02-22 21:27 Ulrich Müller
2020-01-28 5:55 Ulrich Müller
2020-01-16 18:50 Ulrich Müller
2020-01-15 22:36 Ulrich Müller
2020-01-15 22:14 Ulrich Müller
2020-01-15 21:30 Ulrich Müller
2020-01-15 21:29 Ulrich Müller
2020-01-15 21:29 Ulrich Müller
2020-01-15 21:29 Ulrich Müller
2020-01-15 21:29 Ulrich Müller
2020-01-15 21:29 Ulrich Müller
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=1579123727.710b619980ed23811cbc0841466b9502a2c92278.ulm@gentoo \
--to=ulm@gentoo.org \
--cc=gentoo-commits@lists.gentoo.org \
--cc=gentoo-dev@lists.gentoo.org \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox