Gentoo Archives: gentoo-doc-cvs

From: "Sven Vermeulen (swift)" <swift@g.o>
To: gentoo-doc-cvs@l.g.o
Subject: [gentoo-doc-cvs] gentoo commit in xml/htdocs/proj/en/gdp/doc: metadoc-guide.xml
Date: Sun, 04 Sep 2011 14:58:16
Message-Id: 20110904145800.5644420051@flycatcher.gentoo.org
1 swift 11/09/04 14:58:00
2
3 Modified: metadoc-guide.xml
4 Log:
5 Bug #380403 - Update metadoc information with correct entity/attribute information. Thanks to Chema "nimiux" Alonso for patch.
6
7 Revision Changes Path
8 1.7 xml/htdocs/proj/en/gdp/doc/metadoc-guide.xml
9
10 file : http://sources.gentoo.org/viewvc.cgi/gentoo/xml/htdocs/proj/en/gdp/doc/metadoc-guide.xml?rev=1.7&view=markup
11 plain: http://sources.gentoo.org/viewvc.cgi/gentoo/xml/htdocs/proj/en/gdp/doc/metadoc-guide.xml?rev=1.7&content-type=text/plain
12 diff : http://sources.gentoo.org/viewvc.cgi/gentoo/xml/htdocs/proj/en/gdp/doc/metadoc-guide.xml?r1=1.6&r2=1.7
13
14 Index: metadoc-guide.xml
15 ===================================================================
16 RCS file: /var/cvsroot/gentoo/xml/htdocs/proj/en/gdp/doc/metadoc-guide.xml,v
17 retrieving revision 1.6
18 retrieving revision 1.7
19 diff -u -r1.6 -r1.7
20 --- metadoc-guide.xml 23 Aug 2011 14:35:58 -0000 1.6
21 +++ metadoc-guide.xml 4 Sep 2011 14:58:00 -0000 1.7
22 @@ -1,6 +1,6 @@
23 <?xml version='1.0' encoding='UTF-8'?>
24
25 -<!-- $Header: /var/cvsroot/gentoo/xml/htdocs/proj/en/gdp/doc/metadoc-guide.xml,v 1.6 2011/08/23 14:35:58 swift Exp $ -->
26 +<!-- $Header: /var/cvsroot/gentoo/xml/htdocs/proj/en/gdp/doc/metadoc-guide.xml,v 1.7 2011/09/04 14:58:00 swift Exp $ -->
27
28 <!DOCTYPE guide SYSTEM "/dtd/guide.dtd">
29
30 @@ -8,12 +8,14 @@
31 <title>Gentoo Metadoc XML Guide</title>
32
33 <author title="Author">
34 - <mail link="swift@g.o">Sven Vermeulen</mail>
35 + <mail link="swift"/>
36 </author>
37 -
38 <author title="Editor">
39 <mail link="neysx@g.o">Xavier Neys</mail>
40 </author>
41 +<author title="Editor">
42 + <mail link="nimiux"/>
43 +</author>
44
45 <abstract>
46 This guide informs developers how to use the Metadoc XML format that allows the
47 @@ -25,8 +27,8 @@
48 <!-- See http://creativecommons.org/licenses/by-sa/2.0 -->
49 <license/>
50
51 -<version>2</version>
52 -<date>2011-08-23</date>
53 +<version>3</version>
54 +<date>2011-09-04</date>
55
56 <chapter>
57 <title>Introduction</title>
58 @@ -289,21 +291,17 @@
59 </p>
60
61 <p>
62 -Each <c>doc</c> entity has a mandatory <c>id</c> attribute which should be seen
63 -as a primary key for the document.
64 +Each <c>doc</c> entity has a mandatory <c>fileid</c> attribute, which refers to
65 +the <c>id</c> attribute of a <c>file</c> entity corresponding with the main file
66 +for the document.
67 </p>
68
69 <p>
70 -Inside each <c>doc</c> entity, at least one entity should be available: the
71 -<c>fileid</c> entity, which refers to the <c>id</c> attribute of a <c>file</c>
72 -entity corresponding with the main file for the document.
73 -</p>
74 -
75 -<p>
76 -In case of a handbook chapter, one must refer to the main handbook page (the top
77 -handbook XML file). The <c>fileid</c> entity then contains two additional
78 -parameters, called <c>vpart</c> and <c>vchap</c> which refer to the
79 -corresponding part and chapter of the document inside the handbook.
80 +In case of a handbook chapter, the <c>doc</c> entity must contain a
81 +<c>bookref</c> entity which references the main handbook page (the top handbook
82 +XML file). This entity then contains two attributes, called <c>vpart</c> and
83 +<c>vchap</c> which refer to the corresponding part and chapter of the document
84 +inside the handbook.
85 </p>
86
87 <p>
88 @@ -326,27 +324,34 @@
89 </ul>
90
91 <pre caption="Example Docs entity">
92 -&lt;docs&gt;
93 - &lt;doc id="handbook_x86"&gt;
94 - &lt;memberof&gt;install_guides&lt;/memberof&gt;
95 - &lt;fileid&gt;handbook-x86&lt;/fileid&gt;
96 - &lt;bugs&gt;
97 - &lt;bug&gt;70753&lt;/bug&gt;
98 - &lt;/bugs&gt;
99 - &lt;/doc&gt;
100 - &lt;doc id="portage-intro"&gt;
101 - &lt;memberof&gt;gentoo_portage&lt;/memberof&gt;
102 - &lt;fileid vpart="2" vchap="1"&gt;handbook-x86&lt;/fileid&gt;
103 - &lt;/doc&gt;
104 - &lt;doc id="uml"&gt;
105 - &lt;memberof&gt;sysadmin_general&lt;/memberof&gt;
106 - &lt;fileid&gt;uml&lt;/fileid&gt;
107 - &lt;/doc&gt;
108 -&lt;/docs&gt;
109 +<![CDATA[<docs>
110 + <doc fileid="ldap-howto">
111 + <memberof>sysadmin_specific</memberof>
112 + <bugs>
113 + <bug>102481</bug>
114 + <bug stopper="yes">1151330</bug>
115 + </bugs>
116 + </doc>
117 + <doc fileid="uml">
118 + <memberof>sysadmin_general</memberof>
119 + </doc>
120 +</docs>]]>
121 </pre>
122
123 </body>
124 </section>
125 +<section>
126 +<title>Example metadoc.xml file</title>
127 +<body>
128 +
129 +<p>
130 +The Gentoo site uses a <path>metadoc.xml</path> file to aggregate information of
131 +all its documentation. You can view the current version one <uri
132 +link="/doc/en/metadoc.xml?passthru=1">online</uri>.
133 +</p>
134 +
135 +</body>
136 +</section>
137 </chapter>
138
139 <chapter>