swift 11/09/04 14:58:00 Modified: metadoc-guide.xml Log: Bug #380403 - Update metadoc information with correct entity/attribute information. Thanks to Chema "nimiux" Alonso for patch.
Revision Changes Path 1.7 xml/htdocs/proj/en/gdp/doc/metadoc-guide.xml file : http://sources.gentoo.org/viewvc.cgi/gentoo/xml/htdocs/proj/en/gdp/doc/metadoc-guide.xml?rev=1.7&view=markup plain: http://sources.gentoo.org/viewvc.cgi/gentoo/xml/htdocs/proj/en/gdp/doc/metadoc-guide.xml?rev=1.7&content-type=text/plain diff : http://sources.gentoo.org/viewvc.cgi/gentoo/xml/htdocs/proj/en/gdp/doc/metadoc-guide.xml?r1=1.6&r2=1.7 Index: metadoc-guide.xml =================================================================== RCS file: /var/cvsroot/gentoo/xml/htdocs/proj/en/gdp/doc/metadoc-guide.xml,v retrieving revision 1.6 retrieving revision 1.7 diff -u -r1.6 -r1.7 --- metadoc-guide.xml 23 Aug 2011 14:35:58 -0000 1.6 +++ metadoc-guide.xml 4 Sep 2011 14:58:00 -0000 1.7 @@ -1,6 +1,6 @@ <?xml version='1.0' encoding='UTF-8'?> -<!-- $Header: /var/cvsroot/gentoo/xml/htdocs/proj/en/gdp/doc/metadoc-guide.xml,v 1.6 2011/08/23 14:35:58 swift Exp $ --> +<!-- $Header: /var/cvsroot/gentoo/xml/htdocs/proj/en/gdp/doc/metadoc-guide.xml,v 1.7 2011/09/04 14:58:00 swift Exp $ --> <!DOCTYPE guide SYSTEM "/dtd/guide.dtd"> @@ -8,12 +8,14 @@ <title>Gentoo Metadoc XML Guide</title> <author title="Author"> - <mail link="[email protected]">Sven Vermeulen</mail> + <mail link="swift"/> </author> - <author title="Editor"> <mail link="[email protected]">Xavier Neys</mail> </author> +<author title="Editor"> + <mail link="nimiux"/> +</author> <abstract> This guide informs developers how to use the Metadoc XML format that allows the @@ -25,8 +27,8 @@ <!-- See http://creativecommons.org/licenses/by-sa/2.0 --> <license/> -<version>2</version> -<date>2011-08-23</date> +<version>3</version> +<date>2011-09-04</date> <chapter> <title>Introduction</title> @@ -289,21 +291,17 @@ </p> <p> -Each <c>doc</c> entity has a mandatory <c>id</c> attribute which should be seen -as a primary key for the document. +Each <c>doc</c> entity has a mandatory <c>fileid</c> attribute, which refers to +the <c>id</c> attribute of a <c>file</c> entity corresponding with the main file +for the document. </p> <p> -Inside each <c>doc</c> entity, at least one entity should be available: the -<c>fileid</c> entity, which refers to the <c>id</c> attribute of a <c>file</c> -entity corresponding with the main file for the document. -</p> - -<p> -In case of a handbook chapter, one must refer to the main handbook page (the top -handbook XML file). The <c>fileid</c> entity then contains two additional -parameters, called <c>vpart</c> and <c>vchap</c> which refer to the -corresponding part and chapter of the document inside the handbook. +In case of a handbook chapter, the <c>doc</c> entity must contain a +<c>bookref</c> entity which references the main handbook page (the top handbook +XML file). This entity then contains two attributes, called <c>vpart</c> and +<c>vchap</c> which refer to the corresponding part and chapter of the document +inside the handbook. </p> <p> @@ -326,27 +324,34 @@ </ul> <pre caption="Example Docs entity"> -<docs> - <doc id="handbook_x86"> - <memberof>install_guides</memberof> - <fileid>handbook-x86</fileid> - <bugs> - <bug>70753</bug> - </bugs> - </doc> - <doc id="portage-intro"> - <memberof>gentoo_portage</memberof> - <fileid vpart="2" vchap="1">handbook-x86</fileid> - </doc> - <doc id="uml"> - <memberof>sysadmin_general</memberof> - <fileid>uml</fileid> - </doc> -</docs> +<![CDATA[<docs> + <doc fileid="ldap-howto"> + <memberof>sysadmin_specific</memberof> + <bugs> + <bug>102481</bug> + <bug stopper="yes">1151330</bug> + </bugs> + </doc> + <doc fileid="uml"> + <memberof>sysadmin_general</memberof> + </doc> +</docs>]]> </pre> </body> </section> +<section> +<title>Example metadoc.xml file</title> +<body> + +<p> +The Gentoo site uses a <path>metadoc.xml</path> file to aggregate information of +all its documentation. You can view the current version one <uri +link="/doc/en/metadoc.xml?passthru=1">online</uri>. +</p> + +</body> +</section> </chapter> <chapter>
