Gentoo Archives: gentoo-doc-cvs

From: Xavier Neys <neysx@×××××××××××.org>
To: gentoo-doc-cvs@l.g.o
Subject: [gentoo-doc-cvs] cvs commit: xml-guide.xml
Date: Thu, 13 Oct 2005 20:33:45
Message-Id: 200510132024.j9DKO3UZ025935@robin.gentoo.org
1 neysx 05/10/13 20:33:40
2
3 Modified: xml/htdocs/doc/en xml-guide.xml
4 Log:
5 Minor fixes and added new tags to coding style section
6
7 Revision Changes Path
8 1.53 +23 -22 xml/htdocs/doc/en/xml-guide.xml
9
10 file : http://www.gentoo.org/cgi-bin/viewcvs.cgi/xml/htdocs/doc/en/xml-guide.xml?rev=1.53&content-type=text/x-cvsweb-markup&cvsroot=gentoo
11 plain: http://www.gentoo.org/cgi-bin/viewcvs.cgi/xml/htdocs/doc/en/xml-guide.xml?rev=1.53&content-type=text/plain&cvsroot=gentoo
12 diff : http://www.gentoo.org/cgi-bin/viewcvs.cgi/xml/htdocs/doc/en/xml-guide.xml.diff?r1=1.52&r2=1.53&cvsroot=gentoo
13
14 Index: xml-guide.xml
15 ===================================================================
16 RCS file: /var/cvsroot/gentoo/xml/htdocs/doc/en/xml-guide.xml,v
17 retrieving revision 1.52
18 retrieving revision 1.53
19 diff -u -r1.52 -r1.53
20 --- xml-guide.xml 13 Oct 2005 15:57:42 -0000 1.52
21 +++ xml-guide.xml 13 Oct 2005 20:33:40 -0000 1.53
22 @@ -1,5 +1,5 @@
23 <?xml version="1.0" encoding="UTF-8"?>
24 -<!-- $Header: /var/cvsroot/gentoo/xml/htdocs/doc/en/xml-guide.xml,v 1.52 2005/10/13 15:57:42 neysx Exp $ -->
25 +<!-- $Header: /var/cvsroot/gentoo/xml/htdocs/doc/en/xml-guide.xml,v 1.53 2005/10/13 20:33:40 neysx Exp $ -->
26 <!DOCTYPE guide SYSTEM "/dtd/guide.dtd">
27
28 <guide link="/doc/en/xml-guide.xml">
29 @@ -32,8 +32,8 @@
30 <!-- See http://creativecommons.org/licenses/by-sa/2.5 -->
31 <license/>
32
33 -<version>2.27</version>
34 -<date>2005-10-11</date>
35 +<version>2.28</version>
36 +<date>2005-10-13</date>
37
38 <chapter>
39 <title>Guide basics</title>
40 @@ -313,7 +313,7 @@
41 don't put a <c>&lt;note&gt;</c> element inside a <c>&lt;p&gt;</c> element. As
42 you might guess, the <c>&lt;pre&gt;</c> element preserves its whitespace
43 exactly, making it well-suited for code excerpts. You must name the
44 -<c>&lt;pre&gt;</c> tag with a caption attribute:
45 +<c>&lt;pre&gt;</c> tag with a <c>caption</c> attribute:
46 </p>
47
48 <pre caption="Named &lt;pre&gt;">
49 @@ -515,7 +515,7 @@
50 Definition lists (<c>&lt;dl&gt;</c>) are also supported. Please note that
51 neither the definition term tag (<c>&lt;dt&gt;</c>) nor the definition data tag
52 (<c>&lt;dd&gt;</c>) accept any other block level tag such as paragraphs or
53 -admonitions. A definition list comprises
54 +admonitions. A definition list comprises:
55 </p>
56
57 <dl>
58 @@ -548,14 +548,14 @@
59 <dt><b>The procedure:</b></dt>
60 <dd>
61 <ol>
62 - <li>Mix dry ingredients thoroughly.</li>
63 - <li>Pour in wet ingredients.</li>
64 - <li>Mix for 10 minutes.</li>
65 - <li>Bake for one hour at 300 degrees.</li>
66 + <li>Mix dry ingredients thoroughly</li>
67 + <li>Pour in wet ingredients</li>
68 + <li>Mix for 10 minutes</li>
69 + <li>Bake for one hour at 300 degrees</li>
70 </ol>
71 </dd>
72 <dt><b>Notes:</b></dt>
73 - <dd>The recipe may be improved by adding raisins.</dd>
74 + <dd>The recipe may be improved by adding raisins</dd>
75 </dl>
76
77 </body>
78 @@ -696,15 +696,16 @@
79 <p>
80 <b>Indentation</b> may not be used, except with the XML-constructs of which the
81 parent XML-tags are <c>&lt;tr&gt;</c> (from <c>&lt;table&gt;</c>),
82 -<c>&lt;ul&gt;</c>, <c>&lt;ol&gt;</c> and <c>&lt;author&gt;</c>. If indentation
83 -is used, it <e>must</e> be two spaces for each indentation. That means <e>no
84 -tabs</e> and <e>not</e> more spaces. Besides, tabs are not allowed in GuideXML
85 -documents.
86 +<c>&lt;ul&gt;</c>, <c>&lt;ol&gt;</c>, <c>&lt;dl&gt;</c>, and
87 +<c>&lt;author&gt;</c>. If indentation is used, it <e>must</e> be two spaces for
88 +each indentation. That means <e>no tabs</e> and <e>not</e> more spaces.
89 +Besides, tabs are not allowed in GuideXML documents.
90 </p>
91
92 <p>
93 -In case word-wrapping happens in <c>&lt;ti&gt;</c>, <c>&lt;th&gt;</c> or
94 -<c>&lt;li&gt;</c> constructs, indentation must be used for the content.
95 +In case word-wrapping happens in <c>&lt;ti&gt;</c>, <c>&lt;th&gt;</c>,
96 +<c>&lt;li&gt;</c> or <c>&lt;dd&gt;</c>constructs, indentation must be used for
97 +the content.
98 </p>
99
100 <p>
101 @@ -733,8 +734,8 @@
102 </pre>
103
104 <p>
105 -<b>Attributes</b> may not have spaces in between the attribute, the
106 -&quot;=&quot; mark, and the attribute value. As an example:
107 +<b>Attributes</b> may not have spaces in between the attribute, the "=" mark,
108 +and the attribute value. As an example:
109 </p>
110
111 <pre caption="Attributes">
112 @@ -749,10 +750,10 @@
113 <body>
114
115 <p>
116 -Inside tables (<c>&lt;table&gt;</c>) and listings (<c>&lt;ul&gt;</c> and
117 -<c>&lt;ol&gt;</c>), periods (&quot;.&quot;) should not be used unless multiple
118 -sentences are used. In that case, every sentence should end with a period (or
119 -other reading marks).
120 +Inside tables (<c>&lt;table&gt;</c>) and listings (<c>&lt;ul&gt;</c>,
121 +<c>&lt;ol&gt;</c>) and <c>&lt;dl&gt;</c>, periods (".") should not be used
122 +unless multiple sentences are used. In that case, every sentence should end
123 +with a period (or other reading marks).
124 </p>
125
126 <p>
127
128
129
130 --
131 gentoo-doc-cvs@g.o mailing list