| … | |
… | |
| 43 | </tr> |
43 | </tr> |
| 44 | <tr class="field"><th class="field-name">Type:</th><td class="field-body">Standards Track</td> |
44 | <tr class="field"><th class="field-name">Type:</th><td class="field-body">Standards Track</td> |
| 45 | </tr> |
45 | </tr> |
| 46 | <tr class="field"><th class="field-name">Content-Type:</th><td class="field-body"><a class="reference" href="glep-0012.html">text/x-rst</a></td> |
46 | <tr class="field"><th class="field-name">Content-Type:</th><td class="field-body"><a class="reference" href="glep-0012.html">text/x-rst</a></td> |
| 47 | </tr> |
47 | </tr> |
| 48 | <tr class="field"><th class="field-name">Created:</th><td class="field-body">03-March-2005</td> |
48 | <tr class="field"><th class="field-name">Created:</th><td class="field-body">11-March-2005</td> |
| 49 | </tr> |
49 | </tr> |
| 50 | <tr class="field"><th class="field-name">Post-Date:</th><td class="field-body">03-March-2005</td> |
50 | <tr class="field"><th class="field-name">Post-Date:</th><td class="field-body">11-March-2005, 13-March-2005</td> |
| 51 | </tr> |
51 | </tr> |
| 52 | </tbody> |
52 | </tbody> |
| 53 | </table> |
53 | </table> |
| 54 | <hr /> |
54 | <hr /> |
| 55 | <div class="contents topic" id="contents"> |
55 | <div class="contents topic" id="contents"> |
| … | |
… | |
| 60 | <li><a class="reference" href="#specification" id="id11" name="id11">Specification</a><ul> |
60 | <li><a class="reference" href="#specification" id="id11" name="id11">Specification</a><ul> |
| 61 | <li><a class="reference" href="#examples" id="id12" name="id12">Examples</a></li> |
61 | <li><a class="reference" href="#examples" id="id12" name="id12">Examples</a></li> |
| 62 | <li><a class="reference" href="#implementation-requirements" id="id13" name="id13">Implementation Requirements</a></li> |
62 | <li><a class="reference" href="#implementation-requirements" id="id13" name="id13">Implementation Requirements</a></li> |
| 63 | </ul> |
63 | </ul> |
| 64 | </li> |
64 | </li> |
| 65 | <li><a class="reference" href="#backwards-compatability" id="id14" name="id14">Backwards Compatability</a></li> |
65 | <li><a class="reference" href="#backwards-compatibility" id="id14" name="id14">Backwards Compatibility</a></li> |
| 66 | <li><a class="reference" href="#references" id="id15" name="id15">References</a></li> |
66 | <li><a class="reference" href="#references" id="id15" name="id15">References</a></li> |
| 67 | <li><a class="reference" href="#copyright" id="id16" name="id16">Copyright</a></li> |
67 | <li><a class="reference" href="#copyright" id="id16" name="id16">Copyright</a></li> |
| 68 | </ul> |
68 | </ul> |
| 69 | </div> |
69 | </div> |
| 70 | <div class="section" id="abstract"> |
70 | <div class="section" id="abstract"> |
| … | |
… | |
| 95 | <h1><a class="toc-backref" href="#id11" name="specification">Specification</a></h1> |
95 | <h1><a class="toc-backref" href="#id11" name="specification">Specification</a></h1> |
| 96 | <p>It is proposed that the existing <tt class="literal"><span class="pre">metadata.xml</span></tt> format <a class="footnote-reference" href="#id6" id="id2" name="id2">[1]</a> be used. |
96 | <p>It is proposed that the existing <tt class="literal"><span class="pre">metadata.xml</span></tt> format <a class="footnote-reference" href="#id6" id="id2" name="id2">[1]</a> be used. |
| 97 | Even though XML sucks, there is already a framework in place for these |
97 | Even though XML sucks, there is already a framework in place for these |
| 98 | files. The filename will be <tt class="literal"><span class="pre">blah-misc/metadata.xml</span></tt>. The character set |
98 | files. The filename will be <tt class="literal"><span class="pre">blah-misc/metadata.xml</span></tt>. The character set |
| 99 | used shall be UTF-8 for consistency with GLEP 31 <a class="footnote-reference" href="#id7" id="id3" name="id3">[2]</a>.</p> |
99 | used shall be UTF-8 for consistency with GLEP 31 <a class="footnote-reference" href="#id7" id="id3" name="id3">[2]</a>.</p> |
| 100 | <p>A new top level <tt class="literal"><span class="pre"><catmetadata></span></tt> element shall be added to the DTD to |
100 | <p>A new top level <tt class="literal"><span class="pre"><catmetadata></span></tt> element shall be added to the DTD. This |
| 101 | distinguish category metadata elements from the existing <tt class="literal"><span class="pre"><pkgmetadata></span></tt> |
101 | is necessary because the existing <tt class="literal"><span class="pre"><pkgmetadata></span></tt> element is not |
| 102 | elements.</p> |
102 | appropriately named, and doing a global rename would be impractical. Using |
|
|
103 | a different element would also permit additional category-specific data to |
|
|
104 | be added at a later date.</p> |
| 103 | <p>The existing <tt class="literal"><span class="pre"><longdescription></span></tt> elements shall be used for |
105 | <p>The existing <tt class="literal"><span class="pre"><longdescription></span></tt> elements shall be used for |
| 104 | descriptions. The <tt class="literal"><span class="pre">lang</span></tt> attribute shall be used to indicate the human |
106 | descriptions. The <tt class="literal"><span class="pre">lang</span></tt> attribute shall be used to indicate the human |
| 105 | language of the description -- all categories must have at least an |
107 | language of the description -- all categories must have at least an |
| 106 | English (<tt class="literal"><span class="pre">en</span></tt>) description.</p> |
108 | English (<tt class="literal"><span class="pre">en</span></tt>) description.</p> |
| 107 | <p>The <tt class="literal"><span class="pre"><herd></span></tt> and <tt class="literal"><span class="pre"><maintainer></span></tt> elements are not generally relevant at |
109 | <p>The <tt class="literal"><span class="pre"><herd></span></tt> and <tt class="literal"><span class="pre"><maintainer></span></tt> elements are not generally relevant at |
| 108 | the category level.</p> |
110 | the category level. They may be specified as a fall-back "assume that |
|
|
111 | everything in this category is maintained by these people", but this must |
|
|
112 | not be used as a replacement for proper per-package metadata.</p> |
| 109 | <div class="section" id="examples"> |
113 | <div class="section" id="examples"> |
| 110 | <h2><a class="toc-backref" href="#id12" name="examples">Examples</a></h2> |
114 | <h2><a class="toc-backref" href="#id12" name="examples">Examples</a></h2> |
| 111 | <p>The <tt class="literal"><span class="pre">app-vim</span></tt> category could use a <tt class="literal"><span class="pre">metadata.xml</span></tt> file like the |
115 | <p>The <tt class="literal"><span class="pre">app-vim</span></tt> category could use a <tt class="literal"><span class="pre">metadata.xml</span></tt> file like the |
| 112 | following:</p> |
116 | following:</p> |
| 113 | <pre class="literal-block"> |
117 | <pre class="literal-block"> |
| … | |
… | |
| 129 | <h2><a class="toc-backref" href="#id13" name="implementation-requirements">Implementation Requirements</a></h2> |
133 | <h2><a class="toc-backref" href="#id13" name="implementation-requirements">Implementation Requirements</a></h2> |
| 130 | <p>The DTD file would need to be updated to include the <tt class="literal"><span class="pre"><catmetadata></span></tt> |
134 | <p>The DTD file would need to be updated to include the <tt class="literal"><span class="pre"><catmetadata></span></tt> |
| 131 | element.</p> |
135 | element.</p> |
| 132 | <p>A metadata file would have to be added to every category in the tree. This |
136 | <p>A metadata file would have to be added to every category in the tree. This |
| 133 | could be done over a period of time.</p> |
137 | could be done over a period of time.</p> |
| 134 | <p><tt class="literal"><span class="pre">repoman</span></tt> checks for category metadata files would not be necessary.</p> |
138 | <p><tt class="literal"><span class="pre">repoman</span></tt> would need a few small changes to be able to handle |
|
|
139 | per-category metadata files.</p> |
| 135 | <p>The "packages.gentoo.org metadata" bug <a class="footnote-reference" href="#id8" id="id4" name="id4">[3]</a> would need to be |
140 | <p>The "packages.gentoo.org metadata" bug <a class="footnote-reference" href="#id8" id="id4" name="id4">[3]</a> would need to be |
| 136 | updated to ask for category descriptions as well.</p> |
141 | updated to ask for category descriptions as well.</p> |
| 137 | <p>The metadata documentation <a class="footnote-reference" href="#id6" id="id5" name="id5">[1]</a> would require some additions.</p> |
142 | <p>The metadata documentation <a class="footnote-reference" href="#id6" id="id5" name="id5">[1]</a> would require some additions.</p> |
| 138 | </div> |
143 | </div> |
| 139 | </div> |
144 | </div> |
| 140 | <div class="section" id="backwards-compatability"> |
145 | <div class="section" id="backwards-compatibility"> |
| 141 | <h1><a class="toc-backref" href="#id14" name="backwards-compatability">Backwards Compatability</a></h1> |
146 | <h1><a class="toc-backref" href="#id14" name="backwards-compatibility">Backwards Compatibility</a></h1> |
| 142 | <p>The metadata DTD will remain backwards compatible.</p> |
147 | <p>The metadata DTD will remain backwards compatible.</p> |
| 143 | <p>The category metadata files will need to be considered "optional until |
148 | <p>The category metadata files will need to be considered "optional until |
| 144 | implemented" rather than immediately becoming mandatory.</p> |
149 | implemented" rather than immediately becoming mandatory.</p> |
| 145 | </div> |
150 | </div> |
| 146 | <div class="section" id="references"> |
151 | <div class="section" id="references"> |
| … | |
… | |
| 168 | </table> |
173 | </table> |
| 169 | </div> |
174 | </div> |
| 170 | <div class="section" id="copyright"> |
175 | <div class="section" id="copyright"> |
| 171 | <h1><a class="toc-backref" href="#id16" name="copyright">Copyright</a></h1> |
176 | <h1><a class="toc-backref" href="#id16" name="copyright">Copyright</a></h1> |
| 172 | <p>This document has been placed in the public domain.</p> |
177 | <p>This document has been placed in the public domain.</p> |
| 173 | <blockquote> |
|
|
| 174 | vim: set tw=74 fileencoding=utf-8 :</blockquote> |
178 | <!-- vim: set tw=74 fileencoding=utf-8 : --> |
| 175 | </div> |
179 | </div> |
| 176 | </div> |
180 | </div> |
| 177 | |
181 | |
| 178 | <hr class="footer" /> |
182 | <hr class="footer" /> |
| 179 | <div class="footer"> |
183 | <div class="footer"> |
| 180 | <a class="reference" href="glep-0034.txt">View document source</a>. |
184 | <a class="reference" href="glep-0034.txt">View document source</a>. |
| 181 | Generated on: 2005-03-11 19:08 UTC. |
185 | Generated on: 2005-03-13 17:43 UTC. |
| 182 | Generated by <a class="reference" href="http://docutils.sourceforge.net/">Docutils</a> from <a class="reference" href="http://docutils.sourceforge.net/rst.html">reStructuredText</a> source. |
186 | Generated by <a class="reference" href="http://docutils.sourceforge.net/">Docutils</a> from <a class="reference" href="http://docutils.sourceforge.net/rst.html">reStructuredText</a> source. |
| 183 | </div> |
187 | </div> |
| 184 | </body> |
188 | </body> |
| 185 | </html> |
189 | </html> |
| 186 | |
190 | |
Parent Directory
| 
Revision Log
| 
Patch