/[gentoo]/xml/htdocs/proj/en/gdp/doc/metadoc-guide.xml
Gentoo

Diff of /xml/htdocs/proj/en/gdp/doc/metadoc-guide.xml

Parent Directory Parent Directory | Revision Log Revision Log | View Patch Patch

Revision 1.2 Revision 1.3
1<?xml version='1.0' encoding='UTF-8'?> 1<?xml version='1.0' encoding='UTF-8'?>
2 2
3<!-- $Header: /var/cvsroot/gentoo/xml/htdocs/proj/en/gdp/doc/metadoc-guide.xml,v 1.2 2005/01/06 17:18:12 neysx Exp $ --> 3<!-- $Header: /var/cvsroot/gentoo/xml/htdocs/proj/en/gdp/doc/metadoc-guide.xml,v 1.3 2005/04/04 10:19:34 neysx Exp $ -->
4 4
5<!DOCTYPE guide SYSTEM "/dtd/guide.dtd"> 5<!DOCTYPE guide SYSTEM "/dtd/guide.dtd">
6 6
7<guide link="metadoc-guide.xml"> 7<guide link="metadoc-guide.xml">
8<title>Gentoo Metadoc XML Guide</title> 8<title>Gentoo Metadoc XML Guide</title>
23 23
24<!-- The content of this document is licensed under the CC-BY-SA license --> 24<!-- The content of this document is licensed under the CC-BY-SA license -->
25<!-- See http://creativecommons.org/licenses/by-sa/2.0 --> 25<!-- See http://creativecommons.org/licenses/by-sa/2.0 -->
26<license/> 26<license/>
27 27
28<version>1.1</version> 28<version>1.2</version>
29<date>2005-01-06</date> 29<date>2005-04-04</date>
30 30
31<chapter> 31<chapter>
32<title>Introduction</title> 32<title>Introduction</title>
33<section> 33<section>
34<title>Why is MetadocXML Needed?</title> 34<title>Why is MetadocXML Needed?</title>
162the given order): 162the given order):
163</p> 163</p>
164 164
165<ul> 165<ul>
166 <li> 166 <li>
167 <c>version</c> to help keep track of changes
168 </li>
169 <li>
167 <c>members</c> which declares all members of the given language team 170 <c>members</c> which declares all members of the given language team
168 </li> 171 </li>
169 <li> 172 <li>
170 <c>categories</c> which declares the possible categories used 173 <c>categories</c> which declares the possible categories used
171 </li> 174 </li>
174 </li> 177 </li>
175 <li> 178 <li>
176 <c>docs</c> which contains all documents covered by the Metadoc file 179 <c>docs</c> which contains all documents covered by the Metadoc file
177 </li> 180 </li>
178</ul> 181</ul>
182
183</body>
184</section>
185<section>
186<title>The Version Entity</title>
187<body>
188
189<p>
190The version number should be increased when a document or a file is added or
191removed, when a path is changed or on any update that might have an impact on
192translated versions.
193</p>
179 194
180</body> 195</body>
181</section> 196</section>
182<section> 197<section>
183<title>The Members Entity</title> 198<title>The Members Entity</title>
200<pre caption="Example use of the members entity"> 215<pre caption="Example use of the members entity">
201&lt;members&gt; 216&lt;members&gt;
202 &lt;lead&gt;swift&lt;/lead&gt; 217 &lt;lead&gt;swift&lt;/lead&gt;
203 &lt;lead&gt;neysx&lt;/lead&gt; 218 &lt;lead&gt;neysx&lt;/lead&gt;
204 &lt;member&gt;dertobi123&lt;/member&gt; 219 &lt;member&gt;dertobi123&lt;/member&gt;
205 &lt;member mail="gentoo_contributor@gmail.com" fullname="Jhon Doe"&gt;jdoe&lt;/member&gt; 220 &lt;member mail="gentoo_contributor@gmail.com" fullname="John Doe"&gt;jdoe&lt;/member&gt;
206&lt;/members&gt; 221&lt;/members&gt;
207</pre> 222</pre>
208 223
209</body> 224</body>
210</section> 225</section>
249the metadoc's parent file (defined in the root element) to find out whether the 264the metadoc's parent file (defined in the root element) to find out whether the
250file is a translation or an untranslated file. File names would be identical in 265file is a translation or an untranslated file. File names would be identical in
251the latter case. 266the latter case.
252</p> 267</p>
253 268
269<p>
270The metadoc file itself can be listed and will appear on the overview page.
271</p>
272
254<pre caption="Files entity example"> 273<pre caption="Files entity examples">
255&lt;files&gt; 274&lt;files&gt;
275 &lt;file id="metadoc"&gt;/doc/en/metadoc.xml&lt;/file&gt;
256 &lt;file id="ati-faq"&gt;/doc/nl/ati-faq.xml&lt;/file&gt; 276 &lt;file id="ati-faq"&gt;/doc/en/ati-faq.xml&lt;/file&gt;
257&lt;/files&gt; 277&lt;/files&gt;
258</pre> 278</pre>
259 279
260</body> 280</body>
261</section> 281</section>

Legend:
Removed from v.1.2  
changed lines
  Added in v.1.3

  ViewVC Help
Powered by ViewVC 1.1.20