/[gentoo]/xml/htdocs/proj/en/glep/glep-0034.txt
Gentoo

Diff of /xml/htdocs/proj/en/glep/glep-0034.txt

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

Revision 1.1 Revision 1.5
1GLEP: 34 1GLEP: 34
2Title: Per-Category metadata.xml Files 2Title: Per-Category metadata.xml Files
3Version: $Revision: 1.1 $ 3Version: $Revision: 1.5 $
4Author: Ciaran McCreesh <ciaranm@gentoo.org> 4Author: Ciaran McCreesh <ciaranm@gentoo.org>
5Last-Modified: $Date: 2005/03/11 19:07:16 $ 5Last-Modified: $Date: 2005/11/07 22:26:59 $
6Status: Draft 6Status: Final
7Type: Standards Track 7Type: Standards Track
8Content-Type: text/x-rst 8Content-Type: text/x-rst
9Created: 03-March-2005 9Created: 11-Mar-2005
10Post-Date: 03-March-2005 10Post-History: 11-Mar-2005, 13-Mar-2005, 2-May-2005
11 11
12Abstract 12Abstract
13======== 13========
14 14
15A ``metadata.xml`` file [1]_ is currently used to provide extra metadata 15A ``metadata.xml`` file [1]_ is currently used to provide extra metadata
43It is proposed that the existing ``metadata.xml`` format [1]_ be used. 43It is proposed that the existing ``metadata.xml`` format [1]_ be used.
44Even though XML sucks, there is already a framework in place for these 44Even though XML sucks, there is already a framework in place for these
45files. The filename will be ``blah-misc/metadata.xml``. The character set 45files. The filename will be ``blah-misc/metadata.xml``. The character set
46used shall be UTF-8 for consistency with GLEP 31 [2]_. 46used shall be UTF-8 for consistency with GLEP 31 [2]_.
47 47
48A new top level ``<catmetadata>`` element shall be added to the DTD to 48A new top level ``<catmetadata>`` element shall be added to the DTD. This
49distinguish category metadata elements from the existing ``<pkgmetadata>`` 49is necessary because the existing ``<pkgmetadata>`` element is not
50elements. 50appropriately named, and doing a global rename would be impractical. Using
51a different element would also permit additional category-specific data to
52be added at a later date.
51 53
52The existing ``<longdescription>`` elements shall be used for 54The existing ``<longdescription>`` elements shall be used for
53descriptions. The ``lang`` attribute shall be used to indicate the human 55descriptions. The ``lang`` attribute shall be used to indicate the human
54language of the description -- all categories must have at least an 56language of the description -- all categories must have at least an
55English (``en``) description. 57English (``en``) description.
56 58
57The ``<herd>`` and ``<maintainer>`` elements are not generally relevant at 59The ``<herd>`` and ``<maintainer>`` elements are not generally relevant at
58the category level. 60the category level. They may be specified as a fall-back "assume that
61everything in this category is maintained by these people", but this must
62not be used as a replacement for proper per-package metadata.
59 63
60 64
61Examples 65Examples
62-------- 66--------
63 67
84element. 88element.
85 89
86A metadata file would have to be added to every category in the tree. This 90A metadata file would have to be added to every category in the tree. This
87could be done over a period of time. 91could be done over a period of time.
88 92
89``repoman`` checks for category metadata files would not be necessary. 93``repoman`` would need a few small changes to be able to handle
94per-category metadata files.
90 95
91The "packages.gentoo.org metadata" bug [3]_ would need to be 96The "packages.gentoo.org metadata" bug [3]_ would need to be
92updated to ask for category descriptions as well. 97updated to ask for category descriptions as well.
93 98
94The metadata documentation [1]_ would require some additions. 99The metadata documentation [1]_ would require some additions.
95 100
96Backwards Compatability 101Backwards Compatibility
97======================= 102=======================
98 103
99The metadata DTD will remain backwards compatible. 104The metadata DTD will remain backwards compatible.
100 105
101The category metadata files will need to be considered "optional until 106The category metadata files will need to be considered "optional until
114Copyright 119Copyright
115========= 120=========
116 121
117This document has been placed in the public domain. 122This document has been placed in the public domain.
118 123
119 vim: set tw=74 fileencoding=utf-8 : 124.. vim: set tw=74 fileencoding=utf-8 :
120 125

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

  ViewVC Help
Powered by ViewVC 1.1.20