* [gentoo-commits] proj/devmanual:devbook-guide commit in: appendices/contributing/devbook-guide/
@ 2017-04-12 21:24 Göktürk Yüksek
0 siblings, 0 replies; 17+ messages in thread
From: Göktürk Yüksek @ 2017-04-12 21:24 UTC (permalink / raw
To: gentoo-commits
commit: e0a3f3f2db7367737da6d17fa08c22bcf1763834
Author: Göktürk Yüksek <gokturk <AT> gentoo <DOT> org>
AuthorDate: Wed Apr 12 21:08:26 2017 +0000
Commit: Göktürk Yüksek <gokturk <AT> gentoo <DOT> org>
CommitDate: Wed Apr 12 21:08:26 2017 +0000
URL: https://gitweb.gentoo.org/proj/devmanual.git/commit/?id=e0a3f3f2
appendices/contributing/devbook-guide: remove documentation on <mail>
The tag <mail> doesn't work in devmanual. Remove the section devoted
to that.
appendices/contributing/devbook-guide/text.xml | 28 +-------------------------
1 file changed, 1 insertion(+), 27 deletions(-)
diff --git a/appendices/contributing/devbook-guide/text.xml b/appendices/contributing/devbook-guide/text.xml
index 967c990..64db156 100644
--- a/appendices/contributing/devbook-guide/text.xml
+++ b/appendices/contributing/devbook-guide/text.xml
@@ -413,31 +413,10 @@ Fill this section with the information about the use of
</body>
</section>
<section>
-<title><mail> and <uri></title>
+<title><uri></title>
<body>
<p>
-We've taken a look at the <c><mail></c> tag earlier; it's used to link
-some text with a particular email address, and takes the form <c><mail
-link="foo.bar@example.com">Mr. Foo Bar</mail></c>. If you want to display the
-email address, you can use <c><mail>foo.bar@example.com</mail></c>, this
-would be displayed as <mail>foo.bar@example.com</mail>.
-</p>
-
-<p>
-Shorter forms make it easier to use names and emails of Gentoo developers. Both
-<c><mail>neysx</mail></c> and <c><mail link="neysx"/></c>
-would appear as <mail>neysx</mail>. If you want to use a Gentoo dev's email
-with a different content than his full name, use the second form with some
-content. For instance, use a dev's first name: <c><mail
-link="neysx">Xavier</mail></c> appears as <mail
-link="neysx">Xavier</mail>.
-<br/>
-This is particularly useful when you want to name a developer whose name
-contains "funny" characters that you can't type.
-</p>
-
-<p>
The <c><uri></c> tag is used to point to files/locations on the Internet.
It has two forms -- the first can be used when you want to have the actual URI
displayed in the body text, such as this link to
@@ -456,11 +435,6 @@ index</uri></c>. Leaving the trailing slash saves an extra HTTP request.
</p>
<p>
-You should not use a <c><uri></c> tag with a <c>link</c> attribute that
-starts with <c>mailto:</c>. In this case, use a <c><mail></c> tag.
-</p>
-
-<p>
Please avoid the <uri link="http://en.wikipedia.org/wiki/Click_here">click here
syndrome</uri> as recommended by the <uri
link="http://www.w3.org/QA/Tips/noClickHere">W3C</uri>.
^ permalink raw reply related [flat|nested] 17+ messages in thread
* [gentoo-commits] proj/devmanual:devbook-guide commit in: appendices/contributing/devbook-guide/
@ 2017-04-12 21:24 Göktürk Yüksek
0 siblings, 0 replies; 17+ messages in thread
From: Göktürk Yüksek @ 2017-04-12 21:24 UTC (permalink / raw
To: gentoo-commits
commit: 110dbde3493cae38ed58cf748f724cb7f57e6c12
Author: Göktürk Yüksek <gokturk <AT> gentoo <DOT> org>
AuthorDate: Wed Apr 12 21:22:10 2017 +0000
Commit: Göktürk Yüksek <gokturk <AT> gentoo <DOT> org>
CommitDate: Wed Apr 12 21:22:10 2017 +0000
URL: https://gitweb.gentoo.org/proj/devmanual.git/commit/?id=110dbde3
appendices/contributing/devbook-guide: remove the section on Epigraphs
This feature doesn't work in devmanual.
appendices/contributing/devbook-guide/text.xml | 26 --------------------------
1 file changed, 26 deletions(-)
diff --git a/appendices/contributing/devbook-guide/text.xml b/appendices/contributing/devbook-guide/text.xml
index 5cc1d39..eb9bd36 100644
--- a/appendices/contributing/devbook-guide/text.xml
+++ b/appendices/contributing/devbook-guide/text.xml
@@ -305,32 +305,6 @@ exactly, making it well-suited for code excerpts. You must name the
</body>
</section>
<section>
-<title>Epigraphs</title>
-<body>
-
-<p by="Anonymous student">
-Delegates from the original 13 states formed the Contented Congress. Thomas
-Jefferson, a Virgin, and Benjamin Franklin were two singers of the Declaration
-of Independence. Franklin discovered electricity by rubbing two cats backwards
-and declared, "A horse divided against itself cannot stand." Franklin died in
-1790 and is still dead.
-</p>
-
-<p>
-Epigraphs are sometimes used at the beginning of chapters to illustrate what is
-to follow. It is simply a paragraph with a <c>by</c> attribute that contains
-the signature.
-</p>
-
-<pre caption="Short epigraph">
-<p by="Anonymous student">
-Delegates from the original 13 states formed the...
-</p>
-</pre>
-
-</body>
-</section>
-<section>
<title>
<c>, <b>, and <e>
</title>
^ permalink raw reply related [flat|nested] 17+ messages in thread
* [gentoo-commits] proj/devmanual:devbook-guide commit in: appendices/contributing/devbook-guide/
@ 2017-04-12 21:24 Göktürk Yüksek
0 siblings, 0 replies; 17+ messages in thread
From: Göktürk Yüksek @ 2017-04-12 21:24 UTC (permalink / raw
To: gentoo-commits
commit: f12a8205df131d428274ebc13710ec3d82674830
Author: Göktürk Yüksek <gokturk <AT> gentoo <DOT> org>
AuthorDate: Wed Apr 12 19:09:26 2017 +0000
Commit: Göktürk Yüksek <gokturk <AT> gentoo <DOT> org>
CommitDate: Wed Apr 12 19:09:26 2017 +0000
URL: https://gitweb.gentoo.org/proj/devmanual.git/commit/?id=f12a8205
appendices/contributing/devbook-guide: remove the section on disclaimers
Remove the section "Disclaimers and obsolete documents" as it doesn't
apply to devmanual.
appendices/contributing/devbook-guide/text.xml | 47 --------------------------
1 file changed, 47 deletions(-)
diff --git a/appendices/contributing/devbook-guide/text.xml b/appendices/contributing/devbook-guide/text.xml
index 4f4e8ac..a8ebcdf 100644
--- a/appendices/contributing/devbook-guide/text.xml
+++ b/appendices/contributing/devbook-guide/text.xml
@@ -695,53 +695,6 @@ More information can be found in the <uri link="#foo">foo chapter</uri&
</body>
</section>
<section>
-<title>Disclaimers and obsolete documents</title>
-<body>
-
-<p>
-A <c>disclaimer</c> attribute can be applied to guides and handbooks to display
-a predefined disclaimer at the top of the document. The available disclaimers
-are:
-</p>
-
-<ul>
- <li>
- <b>articles</b> is used for <uri link="/doc/en/articles/">republished
- articles</uri>
- </li>
- <li>
- <b>draft</b> is used to indicate a document is still being worked on and
- should not be considered official
- </li>
- <li>
- <b>oldbook</b> is used on old handbooks to indicate they are not maintained
- anymore
- </li>
- <li><b>obsolete</b> is used to mark a document as obsolete.</li>
-</ul>
-
-<p>
-When marking a document as obsolete, you might want to add a link to a new
-version. The <c>redirect</c> attribute does just that. The user might be
-automatically redirected to the new page but you should not rely on that
-behaviour.
-</p>
-
-<pre caption="Disclaimer sample">
-<?xml version="1.0" encoding="UTF-8"?>
-<!DOCTYPE guide SYSTEM "/dtd/guide.dtd">
-<!-- $Header$ -->
-
-<guide disclaimer="obsolete" redirect="/doc/en/handbook/handbook-x86.xml">
-<title>Gentoo x86 Installation Guide</title>
-
-<author title="Author">
-...
-</pre>
-
-</body>
-</section>
-<section>
<title>FAQs</title>
<body>
^ permalink raw reply related [flat|nested] 17+ messages in thread
* [gentoo-commits] proj/devmanual:devbook-guide commit in: appendices/contributing/devbook-guide/
@ 2017-04-12 21:24 Göktürk Yüksek
0 siblings, 0 replies; 17+ messages in thread
From: Göktürk Yüksek @ 2017-04-12 21:24 UTC (permalink / raw
To: gentoo-commits
commit: b946cd6107fb49f7d2e3fef8382711c78d3e8ec4
Author: Göktürk Yüksek <gokturk <AT> gentoo <DOT> org>
AuthorDate: Wed Apr 12 21:19:53 2017 +0000
Commit: Göktürk Yüksek <gokturk <AT> gentoo <DOT> org>
CommitDate: Wed Apr 12 21:19:53 2017 +0000
URL: https://gitweb.gentoo.org/proj/devmanual.git/commit/?id=b946cd61
appendices/contributing/devbook-guide: remove the section "Further Resources"
appendices/contributing/devbook-guide/text.xml | 18 ------------------
1 file changed, 18 deletions(-)
diff --git a/appendices/contributing/devbook-guide/text.xml b/appendices/contributing/devbook-guide/text.xml
index d586956..5cc1d39 100644
--- a/appendices/contributing/devbook-guide/text.xml
+++ b/appendices/contributing/devbook-guide/text.xml
@@ -57,24 +57,6 @@ documents.
</body>
</section>
-<section>
-<title>Further Resources</title>
-<body>
-
-<p>
-If you are planning on contributing documentation to Gentoo, or you want to
-test GuideXML, please read our <uri
-link="/proj/en/gdp/doc/doc-tipsntricks.xml">Doc Tips 'n' Tricks</uri> guide
-which contains tips and tricks for documentation development.
-</p>
-
-<p>
-You may want to look at the <uri link="?passthru=1">XML source</uri> of this
-document while you read it.
-</p>
-
-</body>
-</section>
</chapter>
<chapter>
^ permalink raw reply related [flat|nested] 17+ messages in thread
* [gentoo-commits] proj/devmanual:devbook-guide commit in: appendices/contributing/devbook-guide/
@ 2017-04-12 21:24 Göktürk Yüksek
0 siblings, 0 replies; 17+ messages in thread
From: Göktürk Yüksek @ 2017-04-12 21:24 UTC (permalink / raw
To: gentoo-commits
commit: c7fb6f30580b30728e24fb3a1265a1e17ca359ad
Author: Göktürk Yüksek <gokturk <AT> gentoo <DOT> org>
AuthorDate: Wed Apr 12 21:02:59 2017 +0000
Commit: Göktürk Yüksek <gokturk <AT> gentoo <DOT> org>
CommitDate: Wed Apr 12 21:02:59 2017 +0000
URL: https://gitweb.gentoo.org/proj/devmanual.git/commit/?id=c7fb6f30
appendices/contributing/devbook-guide: erase the code samples section
In devmanual, code samples and syntax highlighting are done using the
<codesample/> now. Erase the content of this section and insert a
<todo>.
appendices/contributing/devbook-guide/text.xml | 66 ++------------------------
1 file changed, 4 insertions(+), 62 deletions(-)
diff --git a/appendices/contributing/devbook-guide/text.xml b/appendices/contributing/devbook-guide/text.xml
index a8ebcdf..967c990 100644
--- a/appendices/contributing/devbook-guide/text.xml
+++ b/appendices/contributing/devbook-guide/text.xml
@@ -405,68 +405,10 @@ The <c><sub></c> and <c><sup></c> elements are used to specify
<title>Code samples and colour-coding</title>
<body>
-<p>
-To improve the readability of code samples, the following tags are allowed
-inside <c><pre></c> blocks:
-</p>
-
-<dl>
- <dt><c><i></c></dt>
- <dd>Distinguishes user input from displayed text</dd>
- <dt><c><comment></c></dt>
- <dd>Comments relevant to the action(s) that appear after the comment</dd>
- <dt><c><keyword></c></dt>
- <dd>Denotes a keyword in the language used in the code sample
- </dd>
- <dt><c><ident></c></dt>
- <dd>Used for an identifier
- </dd>
- <dt><c><const></c></dt>
- <dd>Used for a constant
- </dd>
- <dt><c><stmt></c></dt>
- <dd>Used for a statement
- </dd>
- <dt><c><var></c></dt>
- <dd>Used for a variable
- </dd>
-</dl>
-
-<note>
-Remember that all leading and trailing spaces, and line breaks in
-<c><pre></c> blocks will appear in the displayed html page.
-</note>
-
-<p>
-Sample colour-coded <c><pre></c> block:
-</p>
-
-<pre caption="My first ebuild">
-<comment># Copyright 1999-2009 <b>Gentoo Foundation</b>
-# Distributed under the terms of the GNU General Public License v2
-# $Header: $</comment>
-
-<ident>DESCRIPTION</ident>=<const>"Exuberant ctags generates tags files for quick source navigation"</const>
-<ident>HOMEPAGE</ident>=<const>"http://ctags.sourceforge.net"</const>
-<ident>SRC_URI</ident>=<const>"mirror://sourceforge/ctags/<var>${P}</var>.tar.gz"</const>
-
-<ident>LICENSE</ident>=<const>"GPL-2"</const>
-<ident>SLOT</ident>=<const>"0"</const>
-<ident>KEYWORDS</ident>=<const>"~mips ~sparc ~x86"</const>
-<ident>IUSE</ident>=<const>""</const>
-
-<stmt>src_compile()</stmt> {
- <keyword>econf</keyword> --with-posix-regex
- <keyword>emake</keyword> || <keyword>die</keyword> <const>"emake failed"</const>
-}
-
-<stmt>src_install()</stmt> {
- <keyword>make</keyword> <ident>DESTDIR</ident>="<var>${D}</var>" install || <keyword>die</keyword> <const>"install failed"</const>
-
- <keyword>dodoc</keyword> FAQ NEWS README
- <keyword>dohtml</keyword> EXTENDING.html ctags.html
-}
-</pre>
+<todo>
+Fill this section with the information about the use of
+<codesample/>.
+</todo>
</body>
</section>
^ permalink raw reply related [flat|nested] 17+ messages in thread
* [gentoo-commits] proj/devmanual:devbook-guide commit in: appendices/contributing/devbook-guide/
@ 2017-04-12 21:24 Göktürk Yüksek
0 siblings, 0 replies; 17+ messages in thread
From: Göktürk Yüksek @ 2017-04-12 21:24 UTC (permalink / raw
To: gentoo-commits
commit: e86ac3f696f078dc7aedc5b56111098c16934c10
Author: Göktürk Yüksek <gokturk <AT> gentoo <DOT> org>
AuthorDate: Wed Apr 12 18:00:31 2017 +0000
Commit: Göktürk Yüksek <gokturk <AT> gentoo <DOT> org>
CommitDate: Wed Apr 12 18:00:31 2017 +0000
URL: https://gitweb.gentoo.org/proj/devmanual.git/commit/?id=e86ac3f6
appendices/contributing/devbook-guide: remove unnecessary sections 3 and 4
Remove the unnecessary sections "Handbook Format" and
"Advanced Handbook Features".
appendices/contributing/devbook-guide/text.xml | 279 -------------------------
1 file changed, 279 deletions(-)
diff --git a/appendices/contributing/devbook-guide/text.xml b/appendices/contributing/devbook-guide/text.xml
index a4a69af..4f4e8ac 100644
--- a/appendices/contributing/devbook-guide/text.xml
+++ b/appendices/contributing/devbook-guide/text.xml
@@ -767,285 +767,6 @@ obvious.
</section>
</chapter>
-<chapter>
-<title>Handbook Format</title>
-<section>
-<title>Guide vs Book</title>
-<body>
-
-<p>
-For high-volume documentation, such as the <uri
-link="/doc/en/handbook/handbook-x86.xml?part=1">Installation Instructions</uri>, a
-broader format was needed. We designed a GuideXML-compatible enhancement that
-allows us to write modular and multi-page documentation.
-</p>
-
-</body>
-</section>
-<section>
-<title>Main File</title>
-<body>
-
-<p>
-The first change is the need for a "master" document. This document contains no
-real content, but links to the individual documentation modules. The syntax
-doesn't differ much from GuideXML:
-</p>
-
-<pre caption="Example book usage">
-<?xml version='1.0' encoding='UTF-8'?>
-<!DOCTYPE book SYSTEM "/dtd/book.dtd">
-<!-- $Header$ -->
-
-<<i>book</i>>
-<title>Example Book Usage</title>
-
-<author...>
- ...
-</author>
-
-<abstract>
- ...
-</abstract>
-
-<!-- The content of this document is licensed under the CC-BY-SA license -->
-<!-- See http://creativecommons.org/licenses/by-sa/3.0 -->
-<license version="3.0"/>
-
-<version>...</version>
-<date>...</date>
-</pre>
-
-<p>
-So far no real differences (except for the <c><book></c> instead of
-<c><guide></c> tag). Instead of starting with the individual
-<c><chapter></c>s, you define a <c><part></c>, which is the
-equivalent of a separate part in a book:
-</p>
-
-<pre caption="Defining a part">
-<part>
-<title>Part One</title>
-<abstract>
- ...
-</abstract>
-
-<comment>(Defining the several chapters)</comment>
-</part>
-</pre>
-
-<p>
-Each part is accompanied by a <c><title></c> and an
-<c><abstract></c> which gives a small introduction to the part.
-</p>
-
-<p>
-Inside each part, you define the individual <c><chapter></c>s. Each
-chapter <e>must</e> be a separate document. As a result it is no surprise that
-a special tag (<c><include></c>) is added to allow including the separate
-document.
-</p>
-
-<pre caption="Defining a chapter">
-<chapter>
-<title>Chapter One</title>
-
- <include href="path/to/chapter-one.xml"/>
-
-</chapter>
-</pre>
-
-</body>
-</section>
-<section>
-<title>Designing the Individual Chapters</title>
-<body>
-
-<p>
-The content of an individual chapter is structured as follows:
-</p>
-
-<pre caption="Chapter Syntax">
-<?xml version='1.0' encoding='UTF-8'?>
-<!DOCTYPE sections SYSTEM "/dtd/book.dtd">
-<!-- $Header$ -->
-
-<!-- The content of this document is licensed under the CC-BY-SA license -->
-<!-- See http://creativecommons.org/licenses/by-sa/3.0 -->
-
-<sections>
-
-<abstract>
- This is a small explanation on chapter one.
-</abstract>
-
-<version>...</version>
-<date>...</date>
-
-<comment>(Define the several <section> and <subsection>)</comment>
-
-</sections>
-</pre>
-
-<p>
-Inside each chapter you can define <c><section></c>s (equivalent of
-<c><chapter></c> in a Guide) and <c><subsection></c>s (equivalent
-of <c><section></c> in a Guide).
-</p>
-
-<p>
-Each individual chapter should have its own date and version elements. The
-latest date of all chapters and master document will be displayed when a user
-browses through all parts of the book.
-</p>
-
-</body>
-</section>
-</chapter>
-
-<chapter>
-<title>Advanced Handbook Features</title>
-<section>
-<title>Global Values</title>
-<body>
-
-<p>
-Sometimes, the same values are repeated many times in several parts of a
-handbook. Global search and replace operations tend to forget some or introduce
-unwanted changes. Besides, it can be useful to define different values to be
-used in shared chapters depending on which handbook includes the chapter.
-</p>
-
-<p>
-Global values can be defined in a handbook master file and used in all included
-chapters.
-</p>
-
-<p>
-To define global values, add a <c><values></c> element to the handbook
-master file. Each value is then defined in a <c><key></c> element whose
-<c>id</c> attribute identifies the value, i.e. it is the name of your variable.
-The content of the <c><key></c> is its value.
-</p>
-
-<p>
-The following example defines three values in a handbook master file:
-</p>
-
-<pre caption="Define values in a handbook">
-<?xml version='1.0' encoding='UTF-8'?>
-<!DOCTYPE book SYSTEM "/dtd/book.dtd">
-<!-- $Header$ -->
-
-<book>
-<title>Example Book Usage</title>
-
-<i><values>
- <key id="arch">x86</key>
- <key id="min-cd-name">install-x86-minimal-2007.0-r1.iso</key>
- <key id="min-cd-size">57</key>
-</values></i>
-
-<author...>
- ...
-</author>
-
-...
-</pre>
-
-<p>
-The defined values can then be used throughout the handbook with the in-line
-<c><keyval id="key_id"/></c> element. Specify the name of the key in its
-<c>id</c> attribute, e.g. <keyval id="min-cd-name"/> would be replaced by
-"install-x86-minimal-2007.0-r1.iso" in our example.
-</p>
-
-<pre caption="Using defined values">
-<p>
-The Minimal Installation CD is called <c><i><keyval id="min-cd-name"/></i></c>
-and takes up only <i><keyval id="min-cd-size"/></i> MB of diskspace. You can use this
-Installation CD to install Gentoo, but <e>only</e> with a working Internet
-connection.
-</p>
-</pre>
-
-<p>
-To make life easier on our translators, only use actual values, i.e. content
-that does not need to be translated. For instance, we defined the
-<c>min-cd-size</c> value to <c>57</c> and not <c>57 MB</c>.
-</p>
-
-</body>
-</section>
-<section>
-<title>Conditional Elements</title>
-<body>
-
-<p>
-Chapters that are shared by several handbooks such as our <uri
-link="/doc/en/handbook/">Installation Handbooks</uri> often have small
-differences depending on which handbook includes them. Instead of adding
-content that is irrelevant to some handbooks, authors can add a condition to
-the following elements: <c><section></c>, <c><subsection></c>,
-<c><body></c>, <c><note></c>, <c><impo></c>,
-<c><warn></c>, <c><pre></c>, <c><p></c>,
-<c><table></c>, <c><tr></c>, <c><ul></c>, <c><ol></c>
-and <c><li></c>.
-</p>
-
-<p>
-The condition must be an <uri
-link="http://en.wikipedia.org/wiki/XPath">XPATH</uri> expression that will be
-evaluated when transforming the XML. If it evaluates to <c>true</c>, the
-element is processed, if not, it is ignored. The condition is specified in a
-<c>test</c> attribute.
-</p>
-
-<p>
-The following example uses the <c>arch</c> value that is defined in each
-handbook master file to condition some content:
-</p>
-
-<pre caption="Using conditional elements">
-<body test="contains('AMD64 x86',func:keyval('arch'))">
-
-<p>
-This paragraph applies to both x86 and AMD64 architectures.
-</p>
-
-<p test="func:keyval('arch')='x86'">
-This paragraph only applies to the x86 architecture.
-</p>
-
-<p test="func:keyval('arch')='AMD64'">
-This paragraph only applies to the AMD64 architecture.
-</p>
-
-<p test="func:keyval('arch')='PPC'">
-This paragraph will never be seen!
-The whole body is skipped because of the first condition.
-</p>
-
-</body>
-
-<body test="contains('AMD64 PPC64',func:keyval('arch'))">
-
-<p>
-This paragraph applies to the AMD64, PPC64 <comment>and PPC</comment> architectures because
-the 'AMD64 PPC64' string does contain 'PPC'.
-</p>
-
-<note test="func:keyval('arch')='AMD64' or func:keyval('arch')='PPC64'">
-This note only applies to the AMD64 and PPC64 architectures.
-</note>
-
-</body>
-</pre>
-
-</body>
-</section>
-</chapter>
-
<chapter id="codingstyle">
<title>Coding Style</title>
<section>
^ permalink raw reply related [flat|nested] 17+ messages in thread
* [gentoo-commits] proj/devmanual:devbook-guide commit in: appendices/contributing/devbook-guide/
@ 2017-04-12 21:24 Göktürk Yüksek
0 siblings, 0 replies; 17+ messages in thread
From: Göktürk Yüksek @ 2017-04-12 21:24 UTC (permalink / raw
To: gentoo-commits
commit: 649030b9ed511c725a5690067b3c0c3469267852
Author: Göktürk Yüksek <gokturk <AT> gentoo <DOT> org>
AuthorDate: Wed Apr 12 21:16:13 2017 +0000
Commit: Göktürk Yüksek <gokturk <AT> gentoo <DOT> org>
CommitDate: Wed Apr 12 21:16:13 2017 +0000
URL: https://gitweb.gentoo.org/proj/devmanual.git/commit/?id=649030b9
appendices/contributing/devbook-guide: remove documentation on pre, sub, sup
The elements <pre>, <sub>, and <sup> are not used in devmanual.
appendices/contributing/devbook-guide/text.xml | 20 +-------------------
1 file changed, 1 insertion(+), 19 deletions(-)
diff --git a/appendices/contributing/devbook-guide/text.xml b/appendices/contributing/devbook-guide/text.xml
index 64db156..d586956 100644
--- a/appendices/contributing/devbook-guide/text.xml
+++ b/appendices/contributing/devbook-guide/text.xml
@@ -350,24 +350,11 @@ Delegates from the original 13 states formed the...
</section>
<section>
<title>
- <path>, <c>, <b>, <e>, <sub> and <sup>
+ <c>, <b>, and <e>
</title>
<body>
<p>
-The <c><path></c>, <c><c></c>, <c><b></c>, <c><e></c>,
-<c><sub></c> and <c><sup></c> elements can be used inside any child
-<c><body></c> tag, except for <c><pre></c>.
-</p>
-
-<p>
-The <c><path></c> element is used to mark text that refers to an
-<e>on-disk file</e> -- either an <e>absolute or relative path</e>, or a
-<e>simple filename</e>. This element is generally rendered with a mono spaced
-font to offset it from the standard paragraph type.
-</p>
-
-<p>
The <c><c></c> element is used to mark up a <e>command</e> or <e>user
input</e>. Think of <c><c></c> as a way to alert the reader to something
that they can type in that will perform some kind of action. For example, all
@@ -394,11 +381,6 @@ offset from the regular paragraph type for emphasis. This helps to give your
prose more <e>punch</e>!
</p>
-<p>
-The <c><sub></c> and <c><sup></c> elements are used to specify
-<sub>subscript</sub> and <sup>superscript</sup>.
-</p>
-
</body>
</section>
<section>
^ permalink raw reply related [flat|nested] 17+ messages in thread
* [gentoo-commits] proj/devmanual:devbook-guide commit in: appendices/contributing/devbook-guide/
@ 2017-04-17 23:23 Göktürk Yüksek
0 siblings, 0 replies; 17+ messages in thread
From: Göktürk Yüksek @ 2017-04-17 23:23 UTC (permalink / raw
To: gentoo-commits
commit: 8c02fa014e18dcb0efce809991c34a1171a97f0d
Author: Göktürk Yüksek <gokturk <AT> gentoo <DOT> org>
AuthorDate: Mon Apr 17 22:23:21 2017 +0000
Commit: Göktürk Yüksek <gokturk <AT> gentoo <DOT> org>
CommitDate: Mon Apr 17 22:23:21 2017 +0000
URL: https://gitweb.gentoo.org/proj/devmanual.git/commit/?id=8c02fa01
appendices/contributing/devbook-guide: remove the <license/> tag
It has no use in devmanual.
appendices/contributing/devbook-guide/text.xml | 4 ----
1 file changed, 4 deletions(-)
diff --git a/appendices/contributing/devbook-guide/text.xml b/appendices/contributing/devbook-guide/text.xml
index ce4749e..095365d 100644
--- a/appendices/contributing/devbook-guide/text.xml
+++ b/appendices/contributing/devbook-guide/text.xml
@@ -29,10 +29,6 @@ documentation, and this document itself was created using GuideXML. This guide
assumes a basic working knowledge of XML and HTML.
</abstract>
-<!-- The content of this document is licensed under the CC-BY-SA license -->
-<!-- See http://creativecommons.org/licenses/by-sa/2.5 -->
-<license/>
-
<version>13</version>
<date>2012-10-07</date>
^ permalink raw reply related [flat|nested] 17+ messages in thread
* [gentoo-commits] proj/devmanual:devbook-guide commit in: appendices/contributing/devbook-guide/
@ 2017-04-17 23:23 Göktürk Yüksek
0 siblings, 0 replies; 17+ messages in thread
From: Göktürk Yüksek @ 2017-04-17 23:23 UTC (permalink / raw
To: gentoo-commits
commit: 5fab84aa081174575785c4b747a26e1bc254338b
Author: Göktürk Yüksek <gokturk <AT> gentoo <DOT> org>
AuthorDate: Mon Apr 17 22:23:59 2017 +0000
Commit: Göktürk Yüksek <gokturk <AT> gentoo <DOT> org>
CommitDate: Mon Apr 17 22:23:59 2017 +0000
URL: https://gitweb.gentoo.org/proj/devmanual.git/commit/?id=5fab84aa
appendices/contributing/devbook-guide: remove the <date/> tag
It has no use in devmanual.
appendices/contributing/devbook-guide/text.xml | 2 --
1 file changed, 2 deletions(-)
diff --git a/appendices/contributing/devbook-guide/text.xml b/appendices/contributing/devbook-guide/text.xml
index c8db680..971dddd 100644
--- a/appendices/contributing/devbook-guide/text.xml
+++ b/appendices/contributing/devbook-guide/text.xml
@@ -29,8 +29,6 @@ documentation, and this document itself was created using GuideXML. This guide
assumes a basic working knowledge of XML and HTML.
</abstract>
-<date>2012-10-07</date>
-
<chapter>
<title>GuideXML basics</title>
<section>
^ permalink raw reply related [flat|nested] 17+ messages in thread
* [gentoo-commits] proj/devmanual:devbook-guide commit in: appendices/contributing/devbook-guide/
@ 2017-04-17 23:23 Göktürk Yüksek
0 siblings, 0 replies; 17+ messages in thread
From: Göktürk Yüksek @ 2017-04-17 23:23 UTC (permalink / raw
To: gentoo-commits
commit: 4cbf0bacaee312eb0b240205d5566a6660833814
Author: Göktürk Yüksek <gokturk <AT> gentoo <DOT> org>
AuthorDate: Mon Apr 17 22:07:56 2017 +0000
Commit: Göktürk Yüksek <gokturk <AT> gentoo <DOT> org>
CommitDate: Mon Apr 17 22:07:56 2017 +0000
URL: https://gitweb.gentoo.org/proj/devmanual.git/commit/?id=4cbf0bac
appendices/contributing/devbook-guide: remove the section on FAQ
We do not have FAQ in devmanual and it doesn't render <faqindex/>.
appendices/contributing/devbook-guide/text.xml | 24 ------------------------
1 file changed, 24 deletions(-)
diff --git a/appendices/contributing/devbook-guide/text.xml b/appendices/contributing/devbook-guide/text.xml
index 2ad0ad7..ce4749e 100644
--- a/appendices/contributing/devbook-guide/text.xml
+++ b/appendices/contributing/devbook-guide/text.xml
@@ -485,30 +485,6 @@ to <uri link="#doc_chap2_pre2">code listing 2 in chapter 2</uri>, type
</body>
</section>
-<section>
-<title>FAQs</title>
-<body>
-
-<p>
-FAQ documents need to start with a list of questions with links to their
-answers. Creating such a list is both time-consuming and error-prone. The list
-can be created automatically if you use a <c>faqindex</c> element as the first
-chapter of your document. This element has the same structure as a
-<c>chapter</c> to allow some introductory text. The structure of the document
-is expected to be split into chapters (at least one chapter) containing
-sections, each section containing one question specified in its <c>title</c>
-element with the answer in its <c>body</c>. The FAQ index will appear as one
-section per chapter and one link per question.
-</p>
-
-<p>
-A quick look at a <uri link="/doc/en/faq.xml">FAQ</uri> and <uri
-link="/doc/en/faq.xml?passthru=1">its source</uri> should make the above
-obvious.
-</p>
-
-</body>
-</section>
</chapter>
<chapter id="codingstyle">
^ permalink raw reply related [flat|nested] 17+ messages in thread
* [gentoo-commits] proj/devmanual:devbook-guide commit in: appendices/contributing/devbook-guide/
@ 2017-04-17 23:23 Göktürk Yüksek
0 siblings, 0 replies; 17+ messages in thread
From: Göktürk Yüksek @ 2017-04-17 23:23 UTC (permalink / raw
To: gentoo-commits
commit: f064baa3d7e39b5ca380fcad130d994067c49228
Author: Göktürk Yüksek <gokturk <AT> gentoo <DOT> org>
AuthorDate: Mon Apr 17 22:23:42 2017 +0000
Commit: Göktürk Yüksek <gokturk <AT> gentoo <DOT> org>
CommitDate: Mon Apr 17 22:23:42 2017 +0000
URL: https://gitweb.gentoo.org/proj/devmanual.git/commit/?id=f064baa3
appendices/contributing/devbook-guide: remove the <version/> tag
It has no use in devmanual.
appendices/contributing/devbook-guide/text.xml | 1 -
1 file changed, 1 deletion(-)
diff --git a/appendices/contributing/devbook-guide/text.xml b/appendices/contributing/devbook-guide/text.xml
index 095365d..c8db680 100644
--- a/appendices/contributing/devbook-guide/text.xml
+++ b/appendices/contributing/devbook-guide/text.xml
@@ -29,7 +29,6 @@ documentation, and this document itself was created using GuideXML. This guide
assumes a basic working knowledge of XML and HTML.
</abstract>
-<version>13</version>
<date>2012-10-07</date>
<chapter>
^ permalink raw reply related [flat|nested] 17+ messages in thread
* [gentoo-commits] proj/devmanual:devbook-guide commit in: appendices/contributing/devbook-guide/
@ 2017-04-17 23:23 Göktürk Yüksek
0 siblings, 0 replies; 17+ messages in thread
From: Göktürk Yüksek @ 2017-04-17 23:23 UTC (permalink / raw
To: gentoo-commits
commit: a1cad38db2fa2096b1161bf5a6ec85048d5a3a74
Author: Göktürk Yüksek <gokturk <AT> gentoo <DOT> org>
AuthorDate: Mon Apr 17 21:46:15 2017 +0000
Commit: Göktürk Yüksek <gokturk <AT> gentoo <DOT> org>
CommitDate: Mon Apr 17 21:46:15 2017 +0000
URL: https://gitweb.gentoo.org/proj/devmanual.git/commit/?id=a1cad38d
appendices/contributing/devbook-guide: remove information on definition lists
Devmanual doesn't seem to render definition list elements <dl/>,
<dt/>, <dd/>.
appendices/contributing/devbook-guide/text.xml | 47 --------------------------
1 file changed, 47 deletions(-)
diff --git a/appendices/contributing/devbook-guide/text.xml b/appendices/contributing/devbook-guide/text.xml
index eb9bd36..6ad3a5d 100644
--- a/appendices/contributing/devbook-guide/text.xml
+++ b/appendices/contributing/devbook-guide/text.xml
@@ -465,53 +465,6 @@ that you can have lists inside lists. Don't forget that you are writing XML and
that you must close all tags including list items unlike in HTML.
</p>
-<p>
-Definition lists (<c><dl></c>) are also supported. Please note that
-neither the definition term tag (<c><dt></c>) nor the definition data tag
-(<c><dd></c>) accept any other block level tag such as paragraphs or
-admonitions. A definition list comprises:
-</p>
-
-<dl>
- <dt><c><dl></c></dt>
- <dd>A <b>D</b>efinition <b>L</b>ist Tag containing</dd>
- <dt><c><dt></c></dt>
- <dd>Pairs of <b>D</b>efinition <b>T</b>erm Tags</dd>
- <dt><c><dd></c></dt>
- <dd>and <b>D</b>efinition <b>D</b>ata Tags</dd>
-</dl>
-
-<p>
-The following list copied from <uri
-link="http://www.w3.org/TR/REC-html40/struct/lists.html">w3.org</uri> shows
-that a definition list can contain ordered and unordered lists. It may not
-contain another definition list though.
-</p>
-
-<dl>
- <dt><b>The ingredients:</b></dt>
- <dd>
- <ul>
- <li>100 g. flour</li>
- <li>10 g. sugar</li>
- <li>1 cup water</li>
- <li>2 eggs</li>
- <li>salt, pepper</li>
- </ul>
- </dd>
- <dt><b>The procedure:</b></dt>
- <dd>
- <ol>
- <li>Mix dry ingredients thoroughly</li>
- <li>Pour in wet ingredients</li>
- <li>Mix for 10 minutes</li>
- <li>Bake for one hour at 300 degrees</li>
- </ol>
- </dd>
- <dt><b>Notes:</b></dt>
- <dd>The recipe may be improved by adding raisins</dd>
-</dl>
-
</body>
</section>
<section>
^ permalink raw reply related [flat|nested] 17+ messages in thread
* [gentoo-commits] proj/devmanual:devbook-guide commit in: appendices/contributing/devbook-guide/
@ 2017-04-17 23:23 Göktürk Yüksek
0 siblings, 0 replies; 17+ messages in thread
From: Göktürk Yüksek @ 2017-04-17 23:23 UTC (permalink / raw
To: gentoo-commits
commit: b9c01143d3999b7ef38adccd285624d48576e6d2
Author: Göktürk Yüksek <gokturk <AT> gentoo <DOT> org>
AuthorDate: Mon Apr 17 21:57:00 2017 +0000
Commit: Göktürk Yüksek <gokturk <AT> gentoo <DOT> org>
CommitDate: Mon Apr 17 21:57:00 2017 +0000
URL: https://gitweb.gentoo.org/proj/devmanual.git/commit/?id=b9c01143
appendices/contributing/devbook-guide: chapter doesn't support id attribute
Remove the information on creating uri links to chapters using their
id attribute. This doesn't work in devmanual as expected.
appendices/contributing/devbook-guide/text.xml | 16 ----------------
1 file changed, 16 deletions(-)
diff --git a/appendices/contributing/devbook-guide/text.xml b/appendices/contributing/devbook-guide/text.xml
index 6ad3a5d..2ad0ad7 100644
--- a/appendices/contributing/devbook-guide/text.xml
+++ b/appendices/contributing/devbook-guide/text.xml
@@ -483,22 +483,6 @@ to <uri link="#doc_chap2_pre2">code listing 2 in chapter 2</uri>, type
<c><uri link="#doc_chap2_pre2">code listing 2.2</uri></c>.
</p>
-<p>
-However, some guides change often and using such "counting" can lead to broken
-links. In order to cope with this, you can define a name for a
-<c><chapter></c>, <c><section></c> or a <c><tr></c> by using
-the <c>id</c> attribute, and then point to that attribute, like this:
-</p>
-
-<pre caption="Using the id attribute">
-<chapter id="foo">
-<title>This is foo!</title>
-...
-<p>
-More information can be found in the <uri link="#foo">foo chapter</uri>
-</p>
-</pre>
-
</body>
</section>
<section>
^ permalink raw reply related [flat|nested] 17+ messages in thread
* [gentoo-commits] proj/devmanual:devbook-guide commit in: appendices/contributing/devbook-guide/
@ 2017-07-29 20:55 Göktürk Yüksek
0 siblings, 0 replies; 17+ messages in thread
From: Göktürk Yüksek @ 2017-07-29 20:55 UTC (permalink / raw
To: gentoo-commits
commit: 9409ed6f32c3e5148b1c77c62862916a747c7b6e
Author: Göktürk Yüksek <gokturk <AT> gentoo <DOT> org>
AuthorDate: Sat Jul 29 20:41:16 2017 +0000
Commit: Göktürk Yüksek <gokturk <AT> gentoo <DOT> org>
CommitDate: Sat Jul 29 20:41:16 2017 +0000
URL: https://gitweb.gentoo.org/proj/devmanual.git/commit/?id=9409ed6f
appendices/contributing/devbook-guide: remove the <comment> tag
It has no use in devmanual.
appendices/contributing/devbook-guide/text.xml | 23 +++--------------------
1 file changed, 3 insertions(+), 20 deletions(-)
diff --git a/appendices/contributing/devbook-guide/text.xml b/appendices/contributing/devbook-guide/text.xml
index 971dddd..85a3390 100644
--- a/appendices/contributing/devbook-guide/text.xml
+++ b/appendices/contributing/devbook-guide/text.xml
@@ -218,8 +218,6 @@ This is text output or code.
Make HTML/XML easier to read by using selective emphasis:
<foo><i>bar</i></foo>
-
-<comment>(This is how to insert a comment into a code block)</comment>
</pre>
<note>
@@ -251,8 +249,6 @@ This is text output or code.
Make HTML/XML easier to read by using selective emphasis:
<foo><i>bar</i></foo>
-
-<comment>(This is how to insert a comment into a code block)</comment>
</pre>
<note>
@@ -511,7 +507,7 @@ GuideXML-tag (both opening as closing), except for:
<c><th></c>, <c><ti></c>,
<c><li></c>, <c><i></c>, <c><e></c>,
<c><uri></c>, <c><path></c>, <c><b></c>, <c><c></c>,
-<c><comment></c>, <c><mail></c>.
+<c><mail></c>.
</p>
<p>
@@ -578,8 +574,8 @@ and the attribute value. As an example:
</p>
<pre caption="Attributes">
-<comment>Wrong :</comment> <pre caption = "Attributes">
-<comment>Correct:</comment> <pre caption="Attributes">
+Wrong : <pre caption = "Attributes">
+Correct: <pre caption="Attributes">
</pre>
</body>
@@ -617,19 +613,6 @@ possible. In other words, the <uri link="http://forums.gentoo.org">Gentoo
Forums</uri> is preferred over <uri>http://forums.gentoo.org</uri>.
</p>
-<p>
-When you comment something inside a <c><pre></c> construct, use
-<c><comment></c> and parentheses or the comment marker for the language
-that is being used (<c>#</c> for bash scripts and many other things, <c>//</c>
-for C code, etc.) Also place the comment <e>before</e> the subject of the
-comment.
-</p>
-
-<pre caption="Comment example">
-<comment>(Substitute "john" with your user name)</comment>
-# <i>id john</i>
-</pre>
-
</body>
</section>
</chapter>
^ permalink raw reply related [flat|nested] 17+ messages in thread
* [gentoo-commits] proj/devmanual:devbook-guide commit in: appendices/contributing/devbook-guide/
@ 2018-09-23 14:54 Ulrich Müller
0 siblings, 0 replies; 17+ messages in thread
From: Ulrich Müller @ 2018-09-23 14:54 UTC (permalink / raw
To: gentoo-commits
commit: f568823a1bca21f40a402588871e6396df9322ad
Author: Ulrich Müller <ulm <AT> gentoo <DOT> org>
AuthorDate: Sun Sep 23 14:23:20 2018 +0000
Commit: Ulrich Müller <ulm <AT> gentoo <DOT> org>
CommitDate: Sun Sep 23 14:23:20 2018 +0000
URL: https://gitweb.gentoo.org/proj/devmanual.git/commit/?id=f568823a
appendices/contributing/devbook-guide: Change <pre> to <codesample>.
appendices/contributing/devbook-guide/text.xml | 32 +++++++++++++-------------
1 file changed, 16 insertions(+), 16 deletions(-)
diff --git a/appendices/contributing/devbook-guide/text.xml b/appendices/contributing/devbook-guide/text.xml
index 42865d5..564e29d 100644
--- a/appendices/contributing/devbook-guide/text.xml
+++ b/appendices/contributing/devbook-guide/text.xml
@@ -38,7 +38,7 @@ Let's start learning the GuideXML syntax. We'll start with the the initial
tags used in a GuideXML document:
</p>
-<pre caption="The initial part of a guide XML document">
+<codesample lang="sgml"><!-- The initial part of a guide XML document -->
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE guide SYSTEM "/dtd/guide.dtd">
<!-- $Header$ -->
@@ -63,7 +63,7 @@ using GuideXML.</i>
<version><i>1</i></version>
<date><i>2011-11-29</i></date>
-</pre>
+</codesample>
<p>
On the first lines, we see the requisite tag that identifies this as an XML
@@ -135,7 +135,7 @@ link="#doc_chap2_pre1">previous excerpt</uri> and append a
guide document:
</p>
-<pre caption="Minimal guide example">
+<codesample lang="sgml"><!-- Minimal guide example -->
<chapter>
<title><i>This is my chapter</i></title>
<section>
@@ -149,7 +149,7 @@ guide document:
</body>
</section>
</chapter>
-</pre>
+</codesample>
<p>
Above, I set the chapter title by adding a child <c><title></c>
@@ -180,7 +180,7 @@ Now, it's time to learn how to mark up actual content. Here's the XML code for
an example <c><body></c> element:
</p>
-<pre caption="Example of a body element">
+<codesample lang="sgml"><!-- Example of a body element -->
<p>
This is a paragraph. <path>/etc/passwd</path> is a file.
<uri>http://forums.gentoo.org</uri> is my favorite website.
@@ -206,7 +206,7 @@ This is a warning.
<impo>
This is important.
</impo>
-</pre>
+</codesample>
<p>
Now, here's how the <c><body></c> element above is rendered:
@@ -218,13 +218,13 @@ This is a paragraph. <path>/etc/passwd</path> is a file.
Type <c>ls</c> if you feel like it. I <e>really</e> want to go to sleep now.
</p>
-<pre caption="Code Sample">
+<codesample lang="sgml"><!-- Code Sample -->
This is text output or code.
# <i>this is user input</i>
Make HTML/XML easier to read by using selective emphasis:
<foo><i>bar</i></foo>
-</pre>
+</codesample>
<note>
This is a note.
@@ -259,12 +259,12 @@ exactly, making it well-suited for code excerpts. You must name the
<c><pre></c> tag with a <c>caption</c> attribute:
</p>
-<pre caption="Named <pre>">
+<codesample lang="sgml"><!-- Named <pre> -->
<pre caption="Output of uptime">
# <i>uptime</i>
16:50:47 up 164 days, 2:06, 5 users, load average: 0.23, 0.20, 0.25
</pre>
-</pre>
+</codesample>
</body>
</subsection>
@@ -522,7 +522,7 @@ the content.
An example for indentation is:
</p>
-<pre caption="Indentation Example">
+<codesample lang="sgml"><!-- Indentation Example -->
<table>
<tr>
<th>Foo</th>
@@ -541,17 +541,17 @@ An example for indentation is:
<li>First option</li>
<li>Second option</li>
</ul>
-</pre>
+</codesample>
<p>
<b>Attributes</b> may not have spaces in between the attribute, the "=" mark,
and the attribute value. As an example:
</p>
-<pre caption="Attributes">
+<codesample lang="sgml"><!-- Attributes -->
Wrong : <pre caption = "Attributes">
Correct: <pre caption="Attributes">
-</pre>
+</codesample>
</body>
</subsection>
@@ -571,12 +571,12 @@ Every sentence, including those inside tables and listings, should start
with a capital letter.
</p>
-<pre caption="Periods and capital letters">
+<codesample lang="sgml"><!-- Periods and capital letters -->
<ul>
<li>No period</li>
<li>With period. Multiple sentences, remember?</li>
</ul>
-</pre>
+</codesample>
<p>
Code Listings should <e>always</e> have a <c>caption</c>.
^ permalink raw reply related [flat|nested] 17+ messages in thread
* [gentoo-commits] proj/devmanual:devbook-guide commit in: appendices/contributing/devbook-guide/
@ 2018-09-23 14:54 Ulrich Müller
0 siblings, 0 replies; 17+ messages in thread
From: Ulrich Müller @ 2018-09-23 14:54 UTC (permalink / raw
To: gentoo-commits
commit: 3baf2d35b25408105d25e1f4437dac5f8aa94c9e
Author: Ulrich Müller <ulm <AT> gentoo <DOT> org>
AuthorDate: Sun Sep 23 14:10:43 2018 +0000
Commit: Ulrich Müller <ulm <AT> gentoo <DOT> org>
CommitDate: Sun Sep 23 14:10:43 2018 +0000
URL: https://gitweb.gentoo.org/proj/devmanual.git/commit/?id=3baf2d35
appendices/contributing/devbook-guide: Remove <abstract> tag.
It does not exist in DevBook XML.
appendices/contributing/devbook-guide/text.xml | 7 -------
1 file changed, 7 deletions(-)
diff --git a/appendices/contributing/devbook-guide/text.xml b/appendices/contributing/devbook-guide/text.xml
index 23d496a..42865d5 100644
--- a/appendices/contributing/devbook-guide/text.xml
+++ b/appendices/contributing/devbook-guide/text.xml
@@ -4,13 +4,6 @@
<chapter>
<title>Gentoo GuideXML Guide</title>
-<abstract>
-This guide shows you how to compose web documentation using the new lightweight
-Gentoo GuideXML syntax. This syntax is the official format for Gentoo
-documentation, and this document itself was created using GuideXML. This guide
-assumes a basic working knowledge of XML and HTML.
-</abstract>
-
<section>
<title>GuideXML basics</title>
<subsection>
^ permalink raw reply related [flat|nested] 17+ messages in thread
* [gentoo-commits] proj/devmanual:devbook-guide commit in: appendices/contributing/devbook-guide/
@ 2018-09-23 14:54 Ulrich Müller
0 siblings, 0 replies; 17+ messages in thread
From: Ulrich Müller @ 2018-09-23 14:54 UTC (permalink / raw
To: gentoo-commits
commit: 9f5781ca8f2a0cfeb59194c375704d34a06e451a
Author: Ulrich Müller <ulm <AT> gentoo <DOT> org>
AuthorDate: Sun Sep 23 14:07:48 2018 +0000
Commit: Ulrich Müller <ulm <AT> gentoo <DOT> org>
CommitDate: Sun Sep 23 14:07:48 2018 +0000
URL: https://gitweb.gentoo.org/proj/devmanual.git/commit/?id=9f5781ca
appendices/contributing/devbook-guide: Move everything into a chapter.
Demote previous chapters to sections, and sections to subsections.
appendices/contributing/devbook-guide/text.xml | 72 +++++++++++++-------------
1 file changed, 37 insertions(+), 35 deletions(-)
diff --git a/appendices/contributing/devbook-guide/text.xml b/appendices/contributing/devbook-guide/text.xml
index 48fb0ae..23d496a 100644
--- a/appendices/contributing/devbook-guide/text.xml
+++ b/appendices/contributing/devbook-guide/text.xml
@@ -1,6 +1,7 @@
<?xml version="1.0" encoding="UTF-8"?>
<guide self="appendices/contributing/devbook-guide/">
+<chapter>
<title>Gentoo GuideXML Guide</title>
<abstract>
@@ -10,9 +11,9 @@ documentation, and this document itself was created using GuideXML. This guide
assumes a basic working knowledge of XML and HTML.
</abstract>
-<chapter>
-<title>GuideXML basics</title>
<section>
+<title>GuideXML basics</title>
+<subsection>
<title>GuideXML design goals</title>
<body>
@@ -30,12 +31,12 @@ documents.
</p>
</body>
+</subsection>
</section>
-</chapter>
-<chapter>
-<title>GuideXML</title>
<section>
+<title>GuideXML</title>
+<subsection>
<title>Basic structure</title>
<body>
@@ -125,8 +126,8 @@ license. This is still accepted/allowed.
</p>
</body>
-</section>
-<section>
+</subsection>
+<subsection>
<title>Chapters and sections</title>
<body>
@@ -176,8 +177,8 @@ contain at least one <c><body></c> element.
</note>
</body>
-</section>
-<section>
+</subsection>
+<subsection>
<title>An example <body></title>
<body>
@@ -245,8 +246,8 @@ This is important.
</impo>
</body>
-</section>
-<section>
+</subsection>
+<subsection>
<title>The <body> tags</title>
<body>
@@ -273,8 +274,8 @@ exactly, making it well-suited for code excerpts. You must name the
</pre>
</body>
-</section>
-<section>
+</subsection>
+<subsection>
<title>
<c>, <b>, and <e>
</title>
@@ -308,8 +309,8 @@ prose more <e>punch</e>!
</p>
</body>
-</section>
-<section>
+</subsection>
+<subsection>
<title>Code samples and colour-coding</title>
<body>
@@ -319,8 +320,8 @@ Fill this section with the information about the use of
</todo>
</body>
-</section>
-<section>
+</subsection>
+<subsection>
<title><uri></title>
<body>
@@ -349,8 +350,8 @@ link="http://www.w3.org/QA/Tips/noClickHere">W3C</uri>.
</p>
</body>
-</section>
-<section>
+</subsection>
+<subsection>
<title>Figures</title>
<body>
@@ -365,8 +366,8 @@ for adding images without captions, borders, etc.
</p>
</body>
-</section>
-<section>
+</subsection>
+<subsection>
<title>Tables</title>
<body>
@@ -422,8 +423,8 @@ right-aligned, left-aligned or centered with the <c>align</c> attribute.
</table>
</body>
-</section>
-<section>
+</subsection>
+<subsection>
<title>Lists</title>
<body>
@@ -436,8 +437,8 @@ that you must close all tags including list items unlike in HTML.
</p>
</body>
-</section>
-<section>
+</subsection>
+<subsection>
<title>Intra-document references</title>
<body>
@@ -454,12 +455,12 @@ to <uri link="#doc_chap2_pre2">code listing 2 in chapter 2</uri>, type
</p>
</body>
+</subsection>
</section>
-</chapter>
-<chapter id="codingstyle">
-<title>Coding Style</title>
<section>
+<title>Coding Style</title>
+<subsection>
<title>Introduction</title>
<body>
@@ -476,8 +477,8 @@ Both sections are described next.
</p>
</body>
-</section>
-<section>
+</subsection>
+<subsection>
<title>Internal Coding Style</title>
<body>
@@ -560,8 +561,8 @@ Correct: <pre caption="Attributes">
</pre>
</body>
-</section>
-<section>
+</subsection>
+<subsection>
<title>External Coding Style</title>
<body>
@@ -595,12 +596,12 @@ Forums</uri> is preferred over <uri>http://forums.gentoo.org</uri>.
</p>
</body>
+</subsection>
</section>
-</chapter>
-<chapter>
-<title>Resources</title>
<section>
+<title>Resources</title>
+<subsection>
<title>Start writing</title>
<body>
@@ -617,6 +618,7 @@ to tackle. Have fun!
</p>
</body>
+</subsection>
</section>
</chapter>
</guide>
^ permalink raw reply related [flat|nested] 17+ messages in thread
end of thread, other threads:[~2018-09-23 14:54 UTC | newest]
Thread overview: 17+ messages (download: mbox.gz follow: Atom feed
-- links below jump to the message on this page --
2018-09-23 14:54 [gentoo-commits] proj/devmanual:devbook-guide commit in: appendices/contributing/devbook-guide/ Ulrich Müller
-- strict thread matches above, loose matches on Subject: below --
2018-09-23 14:54 Ulrich Müller
2018-09-23 14:54 Ulrich Müller
2017-07-29 20:55 Göktürk Yüksek
2017-04-17 23:23 Göktürk Yüksek
2017-04-17 23:23 Göktürk Yüksek
2017-04-17 23:23 Göktürk Yüksek
2017-04-17 23:23 Göktürk Yüksek
2017-04-17 23:23 Göktürk Yüksek
2017-04-17 23:23 Göktürk Yüksek
2017-04-12 21:24 Göktürk Yüksek
2017-04-12 21:24 Göktürk Yüksek
2017-04-12 21:24 Göktürk Yüksek
2017-04-12 21:24 Göktürk Yüksek
2017-04-12 21:24 Göktürk Yüksek
2017-04-12 21:24 Göktürk Yüksek
2017-04-12 21:24 Göktürk Yüksek
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox