Diferencia entre revisiones de «MoodleDocs:Guía de Estilo»

De MoodleDocs
Ayuda para Moodle Docs
(tidy up)
(tidy up)
 
(No se muestran 39 ediciones intermedias del mismo usuario)
Línea 1: Línea 1:
{{Plantilla:Ayuda}}
{{Plantilla:Ayuda}}
==Categorías==
{{Note| Vea la [https://moodle.styleguide.com/the-moodle-content-style-guide ''content style guide'' (en inglés)  nueva guía de estilo en idioma inglés.]}}


*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ías ==
:<code><nowiki>[[Categoría:Profesor]]</nowiki></code>, <code><nowiki>[[Categoría:Administrador]]</nowiki></code>, <code><nowiki>[[Categoría:Desarrollador]]</nowiki></code>
Una categoría es un índice de páginas de documentación.


*[[Special:Categories|Categorías]] lista todas las categorías actualmente en uso en MoodleDocs en castellano.
* Una página puede añadirse a una categoría al escribirle <code><nowiki>[[Categoria:Nombre_de_la_categoría]]</nowiki></code>, como por ejemplo <code><nowiki>[[Categoría:Administración del sitio]]</nowiki></code>, al final de la página. Muchas plantillas automáticamente categorizan a las páginas que usan la plantilla, por ejemplo <code><nowiki>[[Plantilla:Foro]]</nowiki></code> categoriza páginas dentro de la [[:Categoría:Foro]].


==Documentación de las diferentes versiones (ramas) de Moodle==
* Para '''enlazar a una categoría''' Usted tiene que añadir un caracter de dos puntos de esta forma: <code><nowiki>[[:Categoría:FAQ]]</nowiki></code> lo que se mostrará como [[:Categoría:FAQ]].
* 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).
*[[Special:Categories|Categorías]] enlista todas las categorías actualmente en uso en MoodleDocs en castellano. Esto puede encontrase en el enlace hacia las Páginas Especiales de Herramientas.
* 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.
* Para '''mayor información''' acerca de categorías y de como funcionan en MediaWiki, por favor refiérase a [https://en.wikipedia.org/wiki/Wikipedia:Categorization Wikipedia:Categorization].


:<code><nowiki>
'''Vea [[MoodleDocs:PlantillasSPANISH]] para conocer las plantillas especialmente hechas para el Español y que no se emplean en Moodle Docs en idioma Inglés.''' Especialmente tome nota de que ahora tenemos una '''Segmentación de la documentación en español''' para separar la documentación en español de Moodle 3.x de la de Moodle 2.x y 1.x.
{{Moodle 1.6}}
{{Moodle 1.7}}
{{Moodle 1.8}}
{{Moodle 1.9}}
</nowiki></code>
 
{{Moodle 1.9}}
{{Moodle 1.8}}
{{Moodle 1.7}}
{{Moodle 1.6}}
 
:<code><nowiki>
{{Moodle 2.0}}
{{Moodle 2.1}}
{{Moodle 2.2}}
{{Moodle 2.3}}
{{Moodle 2.4}}
</nowiki></code>
{{Moodle 2.4}}
{{Moodle 2.3}}
{{Moodle 2.2}}
{{Moodle 2.1}}
{{Moodle 2.0}}
:<code><nowiki>
{{Moodle 2.5}}
{{Moodle 2.6}}
{{Moodle 2.7}}
{{Moodle 2.8}}
{{Moodle 2.9}}
</nowiki></code>
{{Moodle 2.9}}
{{Moodle 2.8}}
{{Moodle 2.7}}
{{Moodle 2.6}}
{{Moodle 2.5}}
 
 
:<code><nowiki>
{{Moodle 2.x}}
</nowiki></code>
{{Moodle 2.x}}
 
 
:<code><nowiki>
{{Moodle 3.0}}
</nowiki></code>
{{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 [https://docs.moodle.org/all/es/Tablero tablero] contra la página de [https://docs.moodle.org/all/es/28/Tablero 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 ::<code><nowiki>{{Versiones}}</nowiki></code> para informar que  existen páginas separadas de documentación en Español para diferentes versiones (ramas) de Moodle.


==Pantallazos==
==Pantallazos==


* Le recomendamos que ilustre la documentación con imágenes de la pantalla (pantallazos). Por favor, emplee el [http://school.demo.moodle.net/ Sitio de demostración], u otro [https://docs.moodle.org/dev/Translating_Moodle_Docs#Translating_the_screen_images_used_in_Moodle_Docs empleando temas estándar], y asegurese de que el pantallazo es lo más razonablemente pequeño posible.
* Le recomendamos que ilustre la documentación con imágenes de la pantalla (pantallazos). Por favor, emplee el [http://school.demo.moodle.net/ Sitio de demostración], u otro [https://docs.moodle.org/dev/Translating_Moodle_Docs#Translating_the_screen_images_used_in_Moodle_Docs 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 [[Especial:Upload|Subir archivo]].
* Los pantallazos deben ser formatos GIF, JPEG o PNG, con resolución de 72ppi (puntos por pulgada), y un ancho máximo habitual de 800px.
* 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).
* Para hacer que quepa más información dentro de una captura de pantalla, seleccione  un menor tamaño de texto para la página web mediante el menú Vista > Tamaño de texto de su navegador de Internet (o use las teclas Control - para reducir y Control + para aumentar la resolución de pantalla.
* 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''.
* Las imágenes de pantalla pueden ser cargadas utilizando el enlace hacia la herramienta para [[Especial:Upload|Subir archivo]].
*Puede añadir su gráfico en el artículo mediante<code><nowiki>[[Image:nombre_del_pantallazo.gif]]</nowiki></code> o <code><nowiki>[[Image:nombre_del_pantallazo.gif|texto del comentario]]</nowiki></code>  
* Por favor use nombres descriptivos para las imágenes de pantalla en un artículo, use un enlace en la forma de <code><nowiki>[[Archivo:Screenshot.png|thumb|texto alterno]]</nowiki></code>.
**Puede añadir su gráfico en el artículo mediante<code><nowiki>[[Image:nombre_del_pantallazo.gif]]</nowiki></code> o <code><nowiki>[[Image:nombre_del_pantallazo.gif|texto del comentario]]</nowiki></code>  
* 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.
* 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.
* Usted puede replicar el aspecto del sitio demostrativo [http://school.demo.moodle.net/ Mount Orange School] con sus fondos anaranjados al duplicar [[Temas_estándar#Mount_Orange:_un_ejemplo_de_un_tema_.27M.C3.A1s.27_personalizado|las características de éste tema]] en su servidor local.
* Para ayuda sobre como colocar una imagen, por favor lea atentamente la documentación en [http://en.wikipedia.org/wiki/Wikipedia:Picture_tutorial Wikipedia:Picture tutorial] y en [http://es.wikipedia.org/wiki/Wikipedia:C%C3%B3mo_se_a%C3%B1aden_im%C3%A1genes Cómo añadir imágenes].
* Para ayuda sobre como colocar una imagen, por favor lea atentamente la documentación en [http://en.wikipedia.org/wiki/Wikipedia:Picture_tutorial Wikipedia:Picture tutorial] y en [http://es.wikipedia.org/wiki/Wikipedia:C%C3%B3mo_se_a%C3%B1aden_im%C3%A1genes Cómo añadir imágenes].
* Usted puede replicar el aspecto del Mount Orange School con sus fondos anaranjados duplicando [[Temas_estándar#Mount_Orange:_un_ejemplo_de_un_tema_.27M.C3.A1s.27_personalizado|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==
==Plantillas==
Línea 87: Línea 36:
* Por favor visite [http://meta.wikimedia.org/wiki/Help:Template MediaWiki Template help] para obtener más información sobre el uso de las plantillas.
* Por favor visite [http://meta.wikimedia.org/wiki/Help:Template 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===
* '''Por favor vea [[MoodleDocs:PlantillasTRANSLATION]] para conocer las plantillas útiles para trabajar en la traducción de Moodle Docs del inglés al Español.''
 
::<code><nowiki>{{Urgente de traducir}}</nowiki></code>
 
{{Urgente de 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.
 
::<code><nowiki>{{Pendiente de traducir}}</nowiki></code>
 
{{Pendiente de traducir}}
::Esta plantilla se utilizará para definir aquellas páginas prioritarias de la documentación en inglés que aún no hayan sido traducidas.
 
 
::<code><nowiki>{{Pendiente 2}}</nowiki></code>
 
{{Pendiente 2}}
::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:
 
::<code><nowiki>{{EnTraduccion}}</nowiki></code>
 
{{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.
 
::<code><nowiki>{{Ilustrar}}</nowiki></code>
 
{{Ilustrar}}
::Esta plantilla se debe utilizar para avisar al resto de usuarios de las Moodle Docs de que el [https://docs.moodle.org/dev/Translating_Moodle_Docs#Translating_the_screen_images_used_in_Moodle_Docs 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:
 
::<code><nowiki>{{Actualizar}}</nowiki></code>
 
{{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).
 
::<code><nowiki>{{chafa}}</nowiki></code>


{{chafa}}
==Marcas (tags) para editar Moodle Docs==
::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..
*[[MoodleDocs:Eliminar|Eliminar]] - Si Usted encuentra alguna página que necesite ser eliminada, escriba <code><nowiki>{{Eliminar}}</nowiki></code> en la parte superior de la página. Use los comentarios de la página si fuera necesario, para argumentar la razón para eliminarla.
*[[MoodleDocs:Actualizar|Actualizar]] - Cada nueva versión de Moodle tiene más características. Si Usted encuentra una página que necesita ser actualizada, escriba <code><nowiki>{{Actualizar}}</nowiki></code> en la parte superior de la página.
*[[:MoodleDocs:Esbozo|Esbozo]] - Los desarrolladores y los administradores de la Documentación de Moodle podrían añadir una nueva pagina que empieza con la marca de <code><nowiki>{{Esbozo}}</nowiki></code> en la parte superior, solicitando ayuda para aumentarle contenido.
*Usted también podría usar [[Help:Editing#Edit_summary|edit summary]] para comunicar la necesidad de más edición. Por ejemplo, en la historia de la página, Usted podría ver: "Sección añadida, necesita más trabajo, ver comentarios de la página".


::<code><nowiki>{{Frequently updated doc page|docpagetitle = Página_original_de_documentación_en_inglés}}</nowiki></code>
'''Por favor vea [[MoodleDocs:SPANISHissues]] para conocer otros aspectos y asuntos importantísimos para traducir la documentación de Moodle al idioma Español.'''
{{Frequently updated doc page
|docpagetitle = 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 ''[https://docs.moodle.org/30/en/Installing_Moodle Installing Moodle]'').


::<code><nowiki>{{Frequently updated page translation|devpagetitle = Página_original_de_documentación_para_DESARROLLADORES_en_inglés}}</nowiki></code>
== Resaltado de la sintaxis de PHP ==
{{Frequently updated page translation
|devpagetitle = 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, ''[https://docs.moodle.org/dev/Releases Releases]'').


===Plantillas que denotan páginas provisionales/iniciales/temporales===
* Para resaltar la sintaxis de [[PHP]], rodee al código con las marcas (tags):
* El equivalente del ''stub'' del idioma inglés:
<pre><nowiki><code php>... Código PHP aquí...</code></nowiki></pre>


::<code><nowiki>{{Esbozo}}</nowiki></code>
Lo cual se renderizará como:


{{Esbozo}}
<code php>
::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.
<?php
require_once(dirname(__FILE__) . '/../../config.php');


===Plantillas con notas importantes===
$cmid = required_param('cmid', 0, PARAM_INT);
::<code><nowiki>{{Nota2|Esta es una nota similar a las usadas en la documentación en Inglés para Moodle 2.x}}</nowiki></code>
if (!$cm = get_coursemodule_from_id('quiz', $id)) {
{{Nota2|Esta es una nota similar a las usadas en la documentación en Inglés para Moodle 2.x}}
    print_error('invalidcoursemodule');
}
...
</code>


::<code><nowiki>{{Nota3|Esta es una nota similar a las usadas en la documentación en Inglés para Moodle 3.x}}</nowiki></code>
* Para ejemplos más largos de código, Usted podría añadir '''numeración de líneas''' así:  
{{Nota3|Esta es una nota similar a las usadas en la documentación en Inglés para Moodle 3.x}}
<pre><nowiki><code php n>... Mucho mucho código PHP aquí...</code></nowiki></pre>


::<code><nowiki>{{Nota|Esta es una nota tal como actualmente están configuradas las notas en la documentación en idioma español}}</nowiki></code>
Lo cual se renderizará como:
{{Nota|Esta es una nota en la documentación en español de Moodle}}


::<code><nowiki>{{Notadeltraductor|Esta es una nota del traductor, que menciona ...}}</nowiki></code>
<code php n>
{{Notadeltraductor|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}}
<?php
require_once(dirname(__FILE__) . '/../../config.php');


===Plantilla usada para diferentes versiones de Moodle===
$cmid = required_param('cmid', 0, PARAM_INT);
if (!$cm = get_coursemodule_from_id('quiz', $id)) {
    print_error('invalidcoursemodule');
}
...
</code>


::<code><nowiki>{{Versiones|Esto es lo que Usted escribió sobre las diferentes versiones de documentación disponibles para Moodle 3.0, 2.x, 1.9...}}</nowiki></code>
Pero sea precavido, ¡la numeración de líneas hace que el copiar y pegar ejemplos de código sea más complicado!
{{Versiones|Esta página es la documentación para Moodle 3.0. Si desea ver la documentación antigua para Moodle 1.9 vaya a ...}}


Vea también la documentación sobre [https://docs.moodle.org/31/en/Code_syntax_highlighting Code syntax highlighting] que usa el filtro GeSHi (Generic Syntax Highlighter).


===Plantillas que denotan enlaces rotos en la documentación===
== Resaltado de la sintaxis de CSS ==
* Otros archivos para corregir:
[https://docs.moodle.org/all/es/Categor%C3%ADa:Páginas_con_enlaces_rotos_a_archivos https://docs.moodle.org/all/es/Categor%C3%ADa:Páginas_con_enlaces_rotos_a_archivos]


== Otros ==
* Para resaltar la sintaxis de CSS, encierre el código entre marcas (tags):
* 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.
<pre><nowiki><code css>... Un pedazo de código CSS aquí...</code></nowiki></pre>
* 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.
* Ejemploe:
* 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 [https://docs.moodle.org/all/es/MoodleDocs:Normas_para_colaboradores Normas para colaboradores] antes de editar la documentación.
<code css>
{{Notadeltraductor|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'.}}
.que .info .grade { display: none; }
</code>
* Usted puede ver muchos ejemplos de esto en la página en idioma Inglés de [https://docs.moodle.org/31/en/index.php?title=Quiz_FAQ&action=edit the Quiz FAQ Doc page].  
* Vea [https://docs.moodle.org/31/en/Code_syntax_highlighting Code syntax highlighting]


==Enlaces útiles para ayudar a traducir y actualizar la documentación en Español==
==DOCUMENTACIÓN ADICIONAL importantísima, pero exclusiva del idioma Español==
* Documentación en inglés de Moodle 3.1: [https://docs.moodle.org/31/en/Special:NewPages nuevas páginas] y [https://docs.moodle.org/31/en/Special:RecentChanges páginas con cambios recientes].
* '''Vea [[MoodleDocs:PlantillasSPANISH]] para conocer las plantillas especialmente hechas para el Español y que no se emplean en Moodle Docs en idioma Inglés.''' Especialmente tome nota de que ahora tenemos una '''Segmentación de la documentación en español''' para separar la documentación en Español de Moodle 3.x de la de Moodle 2.x y 1.x.
* Documentación en inglés de Moodle 3.0: [https://docs.moodle.org/30/en/Special:NewPages nuevas páginas] y [https://docs.moodle.org/30/en/Special:RecentChanges páginas con cambios recientes].
* '''Por favor vea [[MoodleDocs:PlantillasTRANSLATION]] para conocer las plantillas útiles para trabajar en la traducción de Moodle Docs del inglés al Español.''
* Documentación en inglés para desarrolladores: [https://docs.moodle.org/dev/Special:NewPages nuevas páginas] y  [https://docs.moodle.org/dev/Special:RecentChanges páginas con cambios recientes]
* '''Por favor vea [[MoodleDocs:SPANISHissues]] para acceder a los enlaces útiles para ayudar a traducir y actualizar la documentación en Español.'''
* las [https://docs.moodle.org/all/es/Categor%C3%ADa:Urgente_de_traducir páginas urgentes de traducir completamente al español].
* las [https://docs.moodle.org/all/es/Categor%C3%ADa:P%C3%A1ginas_que_requieren_actualizaci%C3%B3n páginas obsoletas en español que requieren actualizarse respecto al original actualizado en inglés].
* y las [https://docs.moodle.org/all/es/Categor%C3%ADa:Pendiente_de_traducir páginas pendientes de traducir total o parcialmente al español].


==Vea también==
*[[MoodleDocs:Desarrollo de Moodle Docs|Desarrollo de Moodle Docs]]
*[https://docs.moodle.org/all/es/MoodleDocs:P%C3%A1ginas_especiales Páginas especiales] de la documentación de Moodle en español


[[Category:MoodleDocs|Guía de Estilo]]
[[Category:MoodleDocs|Guía de Estilo]]

Revisión actual - 17:34 8 nov 2022


Note: Vea la content style guide (en inglés) nueva guía de estilo en idioma inglés.


Categorías

Una categoría es un índice de páginas de documentación.

  • Una página puede añadirse a una categoría al escribirle [[Categoria:Nombre_de_la_categoría]], como por ejemplo [[Categoría:Administración del sitio]], al final de la página. Muchas plantillas automáticamente categorizan a las páginas que usan la plantilla, por ejemplo [[Plantilla:Foro]] categoriza páginas dentro de la Categoría:Foro.
  • Para enlazar a una categoría Usted tiene que añadir un caracter de dos puntos de esta forma: [[:Categoría:FAQ]] lo que se mostrará como Categoría:FAQ.
  • Categorías enlista todas las categorías actualmente en uso en MoodleDocs en castellano. Esto puede encontrase en el enlace hacia las Páginas Especiales de Herramientas.
  • Para mayor información acerca de categorías y de como funcionan en MediaWiki, por favor refiérase a Wikipedia:Categorization.

Vea MoodleDocs:PlantillasSPANISH para conocer las plantillas especialmente hechas para el Español y que no se emplean en Moodle Docs en idioma Inglés. Especialmente tome nota de que ahora tenemos una Segmentación de la documentación en español para separar la documentación en español de Moodle 3.x de la de Moodle 2.x y 1.x.

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 formatos GIF, JPEG o PNG, con resolución de 72ppi (puntos por pulgada), y un ancho máximo habitual de 800px.
  • Para hacer que quepa más información dentro de una captura de pantalla, seleccione un menor tamaño de texto para la página web mediante el menú Vista > Tamaño de texto de su navegador de Internet (o use las teclas Control - para reducir y Control + para aumentar la resolución de pantalla.
  • Las imágenes de pantalla pueden ser cargadas utilizando el enlace hacia la herramienta para Subir archivo.
  • Por favor use nombres descriptivos para las imágenes de pantalla en un artículo, use un enlace en la forma de [[Archivo:Screenshot.png|thumb|texto alterno]].
    • 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.
  • Usted puede replicar el aspecto del sitio demostrativo Mount Orange School con sus fondos anaranjados al duplicar las características de éste tema en su servidor local.
  • 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.

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.

Marcas (tags) para editar Moodle Docs

  • Eliminar - Si Usted encuentra alguna página que necesite ser eliminada, escriba {{Eliminar}} en la parte superior de la página. Use los comentarios de la página si fuera necesario, para argumentar la razón para eliminarla.
  • Actualizar - Cada nueva versión de Moodle tiene más características. Si Usted encuentra una página que necesita ser actualizada, escriba {{Actualizar}} en la parte superior de la página.
  • Esbozo - Los desarrolladores y los administradores de la Documentación de Moodle podrían añadir una nueva pagina que empieza con la marca de {{Esbozo}} en la parte superior, solicitando ayuda para aumentarle contenido.
  • Usted también podría usar edit summary para comunicar la necesidad de más edición. Por ejemplo, en la historia de la página, Usted podría ver: "Sección añadida, necesita más trabajo, ver comentarios de la página".

Por favor vea MoodleDocs:SPANISHissues para conocer otros aspectos y asuntos importantísimos para traducir la documentación de Moodle al idioma Español.

Resaltado de la sintaxis de PHP

  • Para resaltar la sintaxis de PHP, rodee al código con las marcas (tags):
<code php>... Código PHP aquí...</code>

Lo cual se renderizará como:

<?php require_once(dirname(__FILE__) . '/../../config.php');

$cmid = required_param('cmid', 0, PARAM_INT); if (!$cm = get_coursemodule_from_id('quiz', $id)) { 

   print_error('invalidcoursemodule');

} ...

  • Para ejemplos más largos de código, Usted podría añadir numeración de líneas así:
<code php n>... Mucho mucho código PHP aquí...</code>

Lo cual se renderizará como:

<?php require_once(dirname(__FILE__) . '/../../config.php');

$cmid = required_param('cmid', 0, PARAM_INT); if (!$cm = get_coursemodule_from_id('quiz', $id)) { 

   print_error('invalidcoursemodule');

} ...

Pero sea precavido, ¡la numeración de líneas hace que el copiar y pegar ejemplos de código sea más complicado!

Vea también la documentación sobre Code syntax highlighting que usa el filtro GeSHi (Generic Syntax Highlighter).

Resaltado de la sintaxis de CSS

  • Para resaltar la sintaxis de CSS, encierre el código entre marcas (tags):
<code css>... Un pedazo de código CSS aquí...</code>
  • Ejemploe:

.que .info .grade { display: none; }

DOCUMENTACIÓN ADICIONAL importantísima, pero exclusiva del idioma Español

  • Vea MoodleDocs:PlantillasSPANISH para conocer las plantillas especialmente hechas para el Español y que no se emplean en Moodle Docs en idioma Inglés. Especialmente tome nota de que ahora tenemos una Segmentación de la documentación en español para separar la documentación en Español de Moodle 3.x de la de Moodle 2.x y 1.x.
  • 'Por favor vea MoodleDocs:PlantillasTRANSLATION para conocer las plantillas útiles para trabajar en la traducción de Moodle Docs del inglés al Español.
  • Por favor vea MoodleDocs:SPANISHissues para acceder a los enlaces útiles para ayudar a traducir y actualizar la documentación en Español.
Obtenido de «https://docs.moodle.org/all/es/index.php?title=MoodleDocs:Guía_de_Estilo&oldid=55094»
Powered by MediaWiki