From da18f65231cab2a06f925b8e311c829ff7821c3e Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Andr=C3=A9s=20Sanjose?= <44277272+don0t@users.noreply.github.com> Date: Wed, 7 Nov 2018 11:34:11 -0600 Subject: [PATCH] Editing Basic Text editing, would need to see the original version to make a better translation. Made a few changes. --- README.rst | 41 ++++++++++++++++++++--------------------- 1 file changed, 20 insertions(+), 21 deletions(-) diff --git a/README.rst b/README.rst index 16a0793..078ca0b 100644 --- a/README.rst +++ b/README.rst @@ -13,8 +13,7 @@ Obtener y compilar la documentación =================================== El almacenamiento de este material está disponible en un repositorio Git -en GitHub.com "`collective.spanishdocumentation`_". Si usted tiene una -credenciales en este servidor y desea convertirse en un colaborador ejecute +en GitHub.com "`collective.spanishdocumentation`_". Si usted tiene credenciales para entrar en este servidor y desea convertirse en un colaborador ejecute el siguiente comando: :: $ git clone git@github.com:collective/collective.spanishdocumentation.git collective.spanishdocumentation @@ -65,7 +64,7 @@ Codificación de caracteres Su editor debe codificar el texto en **utf-8** si le gusta lo que está leyendo. Si su editor de texto favorito no reconoce esta codificación -(en la actualidad, eso es bien extraño), entonces cambie de editor de texto. +(en la actualidad, eso rara vez sucede), entonces cambie de editor de texto. .. admonition:: Truco @@ -80,18 +79,18 @@ Si su editor de texto favorito no reconoce esta codificación Desplazamientos y indentaciones =============================== -El uso del carácter de tabulación en el texto fuente para las distintas -desplazamientos y indentaciones está **estrictamente prohibido**. Utilice siempre +El uso del carácter de tabulación en el texto fuente para los distintos +desplazamientos e indentaciones está **estrictamente prohibido**. Utilice siempre espacios para este fin. Todos los editores de texto ofrecen opciones avanzadas para insertar espacios al pulsar la tecla TAB. No tiene -excusa si es necesario. +excusa para utilizarlo. Estilos de subrayado ==================== -Sphinx y ReStructuredText no imponer estilo de subrayado para -diferentes niveles de secciones de un documento. Todo se deja a la discreción -editores. Para mantener la coherencia nosotros adoptamos la siguiente convención: :: +Sphinx y ReStructuredText no imponen ningun estilo de subrayado para +diferentes niveles de secciones de un documento. Todo se deja a la discreción de los +editores. Para mantener la coherencia nosotros hemos adoptado la siguiente convención: :: ============================================== Titulo de capitulo (uno solo por cada archivo) @@ -119,35 +118,35 @@ editores. Para mantener la coherencia nosotros adoptamos la siguiente convenció +++++++++++++++++++ No es necesario ni deseable ir más allá del nivel 4. Cuando la generación del -documento allá completado, el nivel de las secciones básicas de un archivo -depende del nivel de anidamiento del archivo en la estructura general de -documento. Para generar el HTML, no es un problema, pero en LaTeX limita +documento se complete, el nivel de las secciones básicas de un archivo +depende del nivel de anidamiento del archivo en la estructura general del +documento. Para generar el HTML esto no es un problema, pero en LaTeX limita la superposición de las secciones a 6 niveles. Contribuciones SVN ================== -Wow, estás contento con tu excelente trabajo. Y le gustaría compartirlo con +Wow, estará contento con su excelente trabajo y le gustaría compartirlo con todo el mundo. Al igual que cuando "contribuidor" de código fuente, las pruebas unitarias no deben mostrar ningún error, compruebe en primer lugar: * Que el comando ``make html`` no genere ningún error o advertencia. * Que su redacción no posea ningún error de ortografía. -* Los enlaces de hipertexto que se ha agregado o cambiado (glosario, enlaces +* Que los enlaces de hipertexto que se han agregado o cambiado (glosario, enlaces externos explícitos, referencias a las secciones, ...) funcionan correctamente. Imágenes ======== Aparte de las capturas de pantalla - ¡Uy, lo siento - las capturas de pantalla!, -las imágenes Sphinx se inserta en el documento debe ir acompañada de su versión -"Fuente" en un formato público interoperables, y para que el editor pueda abrir +las imágenes Sphinx que se inserten en el documento deben ir acompañadas de su versión +"Fuente" en un formato público interoperables para que el editor pueda abrir el archivo fuente que este disponible. Las imágenes deben estar preferentemente en el formato PNG. Además, durante cada inserción o cambio de imagen, usted **debe** -verificar y ajustar si es necesario la representación PDF, a sabiendas de las limitaciones -la imagen a tamaño del papel final. +verificar y ajustar si es necesario la representación PDF, a sabiendas de las limitaciones de +la imagen y el tamaño del papel final. **Ejemplo :** :: @@ -170,8 +169,8 @@ Algunas de las herramientas recomendadas ======================================== Emacs : usted puede agregar a emacs el módulo `rst.el`_ que añade un par -de comandos y la sintaxis de la documentación a los escritores simpatizantes -de Sphinx y reStructuredText. +de comandos y la sintaxis de la documentación a los escritores compatibles con +Sphinx y reStructuredText. Ejemplos de documentación en Sphinx @@ -190,7 +189,7 @@ FAQ **Pregunta :** He añadido una entrada del índice o un nuevo término en el glosario y no se actualiza cuando compilo el documento. -**Respuesta :** El índice de Sphinx es a veces es desorientado y la gestión de la dependencia +**Respuesta :** El índice de Sphinx es a veces desorientado y la gestión de la dependencia a veces, mejor. Por lo tanto, todo se debe reiniciar ejecutando el comando ``make clean`` dentro del directorio ``collective.spanishdocumentation/sphinx/build/``.