* [gentoo-doc-cvs] cvs commit: xml-guide.xml
@ 2005-07-26 11:51 Xavier Neys
0 siblings, 0 replies; 20+ messages in thread
From: Xavier Neys @ 2005-07-26 11:51 UTC (permalink / raw
To: gentoo-doc-cvs
neysx 05/07/26 11:51:06
Modified: xml/htdocs/doc/en xml-guide.xml
Log:
<tr> can be ID'ed as well. See #94939
Revision Changes Path
1.47 +7 -7 xml/htdocs/doc/en/xml-guide.xml
file : http://www.gentoo.org/cgi-bin/viewcvs.cgi/xml/htdocs/doc/en/xml-guide.xml?rev=1.47&content-type=text/x-cvsweb-markup&cvsroot=gentoo
plain: http://www.gentoo.org/cgi-bin/viewcvs.cgi/xml/htdocs/doc/en/xml-guide.xml?rev=1.47&content-type=text/plain&cvsroot=gentoo
diff : http://www.gentoo.org/cgi-bin/viewcvs.cgi/xml/htdocs/doc/en/xml-guide.xml.diff?r1=1.46&r2=1.47&cvsroot=gentoo
Index: xml-guide.xml
===================================================================
RCS file: /var/cvsroot/gentoo/xml/htdocs/doc/en/xml-guide.xml,v
retrieving revision 1.46
retrieving revision 1.47
diff -u -r1.46 -r1.47
--- xml-guide.xml 9 Jun 2005 17:43:44 -0000 1.46
+++ xml-guide.xml 26 Jul 2005 11:51:06 -0000 1.47
@@ -1,5 +1,5 @@
<?xml version="1.0" encoding="UTF-8"?>
-<!-- $Header: /var/cvsroot/gentoo/xml/htdocs/doc/en/xml-guide.xml,v 1.46 2005/06/09 17:43:44 swift Exp $ -->
+<!-- $Header: /var/cvsroot/gentoo/xml/htdocs/doc/en/xml-guide.xml,v 1.47 2005/07/26 11:51:06 neysx Exp $ -->
<!DOCTYPE guide SYSTEM "/dtd/guide.dtd">
<guide link="/doc/en/xml-guide.xml">
@@ -32,8 +32,8 @@
<!-- See http://creativecommons.org/licenses/by-sa/2.5 -->
<license/>
-<version>2.22</version>
-<date>2005-06-09</date>
+<version>2.23</version>
+<date>2005-07-26</date>
<chapter>
<title>Guide basics</title>
@@ -420,8 +420,8 @@
header, and <c><ti></c> if you are inserting a normal informational
block. You can use a <c><th></c> anywhere you can use a <c><ti></c>
-- there's no requirement that <c><th></c> elements appear only in the
-first row. Currently, these tags don't support any attributes, but some will
-be added (such as a <c>caption=</c> attribute for <c><table></c>) soon.
+first row. Currently, these tags don't support any attributes, but some might
+be added (such as a <c>caption=</c> attribute for <c><table></c>) later.
</p>
<p>
@@ -454,8 +454,8 @@
<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> or <c><section></c> by using the <c>id</c>
-attribute, and then point to that attribute, like this:
+<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">
--
gentoo-doc-cvs@gentoo.org mailing list
^ permalink raw reply [flat|nested] 20+ messages in thread
* [gentoo-doc-cvs] cvs commit: xml-guide.xml
@ 2005-08-11 11:01 swift
0 siblings, 0 replies; 20+ messages in thread
From: swift @ 2005-08-11 11:01 UTC (permalink / raw
To: gentoo-doc-cvs
swift 05/08/11 11:01:06
Modified: xml/htdocs/doc/en xml-guide.xml
Log:
Hmmm... adhere to Coding Style in the section about Coding Style :)
Revision Changes Path
1.48 +5 -5 xml/htdocs/doc/en/xml-guide.xml
file : http://www.gentoo.org/cgi-bin/viewcvs.cgi/xml/htdocs/doc/en/xml-guide.xml?rev=1.48&content-type=text/x-cvsweb-markup&cvsroot=gentoo
plain: http://www.gentoo.org/cgi-bin/viewcvs.cgi/xml/htdocs/doc/en/xml-guide.xml?rev=1.48&content-type=text/plain&cvsroot=gentoo
diff : http://www.gentoo.org/cgi-bin/viewcvs.cgi/xml/htdocs/doc/en/xml-guide.xml.diff?r1=1.47&r2=1.48&cvsroot=gentoo
Index: xml-guide.xml
===================================================================
RCS file: /var/cvsroot/gentoo/xml/htdocs/doc/en/xml-guide.xml,v
retrieving revision 1.47
retrieving revision 1.48
diff -u -r1.47 -r1.48
--- xml-guide.xml 26 Jul 2005 11:51:06 -0000 1.47
+++ xml-guide.xml 11 Aug 2005 11:01:06 -0000 1.48
@@ -1,5 +1,5 @@
<?xml version="1.0" encoding="UTF-8"?>
-<!-- $Header: /var/cvsroot/gentoo/xml/htdocs/doc/en/xml-guide.xml,v 1.47 2005/07/26 11:51:06 neysx Exp $ -->
+<!-- $Header: /var/cvsroot/gentoo/xml/htdocs/doc/en/xml-guide.xml,v 1.48 2005/08/11 11:01:06 swift Exp $ -->
<!DOCTYPE guide SYSTEM "/dtd/guide.dtd">
<guide link="/doc/en/xml-guide.xml">
@@ -32,8 +32,8 @@
<!-- See http://creativecommons.org/licenses/by-sa/2.5 -->
<license/>
-<version>2.23</version>
-<date>2005-07-26</date>
+<version>2.24</version>
+<date>2005-08-11</date>
<chapter>
<title>Guide basics</title>
@@ -545,10 +545,10 @@
<th>Bar</th>
</tr>
<tr>
- <ti>This is an example for indentation.</ti>
+ <ti>This is an example for indentation</ti>
<ti>
In case text cannot be shown within an 80-character wide line, you
- must use indentation if the parent tag allows it.
+ must use indentation if the parent tag allows it
</ti>
</tr>
</table>
--
gentoo-doc-cvs@gentoo.org mailing list
^ permalink raw reply [flat|nested] 20+ messages in thread
* [gentoo-doc-cvs] cvs commit: xml-guide.xml
@ 2005-08-23 9:18 Xavier Neys
0 siblings, 0 replies; 20+ messages in thread
From: Xavier Neys @ 2005-08-23 9:18 UTC (permalink / raw
To: gentoo-doc-cvs
neysx 05/08/23 09:18:12
Modified: xml/htdocs/doc/en xml-guide.xml
Log:
#103418 Added missing blank line. Also bumped license to 2.5
Revision Changes Path
1.49 +7 -6 xml/htdocs/doc/en/xml-guide.xml
file : http://www.gentoo.org/cgi-bin/viewcvs.cgi/xml/htdocs/doc/en/xml-guide.xml?rev=1.49&content-type=text/x-cvsweb-markup&cvsroot=gentoo
plain: http://www.gentoo.org/cgi-bin/viewcvs.cgi/xml/htdocs/doc/en/xml-guide.xml?rev=1.49&content-type=text/plain&cvsroot=gentoo
diff : http://www.gentoo.org/cgi-bin/viewcvs.cgi/xml/htdocs/doc/en/xml-guide.xml.diff?r1=1.48&r2=1.49&cvsroot=gentoo
Index: xml-guide.xml
===================================================================
RCS file: /var/cvsroot/gentoo/xml/htdocs/doc/en/xml-guide.xml,v
retrieving revision 1.48
retrieving revision 1.49
diff -u -r1.48 -r1.49
--- xml-guide.xml 11 Aug 2005 11:01:06 -0000 1.48
+++ xml-guide.xml 23 Aug 2005 09:18:12 -0000 1.49
@@ -1,5 +1,5 @@
<?xml version="1.0" encoding="UTF-8"?>
-<!-- $Header: /var/cvsroot/gentoo/xml/htdocs/doc/en/xml-guide.xml,v 1.48 2005/08/11 11:01:06 swift Exp $ -->
+<!-- $Header: /var/cvsroot/gentoo/xml/htdocs/doc/en/xml-guide.xml,v 1.49 2005/08/23 09:18:12 neysx Exp $ -->
<!DOCTYPE guide SYSTEM "/dtd/guide.dtd">
<guide link="/doc/en/xml-guide.xml">
@@ -32,8 +32,8 @@
<!-- See http://creativecommons.org/licenses/by-sa/2.5 -->
<license/>
-<version>2.24</version>
-<date>2005-08-11</date>
+<version>2.25</version>
+<date>2005-08-23</date>
<chapter>
<title>Guide basics</title>
@@ -89,6 +89,7 @@
<guide link="<i>/doc/en/guide.xml</i>" lang="<i>en</i>">
<title><i>Gentoo Linux Documentation Guide</i></title>
+
<author title="<i>Author</i>">
<mail link="<i>yourname@gentoo.org</i>"><i>Your Name</i></mail>
</author>
@@ -158,7 +159,7 @@
<p>
Finally we have the <c><license/></c> tag, used to publish the document
-under the <uri link="http://creativecommons.org/licenses/by-sa/2.0/">Creative
+under the <uri link="http://creativecommons.org/licenses/by-sa/2.5/">Creative
Commons - Attribution / Share Alike</uri> license as required by the <uri
link="/proj/en/gdp/doc/doc-policy.xml">Documentation Policy</uri>.
</p>
@@ -663,7 +664,7 @@
</abstract>
<!-- The content of this document is licensed under the CC-BY-SA license -->
-<!-- See http://creativecommons.org/licenses/by-sa/2.0 -->
+<!-- See http://creativecommons.org/licenses/by-sa/2.5 -->
<license/>
<version>...</version>
@@ -728,7 +729,7 @@
<!-- $Header$ -->
<!-- The content of this document is licensed under the CC-BY-SA license -->
-<!-- See http://creativecommons.org/licenses/by-sa/2.0 -->
+<!-- See http://creativecommons.org/licenses/by-sa/2.5 -->
<sections>
--
gentoo-doc-cvs@gentoo.org mailing list
^ permalink raw reply [flat|nested] 20+ messages in thread
* [gentoo-doc-cvs] cvs commit: xml-guide.xml
@ 2005-10-09 6:07 vapier
0 siblings, 0 replies; 20+ messages in thread
From: vapier @ 2005-10-09 6:07 UTC (permalink / raw
To: gentoo-doc-cvs
vapier 05/10/09 06:07:09
Modified: xml/htdocs/doc/en xml-guide.xml
Log:
Gentoo Linux -> Gentoo
Revision Changes Path
1.50 +8 -8 xml/htdocs/doc/en/xml-guide.xml
file : http://www.gentoo.org/cgi-bin/viewcvs.cgi/xml/htdocs/doc/en/xml-guide.xml?rev=1.50&content-type=text/x-cvsweb-markup&cvsroot=gentoo
plain: http://www.gentoo.org/cgi-bin/viewcvs.cgi/xml/htdocs/doc/en/xml-guide.xml?rev=1.50&content-type=text/plain&cvsroot=gentoo
diff : http://www.gentoo.org/cgi-bin/viewcvs.cgi/xml/htdocs/doc/en/xml-guide.xml.diff?r1=1.49&r2=1.50&cvsroot=gentoo
Index: xml-guide.xml
===================================================================
RCS file: /var/cvsroot/gentoo/xml/htdocs/doc/en/xml-guide.xml,v
retrieving revision 1.49
retrieving revision 1.50
diff -u -r1.49 -r1.50
--- xml-guide.xml 23 Aug 2005 09:18:12 -0000 1.49
+++ xml-guide.xml 9 Oct 2005 06:07:09 -0000 1.50
@@ -1,9 +1,9 @@
<?xml version="1.0" encoding="UTF-8"?>
-<!-- $Header: /var/cvsroot/gentoo/xml/htdocs/doc/en/xml-guide.xml,v 1.49 2005/08/23 09:18:12 neysx Exp $ -->
+<!-- $Header: /var/cvsroot/gentoo/xml/htdocs/doc/en/xml-guide.xml,v 1.50 2005/10/09 06:07:09 vapier Exp $ -->
<!DOCTYPE guide SYSTEM "/dtd/guide.dtd">
<guide link="/doc/en/xml-guide.xml">
-<title>Gentoo Linux XML Guide</title>
+<title>Gentoo XML Guide</title>
<author title="Author">
<mail link="drobbins@gentoo.org">Daniel Robbins</mail>
@@ -23,7 +23,7 @@
<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 Linux
+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>
@@ -32,8 +32,8 @@
<!-- See http://creativecommons.org/licenses/by-sa/2.5 -->
<license/>
-<version>2.25</version>
-<date>2005-08-23</date>
+<version>2.26</version>
+<date>2005-10-09</date>
<chapter>
<title>Guide basics</title>
@@ -88,7 +88,7 @@
<!-- $Header$ -->
<guide link="<i>/doc/en/guide.xml</i>" lang="<i>en</i>">
-<title><i>Gentoo Linux Documentation Guide</i></title>
+<title><i>Gentoo Documentation Guide</i></title>
<author title="<i>Author</i>">
<mail link="<i>yourname@gentoo.org</i>"><i>Your Name</i></mail>
@@ -97,7 +97,7 @@
<abstract>
<i>This guide shows you how to compose web documentation using
our new lightweight Gentoo GuideXML syntax. This syntax is the official
-format for Gentoo Linux web documentation, and this document itself was created
+format for Gentoo web documentation, and this document itself was created
using GuideXML.</i>
</abstract>
@@ -767,7 +767,7 @@
Guide has been specially designed to be "lean and mean" so that developers can
spend more time writing documentation and less time learning the actual XML
syntax. Hopefully, this will allow developers who aren't unusually "doc-savvy"
-to start writing quality Gentoo Linux documentation. You might be interested
+to start writing quality Gentoo documentation. You might be interested
in our <uri link="/proj/en/gdp/doc/doc-tipsntricks.xml">Documentation
Development Tips & Tricks</uri>. If you'd like to help (or have any
questions about guide), please post a message to the <mail
--
gentoo-doc-cvs@gentoo.org mailing list
^ permalink raw reply [flat|nested] 20+ messages in thread
* [gentoo-doc-cvs] cvs commit: xml-guide.xml
@ 2005-10-09 11:00 Xavier Neys
0 siblings, 0 replies; 20+ messages in thread
From: Xavier Neys @ 2005-10-09 11:00 UTC (permalink / raw
To: gentoo-doc-cvs
neysx 05/10/09 11:00:20
Modified: xml/htdocs/doc/en xml-guide.xml
Log:
Documented disclaimers and some extra fixes
Revision Changes Path
1.51 +85 -29 xml/htdocs/doc/en/xml-guide.xml
file : http://www.gentoo.org/cgi-bin/viewcvs.cgi/xml/htdocs/doc/en/xml-guide.xml?rev=1.51&content-type=text/x-cvsweb-markup&cvsroot=gentoo
plain: http://www.gentoo.org/cgi-bin/viewcvs.cgi/xml/htdocs/doc/en/xml-guide.xml?rev=1.51&content-type=text/plain&cvsroot=gentoo
diff : http://www.gentoo.org/cgi-bin/viewcvs.cgi/xml/htdocs/doc/en/xml-guide.xml.diff?r1=1.50&r2=1.51&cvsroot=gentoo
Index: xml-guide.xml
===================================================================
RCS file: /var/cvsroot/gentoo/xml/htdocs/doc/en/xml-guide.xml,v
retrieving revision 1.50
retrieving revision 1.51
diff -u -r1.50 -r1.51
--- xml-guide.xml 9 Oct 2005 06:07:09 -0000 1.50
+++ xml-guide.xml 9 Oct 2005 11:00:20 -0000 1.51
@@ -1,5 +1,5 @@
<?xml version="1.0" encoding="UTF-8"?>
-<!-- $Header: /var/cvsroot/gentoo/xml/htdocs/doc/en/xml-guide.xml,v 1.50 2005/10/09 06:07:09 vapier Exp $ -->
+<!-- $Header: /var/cvsroot/gentoo/xml/htdocs/doc/en/xml-guide.xml,v 1.51 2005/10/09 11:00:20 neysx Exp $ -->
<!DOCTYPE guide SYSTEM "/dtd/guide.dtd">
<guide link="/doc/en/xml-guide.xml">
@@ -113,16 +113,18 @@
On the first lines, we see the requisite tag that identifies this as an XML
document and specifies its DTD. The <c><!-- $Header$ --></c> line
will be automatically modified by the CVS server and helps to track revisions.
-Next, there's a <c><guide></c> tag -- the entire guide document is
-enclosed within a <c><guide> </guide></c> pair. The <c>link</c>
+Next, there's a <c><guide></c> tag -- the entire guide document is
+enclosed within a <c><guide> </guide></c> pair. The <c>link</c>
attribute is compulsory and should preferably contain the absolute path to the
document relatively to the document root even though the file name alone will
work. It is mainly used to generate a link to a printer-friendly version of
-your document. If you use a wrong value, the link to the printable version
-will either not work or point to a wrong document. The <c>lang</c> attribute
-can be used to specify the language code of your document. It is used to format
-the date and insert strings like "<e>Note</e>", "<e>Content</e>", etc. in the
-specified language. The default is English.
+your document. If you use a wrong value, the link to the printable version will
+either not work or point to a wrong document. Translated documents <e>must</e>
+specify the full path because it is also used to check whether a more recent
+original document exists. The <c>lang</c> attribute should be used to specify
+the language code of your document. It is used to format the date and insert
+strings like "<e>Note</e>", "<e>Content</e>", etc. in the specified language.
+The default is English.
</p>
<p>
@@ -305,11 +307,11 @@
stacked -- in other words, don't put a <c><note></c> element inside a
<c><p></c> element. As you might guess, the <c><pre></c> element
preserves its whitespace exactly, making it well-suited for code excerpts.
-You can also name the <c><pre></c> tag:
+You must name the <c><pre></c> tag with a caption attribute:
</p>
<pre caption="Named <pre>">
-<pre caption = "Output of uptime">
+<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>
@@ -318,11 +320,11 @@
</body>
</section>
<section>
-<title><path>, <c>, <i> and <e></title>
+<title><path>, <c>, <i>, <b> and <e></title>
<body>
<p>
-The <c><path></c>, <c><c></c> and <c><e></c> elements can
+The <c><path></c>, <c><c></c>, <c><b></c> and <c><e></c> elements can
be used inside any child <c><body></c> tag, except for
<c><pre></c>. The <c><i></c> element can only be used inside
<c><pre></c>.
@@ -356,6 +358,11 @@
</p>
<p>
+As you might have guessed, <c><b></c> is used to <b>boldface</b> some
+text.
+</p>
+
+<p>
<c><e></c> is used to apply emphasis to a word or phrase; for example:
I <e>really</e> should use semicolons more often. As you can see, this text is
offset from the regular paragraph type for emphasis. This helps to give your
@@ -369,9 +376,11 @@
<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.com">Mr. Foo Bar</mail></c>.
+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.com">Mr. Foo Bar</mail></c>. If you want to display the
+email address, you can use <c><mail>foo@bar.com</mail></c>, this
+would be displayed as <mail>foo@bar.com</mail>.
</p>
<p>
@@ -414,15 +423,14 @@
<body>
<p>
-Guide 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>
+Guide 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
-block. You can use a <c><th></c> anywhere you can use a <c><ti></c>
--- there's no requirement that <c><th></c> elements appear only in the
-first row. Currently, these tags don't support any attributes, but some might
-be added (such as a <c>caption=</c> attribute for <c><table></c>) later.
+block. You can use a <c><th></c> anywhere you can use a <c><ti></c>
+-- there's no requirement that <c><th></c> elements appear only in the
+first row.
</p>
<p>
@@ -470,6 +478,51 @@
</body>
</section>
+<section>
+<title>Disclaimers and obsolete documents</title>
+<body>
+
+<p>
+A disclaimer 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 link="/doc/en/gentoo-x86-install.xml" disclaimer="obsolete" redirect="/doc/en/handbook/handbook-x86.xml">
+<title>Gentoo x86 Installation Guide</title>
+
+<author title="Author">
+...
+</pre>
+
+</body>
+</section>
</chapter>
<chapter>
@@ -517,17 +570,20 @@
<p>
<b>Word-wrapping</b> must be applied at 80 characters except inside
-<c><pre></c>. Only when there is no other choice can be deviated from
-this rule (for instance when a URL exceeds the maximum amount of characters).
-The editor must then wrap whenever the first whitespace occurs.
+<c><pre></c>. You may only deviate from this rule when there is no other
+choice (for instance when a URL exceeds the maximum amount of characters). The
+editor must then wrap whenever the first whitespace occurs. You should try to
+keep the <e>rendered</e> content of <c><pre></c> elements within 80
+columns to help console users.
</p>
<p>
-<b>Indentation</b> may not be used, except with the XML-constructs of which
-the parent XML-tags are <c><tr></c> (from <c><table></c>),
-<c><ul></c>, <c><ol></c> and <c><author></c>. If indentation
-is used, it <e>must</e> be two spaces for each indentation. That means <e>no</e>
-tabs and <e>not</e> more spaces.
+<b>Indentation</b> may not be used, except with the XML-constructs of which the
+parent XML-tags are <c><tr></c> (from <c><table></c>),
+<c><ul></c>, <c><ol></c> and <c><author></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.
</p>
<p>
--
gentoo-doc-cvs@gentoo.org mailing list
^ permalink raw reply [flat|nested] 20+ messages in thread
* [gentoo-doc-cvs] cvs commit: xml-guide.xml
@ 2005-10-13 15:57 Xavier Neys
0 siblings, 0 replies; 20+ messages in thread
From: Xavier Neys @ 2005-10-13 15:57 UTC (permalink / raw
To: gentoo-doc-cvs
neysx 05/10/13 15:57:42
Modified: xml/htdocs/doc/en xml-guide.xml
Log:
GuideXML improvements requested on #106017
Revision Changes Path
1.52 +151 -35 xml/htdocs/doc/en/xml-guide.xml
file : http://www.gentoo.org/cgi-bin/viewcvs.cgi/xml/htdocs/doc/en/xml-guide.xml?rev=1.52&content-type=text/x-cvsweb-markup&cvsroot=gentoo
plain: http://www.gentoo.org/cgi-bin/viewcvs.cgi/xml/htdocs/doc/en/xml-guide.xml?rev=1.52&content-type=text/plain&cvsroot=gentoo
diff : http://www.gentoo.org/cgi-bin/viewcvs.cgi/xml/htdocs/doc/en/xml-guide.xml.diff?r1=1.51&r2=1.52&cvsroot=gentoo
Index: xml-guide.xml
===================================================================
RCS file: /var/cvsroot/gentoo/xml/htdocs/doc/en/xml-guide.xml,v
retrieving revision 1.51
retrieving revision 1.52
diff -u -r1.51 -r1.52
--- xml-guide.xml 9 Oct 2005 11:00:20 -0000 1.51
+++ xml-guide.xml 13 Oct 2005 15:57:42 -0000 1.52
@@ -1,5 +1,5 @@
<?xml version="1.0" encoding="UTF-8"?>
-<!-- $Header: /var/cvsroot/gentoo/xml/htdocs/doc/en/xml-guide.xml,v 1.51 2005/10/09 11:00:20 neysx Exp $ -->
+<!-- $Header: /var/cvsroot/gentoo/xml/htdocs/doc/en/xml-guide.xml,v 1.52 2005/10/13 15:57:42 neysx Exp $ -->
<!DOCTYPE guide SYSTEM "/dtd/guide.dtd">
<guide link="/doc/en/xml-guide.xml">
@@ -32,8 +32,8 @@
<!-- See http://creativecommons.org/licenses/by-sa/2.5 -->
<license/>
-<version>2.26</version>
-<date>2005-10-09</date>
+<version>2.27</version>
+<date>2005-10-11</date>
<chapter>
<title>Guide basics</title>
@@ -62,9 +62,14 @@
<p>
If you are planning on contributing documentation to Gentoo, or you want to
-test GuideXML, please read the <uri
-link="/proj/en/gdp/doc/doc-tipsntricks.xml">Tips and Tricks</uri> which
-contains tips and tricks for documentation development.
+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>
@@ -135,7 +140,7 @@
<p>
Then, we come to the <c><author></c> tags, which contain information
about the various authors of the document. Each <c><author></c> tag
-allows for an optional <c>title=</c> element, used to specify the author's
+allows for an optional <c>title</c> element, used to specify the author's
relationship to the document (author, co-author, editor, etc.). In this
particular example, the authors' names are enclosed in another tag -- a
<c><mail></c> tag, used to specify an email address for this particular
@@ -297,17 +302,18 @@
<body>
<p>
-We introduced a lot of new tags in the previous section -- here's what you
-need to know. The <c><p></c> (paragraph), <c><pre></c> (code
-block), <c><note></c>, <c><warn></c> (warning) and
-<c><impo></c> (important) tags all can contain one or more lines of text.
-Besides the <c><table></c> element (which we'll cover in just a bit),
-these are the only tags that should appear immediately inside a
-<c><body></c> element. Another thing -- these tags <e>should not</e> be
-stacked -- in other words, don't put a <c><note></c> element inside a
-<c><p></c> element. As you might guess, the <c><pre></c> element
-preserves its whitespace exactly, making it well-suited for code excerpts.
-You must name the <c><pre></c> tag with a caption attribute:
+We introduced a lot of new tags in the previous section -- here's what you need
+to know. The <c><p></c> (paragraph), <c><pre></c> (code block),
+<c><note></c>, <c><warn></c> (warning) and <c><impo></c>
+(important) tags all can contain one or more lines of text. Besides the
+<c><table></c>, <c><ul></c>, <c><ol></c> and
+<c><dl></c> elements (which we'll cover in just a bit), these are the
+only tags that should appear immediately inside a <c><body></c> element.
+Another thing -- these tags <e>should not</e> be stacked -- in other words,
+don't put a <c><note></c> element inside a <c><p></c> element. As
+you might guess, the <c><pre></c> element preserves its whitespace
+exactly, making it well-suited for code excerpts. You must name the
+<c><pre></c> tag with a caption attribute:
</p>
<pre caption="Named <pre>">
@@ -320,14 +326,42 @@
</body>
</section>
<section>
-<title><path>, <c>, <i>, <b> and <e></title>
+<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>
+ <path>, <c>, <i>, <b>, <e>, <sub> and <sup>
+</title>
<body>
<p>
-The <c><path></c>, <c><c></c>, <c><b></c> and <c><e></c> elements can
-be used inside any child <c><body></c> tag, except for
-<c><pre></c>. The <c><i></c> element can only be used inside
-<c><pre></c>.
+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>. The <c><i></c>
+element can only be used inside <c><pre></c>.
</p>
<p>
@@ -369,6 +403,11 @@
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>
@@ -409,9 +448,9 @@
<p>
Here's how to insert a figure into a document -- <c><figure
link="mygfx.png" short="my picture" caption="my favorite picture of all
-time"/></c>. The <c>link=</c> attribute points to the actual graphic image,
-the <c>short=</c> attribute specifies a short description (currently used for
-the image's HTML <c>alt=</c> attribute), and a caption. Not too difficult
+time"/></c>. The <c>link</c> attribute points to the actual graphic image,
+the <c>short</c> attribute specifies a short description (currently used for
+the image's HTML <c>alt</c> attribute), and a caption. Not too difficult
:) We also support the standard HTML-style <img src="foo.gif"/> tag
for adding images without captions, borders, etc.
</p>
@@ -419,13 +458,13 @@
</body>
</section>
<section>
-<title>Tables and lists</title>
+<title>Tables</title>
<body>
<p>
-Guide supports a simplified table syntax similar to that of HTML. To start a
+Guide 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
+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
block. You can use a <c><th></c> anywhere you can use a <c><ti></c>
@@ -434,13 +473,91 @@
</p>
<p>
+Besides, the table header tag (<c><th></c>) accepts the <c>colspan</c>
+and <c>rowspan</c> attributes to span titles across rows, columns or both as
+shown below:
+</p>
+
+<table>
+ <tr>
+ <th colspan="4">This title spans 4 columns</th>
+ </tr>
+ <tr>
+ <th rowspan="3">This title spans 3 rows</th>
+ <ti>Item A1</ti>
+ <ti>Item A2</ti>
+ <ti>Item A3</ti>
+ </tr>
+ <tr>
+ <ti>Item B1</ti>
+ <th colspan="2" rowspan="2">Blocky 2x2 title</th>
+ </tr>
+ <tr>
+ <ti>Item C1</ti>
+ </tr>
--
gentoo-doc-cvs@gentoo.org mailing list
^ permalink raw reply [flat|nested] 20+ messages in thread
* [gentoo-doc-cvs] cvs commit: xml-guide.xml
@ 2005-10-13 20:33 Xavier Neys
0 siblings, 0 replies; 20+ messages in thread
From: Xavier Neys @ 2005-10-13 20:33 UTC (permalink / raw
To: gentoo-doc-cvs
neysx 05/10/13 20:33:40
Modified: xml/htdocs/doc/en xml-guide.xml
Log:
Minor fixes and added new tags to coding style section
Revision Changes Path
1.53 +23 -22 xml/htdocs/doc/en/xml-guide.xml
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
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
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
Index: xml-guide.xml
===================================================================
RCS file: /var/cvsroot/gentoo/xml/htdocs/doc/en/xml-guide.xml,v
retrieving revision 1.52
retrieving revision 1.53
diff -u -r1.52 -r1.53
--- xml-guide.xml 13 Oct 2005 15:57:42 -0000 1.52
+++ xml-guide.xml 13 Oct 2005 20:33:40 -0000 1.53
@@ -1,5 +1,5 @@
<?xml version="1.0" encoding="UTF-8"?>
-<!-- $Header: /var/cvsroot/gentoo/xml/htdocs/doc/en/xml-guide.xml,v 1.52 2005/10/13 15:57:42 neysx Exp $ -->
+<!-- $Header: /var/cvsroot/gentoo/xml/htdocs/doc/en/xml-guide.xml,v 1.53 2005/10/13 20:33:40 neysx Exp $ -->
<!DOCTYPE guide SYSTEM "/dtd/guide.dtd">
<guide link="/doc/en/xml-guide.xml">
@@ -32,8 +32,8 @@
<!-- See http://creativecommons.org/licenses/by-sa/2.5 -->
<license/>
-<version>2.27</version>
-<date>2005-10-11</date>
+<version>2.28</version>
+<date>2005-10-13</date>
<chapter>
<title>Guide basics</title>
@@ -313,7 +313,7 @@
don't put a <c><note></c> element inside a <c><p></c> element. As
you might guess, the <c><pre></c> element preserves its whitespace
exactly, making it well-suited for code excerpts. You must name the
-<c><pre></c> tag with a caption attribute:
+<c><pre></c> tag with a <c>caption</c> attribute:
</p>
<pre caption="Named <pre>">
@@ -515,7 +515,7 @@
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
+admonitions. A definition list comprises:
</p>
<dl>
@@ -548,14 +548,14 @@
<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>
+ <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>
+ <dd>The recipe may be improved by adding raisins</dd>
</dl>
</body>
@@ -696,15 +696,16 @@
<p>
<b>Indentation</b> may not be used, except with the XML-constructs of which the
parent XML-tags are <c><tr></c> (from <c><table></c>),
-<c><ul></c>, <c><ol></c> and <c><author></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.
+<c><ul></c>, <c><ol></c>, <c><dl></c>, and
+<c><author></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.
</p>
<p>
-In case word-wrapping happens in <c><ti></c>, <c><th></c> or
-<c><li></c> constructs, indentation must be used for the content.
+In case word-wrapping happens in <c><ti></c>, <c><th></c>,
+<c><li></c> or <c><dd></c>constructs, indentation must be used for
+the content.
</p>
<p>
@@ -733,8 +734,8 @@
</pre>
<p>
-<b>Attributes</b> may not have spaces in between the attribute, the
-"=" mark, and the attribute value. As an example:
+<b>Attributes</b> may not have spaces in between the attribute, the "=" mark,
+and the attribute value. As an example:
</p>
<pre caption="Attributes">
@@ -749,10 +750,10 @@
<body>
<p>
-Inside tables (<c><table></c>) and listings (<c><ul></c> and
-<c><ol></c>), periods (".") should not be used unless multiple
-sentences are used. In that case, every sentence should end with a period (or
-other reading marks).
+Inside tables (<c><table></c>) and listings (<c><ul></c>,
+<c><ol></c>) and <c><dl></c>, periods (".") should not be used
+unless multiple sentences are used. In that case, every sentence should end
+with a period (or other reading marks).
</p>
<p>
--
gentoo-doc-cvs@gentoo.org mailing list
^ permalink raw reply [flat|nested] 20+ messages in thread
* [gentoo-doc-cvs] cvs commit: xml-guide.xml
@ 2005-10-13 20:47 Alin Dobre
0 siblings, 0 replies; 20+ messages in thread
From: Alin Dobre @ 2005-10-13 20:47 UTC (permalink / raw
To: gentoo-doc-cvs
alin 05/10/13 20:47:14
Modified: xml/htdocs/doc/en xml-guide.xml
Log:
attribute name enclosed in a <c> tag + applied word wrap
Revision Changes Path
1.54 +5 -3 xml/htdocs/doc/en/xml-guide.xml
file : http://www.gentoo.org/cgi-bin/viewcvs.cgi/xml/htdocs/doc/en/xml-guide.xml?rev=1.54&content-type=text/x-cvsweb-markup&cvsroot=gentoo
plain: http://www.gentoo.org/cgi-bin/viewcvs.cgi/xml/htdocs/doc/en/xml-guide.xml?rev=1.54&content-type=text/plain&cvsroot=gentoo
diff : http://www.gentoo.org/cgi-bin/viewcvs.cgi/xml/htdocs/doc/en/xml-guide.xml.diff?r1=1.53&r2=1.54&cvsroot=gentoo
Index: xml-guide.xml
===================================================================
RCS file: /var/cvsroot/gentoo/xml/htdocs/doc/en/xml-guide.xml,v
retrieving revision 1.53
retrieving revision 1.54
diff -u -r1.53 -r1.54
--- xml-guide.xml 13 Oct 2005 20:33:40 -0000 1.53
+++ xml-guide.xml 13 Oct 2005 20:47:14 -0000 1.54
@@ -1,5 +1,5 @@
<?xml version="1.0" encoding="UTF-8"?>
-<!-- $Header: /var/cvsroot/gentoo/xml/htdocs/doc/en/xml-guide.xml,v 1.53 2005/10/13 20:33:40 neysx Exp $ -->
+<!-- $Header: /var/cvsroot/gentoo/xml/htdocs/doc/en/xml-guide.xml,v 1.54 2005/10/13 20:47:14 alin Exp $ -->
<!DOCTYPE guide SYSTEM "/dtd/guide.dtd">
<guide link="/doc/en/xml-guide.xml">
@@ -32,7 +32,7 @@
<!-- See http://creativecommons.org/licenses/by-sa/2.5 -->
<license/>
-<version>2.28</version>
+<version>2.29</version>
<date>2005-10-13</date>
<chapter>
@@ -599,7 +599,9 @@
<body>
<p>
-A disclaimer attribute can be applied to guides and handbooks to display a predefined disclaimer at the top of the document. The available disclaimers are:
+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>
--
gentoo-doc-cvs@gentoo.org mailing list
^ permalink raw reply [flat|nested] 20+ messages in thread
* [gentoo-doc-cvs] cvs commit: xml-guide.xml
@ 2005-12-19 17:57 Xavier Neys
0 siblings, 0 replies; 20+ messages in thread
From: Xavier Neys @ 2005-12-19 17:57 UTC (permalink / raw
To: gentoo-doc-cvs
neysx 05/12/19 17:57:43
Modified: xml/htdocs/doc/en xml-guide.xml
Log:
Removed a silly tab
Revision Changes Path
1.55 +2 -2 xml/htdocs/doc/en/xml-guide.xml
file : http://www.gentoo.org/cgi-bin/viewcvs.cgi/xml/htdocs/doc/en/xml-guide.xml?rev=1.55&content-type=text/x-cvsweb-markup&cvsroot=gentoo
plain: http://www.gentoo.org/cgi-bin/viewcvs.cgi/xml/htdocs/doc/en/xml-guide.xml?rev=1.55&content-type=text/plain&cvsroot=gentoo
diff : http://www.gentoo.org/cgi-bin/viewcvs.cgi/xml/htdocs/doc/en/xml-guide.xml.diff?r1=1.54&r2=1.55&cvsroot=gentoo
Index: xml-guide.xml
===================================================================
RCS file: /var/cvsroot/gentoo/xml/htdocs/doc/en/xml-guide.xml,v
retrieving revision 1.54
retrieving revision 1.55
diff -u -r1.54 -r1.55
--- xml-guide.xml 13 Oct 2005 20:47:14 -0000 1.54
+++ xml-guide.xml 19 Dec 2005 17:57:43 -0000 1.55
@@ -1,5 +1,5 @@
<?xml version="1.0" encoding="UTF-8"?>
-<!-- $Header: /var/cvsroot/gentoo/xml/htdocs/doc/en/xml-guide.xml,v 1.54 2005/10/13 20:47:14 alin Exp $ -->
+<!-- $Header: /var/cvsroot/gentoo/xml/htdocs/doc/en/xml-guide.xml,v 1.55 2005/12/19 17:57:43 neysx Exp $ -->
<!DOCTYPE guide SYSTEM "/dtd/guide.dtd">
<guide link="/doc/en/xml-guide.xml">
@@ -947,7 +947,7 @@
Development Tips & Tricks</uri>. If you'd like to help (or have any
questions about guide), please post a message to the <mail
link="gentoo-doc@gentoo.org">gentoo-doc mailing list</mail> stating what you'd
-like to tackle. Have fun!
+like to tackle. Have fun!
</p>
</body>
--
gentoo-doc-cvs@gentoo.org mailing list
^ permalink raw reply [flat|nested] 20+ messages in thread
* [gentoo-doc-cvs] cvs commit: xml-guide.xml
@ 2005-12-31 17:17 Xavier Neys
0 siblings, 0 replies; 20+ messages in thread
From: Xavier Neys @ 2005-12-31 17:17 UTC (permalink / raw
To: gentoo-doc-cvs
neysx 05/12/31 17:17:13
Modified: xml/htdocs/doc/en xml-guide.xml
Log:
#117287 typo fixes
Revision Changes Path
1.56 +7 -7 xml/htdocs/doc/en/xml-guide.xml
file : http://www.gentoo.org/cgi-bin/viewcvs.cgi/xml/htdocs/doc/en/xml-guide.xml?rev=1.56&content-type=text/x-cvsweb-markup&cvsroot=gentoo
plain: http://www.gentoo.org/cgi-bin/viewcvs.cgi/xml/htdocs/doc/en/xml-guide.xml?rev=1.56&content-type=text/plain&cvsroot=gentoo
diff : http://www.gentoo.org/cgi-bin/viewcvs.cgi/xml/htdocs/doc/en/xml-guide.xml.diff?r1=1.55&r2=1.56&cvsroot=gentoo
Index: xml-guide.xml
===================================================================
RCS file: /var/cvsroot/gentoo/xml/htdocs/doc/en/xml-guide.xml,v
retrieving revision 1.55
retrieving revision 1.56
diff -u -r1.55 -r1.56
--- xml-guide.xml 19 Dec 2005 17:57:43 -0000 1.55
+++ xml-guide.xml 31 Dec 2005 17:17:13 -0000 1.56
@@ -1,5 +1,5 @@
<?xml version="1.0" encoding="UTF-8"?>
-<!-- $Header: /var/cvsroot/gentoo/xml/htdocs/doc/en/xml-guide.xml,v 1.55 2005/12/19 17:57:43 neysx Exp $ -->
+<!-- $Header: /var/cvsroot/gentoo/xml/htdocs/doc/en/xml-guide.xml,v 1.56 2005/12/31 17:17:13 neysx Exp $ -->
<!DOCTYPE guide SYSTEM "/dtd/guide.dtd">
<guide link="/doc/en/xml-guide.xml">
@@ -849,7 +849,7 @@
<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
+<c><chapter></c>s, you define a <c><part></c>, which is the
equivalent of a separate part in a book:
</p>
@@ -870,9 +870,9 @@
</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
+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>
@@ -917,8 +917,8 @@
</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
+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>
--
gentoo-doc-cvs@gentoo.org mailing list
^ permalink raw reply [flat|nested] 20+ messages in thread
* [gentoo-doc-cvs] cvs commit: xml-guide.xml
@ 2006-01-09 14:44 Xavier Neys
0 siblings, 0 replies; 20+ messages in thread
From: Xavier Neys @ 2006-01-09 14:44 UTC (permalink / raw
To: gentoo-doc-cvs
neysx 06/01/09 14:44:14
Modified: xml/htdocs/doc/en xml-guide.xml
Log:
Typo: added missing space
Revision Changes Path
1.57 +2 -2 xml/htdocs/doc/en/xml-guide.xml
file : http://www.gentoo.org/cgi-bin/viewcvs.cgi/xml/htdocs/doc/en/xml-guide.xml?rev=1.57&content-type=text/x-cvsweb-markup&cvsroot=gentoo
plain: http://www.gentoo.org/cgi-bin/viewcvs.cgi/xml/htdocs/doc/en/xml-guide.xml?rev=1.57&content-type=text/plain&cvsroot=gentoo
diff : http://www.gentoo.org/cgi-bin/viewcvs.cgi/xml/htdocs/doc/en/xml-guide.xml.diff?r1=1.56&r2=1.57&cvsroot=gentoo
Index: xml-guide.xml
===================================================================
RCS file: /var/cvsroot/gentoo/xml/htdocs/doc/en/xml-guide.xml,v
retrieving revision 1.56
retrieving revision 1.57
diff -u -r1.56 -r1.57
--- xml-guide.xml 31 Dec 2005 17:17:13 -0000 1.56
+++ xml-guide.xml 9 Jan 2006 14:44:14 -0000 1.57
@@ -1,5 +1,5 @@
<?xml version="1.0" encoding="UTF-8"?>
-<!-- $Header: /var/cvsroot/gentoo/xml/htdocs/doc/en/xml-guide.xml,v 1.56 2005/12/31 17:17:13 neysx Exp $ -->
+<!-- $Header: /var/cvsroot/gentoo/xml/htdocs/doc/en/xml-guide.xml,v 1.57 2006/01/09 14:44:14 neysx Exp $ -->
<!DOCTYPE guide SYSTEM "/dtd/guide.dtd">
<guide link="/doc/en/xml-guide.xml">
@@ -706,7 +706,7 @@
<p>
In case word-wrapping happens in <c><ti></c>, <c><th></c>,
-<c><li></c> or <c><dd></c>constructs, indentation must be used for
+<c><li></c> or <c><dd></c> constructs, indentation must be used for
the content.
</p>
--
gentoo-doc-cvs@gentoo.org mailing list
^ permalink raw reply [flat|nested] 20+ messages in thread
* [gentoo-doc-cvs] cvs commit: xml-guide.xml
@ 2006-02-20 12:17 Xavier Neys
0 siblings, 0 replies; 20+ messages in thread
From: Xavier Neys @ 2006-02-20 12:17 UTC (permalink / raw
To: gentoo-doc-cvs
neysx 06/02/20 12:17:24
Modified: xml/htdocs/doc/en xml-guide.xml
Log:
#106017 Add colour coding to <pre>
Revision Changes Path
1.58 +79 -16 xml/htdocs/doc/en/xml-guide.xml
file : http://www.gentoo.org/cgi-bin/viewcvs.cgi/xml/htdocs/doc/en/xml-guide.xml?rev=1.58&content-type=text/x-cvsweb-markup&cvsroot=gentoo
plain: http://www.gentoo.org/cgi-bin/viewcvs.cgi/xml/htdocs/doc/en/xml-guide.xml?rev=1.58&content-type=text/plain&cvsroot=gentoo
diff : http://www.gentoo.org/cgi-bin/viewcvs.cgi/xml/htdocs/doc/en/xml-guide.xml.diff?r1=1.57&r2=1.58&cvsroot=gentoo
Index: xml-guide.xml
===================================================================
RCS file: /var/cvsroot/gentoo/xml/htdocs/doc/en/xml-guide.xml,v
retrieving revision 1.57
retrieving revision 1.58
diff -u -r1.57 -r1.58
--- xml-guide.xml 9 Jan 2006 14:44:14 -0000 1.57
+++ xml-guide.xml 20 Feb 2006 12:17:24 -0000 1.58
@@ -1,11 +1,14 @@
<?xml version="1.0" encoding="UTF-8"?>
-<!-- $Header: /var/cvsroot/gentoo/xml/htdocs/doc/en/xml-guide.xml,v 1.57 2006/01/09 14:44:14 neysx Exp $ -->
+<!-- $Header: /var/cvsroot/gentoo/xml/htdocs/doc/en/xml-guide.xml,v 1.58 2006/02/20 12:17:24 neysx Exp $ -->
<!DOCTYPE guide SYSTEM "/dtd/guide.dtd">
<guide link="/doc/en/xml-guide.xml">
<title>Gentoo XML Guide</title>
<author title="Author">
+ <mail link="neysx@gentoo.org">Xavier Neys</mail>
+</author>
+<author title="Author">
<mail link="drobbins@gentoo.org">Daniel Robbins</mail>
</author>
<author title="Author"><!-- zhen@gentoo.org -->
@@ -17,9 +20,6 @@
<author title="Editor">
<mail link="swift@gentoo.org">Sven Vermeulen</mail>
</author>
-<author title="Editor">
- <mail link="neysx@gentoo.org">Xavier Neys</mail>
-</author>
<abstract>
This guide shows you how to compose web documentation using the new lightweight
@@ -32,8 +32,8 @@
<!-- See http://creativecommons.org/licenses/by-sa/2.5 -->
<license/>
-<version>2.29</version>
-<date>2005-10-13</date>
+<version>3</version>
+<date>2006-02-18</date>
<chapter>
<title>Guide basics</title>
@@ -247,7 +247,7 @@
Make HTML/XML easier to read by using selective emphasis:
<foo><i>bar</i></foo>
-<comment>(This is how to insert an inline note into the code block)</comment>
+<comment>(This is how to insert a comment into a code block)</comment>
</pre>
<note>
@@ -280,7 +280,7 @@
Make HTML/XML easier to read by using selective emphasis:
<foo><i>bar</i></foo>
-<comment>(This is how to insert an inline note into the code block)</comment>
+<comment>(This is how to insert a comment into a code block)</comment>
</pre>
<note>
@@ -353,15 +353,14 @@
</section>
<section>
<title>
- <path>, <c>, <i>, <b>, <e>, <sub> and <sup>
+ <path>, <c>, <b>, <e>, <sub> and <sup>
</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>. The <c><i></c>
-element can only be used inside <c><pre></c>.
+<c><body></c> tag, except for <c><pre></c>.
</p>
<p>
@@ -387,11 +386,6 @@
</p>
<p>
-When you want to highlight some text as user input inside a <c><pre></c>,
-use <c><i></c> instead.
-</p>
-
-<p>
As you might have guessed, <c><b></c> is used to <b>boldface</b> some
text.
</p>
@@ -411,6 +405,75 @@
</body>
</section>
<section>
+<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-2006 <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>die</keyword> <const>"econf failed"</const>
+ <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>
+
+</body>
+</section>
+<section>
<title><mail> and <uri></title>
<body>
--
gentoo-doc-cvs@gentoo.org mailing list
^ permalink raw reply [flat|nested] 20+ messages in thread
* [gentoo-doc-cvs] cvs commit: xml-guide.xml
@ 2006-04-10 9:11 Xavier Neys
0 siblings, 0 replies; 20+ messages in thread
From: Xavier Neys @ 2006-04-10 9:11 UTC (permalink / raw
To: gentoo-doc-cvs
neysx 06/04/10 09:11:22
Modified: xml-guide.xml
Log:
#128998 Allow {row,col}span in <ti> like in <th>
Revision Changes Path
1.59 xml/htdocs/doc/en/xml-guide.xml
file : http://www.gentoo.org/cgi-bin/viewcvs.cgi/xml/htdocs/doc/en/xml-guide.xml?rev=1.59&content-type=text/x-cvsweb-markup&cvsroot=gentoo
plain: http://www.gentoo.org/cgi-bin/viewcvs.cgi/xml/htdocs/doc/en/xml-guide.xml?rev=1.59&content-type=text/plain&cvsroot=gentoo
diff : http://www.gentoo.org/cgi-bin/viewcvs.cgi/xml/htdocs/doc/en/xml-guide.xml.diff?r1=1.58&r2=1.59&cvsroot=gentoo
Index: xml-guide.xml
===================================================================
RCS file: /var/cvsroot/gentoo/xml/htdocs/doc/en/xml-guide.xml,v
retrieving revision 1.58
retrieving revision 1.59
diff -u -r1.58 -r1.59
--- xml-guide.xml 20 Feb 2006 12:17:24 -0000 1.58
+++ xml-guide.xml 10 Apr 2006 09:11:20 -0000 1.59
@@ -1,5 +1,5 @@
<?xml version="1.0" encoding="UTF-8"?>
-<!-- $Header: /var/cvsroot/gentoo/xml/htdocs/doc/en/xml-guide.xml,v 1.58 2006/02/20 12:17:24 neysx Exp $ -->
+<!-- $Header: /var/cvsroot/gentoo/xml/htdocs/doc/en/xml-guide.xml,v 1.59 2006/04/10 09:11:20 neysx Exp $ -->
<!DOCTYPE guide SYSTEM "/dtd/guide.dtd">
<guide link="/doc/en/xml-guide.xml">
@@ -32,8 +32,8 @@
<!-- See http://creativecommons.org/licenses/by-sa/2.5 -->
<license/>
-<version>3</version>
-<date>2006-02-18</date>
+<version>4</version>
+<date>2006-04-09</date>
<chapter>
<title>Guide basics</title>
@@ -546,7 +546,7 @@
<th colspan="4">This title spans 4 columns</th>
</tr>
<tr>
- <th rowspan="3">This title spans 3 rows</th>
+ <th rowspan="6">This title spans 6 rows</th>
<ti>Item A1</ti>
<ti>Item A2</ti>
<ti>Item A3</ti>
@@ -558,6 +558,16 @@
<tr>
<ti>Item C1</ti>
</tr>
+ <tr>
+ <ti colspan="3">Item D1..D3</ti>
+ </tr>
+ <tr>
+ <ti rowspan="2">Item E1..F1</ti>
+ <ti colspan="2">Item E2..E3</ti>
+ </tr>
+ <tr>
+ <ti colspan="2">Item F2..F3</ti>
+ </tr>
</table>
</body>
--
gentoo-doc-cvs@gentoo.org mailing list
^ permalink raw reply [flat|nested] 20+ messages in thread
* [gentoo-doc-cvs] cvs commit: xml-guide.xml
@ 2006-04-10 9:15 Xavier Neys
0 siblings, 0 replies; 20+ messages in thread
From: Xavier Neys @ 2006-04-10 9:15 UTC (permalink / raw
To: gentoo-doc-cvs
neysx 06/04/10 09:15:44
Modified: xml-guide.xml
Log:
#128998 Allow {row,col}span in <ti> like in <th>
Revision Changes Path
1.60 xml/htdocs/doc/en/xml-guide.xml
file : http://www.gentoo.org/cgi-bin/viewcvs.cgi/xml/htdocs/doc/en/xml-guide.xml?rev=1.60&content-type=text/x-cvsweb-markup&cvsroot=gentoo
plain: http://www.gentoo.org/cgi-bin/viewcvs.cgi/xml/htdocs/doc/en/xml-guide.xml?rev=1.60&content-type=text/plain&cvsroot=gentoo
diff : http://www.gentoo.org/cgi-bin/viewcvs.cgi/xml/htdocs/doc/en/xml-guide.xml.diff?r1=1.59&r2=1.60&cvsroot=gentoo
Index: xml-guide.xml
===================================================================
RCS file: /var/cvsroot/gentoo/xml/htdocs/doc/en/xml-guide.xml,v
retrieving revision 1.59
retrieving revision 1.60
diff -u -r1.59 -r1.60
--- xml-guide.xml 10 Apr 2006 09:11:20 -0000 1.59
+++ xml-guide.xml 10 Apr 2006 09:15:44 -0000 1.60
@@ -1,5 +1,5 @@
<?xml version="1.0" encoding="UTF-8"?>
-<!-- $Header: /var/cvsroot/gentoo/xml/htdocs/doc/en/xml-guide.xml,v 1.59 2006/04/10 09:11:20 neysx Exp $ -->
+<!-- $Header: /var/cvsroot/gentoo/xml/htdocs/doc/en/xml-guide.xml,v 1.60 2006/04/10 09:15:44 neysx Exp $ -->
<!DOCTYPE guide SYSTEM "/dtd/guide.dtd">
<guide link="/doc/en/xml-guide.xml">
@@ -32,8 +32,8 @@
<!-- See http://creativecommons.org/licenses/by-sa/2.5 -->
<license/>
-<version>4</version>
-<date>2006-04-09</date>
+<version>5</version>
+<date>2006-04-10</date>
<chapter>
<title>Guide basics</title>
@@ -536,9 +536,9 @@
</p>
<p>
-Besides, the table header tag (<c><th></c>) accepts the <c>colspan</c>
-and <c>rowspan</c> attributes to span titles across rows, columns or both as
-shown below:
+Besides, both table headers (<c><th></c>) and table items
+(<c><ti></c>) accept the <c>colspan</c> and <c>rowspan</c> attributes to
+span their content across rows, columns or both as shown below:
</p>
<table>
--
gentoo-doc-cvs@gentoo.org mailing list
^ permalink raw reply [flat|nested] 20+ messages in thread
* [gentoo-doc-cvs] cvs commit: xml-guide.xml
@ 2006-04-26 10:26 Xavier Neys
0 siblings, 0 replies; 20+ messages in thread
From: Xavier Neys @ 2006-04-26 10:26 UTC (permalink / raw
To: gentoo-doc-cvs
neysx 06/04/26 10:26:56
Modified: xml-guide.xml
Log:
Add al-IAN-gment to <ti>
Revision Changes Path
1.61 xml/htdocs/doc/en/xml-guide.xml
file : http://www.gentoo.org/cgi-bin/viewcvs.cgi/xml/htdocs/doc/en/xml-guide.xml?rev=1.61&content-type=text/x-cvsweb-markup&cvsroot=gentoo
plain: http://www.gentoo.org/cgi-bin/viewcvs.cgi/xml/htdocs/doc/en/xml-guide.xml?rev=1.61&content-type=text/plain&cvsroot=gentoo
diff : http://www.gentoo.org/cgi-bin/viewcvs.cgi/xml/htdocs/doc/en/xml-guide.xml.diff?r1=1.60&r2=1.61&cvsroot=gentoo
Index: xml-guide.xml
===================================================================
RCS file: /var/cvsroot/gentoo/xml/htdocs/doc/en/xml-guide.xml,v
retrieving revision 1.60
retrieving revision 1.61
diff -u -r1.60 -r1.61
--- xml-guide.xml 10 Apr 2006 09:15:44 -0000 1.60
+++ xml-guide.xml 26 Apr 2006 10:26:55 -0000 1.61
@@ -1,5 +1,5 @@
<?xml version="1.0" encoding="UTF-8"?>
-<!-- $Header: /var/cvsroot/gentoo/xml/htdocs/doc/en/xml-guide.xml,v 1.60 2006/04/10 09:15:44 neysx Exp $ -->
+<!-- $Header: /var/cvsroot/gentoo/xml/htdocs/doc/en/xml-guide.xml,v 1.61 2006/04/26 10:26:55 neysx Exp $ -->
<!DOCTYPE guide SYSTEM "/dtd/guide.dtd">
<guide link="/doc/en/xml-guide.xml">
@@ -32,8 +32,8 @@
<!-- See http://creativecommons.org/licenses/by-sa/2.5 -->
<license/>
-<version>5</version>
-<date>2006-04-10</date>
+<version>6</version>
+<date>2006-04-26</date>
<chapter>
<title>Guide basics</title>
@@ -538,7 +538,13 @@
<p>
Besides, both table headers (<c><th></c>) and table items
(<c><ti></c>) accept the <c>colspan</c> and <c>rowspan</c> attributes to
-span their content across rows, columns or both as shown below:
+span their content across rows, columns or both.
+</p>
+
+<p>
+Furthermore, table items (<c><ti></c>) can be right-aligned or centered
+with the <c>align</c> attribute. Table headers (<c><th></c>) are
+automatically centered.
</p>
<table>
@@ -552,21 +558,21 @@
<ti>Item A3</ti>
</tr>
<tr>
- <ti>Item B1</ti>
+ <ti align="center">Item B1</ti>
<th colspan="2" rowspan="2">Blocky 2x2 title</th>
</tr>
<tr>
- <ti>Item C1</ti>
+ <ti align="right">Item C1</ti>
</tr>
<tr>
- <ti colspan="3">Item D1..D3</ti>
+ <ti colspan="3" align="center">Item D1..D3</ti>
</tr>
<tr>
<ti rowspan="2">Item E1..F1</ti>
- <ti colspan="2">Item E2..E3</ti>
+ <ti colspan="2" align="right">Item E2..E3</ti>
</tr>
<tr>
- <ti colspan="2">Item F2..F3</ti>
+ <ti colspan="2" align="right">Item F2..F3</ti>
</tr>
</table>
--
gentoo-doc-cvs@gentoo.org mailing list
^ permalink raw reply [flat|nested] 20+ messages in thread
* [gentoo-doc-cvs] cvs commit: xml-guide.xml
@ 2006-05-07 14:36 Lukasz Damentko
0 siblings, 0 replies; 20+ messages in thread
From: Lukasz Damentko @ 2006-05-07 14:36 UTC (permalink / raw
To: gentoo-doc-cvs
rane 06/05/07 14:36:42
Modified: xml-guide.xml
Log:
adding missing space character, NO CONTENT CHANGE
Revision Changes Path
1.62 xml/htdocs/doc/en/xml-guide.xml
file : http://www.gentoo.org/cgi-bin/viewcvs.cgi/xml/htdocs/doc/en/xml-guide.xml?rev=1.62&content-type=text/x-cvsweb-markup&cvsroot=gentoo
plain: http://www.gentoo.org/cgi-bin/viewcvs.cgi/xml/htdocs/doc/en/xml-guide.xml?rev=1.62&content-type=text/plain&cvsroot=gentoo
diff : http://www.gentoo.org/cgi-bin/viewcvs.cgi/xml/htdocs/doc/en/xml-guide.xml.diff?r1=1.61&r2=1.62&cvsroot=gentoo
Index: xml-guide.xml
===================================================================
RCS file: /var/cvsroot/gentoo/xml/htdocs/doc/en/xml-guide.xml,v
retrieving revision 1.61
retrieving revision 1.62
diff -u -r1.61 -r1.62
--- xml-guide.xml 26 Apr 2006 10:26:55 -0000 1.61
+++ xml-guide.xml 7 May 2006 14:36:42 -0000 1.62
@@ -1,5 +1,5 @@
<?xml version="1.0" encoding="UTF-8"?>
-<!-- $Header: /var/cvsroot/gentoo/xml/htdocs/doc/en/xml-guide.xml,v 1.61 2006/04/26 10:26:55 neysx Exp $ -->
+<!-- $Header: /var/cvsroot/gentoo/xml/htdocs/doc/en/xml-guide.xml,v 1.62 2006/05/07 14:36:42 rane Exp $ -->
<!DOCTYPE guide SYSTEM "/dtd/guide.dtd">
<guide link="/doc/en/xml-guide.xml">
@@ -897,7 +897,7 @@
<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 syntaxis
+real content, but links to the individual documentation modules. The syntax is
doesn't differ much from GuideXML:
</p>
--
gentoo-doc-cvs@gentoo.org mailing list
^ permalink raw reply [flat|nested] 20+ messages in thread
* [gentoo-doc-cvs] cvs commit: xml-guide.xml
@ 2006-05-07 14:41 Lukasz Damentko
0 siblings, 0 replies; 20+ messages in thread
From: Lukasz Damentko @ 2006-05-07 14:41 UTC (permalink / raw
To: gentoo-doc-cvs
rane 06/05/07 14:41:19
Modified: xml-guide.xml
Log:
removing unnecessary word, NO CONTENT CHANGE
Revision Changes Path
1.63 xml/htdocs/doc/en/xml-guide.xml
file : http://www.gentoo.org/cgi-bin/viewcvs.cgi/xml/htdocs/doc/en/xml-guide.xml?rev=1.63&content-type=text/x-cvsweb-markup&cvsroot=gentoo
plain: http://www.gentoo.org/cgi-bin/viewcvs.cgi/xml/htdocs/doc/en/xml-guide.xml?rev=1.63&content-type=text/plain&cvsroot=gentoo
diff : http://www.gentoo.org/cgi-bin/viewcvs.cgi/xml/htdocs/doc/en/xml-guide.xml.diff?r1=1.62&r2=1.63&cvsroot=gentoo
Index: xml-guide.xml
===================================================================
RCS file: /var/cvsroot/gentoo/xml/htdocs/doc/en/xml-guide.xml,v
retrieving revision 1.62
retrieving revision 1.63
diff -u -r1.62 -r1.63
--- xml-guide.xml 7 May 2006 14:36:42 -0000 1.62
+++ xml-guide.xml 7 May 2006 14:41:19 -0000 1.63
@@ -1,5 +1,5 @@
<?xml version="1.0" encoding="UTF-8"?>
-<!-- $Header: /var/cvsroot/gentoo/xml/htdocs/doc/en/xml-guide.xml,v 1.62 2006/05/07 14:36:42 rane Exp $ -->
+<!-- $Header: /var/cvsroot/gentoo/xml/htdocs/doc/en/xml-guide.xml,v 1.63 2006/05/07 14:41:19 rane Exp $ -->
<!DOCTYPE guide SYSTEM "/dtd/guide.dtd">
<guide link="/doc/en/xml-guide.xml">
@@ -897,7 +897,7 @@
<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 is
+real content, but links to the individual documentation modules. The syntax
doesn't differ much from GuideXML:
</p>
--
gentoo-doc-cvs@gentoo.org mailing list
^ permalink raw reply [flat|nested] 20+ messages in thread
* [gentoo-doc-cvs] cvs commit: xml-guide.xml
@ 2006-05-11 17:07 Lukasz Damentko
0 siblings, 0 replies; 20+ messages in thread
From: Lukasz Damentko @ 2006-05-11 17:07 UTC (permalink / raw
To: gentoo-doc-cvs
rane 06/05/11 17:07:42
Modified: xml-guide.xml
Log:
one can't mail gentoo-doc ML directly, switching to link to lists.xml file instead
Revision Changes Path
1.64 xml/htdocs/doc/en/xml-guide.xml
file : http://www.gentoo.org/cgi-bin/viewcvs.cgi/xml/htdocs/doc/en/xml-guide.xml?rev=1.64&content-type=text/x-cvsweb-markup&cvsroot=gentoo
plain: http://www.gentoo.org/cgi-bin/viewcvs.cgi/xml/htdocs/doc/en/xml-guide.xml?rev=1.64&content-type=text/plain&cvsroot=gentoo
diff : http://www.gentoo.org/cgi-bin/viewcvs.cgi/xml/htdocs/doc/en/xml-guide.xml.diff?r1=1.63&r2=1.64&cvsroot=gentoo
Index: xml-guide.xml
===================================================================
RCS file: /var/cvsroot/gentoo/xml/htdocs/doc/en/xml-guide.xml,v
retrieving revision 1.63
retrieving revision 1.64
diff -u -r1.63 -r1.64
--- xml-guide.xml 7 May 2006 14:41:19 -0000 1.63
+++ xml-guide.xml 11 May 2006 17:07:41 -0000 1.64
@@ -1,5 +1,5 @@
<?xml version="1.0" encoding="UTF-8"?>
-<!-- $Header: /var/cvsroot/gentoo/xml/htdocs/doc/en/xml-guide.xml,v 1.63 2006/05/07 14:41:19 rane Exp $ -->
+<!-- $Header: /var/cvsroot/gentoo/xml/htdocs/doc/en/xml-guide.xml,v 1.64 2006/05/11 17:07:41 rane Exp $ -->
<!DOCTYPE guide SYSTEM "/dtd/guide.dtd">
<guide link="/doc/en/xml-guide.xml">
@@ -32,8 +32,8 @@
<!-- See http://creativecommons.org/licenses/by-sa/2.5 -->
<license/>
-<version>6</version>
-<date>2006-04-26</date>
+<version>7</version>
+<date>2006-05-11</date>
<chapter>
<title>Guide basics</title>
@@ -1024,8 +1024,8 @@
to start writing quality Gentoo documentation. You might be interested
in our <uri link="/proj/en/gdp/doc/doc-tipsntricks.xml">Documentation
Development Tips & Tricks</uri>. If you'd like to help (or have any
-questions about guide), please post a message to the <mail
-link="gentoo-doc@gentoo.org">gentoo-doc mailing list</mail> stating what you'd
+questions about guide), please post a message to the <uri
+link="/main/en/lists.xml">gentoo-doc mailing list</uri> stating what you'd
like to tackle. Have fun!
</p>
--
gentoo-doc-cvs@gentoo.org mailing list
^ permalink raw reply [flat|nested] 20+ messages in thread
* [gentoo-doc-cvs] cvs commit: xml-guide.xml
@ 2007-10-04 19:37 Xavier Neys
0 siblings, 0 replies; 20+ messages in thread
From: Xavier Neys @ 2007-10-04 19:37 UTC (permalink / raw
To: gentoo-doc-cvs
neysx 07/10/04 19:37:23
Modified: xml-guide.xml
Log:
Documented recent and much less recent features:
. shortcut for Gentoo devs in <mail>
. @link is not compulsory
. handbook values & conditionals
. <faqindex>
Used GuideXML more consistently
Revision Changes Path
1.67 xml/htdocs/doc/en/xml-guide.xml
file : http://sources.gentoo.org/viewcvs.py/gentoo/xml/htdocs/doc/en/xml-guide.xml?rev=1.67&view=markup
plain: http://sources.gentoo.org/viewcvs.py/gentoo/xml/htdocs/doc/en/xml-guide.xml?rev=1.67&content-type=text/plain
diff : http://sources.gentoo.org/viewcvs.py/gentoo/xml/htdocs/doc/en/xml-guide.xml?r1=1.66&r2=1.67
Index: xml-guide.xml
===================================================================
RCS file: /var/cvsroot/gentoo/xml/htdocs/doc/en/xml-guide.xml,v
retrieving revision 1.66
retrieving revision 1.67
diff -u -r1.66 -r1.67
--- xml-guide.xml 29 Nov 2006 15:48:57 -0000 1.66
+++ xml-guide.xml 4 Oct 2007 19:37:23 -0000 1.67
@@ -1,12 +1,12 @@
<?xml version="1.0" encoding="UTF-8"?>
-<!-- $Header: /var/cvsroot/gentoo/xml/htdocs/doc/en/xml-guide.xml,v 1.66 2006/11/29 15:48:57 nightmorph Exp $ -->
+<!-- $Header: /var/cvsroot/gentoo/xml/htdocs/doc/en/xml-guide.xml,v 1.67 2007/10/04 19:37:23 neysx Exp $ -->
<!DOCTYPE guide SYSTEM "/dtd/guide.dtd">
-<guide link="/doc/en/xml-guide.xml">
-<title>Gentoo XML Guide</title>
+<guide>
+<title>Gentoo GuideXML Guide</title>
<author title="Author">
- <mail link="neysx@gentoo.org">Xavier Neys</mail>
+ <mail link="neysx"/>
</author>
<author title="Author">
<mail link="drobbins@gentoo.org">Daniel Robbins</mail>
@@ -32,17 +32,17 @@
<!-- See http://creativecommons.org/licenses/by-sa/2.5 -->
<license/>
-<version>7</version>
-<date>2006-05-11</date>
+<version>8</version>
+<date>2007-10-04</date>
<chapter>
-<title>Guide basics</title>
+<title>GuideXML basics</title>
<section>
-<title>Guide XML design goals</title>
+<title>GuideXML design goals</title>
<body>
<p>
-The guide XML syntax is lightweight yet expressive, so that it is easy to
+The guideXML 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 -- just those we need.
This makes it easy to transform guide into other formats, such as DocBook
@@ -50,7 +50,7 @@
</p>
<p>
-The goal is to make it easy to <e>create</e> and <e>transform</e> guide XML
+The goal is to make it easy to <e>create</e> and <e>transform</e> guideXML
documents.
</p>
@@ -77,7 +77,7 @@
</chapter>
<chapter>
-<title>Guide XML</title>
+<title>GuideXML</title>
<section>
<title>Basic structure</title>
<body>
@@ -119,17 +119,19 @@
document and specifies its DTD. The <c><!-- $Header$ --></c> line
will be automatically modified by the CVS server and helps to track revisions.
Next, there's a <c><guide></c> tag -- the entire guide document is
-enclosed within a <c><guide> </guide></c> pair. The <c>link</c>
-attribute is compulsory and should preferably contain the absolute path to the
-document relatively to the document root even though the file name alone will
-work. It is mainly used to generate a link to a printer-friendly version of
-your document. If you use a wrong value, the link to the printable version will
-either not work or point to a wrong document. Translated documents <e>must</e>
-specify the full path because it is also used to check whether a more recent
-original document exists. The <c>lang</c> attribute should be used to specify
-the language code of your document. It is used to format the date and insert
-strings like "<e>Note</e>", "<e>Content</e>", etc. in the specified language.
-The default is English.
+enclosed within a <c><guide> </guide></c> pair.
+<br/>
+The <c>link</c> attribute is optional and should preferably contain the
+absolute path to the document relatively to the document root even though the
+file name alone will work. It is only used to generate a link to a
+printer-friendly version of your document and check whether a translation is
+up-to-date. Our XSL back-engine passes the actual path to our XSL stylesheet.
+The link attribute is only used as a fall-back value in case the XML is
+processed by other means.
+<br/>
+The <c>lang</c> attribute should be used to specify the language code of your
+document. It is used to format the date and insert strings like "<e>Note</e>",
+"<e>Content</e>", etc. in the specified language. The default is English.
</p>
<p>
@@ -144,8 +146,8 @@
relationship to the document (author, co-author, editor, etc.). In this
particular example, the authors' names are enclosed in another tag -- a
<c><mail></c> tag, used to specify an email address for this particular
-person. The <c><mail></c> tag is optional and can be omitted, and no
-more than one <c><author></c> element is required per guide document.
+person. The <c><mail></c> tag is optional and can be omitted, and at
+least one <c><author></c> element is required per guide document.
</p>
<p>
@@ -157,9 +159,9 @@
</p>
<p>
-This rounds out the tags that should appear at the beginning of a guide
-document. Besides the <c><title></c> and <c><mail></c> tags, these
-tags shouldn't appear anywhere else except immediately inside the
+This sums up the tags that should appear at the beginning of a guide document.
+Besides the <c><title></c> and <c><mail></c> tags, these tags
+shouldn't appear anywhere else except immediately inside the
<c><guide></c> tag, and for consistency it's recommended (but not
required) that these tags appear before the content of the document.
</p>
@@ -216,10 +218,10 @@
</p>
<note>
-A <c><guide></c> element can contain multiple <c><chapter></c>
-elements, and a <c><chapter></c> can contain multiple
-<c><section></c> elements. However, a <c><section></c>
-element can only contain one <c><body></c> element.
+A <c><guide></c> element must contain at least one <c><chapter></c>
+elements, a <c><chapter></c> must contain at least one
+<c><section></c> elements and a <c><section></c> element must
+contain at least one <c><body></c> element.
</note>
</body>
@@ -480,26 +482,51 @@
<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.com">Mr. Foo Bar</mail></c>. If you want to display the
-email address, you can use <c><mail>foo@bar.com</mail></c>, this
-would be displayed as <mail>foo@bar.com</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
-<uri>http://forums.gentoo.org</uri>. To create this link, I typed
-<c><uri>http://forums.gentoo.org</uri></c>. The alternate form is
+<uri>http://forums.gentoo.org/</uri>. To create this link, I typed
+<c><uri>http://forums.gentoo.org/</uri></c>. The alternate form is
when you want to associate a URI with some other text -- for example, <uri
-link="http://forums.gentoo.org">the Gentoo Forums</uri>. To create <e>this</e>
-link, I typed <c><uri link="http://forums.gentoo.org">the Gentoo
-Forums</uri></c>. You don't need to write <c>http://www.gentoo.org/</c>
-to link to other parts of the Gentoo web site. For instance, a link to the <uri
-link="/doc/en/">documentation main index</uri> should be simply <c><uri
-link="/doc/en/index.xml">documentation main index</uri></c>. You can
-even omit <c>index.xml</c> when you link to a directory index, e.g. <c><uri
-link="/doc/en/">documentation main index</uri></c>.
+link="http://forums.gentoo.org/">the Gentoo Forums</uri>. To create
+<e>this</e> link, I typed <c><uri link="http://forums.gentoo.org/">the
+Gentoo Forums</uri></c>. You don't need to write
+<c>http://www.gentoo.org/</c> to link to other parts of the Gentoo web site.
+For instance, a link to the <uri link="/doc/en/">documentation main index</uri>
+should be simply <c><uri link="/doc/en/index.xml">documentation main
+index</uri></c>. You can even omit <c>index.xml</c> when you link to a
+directory index, e.g. <c><uri link="/doc/en/">documentation main
+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>.
</p>
</body>
@@ -525,10 +552,10 @@
<body>
<p>
-Guide supports a simplified table syntax similar to that of HTML. To start a
+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>
-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
+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
block. You can use a <c><th></c> anywhere you can use a <c><ti></c>
-- there's no requirement that <c><th></c> elements appear only in the
@@ -644,15 +671,15 @@
<body>
<p>
-Guide makes it really easy to reference other parts of the document using
+GuideXML makes it really easy to reference other parts of the document using
hyperlinks. You can create a link pointing to <uri link="#doc_chap1">Chapter
One</uri> by typing <c><uri link="#doc_chap1">Chapter
One</uri></c>. To point to <uri link="#doc_chap1_sect2">section two of
Chapter One</uri>, type <c><uri link="#doc_chap1_sect2">section two of
-Chapter One</uri></c>. To refer to figure 3 in chapter 1, type <c><uri
-link="#doc_chap1_fig3">figure 1.3</uri></c>. Or, to refer 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>.
+Chapter One</uri></c>. To refer to figure 3 in chapter 1, type
+<c><uri link="#doc_chap1_fig3">figure 1.3</uri></c>. Or, to refer
+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>
@@ -711,7 +738,7 @@
<!DOCTYPE guide SYSTEM "/dtd/guide.dtd">
<!-- $Header$ -->
-<guide link="/doc/en/gentoo-x86-install.xml" disclaimer="obsolete" redirect="/doc/en/handbook/handbook-x86.xml">
+<guide disclaimer="obsolete" redirect="/doc/en/handbook/handbook-x86.xml">
<title>Gentoo x86 Installation Guide</title>
<author title="Author">
@@ -720,9 +747,312 @@
</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>
+<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/2.5 -->
+<license/>
+
+<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/2.5 -->
+
+<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>
<title>Introduction</title>
@@ -877,156 +1207,21 @@
</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> link="example.xml">
-<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/2.5 -->
-<license/>
-
-<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>
-<abstract>
- This is a small explanation on chapter one.
-</abstract>
-
- <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/2.5 -->
-
-<sections>
-
-<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>Resources</title>
<section>
<title>Start writing</title>
<body>
<p>
-Guide has been specially designed to be "lean and mean" so that developers can
-spend more time writing documentation and less time learning the actual XML
+GuideXML has been specially designed to be "lean and mean" so that developers
+can spend more time writing documentation and less time learning the actual XML
syntax. Hopefully, this will allow developers who aren't unusually "doc-savvy"
-to start writing quality Gentoo documentation. You might be interested
-in our <uri link="/proj/en/gdp/doc/doc-tipsntricks.xml">Documentation
-Development Tips & Tricks</uri>. If you'd like to help (or have any
-questions about guide), please post a message to the <uri
-link="/main/en/lists.xml">gentoo-doc mailing list</uri> stating what you'd
-like to tackle. Have fun!
+to start writing quality Gentoo documentation. You might be interested in our
+<uri link="/proj/en/gdp/doc/doc-tipsntricks.xml">Documentation Development Tips
+& Tricks</uri>. If you'd like to help (or have any questions about
+GuideXML), please post a message to the <uri
+link="/main/en/lists.xml">gentoo-doc mailing list</uri> stating what you'd like
+to tackle. Have fun!
</p>
</body>
--
gentoo-doc-cvs@gentoo.org mailing list
^ permalink raw reply [flat|nested] 20+ messages in thread
* [gentoo-doc-cvs] cvs commit: xml-guide.xml
@ 2008-03-09 13:13 Xavier Neys
0 siblings, 0 replies; 20+ messages in thread
From: Xavier Neys @ 2008-03-09 13:13 UTC (permalink / raw
To: gentoo-doc-cvs
neysx 08/03/09 13:13:15
Modified: xml-guide.xml
Log:
Allow align on <th> for rane
Revision Changes Path
1.68 xml/htdocs/doc/en/xml-guide.xml
file : http://sources.gentoo.org/viewcvs.py/gentoo/xml/htdocs/doc/en/xml-guide.xml?rev=1.68&view=markup
plain: http://sources.gentoo.org/viewcvs.py/gentoo/xml/htdocs/doc/en/xml-guide.xml?rev=1.68&content-type=text/plain
diff : http://sources.gentoo.org/viewcvs.py/gentoo/xml/htdocs/doc/en/xml-guide.xml?r1=1.67&r2=1.68
Index: xml-guide.xml
===================================================================
RCS file: /var/cvsroot/gentoo/xml/htdocs/doc/en/xml-guide.xml,v
retrieving revision 1.67
retrieving revision 1.68
diff -u -r1.67 -r1.68
--- xml-guide.xml 4 Oct 2007 19:37:23 -0000 1.67
+++ xml-guide.xml 9 Mar 2008 13:13:15 -0000 1.68
@@ -1,5 +1,5 @@
<?xml version="1.0" encoding="UTF-8"?>
-<!-- $Header: /var/cvsroot/gentoo/xml/htdocs/doc/en/xml-guide.xml,v 1.67 2007/10/04 19:37:23 neysx Exp $ -->
+<!-- $Header: /var/cvsroot/gentoo/xml/htdocs/doc/en/xml-guide.xml,v 1.68 2008/03/09 13:13:15 neysx Exp $ -->
<!DOCTYPE guide SYSTEM "/dtd/guide.dtd">
<guide>
@@ -32,8 +32,8 @@
<!-- See http://creativecommons.org/licenses/by-sa/2.5 -->
<license/>
-<version>8</version>
-<date>2007-10-04</date>
+<version>9</version>
+<date>2008-03-09</date>
<chapter>
<title>GuideXML basics</title>
@@ -569,14 +569,13 @@
</p>
<p>
-Furthermore, table items (<c><ti></c>) can be right-aligned or centered
-with the <c>align</c> attribute. Table headers (<c><th></c>) are
-automatically centered.
+Furthermore, table cells (<c><ti></c> & <c><th></c>) can be
+right-aligned, left-aligned or centered with the <c>align</c> attribute.
</p>
<table>
<tr>
- <th colspan="4">This title spans 4 columns</th>
+ <th align="center" colspan="4">This title spans 4 columns</th>
</tr>
<tr>
<th rowspan="6">This title spans 6 rows</th>
@@ -586,7 +585,7 @@
</tr>
<tr>
<ti align="center">Item B1</ti>
- <th colspan="2" rowspan="2">Blocky 2x2 title</th>
+ <th colspan="2" rowspan="2" align="right">Blocky 2x2 title</th>
</tr>
<tr>
<ti align="right">Item C1</ti>
--
gentoo-doc-cvs@lists.gentoo.org mailing list
^ permalink raw reply [flat|nested] 20+ messages in thread
end of thread, other threads:[~2008-03-09 13:13 UTC | newest]
Thread overview: 20+ messages (download: mbox.gz follow: Atom feed
-- links below jump to the message on this page --
2006-04-10 9:15 [gentoo-doc-cvs] cvs commit: xml-guide.xml Xavier Neys
-- strict thread matches above, loose matches on Subject: below --
2008-03-09 13:13 Xavier Neys
2007-10-04 19:37 Xavier Neys
2006-05-11 17:07 Lukasz Damentko
2006-05-07 14:41 Lukasz Damentko
2006-05-07 14:36 Lukasz Damentko
2006-04-26 10:26 Xavier Neys
2006-04-10 9:11 Xavier Neys
2006-02-20 12:17 Xavier Neys
2006-01-09 14:44 Xavier Neys
2005-12-31 17:17 Xavier Neys
2005-12-19 17:57 Xavier Neys
2005-10-13 20:47 Alin Dobre
2005-10-13 20:33 Xavier Neys
2005-10-13 15:57 Xavier Neys
2005-10-09 11:00 Xavier Neys
2005-10-09 6:07 vapier
2005-08-23 9:18 Xavier Neys
2005-08-11 11:01 swift
2005-07-26 11:51 Xavier Neys
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox