Gentoo Archives: gentoo-commits

From: "Ulrich Müller" <ulm@g.o>
To: gentoo-commits@l.g.o
Subject: [gentoo-commits] proj/devmanual:devbook-guide commit in: appendices/contributing/devbook-guide/
Date: Sun, 23 Sep 2018 14:54:33
Message-Id: 1537711668.9f5781ca8f2a0cfeb59194c375704d34a06e451a.ulm@gentoo
1 commit: 9f5781ca8f2a0cfeb59194c375704d34a06e451a
2 Author: Ulrich Müller <ulm <AT> gentoo <DOT> org>
3 AuthorDate: Sun Sep 23 14:07:48 2018 +0000
4 Commit: Ulrich Müller <ulm <AT> gentoo <DOT> org>
5 CommitDate: Sun Sep 23 14:07:48 2018 +0000
6 URL: https://gitweb.gentoo.org/proj/devmanual.git/commit/?id=9f5781ca
7
8 appendices/contributing/devbook-guide: Move everything into a chapter.
9
10 Demote previous chapters to sections, and sections to subsections.
11
12 appendices/contributing/devbook-guide/text.xml | 72 +++++++++++++-------------
13 1 file changed, 37 insertions(+), 35 deletions(-)
14
15 diff --git a/appendices/contributing/devbook-guide/text.xml b/appendices/contributing/devbook-guide/text.xml
16 index 48fb0ae..23d496a 100644
17 --- a/appendices/contributing/devbook-guide/text.xml
18 +++ b/appendices/contributing/devbook-guide/text.xml
19 @@ -1,6 +1,7 @@
20 <?xml version="1.0" encoding="UTF-8"?>
21
22 <guide self="appendices/contributing/devbook-guide/">
23 +<chapter>
24 <title>Gentoo GuideXML Guide</title>
25
26 <abstract>
27 @@ -10,9 +11,9 @@ documentation, and this document itself was created using GuideXML. This guide
28 assumes a basic working knowledge of XML and HTML.
29 </abstract>
30
31 -<chapter>
32 -<title>GuideXML basics</title>
33 <section>
34 +<title>GuideXML basics</title>
35 +<subsection>
36 <title>GuideXML design goals</title>
37 <body>
38
39 @@ -30,12 +31,12 @@ documents.
40 </p>
41
42 </body>
43 +</subsection>
44 </section>
45 -</chapter>
46
47 -<chapter>
48 -<title>GuideXML</title>
49 <section>
50 +<title>GuideXML</title>
51 +<subsection>
52 <title>Basic structure</title>
53 <body>
54
55 @@ -125,8 +126,8 @@ license. This is still accepted/allowed.
56 </p>
57
58 </body>
59 -</section>
60 -<section>
61 +</subsection>
62 +<subsection>
63 <title>Chapters and sections</title>
64 <body>
65
66 @@ -176,8 +177,8 @@ contain at least one <c>&lt;body&gt;</c> element.
67 </note>
68
69 </body>
70 -</section>
71 -<section>
72 +</subsection>
73 +<subsection>
74 <title>An example &lt;body&gt;</title>
75 <body>
76
77 @@ -245,8 +246,8 @@ This is important.
78 </impo>
79
80 </body>
81 -</section>
82 -<section>
83 +</subsection>
84 +<subsection>
85 <title>The &lt;body&gt; tags</title>
86 <body>
87
88 @@ -273,8 +274,8 @@ exactly, making it well-suited for code excerpts. You must name the
89 </pre>
90
91 </body>
92 -</section>
93 -<section>
94 +</subsection>
95 +<subsection>
96 <title>
97 &lt;c&gt;, &lt;b&gt;, and &lt;e&gt;
98 </title>
99 @@ -308,8 +309,8 @@ prose more <e>punch</e>!
100 </p>
101
102 </body>
103 -</section>
104 -<section>
105 +</subsection>
106 +<subsection>
107 <title>Code samples and colour-coding</title>
108 <body>
109
110 @@ -319,8 +320,8 @@ Fill this section with the information about the use of
111 </todo>
112
113 </body>
114 -</section>
115 -<section>
116 +</subsection>
117 +<subsection>
118 <title>&lt;uri&gt;</title>
119 <body>
120
121 @@ -349,8 +350,8 @@ link="http://www.w3.org/QA/Tips/noClickHere">W3C</uri>.
122 </p>
123
124 </body>
125 -</section>
126 -<section>
127 +</subsection>
128 +<subsection>
129 <title>Figures</title>
130 <body>
131
132 @@ -365,8 +366,8 @@ for adding images without captions, borders, etc.
133 </p>
134
135 </body>
136 -</section>
137 -<section>
138 +</subsection>
139 +<subsection>
140 <title>Tables</title>
141 <body>
142
143 @@ -422,8 +423,8 @@ right-aligned, left-aligned or centered with the <c>align</c> attribute.
144 </table>
145
146 </body>
147 -</section>
148 -<section>
149 +</subsection>
150 +<subsection>
151 <title>Lists</title>
152 <body>
153
154 @@ -436,8 +437,8 @@ that you must close all tags including list items unlike in HTML.
155 </p>
156
157 </body>
158 -</section>
159 -<section>
160 +</subsection>
161 +<subsection>
162 <title>Intra-document references</title>
163 <body>
164
165 @@ -454,12 +455,12 @@ to <uri link="#doc_chap2_pre2">code listing 2 in chapter 2</uri>, type
166 </p>
167
168 </body>
169 +</subsection>
170 </section>
171 -</chapter>
172
173 -<chapter id="codingstyle">
174 -<title>Coding Style</title>
175 <section>
176 +<title>Coding Style</title>
177 +<subsection>
178 <title>Introduction</title>
179 <body>
180
181 @@ -476,8 +477,8 @@ Both sections are described next.
182 </p>
183
184 </body>
185 -</section>
186 -<section>
187 +</subsection>
188 +<subsection>
189 <title>Internal Coding Style</title>
190 <body>
191
192 @@ -560,8 +561,8 @@ Correct: &lt;pre caption="Attributes"&gt;
193 </pre>
194
195 </body>
196 -</section>
197 -<section>
198 +</subsection>
199 +<subsection>
200 <title>External Coding Style</title>
201 <body>
202
203 @@ -595,12 +596,12 @@ Forums</uri> is preferred over <uri>http://forums.gentoo.org</uri>.
204 </p>
205
206 </body>
207 +</subsection>
208 </section>
209 -</chapter>
210
211 -<chapter>
212 -<title>Resources</title>
213 <section>
214 +<title>Resources</title>
215 +<subsection>
216 <title>Start writing</title>
217 <body>
218
219 @@ -617,6 +618,7 @@ to tackle. Have fun!
220 </p>
221
222 </body>
223 +</subsection>
224 </section>
225 </chapter>
226 </guide>