1 |
nimiux 11/09/07 19:48:33 |
2 |
|
3 |
Added: metadoc-guide.xml |
4 |
Log: |
5 |
New spanish translation: metadoc-guide.xml |
6 |
|
7 |
Revision Changes Path |
8 |
1.1 xml/htdocs/proj/es/gdp/doc/metadoc-guide.xml |
9 |
|
10 |
file : http://sources.gentoo.org/viewvc.cgi/gentoo/xml/htdocs/proj/es/gdp/doc/metadoc-guide.xml?rev=1.1&view=markup |
11 |
plain: http://sources.gentoo.org/viewvc.cgi/gentoo/xml/htdocs/proj/es/gdp/doc/metadoc-guide.xml?rev=1.1&content-type=text/plain |
12 |
|
13 |
Index: metadoc-guide.xml |
14 |
=================================================================== |
15 |
<?xml version='1.0' encoding='UTF-8'?> |
16 |
|
17 |
<!-- $Header: /var/cvsroot/gentoo/xml/htdocs/proj/es/gdp/doc/metadoc-guide.xml,v 1.1 2011/09/07 19:48:33 nimiux Exp $ --> |
18 |
|
19 |
<!DOCTYPE guide SYSTEM "/dtd/guide.dtd"> |
20 |
|
21 |
<guide lang="es"> |
22 |
<title>Guía Metadoc XML de Gentoo</title> |
23 |
|
24 |
<author title="Autor"> |
25 |
<mail link="swift"/> |
26 |
</author> |
27 |
<author title="Editor"> |
28 |
<mail link="neysx@g.o">Xavier Neys</mail> |
29 |
</author> |
30 |
<author title="Editor"> |
31 |
<mail link="nimiux"/> |
32 |
</author> |
33 |
<author title="Traductor"> |
34 |
<mail link="nimiux"/> |
35 |
</author> |
36 |
|
37 |
<abstract> |
38 |
Esta guía informa a los desarrolladores sobre cómo utilizar el formato |
39 |
Metadoc XML que permite al Proyecto de Documentación de Gentoo mantener |
40 |
sus documentos de una forma jerárquica y también permite almacenar más |
41 |
información sobre cada documento. |
42 |
</abstract> |
43 |
|
44 |
<!-- The content of this document is licensed under the CC-BY-SA license --> |
45 |
<!-- See http://creativecommons.org/licenses/by-sa/2.0 --> |
46 |
<license/> |
47 |
|
48 |
<version>3</version> |
49 |
<date>2011-09-04</date> |
50 |
|
51 |
<chapter> |
52 |
<title>Introducción</title> |
53 |
<section> |
54 |
<title>¿Por qué se necesita MetadocXML?</title> |
55 |
<body> |
56 |
|
57 |
<p> |
58 |
MetadocXML no es realmente necesario, se trata de un recurso adicional para |
59 |
que el Proyecto de Documentación siga la pista de los documentos, incluso si |
60 |
están localizados fuera del ámbito normal |
61 |
<path>[gentoo]/xml/htdocs/doc</path>. |
62 |
</p> |
63 |
|
64 |
<p> |
65 |
Gracias a MetadocXML, podemos: |
66 |
</p> |
67 |
|
68 |
<ul> |
69 |
<li> |
70 |
seguir la pista de los documentos localizados dentro de los espacios |
71 |
web de los proyectos (<path>/proj</path>) en lugar de centrarnos solo |
72 |
en el repositorio normal de documentación (<path>/doc</path>). |
73 |
</li> |
74 |
<li> |
75 |
clasificar la documentación en varias categorías (o subcategorías) con |
76 |
el beneficio adicional de que podemos generar automáticamente el índice |
77 |
de la documentación (y algunas cosas más). |
78 |
</li> |
79 |
<li> |
80 |
seguir la pista de la documentación de miembros de equipos no oficiales |
81 |
(por ejemplo, traductores). |
82 |
</li> |
83 |
<li> |
84 |
utilizar partes de grandes documentos (manuales) como guías individuales |
85 |
en ciertos temas. |
86 |
</li> |
87 |
<li> |
88 |
asignar incidencias (bugs) a documentos particulares para una rápida |
89 |
referencia y tener la posibilidad de enmascarar un documento en caso |
90 |
de una incidencia severa. |
91 |
</li> |
92 |
<li> |
93 |
comprobar de forma primitiva si un fichero traducido está en sincronía con |
94 |
su original en inglés o no. |
95 |
</li> |
96 |
</ul> |
97 |
|
98 |
<p> |
99 |
Observará que la última ventaja mencionada es primitiva y probablemente no |
100 |
será ampliada. Algunos equipos de traducción usan guiones basados en |
101 |
<c>trads-doc</c> para gestionar los documentos traducidos, otros utilizan |
102 |
herramientas de traducción en línea. Si va a comenzar a realizar |
103 |
traducciones para Gentoo, asómese por <c>#gentoo-doc</c> o pida ayuda en |
104 |
la lista de correo <c>gentoo-doc@g.o</c>. |
105 |
</p> |
106 |
|
107 |
<p> |
108 |
Los equipos de traducción que no utilicen MetadocXML no se tienen porqué |
109 |
preocupar, no perderán ninguna funcionalidad ya que se construye contra |
110 |
la infraestructura existente, no hay cambios al formato GuideXML que |
111 |
necesite MetadocXML. |
112 |
</p> |
113 |
|
114 |
</body> |
115 |
</section> |
116 |
<section> |
117 |
<title>¿Cómo funciona MetadocXML?</title> |
118 |
<body> |
119 |
|
120 |
<p> |
121 |
Existe un único fichero central en el que se mantiene toda la |
122 |
meta-información sobre la documentación. A este fichero lo llamamos |
123 |
<path>metadoc.xml</path>. Este fichero debería estar localizado en su |
124 |
repositorio principal (<path>/doc/${IDIOMA}</path>) aunque no está |
125 |
escrito explícitamente. |
126 |
</p> |
127 |
|
128 |
<p> |
129 |
Dentro de este fichero se almacena toda la meta-información: |
130 |
</p> |
131 |
|
132 |
<ul> |
133 |
<li>Miembros del equipo</li> |
134 |
<li>Categorías en las que los documentos participan</li> |
135 |
<li>Ficheros cubiertos</li> |
136 |
<li>Documentos cubiertos</li> |
137 |
<li>Incidencias (Bugs) que son parte de un documento</li> |
138 |
</ul> |
139 |
|
140 |
<p> |
141 |
Además de <path>metadoc.xml</path>, puede haber un documento generado |
142 |
dinámicamente (este fichero normalmente se llama |
143 |
<path>index.xml</path>), una lista global de toda la documentación |
144 |
(normalmente <path>list.xml</path>) y una vista global de todos los |
145 |
miembros, ficheros e incidencias (normalmente <path>overview.xml</path>). |
146 |
</p> |
147 |
|
148 |
</body> |
149 |
</section> |
150 |
</chapter> |
151 |
|
152 |
<chapter> |
153 |
<title>El fichero metadoc.xml</title> |
154 |
<section> |
155 |
<title>Estructura XML</title> |
156 |
<body> |
157 |
|
158 |
<p> |
159 |
El fichero <path>metadoc.xml</path> comienza con el código de inicialización |
160 |
XML y la información de cabecera CVS de Gentoo: |
161 |
</p> |
162 |
|
163 |
<pre caption="Inicialización XML"> |
164 |
<?xml version='1.0' encoding="UTF-8"?> |
165 |
<!-- $Header: /var/cvsroot/gentoo/xml/htdocs/doc/en/metadoc.xml,v 1.25 2004/12/23 09:51:30 swift Exp $ --> |
166 |
<!DOCTYPE metadoc SYSTEM "/dtd/metadoc.dtd"> |
167 |
</pre> |
168 |
|
169 |
<p> |
170 |
A continuación, comienza la declaración MetadocXML. |
171 |
</p> |
172 |
|
173 |
<pre caption="Declaración MetadocXML en Inglés"> |
174 |
<metadoc lang="<comment>en</comment>"> |
175 |
</pre> |
176 |
|
177 |
<p> |
178 |
Los traductores deben hacer referencia al fichero principal |
179 |
<path>/doc/en/metadoc.xml</path> en el atributo <c>parent</c>. Esto hace |
180 |
que metadoc identifique fichero sin traducir y busque si las versiones |
181 |
de los documentos traducidos coinciden con las originales. |
182 |
</p> |
183 |
|
184 |
<pre caption="Declaración de MetadocXML para una traducción"> |
185 |
<metadoc lang="<comment>código de idioma</comment>" parent="/doc/en/metadoc.xml"> |
186 |
</pre> |
187 |
|
188 |
<p> |
189 |
Dentro de la entidad <c>metadoc</c>, se deben declarar las siguientes |
190 |
entidades (en el orden dado): |
191 |
</p> |
192 |
|
193 |
<ul> |
194 |
<li> |
195 |
<c>version</c> para ayudar en el seguimiento de los cambios. |
196 |
</li> |
197 |
<li> |
198 |
<c>members</c> que declara todos los miembros de un equipo de traducción. |
199 |
</li> |
200 |
<li> |
201 |
<c>categories</c> que declara las posibles categorías utilizadas. |
202 |
</li> |
203 |
<li> |
204 |
<c>files</c> que contiene todos los ficheros cubiertos por el fichero |
205 |
Metadoc. |
206 |
</li> |
207 |
<li> |
208 |
<c>docs</c> que contiene todos los documentos cubiertos por el fichero |
209 |
Metadoc. |
210 |
</li> |
211 |
</ul> |
212 |
|
213 |
</body> |
214 |
</section> |
215 |
<section> |
216 |
<title>La entidad version</title> |
217 |
<body> |
218 |
|
219 |
<p> |
220 |
El número de versión debe incrementarse cada vez que se añade o elimina |
221 |
un fichero o un documento, también cuando se cambia una ruta o cualquier |
222 |
otra actualización que tenga algún impacto en las versiones traducidas. |
223 |
</p> |
224 |
|
225 |
</body> |
226 |
</section> |
227 |
<section> |
228 |
<title>La entidad members</title> |
229 |
<body> |
230 |
|
231 |
<p> |
232 |
Dentro de la entidad members, se pueden declarar dos 'tipos' de miembros: |
233 |
<c>lead</c> y <c>member</c>. Un <c>lead</c> debe ser conocido por el |
234 |
equipo de Relaciones con los Desarrolladores de Gentoo (Gentoo Developers |
235 |
Relations) ya que consta únicamente del alias del desarrollador líder |
236 |
y se busca en la lista de miembros de Gentoo. Un <c>member</c> puede ser |
237 |
tanto un desarrollador Gentoo (en cuyo caso solo se muestra el aliar) o |
238 |
un contribuyente. |
239 |
</p> |
240 |
|
241 |
<p> |
242 |
En el caso de un contribuyente, la etiqueta <c>member</c> posee dos |
243 |
atributos: <c>mail</c> y <c>fullname</c>, que contienen la dirección de |
244 |
correo y el nombre completo del contribuyente. |
245 |
</p> |
246 |
|
247 |
<pre caption="Ejemplo de uso de la entidad members"> |
248 |
<members> |
249 |
<lead>chiguire</lead> |
250 |
<lead>nimiux</lead> |
251 |
<member>yoswink</member> |
252 |
<member mail="contribuyente-gentoo@×××××.com" fullname="Juan Nadie">jnad</member> |
253 |
</members> |
254 |
</pre> |
255 |
|
256 |
</body> |
257 |
</section> |
258 |
<section> |
259 |
<title>La entidad categories</title> |
260 |
<body> |
261 |
|
262 |
<p> |
263 |
Dentro de la entidad <c>categories</c> se declaran únicamente entidades |
264 |
<c>cat</c>. Cada entidad <c>cat</c> cubre una categoría. Utiliza un |
265 |
parámetro obligatorio: <c>id</c> que se utiliza para hacer referencia |
266 |
a la categoría. Puede también definir un parámetro <c>parent</c> en el |
267 |
caso en que la categoría sea hija de otra categoría. |
268 |
</p> |
269 |
|
270 |
<p> |
271 |
En este caso, la atributo <c>parent</c> hace referencia al atributo |
272 |
<c>id</c> de la categoría padre. |
273 |
</p> |
274 |
|
275 |
<pre caption="Ejemplo de uso de la entidad categories"> |
276 |
<categories> |
277 |
<cat id="faq">Preguntas de uso frecuente</cat> |
278 |
<cat id="install">Recursos relacionados con la instalación</cat> |
279 |
<cat id="install_guides">Guías de Instalación</cat> |
280 |
</categories> |
281 |
</pre> |
282 |
|
283 |
</body> |
284 |
</section> |
285 |
<section> |
286 |
<title>La entidad files</title> |
287 |
<body> |
288 |
|
289 |
<p> |
290 |
La entidad <c>files</c> contiene únicamente entidades <c>file</c>. |
291 |
</p> |
292 |
|
293 |
<p> |
294 |
Cada entidad <c>file</c> hace referencia a un solo fichero XML. Tiene |
295 |
un atributo obligatorio <c>id</c> que se debe usar como clave primaria para |
296 |
buscar el fichero. Metadoc comparará el nombre del fichero definido con el |
297 |
mismo atributo <c>id</c> en el fichero metadoc padre (definido en el |
298 |
elemento raíz) para averiguar si el fichero es una traducción on no. Los |
299 |
nombres de los ficheros deben ser idénticos en el segundo caso. |
300 |
</p> |
301 |
|
302 |
<p> |
303 |
El propio fichero metadoc se puede listar y aparecerá en la página con la |
304 |
vista general (overview). |
305 |
</p> |
306 |
|
307 |
<pre caption="Ejemlpos de la entidad files"> |
308 |
<files> |
309 |
<file id="metadoc">/doc/es/metadoc.xml</file> |
310 |
<file id="ati-faq">/doc/es/ati-faq.xml</file> |
311 |
</files> |
312 |
</pre> |
313 |
|
314 |
</body> |
315 |
</section> |
316 |
<section> |
317 |
<title>La entidad docs</title> |
318 |
<body> |
319 |
|
320 |
<p> |
321 |
La entidad <c>docs</c> debe contener únicamente entidades <c>doc</c>. |
322 |
</p> |
323 |
|
324 |
<p> |
325 |
Cada entidad <c>doc</c> tiene un atributo <c>id</c> obligatorio que se usará |
326 |
como clave primaria del documento. |
327 |
Cada entidad <c>doc</c> tiene un atributo obligatorio <c>fileid</c>, que hace |
328 |
referencia al atributo <c>id</c> de una entidad <c>file</c> que corresponde |
329 |
con el fichero principal del documento. |
330 |
</p> |
331 |
|
332 |
<p> |
333 |
En el caso de un capítulo de manual, la entidad <c>doc</c> debe contener |
334 |
una entidad <c>bookref</c> que hace referencia a la página principal del manual |
335 |
(el fichero XML principal del manual). Esta entidad contiene dos atributos |
336 |
llamados <c>vpart</c> y <c>vchap</c> que hacen referencia a la parte y |
337 |
capítulo correspondientes del documento dentro del manual. |
338 |
</p> |
339 |
|
340 |
<p> |
341 |
Dentro de la entidad <c>doc</c>, pueden existir otras dos entidades: |
342 |
</p> |
343 |
|
344 |
<ul> |
345 |
<li> |
346 |
Una o más entidades <c>memberof</c>, que hacen referencia a la |
347 |
categoría o categoría en las que se localiza el documento (observar |
348 |
que un documento puede estar en varias categorías a la vez) |
349 |
</li> |
350 |
<li> |
351 |
Una entidad <c>bugs</c> que contiene una o más entidades <c>bug</c>. |
352 |
Una entidad <c>bug</c> hace referencia a un número de bug que cubre |
353 |
una incidencia con el documento. En el caso de una incidencia |
354 |
importante, se puede añadir el atributo <c>stopper="yes"</c> a la |
355 |
entidad <c>bug</c> para que el documento no aparezca en la página |
356 |
índice que se genera. |
357 |
</li> |
358 |
</ul> |
359 |
|
360 |
<pre caption="Example Docs entity"> |
361 |
<![CDATA[<docs> |
362 |
<doc fileid="ldap-howto"> |
363 |
<memberof>sysadmin_specific</memberof> |
364 |
<bugs> |
365 |
<bug>102481</bug> |
366 |
<bug stopper="yes">1151330</bug> |
367 |
</bugs> |
368 |
</doc> |
369 |
<doc fileid="uml"> |
370 |
<memberof>sysadmin_general</memberof> |
371 |
</doc> |
372 |
</docs>]]> |
373 |
</pre> |
374 |
|
375 |
</body> |
376 |
</section> |
377 |
<section> |
378 |
<title>Fichero ejemplo metadoc.xml</title> |
379 |
<body> |
380 |
|
381 |
<p> |
382 |
El sitio de Gentoo utiliza un fichero <path>metadoc.xml</path> para agregar |
383 |
la información contenida en su documentación. Puede ver la versión actual |
384 |
<uri link="/doc/es/metadoc.xml?passthru=1">en línea</uri>. |
385 |
</p> |
386 |
|
387 |
</body> |
388 |
</section> |
389 |
</chapter> |
390 |
|
391 |
<chapter> |
392 |
<title>Fichero adicionales MetadocXML</title> |
393 |
<section> |
394 |
<title>Índice generado automáticamente</title> |
395 |
<body> |
396 |
|
397 |
<p> |
398 |
Si se desea un índice generado automáticamente, se debe comenzar el |
399 |
documento con el siguiente código: |
400 |
</p> |
401 |
|
402 |
<pre caption="Generar índice automáticamente"> |
403 |
<?xml version='1.0' encoding='UTF-8'?> |
404 |
<?xml-stylesheet href="/xsl/metadoc.xsl" type="text/xsl"?> |
405 |
<?xml-stylesheet href="/xsl/guide.xsl" type="text/xsl"?> |
406 |
|
407 |
<!-- $Header$ --> |
408 |
|
409 |
<!DOCTYPE dynamic SYSTEM "/dtd/metadoc.dtd"> |
410 |
|
411 |
<comment><!-- Sustituya "/doc/es/metadoc.xml" por la localización de su fichero metadoc --></comment> |
412 |
<dynamic metadoc="<i>/doc/es/metadoc.xml</i>"> |
413 |
<title><i>Recursos de documentación de Gentoo</i></title> |
414 |
<intro> |
415 |
|
416 |
<comment>(...)</comment> |
417 |
|
418 |
</intro> |
419 |
|
420 |
<catid><i>faq</i></catid> |
421 |
<catid><i>install</i></catid> |
422 |
|
423 |
</dynamic> |
424 |
</pre> |
425 |
|
426 |
<p> |
427 |
Entre las etiquetas <c>intro</c> debe escribir una o más secciones que |
428 |
siempre aparecerán al comienzo de la página. Probablemente quiera escribir |
429 |
una introducción y alguna información adicional para que el lector sepa |
430 |
con quién contactar en caso de errores en la traducción u otras cuestiones. |
431 |
</p> |
432 |
|
433 |
<p> |
434 |
Dentro de las etiquetas <c>intro</c> puede utilizar texto GuideXML que |
435 |
comience con la etiqueta <c>section</c>. |
436 |
</p> |
437 |
|
438 |
<p> |
439 |
Las etiquetas <c>catid</c> hacen referencia a las categorías principales |
440 |
utilizadas or el índice dinámico. Debe listar cada categoría posible |
441 |
que no sea terminal y que esté declarada en su fichero metadoc. |
442 |
<e>No liste</e> categorías que son hijas de otras categorías. |
443 |
</p> |
444 |
|
445 |
</body> |
446 |
</section> |
447 |
<section> |
448 |
<title>Documento tipo lista generado dinámicamente</title> |
449 |
<body> |
450 |
|
451 |
<p> |
452 |
Un documento tipo lista que se genera dinámicamente comienza de forma |
453 |
similar a un fichero índice generado automáticamente. |
454 |
</p> |
455 |
|
456 |
<pre caption="Documento tipo lista generado dinámicamente"> |
457 |
<?xml version='1.0' encoding='UTF-8'?> |
458 |
<?xml-stylesheet href="/xsl/metadoc.xsl" type="text/xsl"?> |
459 |
<?xml-stylesheet href="/xsl/guide.xsl" type="text/xsl"?> |
460 |
|
461 |
<!-- $Header$ --> |
462 |
|
463 |
<!DOCTYPE dynamic SYSTEM "/dtd/metadoc.dtd"> |
464 |
|
465 |
<comment><!-- Sustituya "/doc/es/metadoc.xml" por la localización de su fichero metadoc --></comment> |
466 |
<dynamic metadoc="<i>/doc/es/metadoc.xml</i>"> |
467 |
<title><i>Listado de documentación Gentoo</i></title> |
468 |
</pre> |
469 |
|
470 |
<p> |
471 |
Sin embargo, no posee la etiqueta <c>intro</c>. Lo que se necesita añadir |
472 |
en este caso son todas las categorías de primer nivel que se van a usar |
473 |
en el listado. Para diferenciar este documento del índice (que también |
474 |
mostrará la información de resumen en cada documento), las categorías |
475 |
se añaden entre etiquetas <c>list</c> dentro de una etiqueta |
476 |
<c>listing</c>: |
477 |
</p> |
478 |
|
479 |
<pre caption="Listar categorias"> |
480 |
<listing> |
481 |
<list>faq</list> |
482 |
<list>install</list> |
483 |
</listing> |
484 |
</pre> |
485 |
|
486 |
</body> |
487 |
</section> |
488 |
<section> |
489 |
<title>Documento tipo sumario generado automáticamente</title> |
490 |
<body> |
491 |
|
492 |
<p> |
493 |
El documento tipo sumario (vista general) comienza de forma similar a |
494 |
los dos documentos descritos automáticamente: |
495 |
</p> |
496 |
|
497 |
<pre caption="Documento tipo sumario generado automáticamente"> |
498 |
<?xml version='1.0' encoding='UTF-8'?> |
499 |
<?xml-stylesheet href="/xsl/metadoc.xsl" type="text/xsl"?> |
500 |
<?xml-stylesheet href="/xsl/guide.xsl" type="text/xsl"?> |
501 |
|
502 |
<!-- $Header$ --> |
503 |
|
504 |
<!DOCTYPE dynamic SYSTEM "/dtd/metadoc.dtd"> |
505 |
|
506 |
<comment><!-- Sustituya "/doc/es/metadoc.xml" por la localización de su fichero metadoc --></comment> |
507 |
<dynamic metadoc="<i>/doc/es/metadoc.xml</i>"> |
508 |
<title><i>Vista general de la documentación</i></title> |
509 |
</pre> |
510 |
|
511 |
<p> |
512 |
Puede, de nuevo, escribir una pequeña introducción en formato GuideXML |
513 |
entre las etiquetas XML <c>intro</c>, comenzando con una etiqueta |
514 |
<c>section</c>. Una vez terminado, una etiqueta <c><overview/></c> |
515 |
simple será suficiente. |
516 |
</p> |
517 |
|
518 |
<pre caption="Etiquetas intro y overview"> |
519 |
<intro> |
520 |
<comment>(...)</comment> |
521 |
</intro> |
522 |
|
523 |
<overview/> |
524 |
</pre> |
525 |
|
526 |
</body> |
527 |
</section> |
528 |
</chapter> |
529 |
</guide> |