MoodleDocs:Guía de Estilo

Categorías

• Por favor añada por lo menos una categoría a cada página tecleando una o varias de las siguientes expresiones al final del artículo:

[[Categoría:Profesor]], [[Categoría:Administrador]], [[Categoría:Desarrollador]]

• Categorías lista todas las categorías actualmente en uso en MoodleDocs en castellano.

Documentación de las diferentes versiones (ramas) de Moodle

• La documentación de Moodle en español tiene páginas que tratan con versiones tan antiguas como la 1.6 y tan recientes como la 3.1 (mayo del 2016).
• Las siguientes plantillas se utilizarán para definir aquellos apartados y páginas de la documentación que corresponden a alguna versión concreta de Moodle.

{{Moodle 1.6}} {{Moodle 1.7}} {{Moodle 1.8}} {{Moodle 1.9}}

Moodle 1.9

Moodle 1.8

Moodle 1.7

Moodle 1.6

{{Moodle 2.0}} {{Moodle 2.1}} {{Moodle 2.2}} {{Moodle 2.3}} {{Moodle 2.4}}

Moodle 2.4

Moodle 2.3

Moodle 2.2

Moodle 2.1

Moodle 2.0

{{Moodle 2.5}} {{Moodle 2.6}} {{Moodle 2.7}} {{Moodle 2.8}} {{Moodle 2.9}}

Moodle 2.9

Moodle 2.8

Moodle 2.7

Moodle 2.6

Moodle 2.5

{{Moodle 2.x}}

Moodle 2.x

{{Moodle 3.0}} {{Moodle 3.1}}

Moodle 3.1

Moodle 3.0

Segmentación de la documentación en español

• Hace varios años, los usuarios hispanohablantes de Moodle decidieron que solamente existiría una versión de documentación en español, aunque la documentación en inglés se había separado en versiones diferentes para cada rama 2.x y una antigua para 1.x
• Como la documentación en español se retrasó muchísimo respecto a la de inglés, no había interés en mantener documentaciones diferentes para cada versión en idioma español.
• En 2013 se reorganizó la documentación en español para que se asemejara más a la página en inglés. Muchas páginas muy antiguas se movieron a carpetas situadas en 19/ para dejar espacio a la nueva versión de documentación para Moodle 2.x
• Cuando la documentación original en idioma inglés cambió radicalmente para cierta versión (por ejemplo, a finales del 2015, cuando apareció Moodle 3.0), la documentación antigua en español se renombró y movió a un subdirectorio con el nombre de la versión anterior correspondiente (por ejemplo, la documentación antigua de 'cierta_página' se acomodó en '29/cierta_página' y la nueva página de documentación en español creada solamente contiene la traducción actualizada para la versión más reciente).
  • Vea un ejemplo con la página de tablero contra la página de tablero para Moodle 2.8, que en aquel entonces se conocía como mi hogar o área personal.
• Si Usted observa que una página en inglés cambia radicalmente para una nueva versión de Moodle y decide actualizar la documentación en español (muy loable), por favor mueva la página con la documentación anterior en español a una carpeta con el nombre de la versión antigua (como se hizo con Tablero en el ejemplo de arriba).
• Por favor, use la plantilla ::{{Versiones}} para informar que existen páginas separadas de documentación en Español para diferentes versiones (ramas) de Moodle.

Pantallazos

• Le recomendamos que ilustre la documentación con imágenes de la pantalla (pantallazos). Por favor, emplee el Sitio de demostración, u otro empleando temas estándar, y asegurese de que el pantallazo es lo más razonablemente pequeño posible.
• Los pantallazos deben ser cargados utilizando la herramienta enlazada en Subir archivo.
• Los pantallazos no deben tener más de 800 píxeles de ancho y se recomienda preferente el formato GIF, también puede ser PNG y cuando contenga fotografías con degradados se recomienda JPG. Al ser capturas de pantalla deben tener 72 ppp (puntos por pulgada).
• El nombre del gráfico debe ser descriptivo y, si lo desea, puede añadir la misma ruta que aparece en Moodle, por ejemplo como ruta: course/view y como nombre: colapsar_sección.
• Puede añadir su gráfico en el artículo mediante[[Image:nombre_del_pantallazo.gif]] o [[Image:nombre_del_pantallazo.gif|texto del comentario]]
• Por favor, no aplique efectos como bordes, marcas de agua o sombreados a los pantallazos. Esto permitirá a otros remplazar o añadir pantallazos manteniendo una apariencia consistente entre artículos.
• Para ayuda sobre como colocar una imagen, por favor lea atentamente la documentación en Wikipedia:Picture tutorial y en Cómo añadir imágenes.
• Usted puede replicar el aspecto del Mount Orange School con sus fondos anaranjados duplicando las características de éste tema en su servidor local.

Screencasts

• Usted también podría considerar el usar screencasts, los primos dinámicos de las pantallas estáticas.
• Para más información, vea Screencasts.

Plantillas

• En MediaWiki, una plantilla (template) es una página que puede ser insertada en otra página. Por ejemplo, el bloque "Ayuda MoodleDocs" presente en esta página es una plantilla.
• Una plantilla puede ser añadida a una página escribiendo, por ejemplo, {{Nombre}} para crear la plantilla "Nombre"
• Páginas (del espacio de nombres "Plantilla") muestra las plantillas definidas en MoodleDocs en castellano.
• Por favor visite MediaWiki Template help para obtener más información sobre el uso de las plantillas.

Plantillas asociadas con el proceso de traducción de páginas de documentación

{{Urgente de traducir}}

Nota: Urgente de Traducir. ¡ Anímese a traducir esta muy importante página !.     ( y otras páginas muy importantes que urge traducir)

Esta plantilla se utilizará para definir aquellas páginas muy prioritarias de la documentación en inglés que aún no hayan sido traducidas.

{{Pendiente de traducir}}

Nota: Pendiente de Traducir. ¡Anímese a traducir esta página!.     ( y otras páginas pendientes)

Esta plantilla se utilizará para definir aquellas páginas prioritarias de la documentación en inglés que aún no hayan sido traducidas.

{{Pendiente 2}}

Nota: Pendiente 2. ¡Corresponden a complementos (add-ons) y serán traducidas después de traducir la documentación del núcleo de Moodle!.     (otras páginas pendientes)

Esta plantilla se utilizará para definir aquellas páginas de la documentación de complementos (add-ons en inglés) y características poco comunes/importantes que aún no hayan sido traducidas y sean menos prioritarias que las de arriba.

• Otra plantilla que resulta interesante es:

{{EnTraduccion}}

Esta plantilla se debe utilizar para avisar al resto de usuarios de las Moodle Docs de que el trabajo de traducción de una página ha comenzado, previniendo a otros de realizar modificaciones mientras no se haya finalizado por parte de quién añadió la plantilla. Una especie de "reserva del derecho de edición" en plan cortés.

{{Falta es|fecha}}

Nota del traductor: Al momento de escribir esta documentación (mayo2016), las frases originales en idioma Inglés solamente estaban traducidas al Español de México, pero no se habían hecho las traducciones al Español internacional, por lo que posiblemente algunos usuarios tengan ciertas frases en el idioma inglés original y otras frases tengan una redacción diferente.. Por favor, si le es posible, ayúdenos con la Traducción en el sitio de AMOS, otras páginas muy importantes que denotan que faltan de traducir frases del Inglés, y después quite esta plantilla.

Esta plantilla se puede utilizar para avisar a los usuarios de Moodle que existen traducciones de frases del código de Moodle del idioma inglés original al Español de México, pero que hacen falta traducciones al Español internacional en el sitio de AMOS. La documentación de Moodle en español actualmente escrita, obviamente, contiene ejemplos e imágenes de pantalla únicamente con la redacción del Español de México.

{{Ilustrar}}

Esta plantilla se debe utilizar para avisar al resto de usuarios de las Moodle Docs de que el trabajo de traducción de las ilustraciones de una página ha comenzado, previniendo a otros de realizar modificaciones mientras no se haya finalizado por parte de quién añadió la plantilla. Una especie de "reserva del derecho de edición de imágenes" en plan cortés.

• Otra plantilla que resulta interesante es:

{{Actualizar}}

Esta página necesita actualizarse con la información existente en la documentación vigente/moderna/actualizada en el idioma inglés original para Moodle. Se le sugiere al lector que consulte la página original en idioma inglés cuyo enlace está al fondo de esta página. y que, por favor, actualice esta información y quite la plantilla {{Actualizar}} cuando haya terminado.     (otras páginas pendientes de actualizar)

Esta plantilla se utilizará para definir aquellas páginas importantes de la documentación en español de Moodle a las que les falta información actualizada que existe en la versión original en inglés (que les falte texto, enlaces, o las imágenes y cuadros que tiene la versión en inglés).

{{chafa}}

Nota: Pendiente de ACTUALIZAR esta traducción respecto a la página original en inglés (ver enlace hacia English en el cuadro abajo a la derecha).     (otras páginas pendientes)

Esta plantilla se utilizó para definir algunas páginas de la documentación muy antigua en español de Moodle (principalmente 1.9) a las que les falta información actualizada que existe en la versión original en inglés (que les falte texto, enlaces, o las imágenes y cuadros que tiene la versión en inglés) pero que se consideran de poca relevancia porque ya existe una página con información actualizada en español..

{{Frequently updated doc page|docpagetitle = Página_original_de_documentación_en_inglés}}

Nota: Esta es una traducción de una página de la documentación en idioma Inglés (Docs), que se considera particularmente importante, y que en su versión original se actualiza frecuentemente. Por ello, se le recomienda que revise la página original en idioma inglés: Installing Moodle.

Esta plantilla debe ser aplicada en aquellos artículos (por ejemplo, Instalación de Moodle) cuya documentación original en idioma inglés se actualiza con frecuencia. Puede entenderse como una advertencia a que la página en español puede desactualizarse en poco tiempo y sería conveniente consultar la versión actualizada original en inglés (por ejemplo Installing Moodle).

{{Frequently updated page translation|devpagetitle = Página_original_de_documentación_para_DESARROLLADORES_en_inglés}}

Nota: Esta es una traducción de una página de la documentación para desarrolladores (Developer docs), que se considera particularmente importante, y que en su versión original se actualiza frecuentemente. Por ello, se le recomienda que revise la página original en idioma inglés: Releases.

Esta plantilla debe ser aplicada en aquellos artículos en español (por ejemplo, Historia de las versiones) cuya documentación para desarrolladores original en idioma inglés se actualiza con frecuencia. Puede entenderse como una advertencia a que la página en español puede desactualizarse en poco tiempo y sería conveniente consultar la versión original para desarrolladores en inglés (por ejemplo, Releases).

Plantillas que denotan páginas provisionales/iniciales/temporales

• El equivalente del stub del idioma inglés:

{{Esbozo}}

Esta plantilla debe ser aplicada en aquellos artículos que acaban de ser creados y cuyo contenido y estructura dista mucho de ser completa. Puede entenderse como una llamada a aportar ideas y contenidos sobre el artículo en cuestión.

Plantillas con notas importantes

{{Nota2|Esta es una nota similar a las usadas en la documentación en Inglés para Moodle 2.x}}

Nota: Esta es una nota similar a las usadas en la documentación en Inglés para Moodle 2.x

{{Nota3|Esta es una nota similar a las usadas en la documentación en Inglés para Moodle 3.x}}

Nota: Esta es una nota similar a las usadas en la documentación en Inglés para Moodle 3.x

{{Nota|Esta es una nota tal como actualmente están configuradas las notas en la documentación en idioma español}}

Nota: Esta es una nota en la documentación en español de Moodle

{{Notadeltraductor|Esta es una nota del traductor, que menciona ...}}

Nota del traductor: Esta es una nota del traductor, que menciona importantes diferencias de la página traducida (por ejemplo, entre el Español internacional y el Español de México) contra la página original en idioma inglés

Plantilla usada para diferentes versiones de Moodle

{{Versiones|Esto es lo que Usted escribió sobre las diferentes versiones de documentación disponibles para Moodle 3.0, 2.x, 1.9...}}

Existe documentación diferente para varias versiones de Moodle: Esta página es la documentación para Moodle 3.0. Si desea ver la documentación antigua para Moodle 1.9 vaya a ...

Plantillas que denotan enlaces rotos en la documentación

• Otros archivos para corregir:

https://docs.moodle.org/all/es/Categor%C3%ADa:Páginas_con_enlaces_rotos_a_archivos

Otros

• El uso habitual del género masculino en toda la documentación responde únicamente a criterios de simplicidad y fluidez en su escritura y lectura, y no a encubrir conceptos estereotipados en relación al género.
• El uso recomendado del tratamiento de Usted en toda la documentación responde a criterios adoptados inicialmente en la redacción de ayudas, traducción y documentación.
• La documentación en línea de Moodle en Inglés y en Español fue escrita por humanos, que al parecer cometen errores humanos ocasionalmente, por lo que es perfectible. Por favor, lea las Normas para colaboradores antes de editar la documentación.

Nota del traductor: La documentación inicialmente hacía referencia primariamente a la traducción de Moodle del Español internacional, y se anotaban entre paréntesis o en una Nota las diferencias con el Español de México. Cuando hay diferencias importantes en ambos paquetes de idioma (por ejemplo, homonimias en uno de ellos), cada documentador puede emplear la traducción que considere más completa, precisa o con menor riesgo de ambiguedad. Las diferencias importantes se pueden señalar en una 'Nota del traductor'.

Enlaces útiles para ayudar a traducir y actualizar la documentación en Español

• Documentación en inglés de Moodle 3.1: nuevas páginas y páginas con cambios recientes.
• Documentación en inglés para desarrolladores: nuevas páginas y páginas con cambios recientes
• las páginas urgentes de traducir completamente al español.
• las páginas obsoletas en español que requieren actualizarse respecto al original actualizado en inglés.
• y las páginas pendientes de traducir total o parcialmente al español.

Vea también

• Desarrollo de Moodle Docs
• Páginas especiales de la documentación de Moodle en español