/[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.4 Revision 1.5
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.4 2006/05/23 13:26:41 nightmorph Exp $ --> 3<!-- $Header: /var/cvsroot/gentoo/xml/htdocs/proj/en/gdp/doc/metadoc-guide.xml,v 1.5 2007/06/10 19:33:13 nightmorph 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>
44Thanks to MetadocXML, we can now 44Thanks to MetadocXML, we can now
45</p> 45</p>
46 46
47<ul> 47<ul>
48 <li> 48 <li>
49 track documents that are located inside project webspace 49 track documents that are located inside project webspaces
50 (<path>/proj</path>) instead of the usual documentation repository 50 (<path>/proj</path>) instead of the usual documentation repository
51 (<path>/doc</path>) 51 (<path>/doc</path>)
52 </li> 52 </li>
53 <li> 53 <li>
54 categorize documentation into various categories (or subcategories) with the 54 categorize documentation into various categories (or subcategories) with the
55 additional benefit that we can now automatically generate the documentation 55 additional benefit that we can now automatically generate the documentation
56 index (and more) 56 index (and more)
57 </li> 57 </li>
58 <li> 58 <li>
59 track non-official documentation team members (such as translators) 59 track unofficial documentation team members (such as translators)
60 </li> 60 </li>
61 <li> 61 <li>
62 use parts of big documents (Handbooks) as individual guides on certain 62 use parts of big documents (Handbooks) as individual guides on certain
63 topics 63 topics
64 </li> 64 </li>
65 <li> 65 <li>
66 assign bugs to particular documents for quick reference and with the 66 assign bugs to particular documents for quick reference and with the
67 possibility of masking out a document in case of a major showstopping bug 67 possibility of masking out a document in case of a major showstopping bug
68 </li> 68 </li>
69 <li> 69 <li>
70 primitively check if a translated file is in sync with it's English 70 primitively check if a translated file is in sync with its English
71 counterpart or not 71 counterpart or not
72 </li> 72 </li>
73</ul> 73</ul>
74 74
75<p> 75<p>
309Inside the <c>doc</c> entity, two other entities are possible: 309Inside the <c>doc</c> entity, two other entities are possible:
310</p> 310</p>
311 311
312<ul> 312<ul>
313 <li> 313 <li>
314 One or more <c>memberof</c> entities, referring to the categorie(s) in which 314 One or more <c>memberof</c> entities, referring to the category or
315 the document is located (note that a document can be in several categories 315 categories in which the document is located (note that a document can be in
316 at once) 316 several categories at once)
317 </li> 317 </li>
318 <li> 318 <li>
319 One <c>bugs</c> entity containing one or more <c>bug</c> entities. A 319 One <c>bugs</c> entity containing one or more <c>bug</c> entities. A
320 <c>bug</c> entity refers to a bugnumber that covers a bug in the document. 320 <c>bug</c> entity refers to a bugnumber that covers a bug in the document.
321 In case of a major bug, one can add the attribute <c>stopper="yes"</c> to 321 In case of a major bug, one can add the attribute <c>stopper="yes"</c> to
396</p> 396</p>
397 397
398<p> 398<p>
399The <c>catid</c> tags refer to the main categories used by the dynamical index. 399The <c>catid</c> tags refer to the main categories used by the dynamical index.
400You should list each possible non-child category that is declared in your 400You should list each possible non-child category that is declared in your
401metadoc file. <e>Do not list</e> categories that are child of another category. 401metadoc file. <e>Do not list</e> categories that are children of another
402category.
402</p> 403</p>
403 404
404</body> 405</body>
405</section> 406</section>
406<section> 407<section>

Legend:
Removed from v.1.4  
changed lines
  Added in v.1.5

  ViewVC Help
Powered by ViewVC 1.1.20