MoodleDocs:Guía de Estilo

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.

'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.

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; }

Usted puede ver muchos ejemplos de esto en la página en idioma Inglés de the Quiz FAQ Doc page.
Vea Code syntax highlighting

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.

Documentation