Ayuda:Guía para editores

De wiki EOI de documentación docente
Saltar a: navegación, buscar
UnderwoodKeyboard.jpg

Esta es una guía para autores y cualquier persona que edite los contenidos de este wiki. Intenta ser una explicación detallada de como trabajar en él. Si empiezas por leerla completa y, en paralelo, pruebas de abrir los formularios en los que vas a trabajar, tendrás una visión global de como hacerlo. Si crees que te apañas siguiendo la ayuda en línea que hay en los propios formularios no es necesario que la leas para trabajar, pero puede servirte como referencia de consulta si tienes alguna duda.

Crear contenido

Wikilibro

Un wikilibro de documentación docente es un conjunto organizado de contenidos sobre una materia creado mediante páginas de este wiki.

Un wikilibro tiene:

  1. una portada
  2. varios capítulos
  3. varias secciones con sus apartados

Dónde realmente tienes que escribir los contenidos es en las páginas de secciones pero previamente debe existir una portada del wikilibro y una portada del capítulo del que forma parte esa sección.

Un wikilibro puede tener uno o varios autores que pueden trabajar conjuntamente o repartirse el trabajo por capítulos o secciones, dependiendo de cada materia y de cada encargo.

Crear un wikilibro

Para crear un wikilibro el primer paso es crear una portada. Probablemente cuando recibas el encargo de autoría y accedas al wiki la portada del libro en el que vas a trabajar ya esté creada. Encontrarás un enlace en la Página principal o bien en la lista de Wikilibros. Busca el título del libro en el que vas a trabajar y clica el enlace.

Si el libro no tuviera portada habría que crearla pulsando este botón y rellenando el formulario:

Si la portada ya estaba creada y has accedido a ella puedes completar la información editándola mediante la pestaña Editar con formulario que aparece en la parte superior de la página.

La información que obligatoriamente debe tener una portada de wikilibro es la siguiente:

  • Un título (que tiene que ser distinto a otros wikilibros)
  • El estado de desarrollo del libro (que por defecto es esbozo)

Además puede tener:

  • Una breve presentación escrita
  • Una imagen de portada
  • Una lista de los autores más relevantes
  • Unas etiquetas o expresiones clave para relacionarlo con otros contenidos

Si estás empezando un wikilibro puedes dejar estos contenidos opcionales para completarlos cuando el trabajo esté más avanzado.

Atención: no es recomendable cambiar el título de un libro una vez creado. Si debes hacerlo consulta Cambiar títulos

Crear un capítulo

Probablemente hayas definido y acordado una estructura del material en módulos o capítulos. Para crear un capítulo tienes que crear una subportada para el mismo. En la portada del wikilibro encontrarás un botón para

... que, a diferencia de este que sirve como ejemplo, sí funciona y te abrirá un formulario. Con él podrás crear una portada de capítulo.

La información que obligatoriamente debe tener una portada de capítulo es la siguiente:

  • Un título (que tiene que ser distinto a otros capítulos del mismo wikilibro)
  • El título del libro del que forma parte (a elegir en un listado de los ya creados)
  • El estado de desarrollo del capítulo (que por defecto es esbozo)

Además puede tener:

  • El número de capítulo dentro del libro (no es imprescindible pero es importante para que salga ordenado, en cualquier momento puede cambiarse para reordenar los capítulos)
  • Un resumen del contenido del capítulo (puedes redactarlo una vez esté avanzado el trabajo en las secciones y apartados del capítulo)

Una vez creada una subportada de capítulo esta saldrá enlazada en el índice de contenido de la portada del wikilibro. La subportada de capítulo puede re-editarse para completar o cambiar datos usando la pestaña Editar con formulario que aparece en la parte superior de la página.

Más allá del resumen en la subportada del capítulo no hay contenido propiamente dicho, sirve para agrupar las páginas de secciones que es dónde realmente está el contenido.

Crear una sección

Las páginas de sección son las páginas dónde está el contenido docente dentro de un capítulo. Esas páginas se pueden dividir en apartados que son unidades de contenido dentro de la misma página. El número de apartados y la extensión de los mismos depende de cada wikilibro y de sus autores. Pero si estás creando una página muy extensa considera la posibilidad de dividir la sección en dos o más.

En la subportada del capítulo encontrarás un botón para crear una sección nueva...

... que, a diferencia de este que sirve como ejemplo, sí funciona y te abrirá un formulario. Con él podrás crear una página de sección.

La información que obligatoriamente debe tener una página de sección es la siguiente:

  • Un título (que no puede ser el mismo del capítulo y que tiene que ser distinto a otras secciones del mismo wikilibro)
  • El título del capítulo del que forma parte (a elegir en un listado de los ya creados, es posible cambiar una sección de capítulo posteriormente si hay que re-ordenar la estructura del libro)
  • El título del libro del que forma parte (a elegir en un listado de los ya creados)
  • El estado de desarrollo de la sección (que por defecto es esbozo)

Además debería tener:

  • El número de la sección dentro del capítulo (no es imprescindible pero es importante para que salga ordenado, en cualquier momento puede cambiarse para reordenar las secciones)
  • Una presentación o apartado introductorio (que se mostrará en el encabezado)
  • Los apartados propiamente dichos, con los contenidos de la sección

Una vez creada la página de una sección esta saldrá enlazada en el índice de contenido de la subportada del capítulo al que ha sido asignada. La página de sección puede re-editarse para completar o cambiar datos usando la pestaña Editar con formulario que aparece en la parte superior de la página.

Crear apartados

Los apartados no son páginas independientes, están juntos en la misma página de sección. Para crear y editar apartados se usa el mismo formulario que para crear una sección.

Ese formulario tiene una pestaña "Apartados" desde la que se pueden crear con el botón Agregar otro.

Un apartado tiene:

  • Un título
  • Un número dentro de la sección
  • Un contenido principal, mayoritáriamente escrito
  • Una columna lateral con recursos multimedia (imágenes, vídeos, sonido)

Al clicar el botón Agregar otro se muestra una parte del formulario para rellenar estos contenidos. Para añadir más apartados hay que clicar el botón Agregar otro tantas veces como sea necesario.

La parte de contenido principal está pensada para el contenido escrito. Pero admite codificación wikitext, por lo que si la conoces puedes dar el formato que quieras y añadir otros contenidos.

La columna lateral admite hasta 4 imágenes y 4 archivos audiovisuales de vídeo o sonido.

Si has trabajado con el procesador de textos

Puede que hayas estado redactando previamente con un procesador de textos (como Microsoft-Word, OpenOffice, LibreOffice, iWork Pages). Para incorporar al wiki el contenido que ya tienes escrito bastará con ir copiando y pegando por partes el texto en las secciones y apartados.

Si quieres conservar el formato básico de texto que tienes en el procesador (negritas, cursivas, listas, ...) puedes usar la exportación a formato MediaWiki que tienen algunos procesadores. En LibreOffice y OpenOffice (programas libres y gratuitos que puedes descargar e instalar y en los que puedes abrir los archivos escritos en otros procesadores de texto) desde el menú Archivo elige la opción Exportar y en ella el formato MediaWiki (.txt). Al guardar generará un fichero de texto simple en el que el formato de texto del procesador se ha convertido a la sintaxis wikitext. Pegándolo en el campo de texto del apartado en el formulario de una sección, deberías conseguir un texto con aspecto similar al que tenías en el procesador.

Atención: si trabajáis varios autores en una misma sección o apartado es mejor escribir directamente en el wiki ya que tendréis todas las versiones y además está preparado para detectar un conflicto de ediciones en caso que estéis trabajando simultáneamente. Si trabajáis en colaboración y no tenéis bien delimitadas las secciones en las que cada cual trabaja es mejor no escribir aparte y copiar después porqué podrías eliminar lo que otro ha hecho.

Formularios y wiki semántico

Un wiki con formularios

Este wiki usa distintos formularios que facilitan la creación y edición de las páginas. Básicamente hay 3 tipos de formularios para funciones que ya hemos explicado:

  • Para crear un wikilibro
  • Para crear un capítulo
  • Para crear una sección y sus apartados.

Los formularios nos ayudan a estructurar los contenidos y a tener diversas páginas con un aspecto común. Como guardamos los datos que escribís en los campos de los formularios es posible agrupar lo que en realidad son páginas de un mismo wiki como secciones y capítulos de un wikilibro en concreto.

Este wiki es Web Semántica

El wiki wiki EOI de documentación docente usa tecnología de web semántica. En la práctica eso significa que podemos etiquetar algunas expresiones que usamos en las páginas de forma que podemos establecer relaciones entre los contenidos. Si etiquetamos adecuadamente, el programa que hace funcionar el wiki podrá crear listados y mostrarnos información de forma automática. Los formularios aprovechan esta tecnología.

Aunque en la práctica como editor no es algo de lo que te tengas que preocupar, sólo rellena los campos de los formularios y eso ya funcionará automáticamente.