--- xml/htdocs/proj/en/glep/glep-0034.html 2005/03/17 23:58:15 1.3 +++ xml/htdocs/proj/en/glep/glep-0034.html 2005/05/02 20:32:51 1.4 @@ -8,7 +8,7 @@ --> - + GLEP 34 -- Per-Category metadata.xml Files @@ -24,8 +24,7 @@ [GLEP Index] [GLEP Source] -
- +
@@ -33,13 +32,13 @@ - + - + - + @@ -47,7 +46,7 @@ - +
Title:Per-Category metadata.xml Files
Version:1.3
Version:1.4
Author:Ciaran McCreesh <ciaranm at gentoo.org>
Last-Modified:2005/03/17 23:57:56
Last-Modified:2005/05/02 20:30:24
Status:Accepted
Status:Final
Type:Standards Track
Created:11-March-2005
Post-Date:11-March-2005, 13-March-2005
Post-Date:11-March-2005, 13-March-2005, 2-May-2005
@@ -69,7 +68,7 @@

Abstract

-

A metadata.xml file [1] is currently used to provide extra metadata +

A metadata.xml file [1] is currently used to provide extra metadata (long descriptions, herd and maintainer information) about a package. It is proposed that these files also be used to describe the purpose of a category.

@@ -81,38 +80,38 @@

Specification

-

It is proposed that the existing metadata.xml format [1] be used. +

It is proposed that the existing metadata.xml format [1] be used. Even though XML sucks, there is already a framework in place for these -files. The filename will be blah-misc/metadata.xml. The character set +files. The filename will be blah-misc/metadata.xml. The character set used shall be UTF-8 for consistency with GLEP 31 [2].

-

A new top level <catmetadata> element shall be added to the DTD. This -is necessary because the existing <pkgmetadata> element is not +

A new top level <catmetadata> element shall be added to the DTD. This +is necessary because the existing <pkgmetadata> element is not appropriately named, and doing a global rename would be impractical. Using a different element would also permit additional category-specific data to be added at a later date.

-

The existing <longdescription> elements shall be used for -descriptions. The lang attribute shall be used to indicate the human +

The existing <longdescription> elements shall be used for +descriptions. The lang attribute shall be used to indicate the human language of the description -- all categories must have at least an -English (en) description.

-

The <herd> and <maintainer> elements are not generally relevant at +English (en) description.

+

The <herd> and <maintainer> elements are not generally relevant at the category level. They may be specified as a fall-back "assume that everything in this category is maintained by these people", but this must not be used as a replacement for proper per-package metadata.

Examples

-

The app-vim category could use a metadata.xml file like the +

The app-vim category could use a metadata.xml file like the following:

 <?xml version="1.0" encoding="UTF-8"?>
@@ -131,11 +130,11 @@
 

Implementation Requirements

-

The DTD file would need to be updated to include the <catmetadata> +

The DTD file would need to be updated to include the <catmetadata> element.

A metadata file would have to be added to every category in the tree. This could be done over a period of time.

-

repoman would need a few small changes to be able to handle +

repoman would need a few small changes to be able to handle per-category metadata files.

The "packages.gentoo.org metadata" bug [3] would need to be updated to ask for category descriptions as well.

@@ -150,21 +149,21 @@

References

- +
[1](1, 2, 3) Gentoo Metadata, (http://www.gentoo.org/proj/en/devrel/handbook/handbook.xml?part=2&chap=4)
- +
[2]GLEP 31: Character Sets for Portage Tree Items (http://www.gentoo.org/proj/en/glep/glep-0031.html)
- +
[3]Gentoo bug 66917 @@ -177,12 +176,12 @@

This document has been placed in the public domain.

- - + +