1 |
nightmorph 08/09/11 09:22:03 |
2 |
|
3 |
Modified: hb-guide-metadata.xml |
4 |
Log: |
5 |
adding more tags stuff, this time to the developer handbook. bug 234730. with calchan's blessing. |
6 |
|
7 |
Revision Changes Path |
8 |
1.14 xml/htdocs/proj/en/devrel/handbook/hb-guide-metadata.xml |
9 |
|
10 |
file : http://sources.gentoo.org/viewcvs.py/gentoo/xml/htdocs/proj/en/devrel/handbook/hb-guide-metadata.xml?rev=1.14&view=markup |
11 |
plain: http://sources.gentoo.org/viewcvs.py/gentoo/xml/htdocs/proj/en/devrel/handbook/hb-guide-metadata.xml?rev=1.14&content-type=text/plain |
12 |
diff : http://sources.gentoo.org/viewcvs.py/gentoo/xml/htdocs/proj/en/devrel/handbook/hb-guide-metadata.xml?r1=1.13&r2=1.14 |
13 |
|
14 |
Index: hb-guide-metadata.xml |
15 |
=================================================================== |
16 |
RCS file: /var/cvsroot/gentoo/xml/htdocs/proj/en/devrel/handbook/hb-guide-metadata.xml,v |
17 |
retrieving revision 1.13 |
18 |
retrieving revision 1.14 |
19 |
diff -u -r1.13 -r1.14 |
20 |
--- hb-guide-metadata.xml 15 Jul 2008 19:31:51 -0000 1.13 |
21 |
+++ hb-guide-metadata.xml 11 Sep 2008 09:22:03 -0000 1.14 |
22 |
@@ -1,6 +1,6 @@ |
23 |
<?xml version='1.0' encoding='UTF-8'?> |
24 |
<!DOCTYPE sections SYSTEM "/dtd/book.dtd"> |
25 |
-<!-- $Header: /var/cvsroot/gentoo/xml/htdocs/proj/en/devrel/handbook/hb-guide-metadata.xml,v 1.13 2008/07/15 19:31:51 betelgeuse Exp $--> |
26 |
+<!-- $Header: /var/cvsroot/gentoo/xml/htdocs/proj/en/devrel/handbook/hb-guide-metadata.xml,v 1.14 2008/09/11 09:22:03 nightmorph Exp $--> |
27 |
|
28 |
<!-- The content of this document is licensed under the CC-BY-SA license --> |
29 |
<!-- See http://creativecommons.org/licenses/by-sa/1.0 --> |
30 |
@@ -10,8 +10,8 @@ |
31 |
--> |
32 |
|
33 |
<sections> |
34 |
-<version>1.0.6</version> |
35 |
-<date>2008-07-10</date> |
36 |
+<version>1.0.7</version> |
37 |
+<date>2008-09-11</date> |
38 |
|
39 |
<section> |
40 |
<title>Why the need for metadata.xml?</title> |
41 |
@@ -139,6 +139,66 @@ |
42 |
</ti> |
43 |
</tr> |
44 |
<tr> |
45 |
+ <ti><brite><upstream></brite></ti> |
46 |
+ <ti> |
47 |
+ This tag contains information about the upstream developers/project. |
48 |
+ </ti> |
49 |
+</tr> |
50 |
+<tr> |
51 |
+ <ti><brite><maintainer></brite></ti> |
52 |
+ <ti> |
53 |
+ Name and e-mail of an upstream maintainer. May appear more than once. |
54 |
+ </ti> |
55 |
+</tr> |
56 |
+<tr> |
57 |
+ <ti><brite><name></brite></ti> |
58 |
+ <ti> |
59 |
+ The name of an usptream maintainer should contain a block of text with upstream's name. |
60 |
+ This element is mandatory for an upstream maintainer and must appear only once. |
61 |
+ </ti> |
62 |
+</tr> |
63 |
+<tr> |
64 |
+ <ti><brite><email></brite></ti> |
65 |
+ <ti> |
66 |
+ The email address of an upstream may appear only once. |
67 |
+ </ti> |
68 |
+</tr> |
69 |
+<tr> |
70 |
+ <ti><brite><changelog></brite></ti> |
71 |
+ <ti> |
72 |
+ Should contain a URL where the location of the upstream changelog can be found. |
73 |
+ The URL must be version independent and must point to a changelog which is only |
74 |
+ updated on new releases of the corresponding package. (This also implies that |
75 |
+ one can link to an automatically updated changelog in case of vcs snapshots |
76 |
+ only.) |
77 |
+ </ti> |
78 |
+</tr> |
79 |
+<tr> |
80 |
+ <ti><brite><doc></brite></ti> |
81 |
+ <ti> |
82 |
+ Should contain a URL where the location of the upstream documentation can be |
83 |
+ found. The link must not point to any third party documentation and must be |
84 |
+ version independent. If the documentation is available in more than one language, |
85 |
+ a lang attribute can be used which follows the same rules as the one for |
86 |
+ longdescription. |
87 |
+ </ti> |
88 |
+</tr> |
89 |
+<tr> |
90 |
+ <ti><brite><bugs-to></brite></ti> |
91 |
+ <ti> |
92 |
+ Should contain a place where bugs can be filed, a URL or an e-mail address prefixed |
93 |
+ with mailto:. |
94 |
+ </ti> |
95 |
+</tr> |
96 |
+<tr> |
97 |
+ <ti><brite><remote-id></brite></ti> |
98 |
+ <ti> |
99 |
+ Should specify a type of package identification tracker and the identification that |
100 |
+ corresponds to the package in question. remote-id should make it easier to index |
101 |
+ information such as its Freshmeat ID or its CPAN name. |
102 |
+ </ti> |
103 |
+</tr> |
104 |
+<tr> |
105 |
<ti><brite><pkg></brite></ti> |
106 |
<ti> |
107 |
This tag contains a valid package name in the format of a DEPEND. |
108 |
@@ -168,7 +228,7 @@ |
109 |
<ti>lang</ti> |
110 |
<ti> |
111 |
<brite><description></brite>, <brite><longdescription></brite>, |
112 |
- <brite><use></brite> |
113 |
+ <brite><use></brite>, <brite><doc></brite> |
114 |
</ti> |
115 |
<ti> |
116 |
In every case where a description is required, there must be at |
117 |
@@ -212,6 +272,28 @@ |
118 |
Enables ACPI</flag></c> |
119 |
</ti> |
120 |
</tr> |
121 |
+<tr> |
122 |
+ <ti>status</ti> |
123 |
+ <ti> |
124 |
+ <brite><maintainer></brite> |
125 |
+ </ti> |
126 |
+ <ti> |
127 |
+ The upstream maintainer element has a status attribute, which is one of active or inactive. |
128 |
+ This attribute is not mandatory. The absence of it shall be interpreted as unknown. |
129 |
+ Please note: This attribute is only allowed in the <upstream> <maintainer> element! |
130 |
+ </ti> |
131 |
+</tr> |
132 |
+<tr> |
133 |
+ <ti>type</ti> |
134 |
+ <ti> |
135 |
+ <brite><remote-id></brite> |
136 |
+ </ti> |
137 |
+ <ti> |
138 |
+ A string identifying the type of upstream source. A list of valid strings are kept in metadata.dtd. |
139 |
+ Developers should email the gentoo-dev mailing list before using a new type value. |
140 |
+ </ti> |
141 |
+</tr> |
142 |
+ |
143 |
</table> |
144 |
|
145 |
</body> |
146 |
@@ -357,5 +439,34 @@ |
147 |
|
148 |
</body> |
149 |
</subsection> |
150 |
+<subsection> |
151 |
+<title>Fourth Example</title> |
152 |
+<body> |
153 |
+ |
154 |
+<p> |
155 |
+This example demonstrates the usage of the upstream element: |
156 |
+</p> |
157 |
+ |
158 |
+<pre caption="Upstream description"> |
159 |
+<upstream> |
160 |
+ <maintainer status="inactive"> |
161 |
+ <name>Foo Bar</name> |
162 |
+ <email>foo@×××.bar</email> |
163 |
+ </maintainer> |
164 |
+ <maintainer status="active"> |
165 |
+ <name>Foo Gentoo</name> |
166 |
+ <email>foo@g.o</email> |
167 |
+ </maintainer> |
168 |
+ <changelog>http://foo.bar/changelog.txt</changelog> |
169 |
+ <doc lang="en">http://foo.bar/doc/index.html</doc> |
170 |
+ <doc lang="de">http://foo.bar/doc/index.de.html</doc> |
171 |
+ <bugs-to>https://bugs.foo.bar</bugs-to> |
172 |
+ <remote-id type="freshmeat">foobar</remote-id> |
173 |
+ <remote-id type="sourceforge">foobar</remote-id> |
174 |
+</upstream> |
175 |
+</pre> |
176 |
+ |
177 |
+</body> |
178 |
+</subsection> |
179 |
</section> |
180 |
</sections> |