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