Importante
A tradução é um esforço comunitário você pode contribuir. Esta página está atualmente traduzida em 61.11%.
19. Apêndice: Contribuindo para este manual
To add materials to this course, you must follow the guidelines in this Appendix. You are not allowed to alter the conditions in this Appendix except for clarification. This is to ensure that the quality and consistency of this manual can be maintained.
19.1. Download de recursos
A fonte deste documento está disponível em ‘GitHub <https://github.com/qgis/QGIS-Documentation>’_. Consulte ‘GitHub.com <https://github.com/>’_ para obter instruções sobre como usar o sistema de controle de versão git.
19.2. Formato do Manual
This manual is written using Sphinx, a Python document generator using the reStructuredText markup language. Instructions on how to use these tools are available on their respective sites.
19.3. Adicionando um módulo
To add a new module:
First create a new directory (directly under the top-level of the
qgis-training-manual
directory) with the name of the new module.Under this new directory, create a file called
index.rst
. Leave this file blank for now.Open the
index.rst
file under the top-level directory. Its first lines are:.. toctree:: :maxdepth: 2 foreword/index introduction/index
You will note that this is a list of directory names, followed by the name
index
. This directs the top-level index file to the index files in each directory. The order in which they are listed determines the order they will have in the document.
Add the name of your new module (i.e., the name you gave the new directory), followed by
/index
, to this list, wherever you want your module to appear.Recuerda mantener el orden de los módulos de forma lógica, de forma que los módulos finales se basen en el conocimiento presentado por los iniciales.
Open your new module’s own index file (
module_name/index.rst
).Along the top of the page, create the module heading:
write a first line of asterisks (
*
).Follow this with a line containing the markup phrase
Module:
, followed by the name of your module.End this off with another line of same number of asterisks.
Nota
The underline and the overline should not be shorter than the line containing the module title.
Deja una línea abierta por debajo.
Escribe un párrafo corto explicando el propósito y contenido del módulo.
Deja una línea abierta, luego añade el texto siguiente:
.. toctree:: :maxdepth: 2 lesson1 lesson2
… where
lesson1
,lesson2
, etc., are the names of your planned lessons.
El archivo índice del nivel del módulo tendrá este aspecto:
*******************************************************************************
Module: Module Name
*******************************************************************************
Short paragraph describing the module.
.. toctree::
:maxdepth: 2
lesson1
lesson2
19.4. Adición de una Lección
Para añadir una lección a un módulo existente:
Abre el directorio del módulo.
Open the
index.rst
file (created above in the case of new modules).Ensure that the name of the planned lesson is listed underneath the
toctree
directive, as shown above.Crea un archivo nuevo en el directorio del módulo.
Name this file exactly the same as the name you provided in the module’s
index.rst
file, and add the extension.rst
.
Nota
For editing purposes, a
.rst
file works exactly like a normal text file (.txt
).
To begin writing the lesson, write the markup phrase
Lesson
, followed by the lesson name.In the next line, write a line of equal signs (
=
), not shorter than the lesson title.Deja una línea abierta después de eso.
Escribe una corta descripción del propósito de la lección.
Incluye una introducción general del tema. Mira lecciones existentes como ejemplos.
Debajo, comienza un nuevo párrafo, comenzando con esta frase:
**The goal for this lesson:**
Explica brevemente el resultado previsto a completar en esta lección.
Si no puedes describir el objetivo de la lección en una o dos frases, considera dividir el tema en varias lecciones.
Cada lección estará subdividida en varias secciones, que se abordarán luego.
19.5. Añadir una Lección
Hay dos tipos de secciones: “sigue los pasos” y “prueba tú mismo”.
Una sección “sigue los pasos” detalla un conjunto de direcciones para enseñar al lector cómo utilizar un aspecto dado del QGIS. Esto se hace dando direcciones clic por clic tan claramente como sea posible, intercaladas con capturas de pantalla.
A “try yourself” section gives the reader a short assignment to try by themselves. It is usually associated with an entry in the answer box beneath, which will show or explain how to complete the assignment, and will show the expected outcome if possible.
Every section comes with a difficulty level. An easy section is denoted by
★☆☆
, moderate by ★★☆
, and advanced by ★★★
.
19.5.1. Añadir una sección “sique los pasos”
Para comenzar esta lección, escribe la frase de marcado de la dificultad del nivel (como se muestra arriba).
Leave a space and then write
Follow Along:
.Deja otro espacio y escribe el nombre de la lección (utiliza solo una inicial en mayúsculas, así como las mayúsculas para nombres propios).
In the next line, write a line of minuses/dashes (
-
), not shorter than the section title.Escribe una introducción corta a la sección, explicando sus objetivos. Luego dá instrucciones detalladas (clic por clic) al procedimiento a ser demostrado.
En cada sección, incluye enlaces internos y externos y capturas de pantalla según se necesiten.
Intenta acabar cada sección con un párrafo corto que concluya y abra paso a la siguiente sección de forma natural, si es posible.
19.5.2. Añadir una sección “prueba tú mismo”
Para comenzar esta lección, escribe la frase de marcado de la dificultad del nivel (como se muestra arriba).
Leave a space and then write
Try Yourself:
.In the next line, write a line of minuses/dashes (
-
), not shorter than the section title.Explica el ejercicio que quieres que el lector complete. Refiérete a las secciones, lecciones o módulos anteriores si es necesario.
Incluye capturas de pantalla para clarificar los requisitos si alguna descripción textual no está clara.
In most cases, you will want to provide an answer regarding how to complete the assignment given in this section. To do so, you will need to create and feed an answer block beneath the instructions.
First, create the custom collapsible widget that contains the answer:
.. admonition:: Answer :class: dropdown
Keeping an indentation with regard to the above block, write the instructions on how to complete the assignment, using links and images where needed.
19.6. Añadir una Conclusión
To end a lesson:
Write the phrase
In Conclusion
, followed by a new line of minuses/dashes (-
).Write a conclusion for the lesson, explaining which concepts have been covered in the lesson.
19.7. Añadir una Sección de Lectura Adicional
Esta sección es opcional.
Write the phrase
Further Reading
, followed by a new line of minuses/dashes (-
).Incluye enlaces a webs externas apropiadas.
19.8. Añade un Cuál es la Próxima Sección
Write the phrase
What's Next?
, followed by a new line of minuses/dashes (-
).Explica cómo esta lección ha preparado a los estudiantes para las secciones o módulos siguientes.
Recuerda cambiar la sección “qué es lo siguiente” de la lección anterior si es necesario, para que se refiera a tu nueva lección. Esto será necesario si has insertado una lección entre lecciones existentes, o después de una lección existente.
19.9. Utilizar el Marcado
Para acoplarte a los estándares de este documento, necesitarás añadir marcadores estándares a tu texto.
19.9.1. Nuevos conceptos
If you are explaining a new concept, you will need to write the new concept’s
name in italics by enclosing it in asterisks (*
).
This sample text shows how to introduce a *new concept*.
19.9.2. Énfasis
To emphasize a crucial term which is not a new concept, write the term in bold by enclosing it in double asterisks (
**
).¡Úsalo moderadamente! Si lo usas demasiado, puede parecer que estás gritando o siendo condescendiente.
This sample text shows how to use **emphasis** in a sentence. Include the
punctuation mark if it is followed by a **comma,** or at the **end of the
sentence.**
19.9.3. Imágenes
When adding an image, save it to an
img
folder next to the lesson file.Inclúyela en el documento de esta forma:
.. figure:: img/image_file.extension :align: center
Recuerda dejar una línea abierta sobre y bajo el marcador de la imagen.
19.9.4. Enlaces internos
Para anclar un enlace, escribe la línea siguiente sobre la posición donde quieras que el enlace señale:
.. _link-name:
Recuerda dejar una línea abierta sobre y bajo esta línea.
To create a link, refer to it as below:
:ref:`Descriptive link text <link-name>`
19.9.5. Enlaces externos
Para crear un enlace externo, escribelo así:
`Descriptive link text <link-url>`_
19.9.6. Utilizar el texto monoespaciado
When you are writing text that the user needs to enter, a path name, or the name of a database element such as a table or column name, you must write it in
monospaced text
. For example:Enter the following path in the text box: ``path/to/file``.
19.9.7. Etiquetado de elementos GUI
Si te refieres a un elemento GUI, como un botón, debes escribir su nombre en the GUI label format.Por ejemplo:
To access this tool, click on the :guilabel:`Tool Name` button.
Esto también se aplica si estás mencionando el nombre de una herramienta sin que requiera que el usuario haga clic en un botón.
19.9.9. Añadir notas
You might need to add a note in the text, which explains extra details that can’t easily be made part of the flow of the lesson. This is the markup:
[Normal paragraph.] .. note:: Note text. New line within note. New paragraph within note. [Unindented text resumes normal paragraph.]
19.10. ¡Gracias!
¡Gracias por tu aportación a este proyecto! Haciendolo, estás mejorando la accesibilidad del QGIS a usuarios y añades valor al proyecto QGIS en su conjunto.