| 1 |
chiguire 08/05/03 11:28:58 |
| 2 |
|
| 3 |
Modified: xml-guide.xml |
| 4 |
Log: |
| 5 |
updated/revised spanish translation |
| 6 |
|
| 7 |
Revision Changes Path |
| 8 |
1.18 xml/htdocs/doc/es/xml-guide.xml |
| 9 |
|
| 10 |
file : http://sources.gentoo.org/viewcvs.py/gentoo/xml/htdocs/doc/es/xml-guide.xml?rev=1.18&view=markup |
| 11 |
plain: http://sources.gentoo.org/viewcvs.py/gentoo/xml/htdocs/doc/es/xml-guide.xml?rev=1.18&content-type=text/plain |
| 12 |
diff : http://sources.gentoo.org/viewcvs.py/gentoo/xml/htdocs/doc/es/xml-guide.xml?r1=1.17&r2=1.18 |
| 13 |
|
| 14 |
Index: xml-guide.xml |
| 15 |
=================================================================== |
| 16 |
RCS file: /var/cvsroot/gentoo/xml/htdocs/doc/es/xml-guide.xml,v |
| 17 |
retrieving revision 1.17 |
| 18 |
retrieving revision 1.18 |
| 19 |
diff -u -r1.17 -r1.18 |
| 20 |
--- xml-guide.xml 9 Nov 2006 12:54:11 -0000 1.17 |
| 21 |
+++ xml-guide.xml 3 May 2008 11:28:58 -0000 1.18 |
| 22 |
@@ -1,12 +1,12 @@ |
| 23 |
<?xml version="1.0" encoding="UTF-8"?> |
| 24 |
-<!-- $Header: /var/cvsroot/gentoo/xml/htdocs/doc/es/xml-guide.xml,v 1.17 2006/11/09 12:54:11 chiguire Exp $ --> |
| 25 |
+<!-- $Header: /var/cvsroot/gentoo/xml/htdocs/doc/es/xml-guide.xml,v 1.18 2008/05/03 11:28:58 chiguire Exp $ --> |
| 26 |
<!DOCTYPE guide SYSTEM "/dtd/guide.dtd"> |
| 27 |
|
| 28 |
<guide link="/doc/es/xml-guide.xml" lang="es"> |
| 29 |
-<title>Guía XML de Gentoo</title> |
| 30 |
+<title>Guía Gentoo de GuideXML</title> |
| 31 |
|
| 32 |
<author title="Autor"> |
| 33 |
- <mail link="neysx@g.o">Xavier Neys</mail> |
| 34 |
+ <mail link="neysx"/> |
| 35 |
</author> |
| 36 |
<author title="Autor"> |
| 37 |
<mail link="drobbins@g.o">Daniel Robbins</mail> |
| 38 |
@@ -39,22 +39,22 @@ |
| 39 |
<!-- See http://creativecommons.org/licenses/by-sa/2.5 --> |
| 40 |
<license/> |
| 41 |
|
| 42 |
-<version>7</version> |
| 43 |
-<date>2006-05-11</date> |
| 44 |
+<version>9</version> |
| 45 |
+<date>2008-03-09</date> |
| 46 |
|
| 47 |
<chapter> |
| 48 |
-<title>Fundamentos de la guía</title> |
| 49 |
+<title>Fundamentos de GuideXML</title> |
| 50 |
<section> |
| 51 |
-<title>Metas del diseño de guías XML </title> |
| 52 |
+<title>Metas de GuideXML </title> |
| 53 |
<body> |
| 54 |
|
| 55 |
<p> |
| 56 |
-La sintaxis de las guías XML es sencilla pero expresiva, por eso es |
| 57 |
-fácil de aprender y al mismo tiempo proporciona todas las |
| 58 |
-características necesarias para la creación de documentación Web. El |
| 59 |
-número de etiquetas es muy pequeño -- solamente las necesarias. Esto |
| 60 |
-hace muy fácil la transformación de la guía a otros formatos, tales |
| 61 |
-como DocBook XML/SGML y páginas web (HTML). |
| 62 |
+La sintaxis de GuideXML es sencilla pero expresiva, por eso es fácil |
| 63 |
+de aprender y al mismo tiempo proporciona todas las características |
| 64 |
+necesarias para la creación de documentación Web. El número de |
| 65 |
+etiquetas es muy pequeño -- solamente las necesarias. Esto hace muy |
| 66 |
+fácil la transformación de la guía a otros formatos, tales como |
| 67 |
+DocBook XML/SGML y páginas web (HTML). |
| 68 |
</p> |
| 69 |
|
| 70 |
<p> |
| 71 |
@@ -70,30 +70,30 @@ |
| 72 |
|
| 73 |
<p> |
| 74 |
Si planea contribuir a la documentación de Gentoo, o quiere probar la |
| 75 |
-Guía XML, por favor lea nuestra guía <uri |
| 76 |
+GuideXML, por favor lea nuestra guía de <uri |
| 77 |
link="http://www.gentoo.org/proj/es/gdp/doc/doc-tipsntricks.xml">Trucos |
| 78 |
y Consejos</uri>, que contiene trucos y consejos para el desarrollo de |
| 79 |
documentación. |
| 80 |
</p> |
| 81 |
|
| 82 |
<p> |
| 83 |
-Tal sea interesante mirar <uri link="?passthru=1">las fuentes |
| 84 |
-XML</uri> de este documento mientras lo lee. |
| 85 |
+Tal le interese mirar <uri link="?passthru=1">las fuentes XML</uri> de |
| 86 |
+este documento mientras lo lee. |
| 87 |
</p> |
| 88 |
</body> |
| 89 |
</section> |
| 90 |
</chapter> |
| 91 |
|
| 92 |
<chapter> |
| 93 |
-<title> Guía de XML</title> |
| 94 |
+<title>GuideXML</title> |
| 95 |
<section> |
| 96 |
<title>Estructura básica</title> |
| 97 |
<body> |
| 98 |
|
| 99 |
<p> |
| 100 |
-Vamos a comenzar con el aprendizaje de la sintaxis de la Guía XML. |
| 101 |
-Comenzaremos con las etiquetas iniciales usadas en un documento |
| 102 |
-de guía en XML: |
| 103 |
+Vamos a comenzar con el aprendizaje de la sintaxis de GuideXML. |
| 104 |
+Comenzaremos con las etiquetas iniciales usadas en un documento de |
| 105 |
+guía en XML: |
| 106 |
</p> |
| 107 |
|
| 108 |
<pre caption="El comienzo de un documento de GuideXML"> |
| 109 |
@@ -110,8 +110,8 @@ |
| 110 |
|
| 111 |
<abstract> |
| 112 |
Esta guía enseña cómo estructurar documentación para la web usando la |
| 113 |
-nueva sintaxis liviana Gentoo GuideXML. Esta sintaxis constituye el |
| 114 |
-formato oficial para la documentación del Gentoo, este mismo documento |
| 115 |
+nueva sintaxis liviana GuideXML de Gentoo. Esta sintaxis constituye el |
| 116 |
+formato oficial para la documentación de Gentoo, este mismo documento |
| 117 |
fue creado usando GuideXML. Esta guía asume un conocimiento básico de |
| 118 |
XML y HTML. |
| 119 |
</abstract> |
| 120 |
@@ -129,21 +129,21 @@ |
| 121 |
identifica este documento como un documento XML y especifica su |
| 122 |
DTD. La línea <c><!-- $Header$ --></c> será modificada |
| 123 |
automáticamente por el servidor CVS y sirve para llevar la cuenta de |
| 124 |
-las revisiones. A continuación, sigue una etiqueta de |
| 125 |
-<c><guide></c> -- el documento guía entero está encerrado entre |
| 126 |
-etiquetas <c><guide> y </guide></c>. El atributo |
| 127 |
-<c>link</c> es obligatorio y preferiblemente contiene el trayecto |
| 128 |
-absoluto relativa a la raíz de los documentos, aunque el nombre del |
| 129 |
-archivo solo también funcionará. Es utilizado principalmente para |
| 130 |
-generar un enlace a la versión "para imprimir" del documento. Si |
| 131 |
-utilizas un valor incorrecto, el enlace a la versión "para imprimir" |
| 132 |
-no funcionará o apuntará a otro documento. Los documentos traducidos |
| 133 |
-<e>deben</e> dar la trayectoria completa, porque esta también sirve |
| 134 |
-para verificar la existencia de un original más reciente. El atributo |
| 135 |
-<c>lang</c> debe ser usado para colocar el código de idioma del |
| 136 |
-documento. Sirve para usar el formato de la fecha y para traducir |
| 137 |
-cadenas de caracteres como "<e>Note</e>", "<e>Content</e>", etc. al |
| 138 |
-lenguaje en cuestión. La opción por defecto es inglés. |
| 139 |
+las revisiones. Le sigue una etiqueta <c><guide></c> -- el |
| 140 |
+documento guía entero está encerrado entre etiquetas <c><guide> |
| 141 |
+y </guide></c>. El atributo <c>link</c> es opcional y |
| 142 |
+preferiblemente debería contener el trayecto relativa a la raíz del |
| 143 |
+documento, aunque el nombre del archivo por sí solo también |
| 144 |
+funcionará. Solo se usa para generar un enlace a la versión "para |
| 145 |
+imprimir" del documento y para revisar si la traducción está |
| 146 |
+actualizada. Nuestro motor XSL pasa la trayectoria real a la hoja de |
| 147 |
+estilo XSL. El atributo del enlace solo se usa como valor por defecto |
| 148 |
+en caso que el XML sea procesado por otros medios. |
| 149 |
+<br/> |
| 150 |
+El atributo <c>lang</c> debe ser usado para especificar el código de |
| 151 |
+idioma del documento. Sirve para definir el formato de la fecha y para |
| 152 |
+traducir cadenas de caracteres como "<e>Note</e>", "<e>Content</e>", |
| 153 |
+etc. al lenguaje especificado. La opción por defecto es inglés. |
| 154 |
</p> |
| 155 |
|
| 156 |
<p> |
| 157 |
@@ -160,7 +160,7 @@ |
| 158 |
los autores están encerrados en otra etiqueta -- una etiqueta |
| 159 |
<c><mail></c>, usada para especificar una dirección email para |
| 160 |
esta persona en particular. La etiqueta <c><mail></c> es |
| 161 |
-opcional y puede ser omitida, y solamente se requiere un elemento |
| 162 |
+opcional y puede ser omitida, requiriéndose al menos un elemento |
| 163 |
<c><author></c> por cada documento de guía. |
| 164 |
</p> |
| 165 |
|
| 166 |
@@ -175,7 +175,7 @@ |
| 167 |
|
| 168 |
<p> |
| 169 |
Esto es todo en cuanto a las etiquetas que deben aparecer al comienzo |
| 170 |
-del documento. Todas estas etiquetas, salvo <c><title></c> y |
| 171 |
+del documento. Estas etiquetas, salvo <c><title></c> y |
| 172 |
<c><mail></c>, no deberían aparecer en ningún otro lugar que no |
| 173 |
sea inmediatamente dentro de la etiqueta <c><guide></c>, y por |
| 174 |
consistencia, se recomienda (aunque no es obligatorio) que esas |
| 175 |
@@ -198,7 +198,7 @@ |
| 176 |
<body> |
| 177 |
|
| 178 |
<p> |
| 179 |
-Una vez que las etiquetas iniciales han sido especificadas, stamos |
| 180 |
+Una vez que las etiquetas iniciales han sido especificadas, estamos |
| 181 |
listos para empezar a añadir los elementos estructurales del |
| 182 |
documento. Los documentos de guía están divididos en capítulos, y cada |
| 183 |
capítulo puede tener una o más secciones. Cada capítulo y cada sección |
| 184 |
@@ -219,7 +219,7 @@ |
| 185 |
<p> |
| 186 |
<i>Esto es texto contenido en mi sección .</i> |
| 187 |
</p> |
| 188 |
- |
| 189 |
+ |
| 190 |
</body> |
| 191 |
</section> |
| 192 |
</chapter> |
| 193 |
@@ -287,7 +287,7 @@ |
| 194 |
</pre> |
| 195 |
|
| 196 |
<p> |
| 197 |
-Ahora, aquí se ve cómo se queda el elemento <c><body></c> |
| 198 |
+Ahora, aquí se ve cómo se queda el elemento <c><body></c> |
| 199 |
antes descrito: |
| 200 |
</p> |
| 201 |
|
| 202 |
@@ -430,7 +430,8 @@ |
| 203 |
</p> |
| 204 |
|
| 205 |
<p> |
| 206 |
-Los elementos <c><sub></c> y <c><sup></c> se utilizan para especificar <sub>subíndice</sub> y <sup>superíndices</sup>. |
| 207 |
+Los elementos <c><sub></c> y <c><sup></c> se utilizan para |
| 208 |
+especificar <sub>subíndice</sub> y <sup>superíndices</sup>. |
| 209 |
</p> |
| 210 |
</body> |
| 211 |
</section> |
| 212 |
@@ -441,8 +442,7 @@ |
| 213 |
|
| 214 |
<p> |
| 215 |
Para incrementar la legibilidad de ejemplos de código, se permite el |
| 216 |
-uso de las siguientes etiquetas dentro de bloques de texto |
| 217 |
-<c><pre></c>: |
| 218 |
+uso de las siguientes etiquetas dentro de bloques <c><pre></c>: |
| 219 |
</p> |
| 220 |
|
| 221 |
<dl> |
| 222 |
@@ -512,8 +512,26 @@ |
| 223 |
<p> |
| 224 |
Anteriormente echamos un vistazo a la etiqueta <c><mail></c> ; |
| 225 |
se usa para enlazar un texto con una dirección de corre electrónico, y |
| 226 |
-tiene la forma <c><mail link="foo@×××.com">Mr. Foo |
| 227 |
-Bar</mail></c>. Si desea mostrar la dirección de email, puede usar <c><mail>foo@×××.com</mail></c>, lo cual se vería como <mail>foo@×××.com</mail>. |
| 228 |
+tiene la forma <c><mail link="foo.bar@×××××××.com">Mr. Foo |
| 229 |
+Bar</mail></c>. Si desea mostrar la dirección de email, puede |
| 230 |
+usar <c><mail>foo.bar@×××××××.com</mail></c>, lo cual se |
| 231 |
+vería como <mail>foo.bar@×××××××.com</mail>. |
| 232 |
+</p> |
| 233 |
+ |
| 234 |
+<p> |
| 235 |
+Las formas abreviadas facilitan el uso de nombres y direcciones de |
| 236 |
+correo de desarrolladores Gentoo. Ambas formas |
| 237 |
+<c><mail>neysx</mail></c> y <c><mail |
| 238 |
+link="neysx"/></c> aparecerán como <mail>neysx</mail>. Si desea |
| 239 |
+usar un correo de un desarrollador Gentoo con un contenido distinto a |
| 240 |
+su nombre completo, use la segunda forma con algun contenido. Por |
| 241 |
+ejemplo, usar el primer nombre del desarrollador: <c><mail |
| 242 |
+link="neysx">Xavier</mail></c> aparece como <mail |
| 243 |
+link="neysx">Xavier</mail>. |
| 244 |
+<br/> |
| 245 |
+Esto es particularmente útil cuando quiere referirse a un |
| 246 |
+desarrollador cuyo nombre contiene caracteres "extraños" que no puede |
| 247 |
+escribir. |
| 248 |
</p> |
| 249 |
|
| 250 |
<p> |
| 251 |
@@ -523,7 +541,7 @@ |
| 252 |
texto, como en este enlace a <uri>http://forums.gentoo.org</uri>. Para |
| 253 |
crear este enlace, escribí |
| 254 |
<c><uri>http://forums.gentoo.org</uri></c>. La forma |
| 255 |
-alternativa es cuando se quiere asociar una URI con un texto -- por |
| 256 |
+alternativa es cuando se quiere asociar una URI con otro texto -- por |
| 257 |
ejemplo, <uri link="http://forums.gentoo.org">Foros de Gentoo</uri>. |
| 258 |
Para crear <e>este</e> enlace, escribí <c><uri |
| 259 |
link="http://forums.gentoo.org"> Foros de |
| 260 |
@@ -532,16 +550,30 @@ |
| 261 |
de Gentoo. Por ejemplo, para enlazar al <uri link="/doc/en/">índice |
| 262 |
principal de la documentación</uri> simplemente sería <c><uri |
| 263 |
link="/doc/en/index.xml">índice principal de la |
| 264 |
-documentación</uri></c>. También puede omitir <c>index.xml</c> |
| 265 |
+documentación</uri></c>. Hasta puede omitir <c>index.xml</c> |
| 266 |
cuando apunte directamente al índice de un directorio, ejemplo: |
| 267 |
<c><uri link="/doc/en/">índice principal de la |
| 268 |
-documentación</uri></c>. |
| 269 |
+documentación</uri></c>. El dejar la barra final ahorra una |
| 270 |
+petición HTTP adicional. |
| 271 |
+</p> |
| 272 |
+ |
| 273 |
+<p> |
| 274 |
+No debe usar una etiqueta <c><uri></c> con un atributo |
| 275 |
+<c>link</c> que comienze con <c>mailto:</c>. En este caso, haga uso de |
| 276 |
+la etiqueta <c><mail></c>. |
| 277 |
+</p> |
| 278 |
+ |
| 279 |
+<p> |
| 280 |
+Por favor evite el síndrome de <uri |
| 281 |
+link="http://en.wikipedia.org/wiki/Click_here">haga click aquí</uri> |
| 282 |
+tal como nos recomienda el <uri |
| 283 |
+link="http://www.w3.org/QA/Tips/noClickHere">W3C</uri>. |
| 284 |
</p> |
| 285 |
</body> |
| 286 |
</section> |
| 287 |
|
| 288 |
<section> |
| 289 |
-<title>Ilustraciones e imágenes</title> |
| 290 |
+<title>Ilustraciones</title> |
| 291 |
<body> |
| 292 |
|
| 293 |
<p> |
| 294 |
@@ -549,7 +581,7 @@ |
| 295 |
link="mygfx.png" short="mi imagen" caption="mi imagen favorita de |
| 296 |
todos los tiempos"/></c>. El atributo <c>link=</c> apunta a la |
| 297 |
imagen, el atributo <c>short=</c> especifica una descripción corta |
| 298 |
-(actualmente usada para el atributo <c>alt=</c> de HTML), y un |
| 299 |
+(actualmente usada para el atributo <c>alt=</c> de HTML), y una |
| 300 |
leyenda. No es demasiado difícil :) También soportamos el estilo |
| 301 |
estándar de HTML con la etiqueta <img src="foo.gif"/> para |
| 302 |
añadir imágenes sin leyendas, bordes, etc. |
| 303 |
@@ -562,33 +594,31 @@ |
| 304 |
<body> |
| 305 |
|
| 306 |
<p> |
| 307 |
-Las guías soportan una sintaxis simplificado para tablas similar al de |
| 308 |
+GuideXML soporta una sintaxis simplificada para tablas, similar al de |
| 309 |
HTML. Para comenzar una tabla, use la etiqueta <c><table></c>. |
| 310 |
-Antecedemos una hilera con una etiqueta <c><tr></c>. Sin |
| 311 |
-embargo, para insertar datos en la tabla, <e>no</e> soportamos el uso |
| 312 |
-de la etiqueta HTML <td>; en vez, usamos <c><th></c> para |
| 313 |
-la cabecera y <c><ti></c> si vamos a insertar un bloque normal |
| 314 |
-de información. Se puede usar <c><th></c> en cualquier lugar |
| 315 |
-donde se pueda usar <c><ti></c> -- no hay ninguna obligación que |
| 316 |
-los elementos <c><th></c> aparezcan solamente en la primera |
| 317 |
-hilera. |
| 318 |
+Comience una hilera con una etiqueta <c><tr></c>. Sin embargo, |
| 319 |
+para los datos propios de la tabla, <e>no</e> soportamos el uso de la |
| 320 |
+etiqueta <td> de HTML; en cambio, use <c><th></c> para la |
| 321 |
+cabecera y <c><ti></c> si va a insertar un bloque de información |
| 322 |
+normal. Puede usar <c><th></c> en cualquier lugar donde se pueda |
| 323 |
+usar <c><ti></c> -- no hay obligación que los elementos |
| 324 |
+<c><th></c> aparezcan solo en la primera hilera. |
| 325 |
</p> |
| 326 |
|
| 327 |
<p> |
| 328 |
Los encabezados de tabla (<c><th></c>) y los ítems de tabla |
| 329 |
(<c><ti></c>) aceptan los atributos <c>colspan</c> y |
| 330 |
-<c>rowspan</c> para que su contenido abarque columnas, hileras o ambos |
| 331 |
+<c>rowspan</c> para que su contenido abarque columnas, hileras o ambas |
| 332 |
</p> |
| 333 |
|
| 334 |
<p> |
| 335 |
-Además los ítems de tabla (<c><ti></c>) pueden ser alineados a |
| 336 |
-la derecha o centrados con el atributo <c>align</c>. Las cabeceras de |
| 337 |
-las tablas (<c><th></c>) son centradas automáticamente. |
| 338 |
+Además los ítems de tabla (<c><ti></c>) pueden alinearse a la |
| 339 |
+derecha, a la izquierda o centrados con el atributo <c>align</c>. |
| 340 |
</p> |
| 341 |
|
| 342 |
<table> |
| 343 |
<tr> |
| 344 |
- <th colspan="4">Este titular abarca 4 columnas</th> |
| 345 |
+ <th align="center" colspan="4">Este titular abarca 4 columnas</th> |
| 346 |
</tr> |
| 347 |
<tr> |
| 348 |
<th rowspan="6">Este título abarca 6 hileras</th> |
| 349 |
@@ -622,17 +652,21 @@ |
| 350 |
<body> |
| 351 |
|
| 352 |
<p> |
| 353 |
-Para crear listas ordenadas o no, simplemente se usa al estilo XHTML |
| 354 |
-las etiquetas <c><ol></c>, <c><ul></c> y |
| 355 |
-<c><li></c>. Las listas solo deben aparecer dentro de las |
| 356 |
-etiquetas <c><body></c> y <c><li></c> lo cual significa |
| 357 |
-que pueden hacerse listas dentro de listas. No se olvide que está |
| 358 |
-escribiendo XML y que debe colocar las etiquetas de cierre incluyendo |
| 359 |
-ítems en listas, a diferencia de HTML. |
| 360 |
+Para crear listas, ordenadas o no, simplemente use las etiquetas |
| 361 |
+<c><ol></c>, <c><ul></c> y <c><li></c> al estilo |
| 362 |
+XHTML. Las listas solo deben aparecer dentro de las etiquetas |
| 363 |
+<c><body></c> y <c><li></c> lo cual significa que pueden |
| 364 |
+hacerse listas dentro de listas. No se olvide que está escribiendo XML |
| 365 |
+y que debe colocar las etiquetas de cierre, incluyendo ítems en listas, |
| 366 |
+a diferencia de HTML. |
| 367 |
</p> |
| 368 |
|
| 369 |
<p> |
| 370 |
-También soportamos listas de definiciones (<c><dl></c>). Por favor note que ni la etiqueta de definición de término (<c><dt></c>) ni la de definición de datos (<c><dd></c>) aceptan etiquetas de otro nivel, como de párrafo o advertencia. Una lista de definición se parece a esta: |
| 371 |
+También soportamos listas de definiciones (<c><dl></c>). Por |
| 372 |
+favor note que ni la etiqueta de definición de término |
| 373 |
+(<c><dt></c>) ni la de definición de datos (<c><dd></c>) |
| 374 |
+aceptan etiquetas de otro nivel, como de párrafo o advertencia. Una |
| 375 |
+lista de definición se parece a esta: |
| 376 |
</p> |
| 377 |
|
| 378 |
<dl> |
| 379 |
@@ -646,15 +680,17 @@ |
| 380 |
|
| 381 |
<p> |
| 382 |
La siguiente lista, copiada de <uri |
| 383 |
-link="http://www.w3.org/TR/REC-html40/struct/lists.html">w3.org</uri> muestra que una lista de definición puede contener listas ordenadas y sin orden, sin embargo, no puede contener otra lista de definición. |
| 384 |
+link="http://www.w3.org/TR/REC-html40/struct/lists.html">w3.org</uri> |
| 385 |
+muestra que una lista de definición puede contener listas ordenadas y |
| 386 |
+sin orden, sin embargo, no puede contener otra lista de definición. |
| 387 |
</p> |
| 388 |
|
| 389 |
<dl> |
| 390 |
<dt><b>The ingredients:</b></dt> |
| 391 |
<dd> |
| 392 |
<ul> |
| 393 |
- <li>100 g. flour</li> |
| 394 |
- <li>10 g. sugar</li> |
| 395 |
+ <li>100 g flour</li> |
| 396 |
+ <li>10 g sugar</li> |
| 397 |
<li>1 cup water</li> |
| 398 |
<li>2 eggs</li> |
| 399 |
<li>salt, pepper</li> |
| 400 |
@@ -681,25 +717,24 @@ |
| 401 |
|
| 402 |
<p> |
| 403 |
GuideXML hace que sea realmente sencillo referenciar a otras partes |
| 404 |
-del documento mediante el uso de hiperenlaces. Se puede crear un |
| 405 |
-enlace apuntando al <uri link="#doc_chap1">Capítulo Uno</uri> |
| 406 |
-escribiendo <c><uri link="#doc_chap1">Capítulo |
| 407 |
-Uno</uri></c>. Para apuntar a <uri link="#doc_chap1_sect2"> la |
| 408 |
-sección dos del Capítulo Uno</uri>, se escribe <c><uri |
| 409 |
-link="#doc_chap1_sect2">la sección dos del Capítulo |
| 410 |
-Uno</uri></c>. Para hacer una referencia a la figura 3, se |
| 411 |
-escribe <c><uri link="doc_fig3">figura 3</uri></c>. O para |
| 412 |
-referirse al <uri link="#doc_pre2">listado de código 2 </uri>, se |
| 413 |
+del documento con hiperenlaces. Se puede crear un enlace que apunte al |
| 414 |
+<uri link="#doc_chap1">Capítulo Uno</uri> escribiendo <c><uri |
| 415 |
+link="#doc_chap1">Capítulo Uno</uri></c>. Para apuntar a <uri |
| 416 |
+link="#doc_chap1_sect2"> la sección dos del Capítulo Uno</uri>, se |
| 417 |
+escribe <c><uri link="#doc_chap1_sect2">la sección dos del |
| 418 |
+Capítulo Uno</uri></c>. Para hacer una referencia a la figura 3, |
| 419 |
+se escribe <c><uri link="doc_fig3">figura 3</uri></c>. O |
| 420 |
+para referirse al <uri link="#doc_pre2">listado de código 2 </uri>, se |
| 421 |
escribe <c><uri link="doc_pre2">listado de código |
| 422 |
2</uri></c>. |
| 423 |
</p> |
| 424 |
|
| 425 |
<p> |
| 426 |
-Sin embargo, algunas guías cambian frecuentemente y al emplear este |
| 427 |
-'contador' puede conllevar a enlaces rotos. Para hacer frente a esto, |
| 428 |
-se puede definir un nombre para el <c><capítulo></c>, |
| 429 |
+Sin embargo, algunas guías cambian a menudo y al emplear este 'conteo' |
| 430 |
+pueden producirse enlaces rotos. Para hacer frente a esto, se puede |
| 431 |
+definir un nombre para el <c><capítulo></c>, |
| 432 |
<c><sección></c> o <c><tr></c> con el atributo <c>id</c> y |
| 433 |
-después apuntar a este atributo así: |
| 434 |
+después apuntarlo así: |
| 435 |
</p> |
| 436 |
|
| 437 |
<pre caption="Utilizando el atributo id"> |
| 438 |
@@ -719,7 +754,7 @@ |
| 439 |
|
| 440 |
<p> |
| 441 |
El atributo <c>disclaimer</c> puede ser aplicado a guías y manuales |
| 442 |
-para desplegar un aviso de renuncia de responsabilidad predefinido al |
| 443 |
+para desplegar un aviso predefinido de renuncia de responsabilidad al |
| 444 |
comienzo del documento. Los textos de renuncia de responsabilidad |
| 445 |
disponibles son: |
| 446 |
</p> |
| 447 |
@@ -742,10 +777,10 @@ |
| 448 |
</ul> |
| 449 |
|
| 450 |
<p> |
| 451 |
-Al marcar un documento como obsoleto, tal vez quiera agregar un enlace |
| 452 |
+Al marcar un documento como obsoleto, tal vez desee agregar un enlace |
| 453 |
a una versión nueva. El atributo <c>redirect</c> hace justamente |
| 454 |
eso. El usuario puede ser redirigido automáticamente a la página |
| 455 |
-nueva, pero no debe depender de este comportamiento. behaviour. |
| 456 |
+nueva, pero no debe depender de este comportamiento. |
| 457 |
</p> |
| 458 |
|
| 459 |
<pre caption="Ejemplo de renuncia de responsabilidad"> |
| 460 |
@@ -761,6 +796,321 @@ |
| 461 |
</pre> |
| 462 |
</body> |
| 463 |
</section> |
| 464 |
+ |
| 465 |
+<section> |
| 466 |
+<title>FAQs</title> |
| 467 |
+<body> |
| 468 |
+ |
| 469 |
+<p> |
| 470 |
+Los documentos FAQ (preguntas de uso frecuente) necesitan comenzar con |
| 471 |
+una lista de preguntas enlazadas a sus respuestas. Se pierde mucho |
| 472 |
+tiempo creando este tipo de lista y se pueden cometer errores. Este |
| 473 |
+tipo de lista puede ser creada automáticamente si usa el elemento |
| 474 |
+<c>faqindex</c> como el primer capítulo del documento. Este elemento |
| 475 |
+tiene la misma estructura que un <c>chapter</c> y permite un texto |
| 476 |
+introductorio. Se espera que la estructura del documento se divida en |
| 477 |
+capítulos (al menos uno), que contenga secciones, cada sección con una |
| 478 |
+pregunta especificada en su elemento <c>title</c> y con la respuesta |
| 479 |
+en su <c>body</c>. El índice aparecerá como una sección por capítulo y |
| 480 |
+un enlace por pregunta. |
| 481 |
+</p> |
| 482 |
+ |
| 483 |
+<p> |
| 484 |
+Una mirada rápida a <uri link="/doc/es/faq.xml">FAQ</uri> y <uri |
| 485 |
+link="/doc/es/faq.xml?passthru=1">sus fuentes</uri> nos proporcionará |
| 486 |
+todas las explicaciones necesarias. |
| 487 |
+</p> |
| 488 |
+</body> |
| 489 |
+</section> |
| 490 |
+</chapter> |
| 491 |
+ |
| 492 |
+<chapter> |
| 493 |
+<title>Formato del Manual</title> |
| 494 |
+<section> |
| 495 |
+<title>Guide vs Book</title> |
| 496 |
+<body> |
| 497 |
+ |
| 498 |
+<p> |
| 499 |
+Para documentación de alto volument, como las <uri |
| 500 |
+link="/doc/es/handbook/handbook-x86.xml?part=1">Instrucciones de |
| 501 |
+Instalación</uri> se necesitaba un formato más amplio. Diseñamos unas |
| 502 |
+mejoras compatibles con GuideXML que nos permiten escribir |
| 503 |
+documentación modular y multi-página. |
| 504 |
+</p> |
| 505 |
+</body> |
| 506 |
+</section> |
| 507 |
+ |
| 508 |
+<section> |
| 509 |
+<title>Archivo principal</title> |
| 510 |
+<body> |
| 511 |
+ |
| 512 |
+<p> |
| 513 |
+El primer cambio responde a la necesidad de un documento |
| 514 |
+"maestro". Este documento realmente no comprende verdadero contenido, |
| 515 |
+sino enlaces a los módulos individuales del documento. La sintaxis no |
| 516 |
+difiere mucho de GuideXML: |
| 517 |
+</p> |
| 518 |
+ |
| 519 |
+<pre caption="Ejemplo del uso de book"> |
| 520 |
+<?xml version='1.0' encoding='UTF-8'?> |
| 521 |
+<!DOCTYPE book SYSTEM "/dtd/book.dtd"> |
| 522 |
+<!-- $Header$ --> |
| 523 |
+ |
| 524 |
+<<i>book</i>> |
| 525 |
+<title>Example Book Usage</title> |
| 526 |
+ |
| 527 |
+<author...> |
| 528 |
+ ... |
| 529 |
+</author> |
| 530 |
+ |
| 531 |
+<abstract> |
| 532 |
+ ... |
| 533 |
+</abstract> |
| 534 |
+ |
| 535 |
+<!-- The content of this document is licensed under the CC-BY-SA license --> |
| 536 |
+<!-- See http://creativecommons.org/licenses/by-sa/2.5 --> |
| 537 |
+<license/> |
| 538 |
+ |
| 539 |
+<version>...</version> |
| 540 |
+<date>...</date> |
| 541 |
+</pre> |
| 542 |
+ |
| 543 |
+<p> |
| 544 |
+Por los momentos no se ven diferencias sustanciales (excepto por la |
| 545 |
+etiqueta <c><book></c> en vez de <c><guide></c>). En vez |
| 546 |
+de comenzar con los <c><chapter></c>s (capítulos) individuales, |
| 547 |
+definimos un <c><part></c>, el cual equivale a una parte |
| 548 |
+separada de un libro: |
| 549 |
+</p> |
| 550 |
+ |
| 551 |
+<pre caption="Definiendo una parte"> |
| 552 |
+<part> |
| 553 |
+<title>Part One</title> |
| 554 |
+<abstract> |
| 555 |
+ ... |
| 556 |
+</abstract> |
| 557 |
+ |
| 558 |
+<comment>(Definiendo varios capítulos)</comment> |
| 559 |
+</part> |
| 560 |
+</pre> |
| 561 |
+ |
| 562 |
+<p> |
| 563 |
+Cada "part" se acompaña de un <c><title></c> y un resumen |
| 564 |
+(<c><abstract></c>) que proporciona una introducción resumida a |
| 565 |
+la parte. |
| 566 |
+</p> |
| 567 |
+ |
| 568 |
+<p> |
| 569 |
+Dentro de cada parte, definimos los capítulos individuales |
| 570 |
+(<c><chapter></c>s). Cada capítulo <e>debe</e> ser un documento |
| 571 |
+separado. Como resultado, no es de sorprenderse que podamos agregar |
| 572 |
+una etiqueta especial (<c><include></c>) para permitir la |
| 573 |
+inclusión del documento separado. |
| 574 |
+</p> |
| 575 |
+ |
| 576 |
+<pre caption="Definiendo un capítulo"> |
| 577 |
+<chapter> |
| 578 |
+<title>Chapter One</title> |
| 579 |
+ |
| 580 |
+ <include href="path/to/chapter-one.xml"/> |
| 581 |
+ |
| 582 |
+</chapter> |
| 583 |
+</pre> |
| 584 |
+</body> |
| 585 |
+</section> |
| 586 |
+ |
| 587 |
+<section> |
| 588 |
+<title>Diseñando los capítulos individuales</title> |
| 589 |
+<body> |
| 590 |
+ |
| 591 |
+<p> |
| 592 |
+El contenido de un capítulo individual se estructura de la siguiente |
| 593 |
+manera: |
| 594 |
+</p> |
| 595 |
+ |
| 596 |
+<pre caption="Sintaxis de un capítulo"> |
| 597 |
+<?xml version='1.0' encoding='UTF-8'?> |
| 598 |
+<!DOCTYPE sections SYSTEM "/dtd/book.dtd"> |
| 599 |
+<!-- $Header$ --> |
| 600 |
+ |
| 601 |
+<!-- The content of this document is licensed under the CC-BY-SA license --> |
| 602 |
+<!-- See http://creativecommons.org/licenses/by-sa/2.5 --> |
| 603 |
+ |
| 604 |
+<sections> |
| 605 |
+ |
| 606 |
+<abstract> |
| 607 |
+ This is a small explanation on chapter one. |
| 608 |
+</abstract> |
| 609 |
+ |
| 610 |
+<version>...</version> |
| 611 |
+<date>...</date> |
| 612 |
+ |
| 613 |
+<comment>(Defina varias <section>s <subsection>s)</comment> |
| 614 |
+ |
| 615 |
+</sections> |
| 616 |
+</pre> |
| 617 |
+ |
| 618 |
+<p> |
| 619 |
+En cada capítulo se pueden definir secciones (<c><section></c>s) |
| 620 |
+que equivale a un capítulo (<c><chapter></c>) en una Guía y |
| 621 |
+subsecciones (<c><subsection></c>s), que equivalen a una sección |
| 622 |
+(<c><section></c>) en una Guía. |
| 623 |
+</p> |
| 624 |
+ |
| 625 |
+<p> |
| 626 |
+Cada capítulo individual debe tener sus propios elementos para fecha y |
| 627 |
+versión. La última fecha de todos los capítulos y documento maestro |
| 628 |
+será desplegada cuando un usuario consult las distintas partes del |
| 629 |
+libro. |
| 630 |
+</p> |
| 631 |
+</body> |
| 632 |
+</section> |
| 633 |
+</chapter> |
| 634 |
+ |
| 635 |
+<chapter> |
| 636 |
+<title>Características avanzadas del manual</title> |
| 637 |
+<section> |
| 638 |
+<title>Valores globales</title> |
| 639 |
+<body> |
| 640 |
+ |
| 641 |
+<p> |
| 642 |
+A veces se repiten los mismos valores una y otra vez a través del |
| 643 |
+manual. Una operación global de búsqueda y reemplazo podría pasar algo |
| 644 |
+por alto o introducir cambios no deseados. Además, puede ser útil |
| 645 |
+definir diferentes valores a ser usados en capítulos compartidos, |
| 646 |
+dependiendo de cual manual incluya el capítulo. |
| 647 |
+</p> |
| 648 |
+ |
| 649 |
+<p> |
| 650 |
+Los valores globales pueden ser definidos en el archivos maestro del |
| 651 |
+manual y usados en todos los capítulos incluidos. |
| 652 |
+</p> |
| 653 |
+ |
| 654 |
+<p> |
| 655 |
+Para definir valores globales, agregue el elemento |
| 656 |
+<c><values></c> al archivo maestro del manual. Cada valor es |
| 657 |
+definido con un elemento <c><key></c> cuyo atributo <c>id</c> |
| 658 |
+identifica el valor, o sea, el nombre de la variable. El contenido de |
| 659 |
+<c><key></c> corresponde a su valor. |
| 660 |
+</p> |
| 661 |
+ |
| 662 |
+<p> |
| 663 |
+El siguiente ejemplo define tres valores en un archivo maestro de un |
| 664 |
+manual: |
| 665 |
+</p> |
| 666 |
+ |
| 667 |
+<pre caption="Definir valores en un manual"> |
| 668 |
+<?xml version='1.0' encoding='UTF-8'?> |
| 669 |
+<!DOCTYPE book SYSTEM "/dtd/book.dtd"> |
| 670 |
+<!-- $Header$ --> |
| 671 |
+ |
| 672 |
+<book> |
| 673 |
+<title>Example Book Usage</title> |
| 674 |
+ |
| 675 |
+<i><values> |
| 676 |
+ <key id="arch">x86</key> |
| 677 |
+ <key id="min-cd-name">install-x86-minimal-2007.0-r1.iso</key> |
| 678 |
+ <key id="min-cd-size">57</key> |
| 679 |
+</values></i> |
| 680 |
+ |
| 681 |
+<author...> |
| 682 |
+ ... |
| 683 |
+</author> |
| 684 |
+ |
| 685 |
+... |
| 686 |
+</pre> |
| 687 |
+ |
| 688 |
+<p> |
| 689 |
+Los valores definidos pueden entonces ser usados a través del manual |
| 690 |
+con el elemento <c><keyval id="key_id"/></c>. Especifique el |
| 691 |
+nombre de la clave (key) en su atributo <c>id</c>, por lo que |
| 692 |
+<keyval id="min-cd-name"/> sería reemplazado por |
| 693 |
+"install-x86-minimal-2007.0-r1.iso" en el ejemplo. |
| 694 |
+</p> |
| 695 |
+ |
| 696 |
+<pre caption="Usando valores definidos"> |
| 697 |
+<p> |
| 698 |
+The Minimal Installation CD is called <c><i><keyval id="min-cd-name"/></i></c> |
| 699 |
+and takes up only <i><keyval id="min-cd-size"/></i> MB of diskspace. You can use this |
| 700 |
+Installation CD to install Gentoo, but <e>only</e> with a working Internet |
| 701 |
+connection. |
| 702 |
+</p> |
| 703 |
+</pre> |
| 704 |
+ |
| 705 |
+<p> |
| 706 |
+Para facilitarle la vida a nuestros traductores, use solo valores que |
| 707 |
+no requieran traducción. Por ejemplo, definimos el valor de |
| 708 |
+<c>min-cd-size</c> como <c>57</c> y no <c>57 MB</c>. |
| 709 |
+</p> |
| 710 |
+</body> |
| 711 |
+</section> |
| 712 |
+ |
| 713 |
+<section> |
| 714 |
+<title>Elementos condicionales</title> |
| 715 |
+<body> |
| 716 |
+ |
| 717 |
+<p> |
| 718 |
+Los capítulos compartidos por varios manuales, tales como nuestro <uri |
| 719 |
+link="/doc/es/handbook/">Manuales de Instalación</uri> frecuentemente |
| 720 |
+tienen pequeñas diferencias, dependiendo de cuál manual los incluy. En |
| 721 |
+vez de agregar contenido que sea irrelevante a algunos manuales, los |
| 722 |
+autores pueden agregar una condición a los siguientes elementos: |
| 723 |
+<c><section></c>, <c><subsection></c>, |
| 724 |
+<c><body></c>, <c><note></c>, <c><impo></c>, |
| 725 |
+<c><warn></c>, <c><pre></c>, <c><p></c>, |
| 726 |
+<c><table></c>, <c><tr></c>, <c><ul></c>, |
| 727 |
+<c><ol></c> y <c><li></c>. |
| 728 |
+</p> |
| 729 |
+ |
| 730 |
+<p> |
| 731 |
+La condición debe ser una expresión <uri |
| 732 |
+link="http://es.wikipedia.org/wiki/XPath">Xpath</uri> que será |
| 733 |
+evaluada al transformar el XML. Si evalúa a <c>true</c>, este elemento |
| 734 |
+es procesado, si no, es ignorado. La condición es especificada en un |
| 735 |
+atributo <c>test</c>. |
| 736 |
+</p> |
| 737 |
+ |
| 738 |
+<p> |
| 739 |
+El siguiente ejemplo usa el valor <c>arch</c>, el cual es definido en |
| 740 |
+cada archivo maestro de manual para condicionar el contenido: |
| 741 |
+</p> |
| 742 |
+ |
| 743 |
+<pre caption="Usando elementos condicionales"> |
| 744 |
+<body test="contains('AMD64 x86',func:keyval('arch'))"> |
| 745 |
+ |
| 746 |
+<p> |
| 747 |
+Este párrafo aplica a ambas plataformas, x86 y AMD64. |
| 748 |
+</p> |
| 749 |
+ |
| 750 |
+<p test="func:keyval('arch')='x86'"> |
| 751 |
+Este párrafo aplica solo a la plataforma x86. |
| 752 |
+</p> |
| 753 |
+ |
| 754 |
+<p test="func:keyval('arch')='AMD64'"> |
| 755 |
+Este párrafo aplica solo a la plataforma AMD64. |
| 756 |
+</p> |
| 757 |
+ |
| 758 |
+<p test="func:keyval('arch')='PPC'"> |
| 759 |
+¡Este párrafo no será visto nunca! |
| 760 |
+El boy entero es ignorado dada la primera condición. |
| 761 |
+</p> |
| 762 |
+ |
| 763 |
+</body> |
| 764 |
+ |
| 765 |
+<body test="contains('AMD64 PPC64',func:keyval('arch'))"> |
| 766 |
+ |
| 767 |
+<p> |
| 768 |
+Este párrafo aplica a las plataformas AMD64, PPC64 <comment>y PPC</comment> porque la cadena 'AMD64 PPC64' contiene 'PPC'. |
| 769 |
+</p> |
| 770 |
+ |
| 771 |
+<note test="func:keyval('arch')='AMD64' or func:keyval('arch')='PPC64'"> |
| 772 |
+Esta nota solo aplica a las plataformas AMD64 y PPC64. |
| 773 |
+</note> |
| 774 |
+ |
| 775 |
+</body> |
| 776 |
+</pre> |
| 777 |
+</body> |
| 778 |
+</section> |
| 779 |
</chapter> |
| 780 |
|
| 781 |
<chapter> |
| 782 |
@@ -771,7 +1121,7 @@ |
| 783 |
|
| 784 |
<p> |
| 785 |
Puesto que toda la documentación de Gentoo es esfuerzo conjunto y |
| 786 |
-varias personas probablemente cambiarán la documentación existente, es |
| 787 |
+probablemente varias personas cambiarán la documentación existente, es |
| 788 |
necesario un estilo de codificación. Un estilo de codificación abarca |
| 789 |
dos secciones. La primera es relativa a la codificación interna - como |
| 790 |
se sitúan las etiquetas XML. La segunda trata sobre el contenido - |
| 791 |
@@ -790,7 +1140,7 @@ |
| 792 |
|
| 793 |
<p> |
| 794 |
Los <b>fines de línea</b> deben ponerse inmediatamente después de |
| 795 |
-<e>cada</e> etiqueta de la guía XML (tanto de apertura como de cierre) |
| 796 |
+<e>cada</e> etiqueta GuideXML (tanto de apertura como de cierre) |
| 797 |
exceptuando: <c><version></c>, <c><date></c>, |
| 798 |
<c><title></c>, <c><th></c>, <c><ti></c>, |
| 799 |
<c><li></c>, <c><i></c>, <c><e></c>, |
| 800 |
@@ -809,13 +1159,14 @@ |
| 801 |
</p> |
| 802 |
|
| 803 |
<p> |
| 804 |
-Los <b>ajustes de líneas</b> deben ser aplicados a los 80 caracteres |
| 805 |
-excepto dentro de <c><pre></c>. Se puede desviar de esta regla |
| 806 |
-solamente cuando no hay otra opción (por ejemplo cuando una URL excede |
| 807 |
-el máximo de caracteres). El editor debe entonces ajustar la línea en |
| 808 |
-cuanto exista el primer espacio en blanco. Debe intentar mantenerse el |
| 809 |
-contenido <e>desplegado</e> de los elementos <c><pre></c> dentro |
| 810 |
-de 80 columnas para ayudar a los usuarios de consola. |
| 811 |
+Los <b>ajustes de líneas</b> (word wrap) deben ser aplicados a los 80 |
| 812 |
+caracteres, excepto dentro de <c><pre></c>. Solamente se puede |
| 813 |
+desviar de esta regla cuando no hay otra opción (por ejemplo cuando |
| 814 |
+una URL excede el máximo de caracteres). El editor debe entonces |
| 815 |
+ajustar la línea en cuanto exista el primer espacio en blanco. Debe |
| 816 |
+intentar mantenerse el contenido <e>desplegado</e> de los elementos |
| 817 |
+<c><pre></c> dentro de 80 columnas para ayudar a los usuarios de |
| 818 |
+consola. |
| 819 |
</p> |
| 820 |
|
| 821 |
<p> |
| 822 |
@@ -824,8 +1175,8 @@ |
| 823 |
<c><table></c>), <c><ul></c>, <c><ol></c> |
| 824 |
<c><dl></c> y <c><author></c>. Si se usan sangrados, estos |
| 825 |
<e>obligatoriamente</e> debe ser de dos espacios por cada paso de |
| 826 |
-sangrado. Esto significa que <e>nada</e> de tabulaciones <e>ni</e> de |
| 827 |
-más (de dos) espacios. De todas formas, las tabulaciones no están |
| 828 |
+sangrado. Esto significa que <e>nada</e> de tabs <e>ni</e> de más (de |
| 829 |
+dos) espacios. Dicho sea de paso, que las tabulaciones no están |
| 830 |
permitidas en los documentos GuideXML. |
| 831 |
</p> |
| 832 |
|
| 833 |
@@ -848,7 +1199,7 @@ |
| 834 |
<tr> |
| 835 |
<ti>Esto es un ejemplo de sangrado.</ti> |
| 836 |
<ti> |
| 837 |
- En caso de que el texto no pueda ser mostrado en los 80 caracteres de |
| 838 |
+ En caso de que el texto no pueda ser mostrado en los 80 caracteres de |
| 839 |
ancho de línea, deberá usar el sangrado si la etiqueta padre lo permite. |
| 840 |
</ti> |
| 841 |
</tr> |
| 842 |
@@ -861,11 +1212,11 @@ |
| 843 |
</pre> |
| 844 |
|
| 845 |
<p> |
| 846 |
-<b>Atributos</b> no deben tener espacios entre el atributo, el signo |
| 847 |
+Los <b>atributos</b> no deben tener espacios entre sí, el signo |
| 848 |
"=" y el valor del atributo. Como en el ejemplo: |
| 849 |
</p> |
| 850 |
|
| 851 |
-<pre caption="Attributes"> |
| 852 |
+<pre caption="Atributos"> |
| 853 |
<comment>Incorrecto :</comment> <pre caption = "Atributos"> |
| 854 |
<comment>Correcto:</comment> <pre caption="Atributos"> |
| 855 |
</pre> |
| 856 |
@@ -885,8 +1236,8 @@ |
| 857 |
</p> |
| 858 |
|
| 859 |
<p> |
| 860 |
-Cada oración, incluyendo aquellas contenidas en tablas y listados, |
| 861 |
-debe empezar por una letra mayúscula. |
| 862 |
+Cada oración, incluyendo aquellas dentro de tablas y listados, debe |
| 863 |
+empezar por una letra mayúscula. |
| 864 |
</p> |
| 865 |
|
| 866 |
<pre caption="Puntos y letras mayúsculas"> |
| 867 |
@@ -897,7 +1248,7 @@ |
| 868 |
</pre> |
| 869 |
|
| 870 |
<p> |
| 871 |
-Listados de código deben tener <e>siempre</e> un <c>leyenda</c> |
| 872 |
+Los listados de código deben tener <e>siempre</e> una <c>leyenda</c> |
| 873 |
</p> |
| 874 |
|
| 875 |
<p> |
| 876 |
@@ -924,158 +1275,18 @@ |
| 877 |
</chapter> |
| 878 |
|
| 879 |
<chapter> |
| 880 |
-<title>Formato del Manual</title> |
| 881 |
-<section> |
| 882 |
-<title>Guide vs Book</title> |
| 883 |
-<body> |
| 884 |
- |
| 885 |
-<p> |
| 886 |
-Para documentación voluminosa, como puede ser <uri |
| 887 |
-link="/doc/en/handbook/handbook-x86.xml?part=1">Instrucciones de |
| 888 |
-Instalación</uri>, se necesitaba un formato más amplio. Hemos diseñado |
| 889 |
-mejoras compatibles con GuideXML que nos permite escribir |
| 890 |
-documentación modular y de múltiples páginas. |
| 891 |
-</p> |
| 892 |
-</body> |
| 893 |
-</section> |
| 894 |
- |
| 895 |
-<section> |
| 896 |
-<title>Fichero principal</title> |
| 897 |
-<body> |
| 898 |
- |
| 899 |
-<p> |
| 900 |
-El primer cambio es la necesidad de un fichero "maestro". Este |
| 901 |
-documento no alberga realmente un contenido, pero enlaza a los módulos |
| 902 |
-individuales de documentación. La sintaxis no difiere mucho del |
| 903 |
-GuideXML: |
| 904 |
-</p> |
| 905 |
- |
| 906 |
-<pre caption="Empleo de un libro de ejemplo"> |
| 907 |
-<?xml version='1.0' encoding='UTF-8'?> |
| 908 |
-<!DOCTYPE book SYSTEM "/dtd/book.dtd"> |
| 909 |
- |
| 910 |
-<<i>book</i> link="example.xml"> |
| 911 |
-<title>Empleo de un libro de ejemplo</title> |
| 912 |
- |
| 913 |
-<author...> |
| 914 |
- ... |
| 915 |
-</author> |
| 916 |
- |
| 917 |
-<abstract> |
| 918 |
- ... |
| 919 |
-</abstract> |
| 920 |
- |
| 921 |
-<!-- The content of this document is licensed under the CC-BY-SA license --> |
| 922 |
-<!-- See http://creativecommons.org/licenses/by-sa/2.5 --> |
| 923 |
-<license/> |
| 924 |
- |
| 925 |
-<version>...</version> |
| 926 |
-<date>...</date> |
| 927 |
-</pre> |
| 928 |
- |
| 929 |
-<p> |
| 930 |
-Hasta ahora no hay realmente muchas diferencias (excepto el empleo de |
| 931 |
-la etiqueta <c><book></c> en vez de <c><guide></c>). En |
| 932 |
-lugar de comenzar con un <c><chapter></c> (capítulo) individual, |
| 933 |
-se define un <c><part></c>, que es el equivalente a una parte |
| 934 |
-independiente de un libro: |
| 935 |
-</p> |
| 936 |
- |
| 937 |
-<pre caption="Definiendo una parte"> |
| 938 |
-<part> |
| 939 |
-<title>Parte Uno</title> |
| 940 |
-<abstract> |
| 941 |
- ... |
| 942 |
-</abstract> |
| 943 |
- |
| 944 |
-<comment>(Definiendo los distintos capítulos)</comment> |
| 945 |
-</part> |
| 946 |
-</pre> |
| 947 |
- |
| 948 |
-<p> |
| 949 |
-Cada parte es acompañada por un <c><title></c> (título) y un |
| 950 |
-<c><abstract></c> el cual da una pequeña introducción de la |
| 951 |
-parte |
| 952 |
-</p> |
| 953 |
- |
| 954 |
-<p> |
| 955 |
-Dentro de cada parte, se define un <c><chapter></c> |
| 956 |
-independiente. Cada capítulo <e>debe</e> ser un documento por |
| 957 |
-separado. Consecuentemente no es sorpresa que una etiqueta especial |
| 958 |
-(<c><include></c>) sea agregada para permitir el incluir del |
| 959 |
-documento separado. |
| 960 |
-</p> |
| 961 |
- |
| 962 |
-<pre caption="Definiendo un capítulo"> |
| 963 |
-<chapter> |
| 964 |
-<title>Capítulo Uno</title> |
| 965 |
-<abstract> |
| 966 |
- Esta es una pequeña explicación del capítulo uno. |
| 967 |
-</abstract> |
| 968 |
- |
| 969 |
- <include href="path/to/chapter-one.xml"/> |
| 970 |
- |
| 971 |
-</chapter> |
| 972 |
-</pre> |
| 973 |
-</body> |
| 974 |
-</section> |
| 975 |
- |
| 976 |
-<section> |
| 977 |
-<title>Diseñando los capítulos independientes</title> |
| 978 |
-<body> |
| 979 |
- |
| 980 |
-<p> |
| 981 |
-El contenido de un capítulo independiente se estructura así: |
| 982 |
-</p> |
| 983 |
- |
| 984 |
-<pre caption="Sintaxis de capítulo"> |
| 985 |
-<?xml version='1.0' encoding='UTF-8'?> |
| 986 |
-<!DOCTYPE sections SYSTEM "/dtd/book.dtd"> |
| 987 |
- |
| 988 |
-<!-- The content of this document is licensed under the CC-BY-SA license --> |
| 989 |
-<!-- See http://creativecommons.org/licenses/by-sa/2.5 --> |
| 990 |
- |
| 991 |
-<sections> |
| 992 |
- |
| 993 |
-<version>...</version> |
| 994 |
- <date>...</date> |
| 995 |
- |
| 996 |
-<comment>(Defina las distintas <section> |
| 997 |
-y <subsection>)</comment> |
| 998 |
- |
| 999 |
-</sections> |
| 1000 |
-</pre> |
| 1001 |
- |
| 1002 |
-<p> |
| 1003 |
-Dentro de cada capítulo puede definir las <c><section></c>s (el |
| 1004 |
-equivalente de los <c><chapter></c> en una Guía) y |
| 1005 |
-<c><subsection></c>'s (equivalente de <c><section></c> en |
| 1006 |
-una Guía). |
| 1007 |
-</p> |
| 1008 |
- |
| 1009 |
-<p> |
| 1010 |
-Cada capítulo individual debería tener su propios elementos de fecha y |
| 1011 |
-versión. La última fecha de todos los capítulos y el documento |
| 1012 |
-maestro se mostrarán cuando un usuario navegue a través de las partes |
| 1013 |
-del libro. |
| 1014 |
-</p> |
| 1015 |
-</body> |
| 1016 |
-</section> |
| 1017 |
-</chapter> |
| 1018 |
- |
| 1019 |
-<chapter> |
| 1020 |
<title>Recursos</title> |
| 1021 |
<section> |
| 1022 |
-<title>Comenzar a escribir</title> |
| 1023 |
+<title>Comience a escribir</title> |
| 1024 |
<body> |
| 1025 |
|
| 1026 |
<p> |
| 1027 |
Esta guía ha sido diseñada especialmente para ser "clara y directa" |
| 1028 |
para que los desarrolladores puedan pasar más tiempo escribiendo |
| 1029 |
documentación y menos tiempo aprendiendo la sintaxis XML. Esperamos |
| 1030 |
-que esto permitirá a los desarrolladores que no son muy amantes de la |
| 1031 |
-documentación, comenzar a escribir documentación de gran calidad de |
| 1032 |
-Gentoo Linux. Quizá esté interesado en nuestra página de <uri |
| 1033 |
+que esto permitirá a los desarrolladores que no son muy conocedores de |
| 1034 |
+la documentación, comenzar a escribir documentación Gentoo de gran |
| 1035 |
+calidad. Quizá esté interesado en nuestra página de <uri |
| 1036 |
link="/proj/es/gdp/doc/doc-tipsntricks.xml">Trucos y consejos sobre |
| 1037 |
Documentación de Desarrollo</uri>. Si quiere ayudar (o tiene alguna |
| 1038 |
duda sobre la guía), por favor mande un mensaje a la <mail |
| 1039 |
|
| 1040 |
|
| 1041 |
|
| 1042 |
-- |
| 1043 |
gentoo-commits@l.g.o mailing list |
Archives