Diferencia entre revisiones de «Ayuda:Guía para editores»

De wiki EOI de documentación docente
Saltar a: navegación, buscar
(Formularios y wiki semántico)
(Si has trabajado con el procesador de textos)
Línea 94: Línea 94:
 
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.
 
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 '''[http://es.libreoffice.org/ LibreOffice]''' y '''[http://www.openoffice.org/es/ 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.
+
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 '''[http://es.libreoffice.org/ LibreOffice]''' y '''[http://www.openoffice.org/es/ OpenOffice]''' (programas libres y gratuitos que puedes descargar e instalar y en los que puedes abrir los archivos escritos en otros procesadores de texto como ''Microsoft Word'') 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.
 +
 
 +
Algunas versiones de ''OpenOffice'' (anteriores a 3.3) requieren de la instalación de una extensión (''Wiki Publisher'') para que la opción de exportación esté disponible. Existe también una [http://www.microsoft.com/download/en/details.aspx?id=12298 extensión] para ''Microsoft Word''. Hay información sobre el paso de procesadores de textos a formato ''wikitext'' aquí: [http://es.wikipedia.org/wiki/Ayuda:Recursos_para_Wikipedia#Conversi.C3.B3n_de_documentos_a_wikitexto Conversión de documentos a wikitexto (''Wikipedia en español'')].
 +
 
 +
Estos sistemas de conversión '''no incluyen''' en ningún caso '''las imágenes'''. Si tienes imágenes en tu documento de texto deberás cargarlas de nuevo al wiki e insertarlas en el texto posteriormente (o incorporarlas en la barra lateral con el formulario). Quizás puedes marcar en el texto dónde hay imágenes con un texto destacado en mayúsculas para luego ir retirándolo e incorporándolas. Algunos conversores ya dejan una señal escribiendo <nowiki>[[Image:]]</nowiki> dónde encuentran una imagen.
 +
 
 +
Los conversores de procesador de textos '''no conservan todos los estilos y formatado''', sólo aquellos que son soportados por el wiki. Así podemos esperar que adapte a '''wikitext''':
 +
* '''Las negritas y cursivas'''
 +
* '''Las listas''' por puntos o números. Y también las listas anidadas.
 +
* '''Los títulos o encabezados''' respetando su jerarquía (si se han usado los estilos para definirlos)
 +
* '''Los enlaces externos''' a páginas web (atención: no los enlaces a documentos contiguos en el disco duro)
 +
* '''Las tablas''' de filas y columnas, incluso los colores de las celdas.
 +
De todas formas habrá que repasar el texto una vez publicado, porqué los conversores pueden fallar en algún punto. Merece la pena saber algo de [[Ayuda:Contenidos#Edición_con_wikitext|wikitext]] para repasarlo y corregirlo.
  
 
:'''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.
 
:'''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.
 +
 +
=== Convertir HTML a wikitext ===
 +
Existen algunos conversores de etiquetas HTML a ''wikitext'' que pueden ser útiles:
 +
* [http://bmanolov.free.fr/html2wiki-tables.php html2wiki-tables]: programa online para convertir tablas HTML a wikitext. Pegas la tabla en HTML y luego copias el texto en wikitext para pegarlo en el wiki.
 +
* [http://search.cpan.org/~diberri/HTML-WikiConverter-0.68/lib/HTML/WikiConverter.pm HTML-WikiConverter]: un programa (que hay que descargar) que convierte etiquetas HTML a una ámplia variedad de lenguajes wiki, entre ellos ''wikitext'' de ''MediaWiki''
  
 
=== Los títulos ===
 
=== Los títulos ===

Revisión del 10:13 9 ene 2012

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 como Microsoft Word) 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.

Algunas versiones de OpenOffice (anteriores a 3.3) requieren de la instalación de una extensión (Wiki Publisher) para que la opción de exportación esté disponible. Existe también una extensión para Microsoft Word. Hay información sobre el paso de procesadores de textos a formato wikitext aquí: Conversión de documentos a wikitexto (Wikipedia en español).

Estos sistemas de conversión no incluyen en ningún caso las imágenes. Si tienes imágenes en tu documento de texto deberás cargarlas de nuevo al wiki e insertarlas en el texto posteriormente (o incorporarlas en la barra lateral con el formulario). Quizás puedes marcar en el texto dónde hay imágenes con un texto destacado en mayúsculas para luego ir retirándolo e incorporándolas. Algunos conversores ya dejan una señal escribiendo [[Image:]] dónde encuentran una imagen.

Los conversores de procesador de textos no conservan todos los estilos y formatado, sólo aquellos que son soportados por el wiki. Así podemos esperar que adapte a wikitext:

  • Las negritas y cursivas
  • Las listas por puntos o números. Y también las listas anidadas.
  • Los títulos o encabezados respetando su jerarquía (si se han usado los estilos para definirlos)
  • Los enlaces externos a páginas web (atención: no los enlaces a documentos contiguos en el disco duro)
  • Las tablas de filas y columnas, incluso los colores de las celdas.

De todas formas habrá que repasar el texto una vez publicado, porqué los conversores pueden fallar en algún punto. Merece la pena saber algo de wikitext para repasarlo y corregirlo.

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.

Convertir HTML a wikitext

Existen algunos conversores de etiquetas HTML a wikitext que pueden ser útiles:

  • html2wiki-tables: programa online para convertir tablas HTML a wikitext. Pegas la tabla en HTML y luego copias el texto en wikitext para pegarlo en el wiki.
  • HTML-WikiConverter: un programa (que hay que descargar) que convierte etiquetas HTML a una ámplia variedad de lenguajes wiki, entre ellos wikitext de MediaWiki

Los títulos

Los títulos que damos a los capítulos o secciones determinan los títulos que sus páginas tendrán en el wiki y sirven también para generar los índices o para recuperar páginas para poder navegar hacia el anterior o el siguiente.

Para no confundir al lector es importante que los títulos sigan algunas pautas comunes en todos los wikilibros. La estructura de un wikilibro es, como se ha mencionado, la siguiente: Wikilibro > Capítulo > Sección > Apartado. Aunque puedan gustarnos más otras denominaciones por cada unidad de contenido (como Tema o Módulo) no las vamos a usar, en pro de la claridad estructural de los wikilibros de cara los lectores.

Así no pondremos, por ejemplo:

Tema 1 Igualdad de oportunidades entre hombres y mujeres

En su lugar simplemente vamos a escribir:

Igualdad de oportunidades entre hombres y mujeres

Tampoco debemos incluir "Capítulo" o "Sección" dentro de un título. El título es sólo el título. Automáticamente ese título se convertirá en un nombre de página o un título de índice añadiendo lo que haga falta.

Así no pondremos, por ejemplo:

Capítulo 1 Igualdad de oportunidades entre hombres y mujeres

En su lugar simplemente vamos a escribir:

Igualdad de oportunidades entre hombres y mujeres

Y en vez de:

Sección 1 La función

Debemos escribir simplemente:

La función

El orden de capítulos y secciones

Para definir el orden de los capítulos o secciones en sus formularios hay un campo para numerarlos. Ese campo siempre se puede cambiar (por si es necesario re-ordenarlos). El valor de ese campo siempre tiene que ser un número entero.

Así no debemos usar cosas como:

2.

ni tampoco:

1.2

ni tampoco:

a

Usaremos en cambio simplemente (sin letras, ni puntos, ni ningún otro signo que no sea un número entero):

1

o bien

2


La numeración de capítulos y secciones en los índices se crea automáticamente a partir de los datos que hay en esos campos.

En la sección 2 del capítulo 1 no pondremos

1.2

sólo escribiremos

2

ya que al decirle a qué capítulo pertenece internamente ya está identificado qué número tiene (y además puede cambiar si se cambia el orden de los capítulos).

Mayúsculas y minúsculas

Para seguir un criterio común por lo que respecta al uso de mayúsculas y minúsculas, vamos a usar las pautas de ortotipografía propias del castellano[1]:

  • Mayúscula en la primera palabra de un título
  • Minúscula en el resto de palabras si no son nombres propios o de lugar
  • Mayúscula para las siglas de una organización

Así no escribiremos:

LA FUNCIÓN

en su lugar escribiremos:

La función


Y no escribiremos:

La Función

en su lugar escribiremos (sólo mayúscula en la primera letra):

La función


Y no escribiremos:

Igualdad de Oportunidades entre Hombres y Mujeres

En su lugar vamos a escribir (sólo mayúscula en la primera letra):

Igualdad de oportunidades entre hombres y mujeres


Y podemos escribir:

Sinergias en el caso de Silicon Valley

O bien:

La aportación del CSIC

Como se genera un nombre de página

Cuando guardamos un formulario por primera vez estamos generando una página del wiki. Automáticamente se genera un nombre para esa página (que es el que sale en el título en la parte superior). Ese nombre se genera a partir de lo que hemos escrito en el campo Título del formulario y, en el caso de capítulos y secciones, a partir del título del wikilibro al que pertenecen.

Así los nombres de página resultantes son del tipo:

La función en Diseño

O sea que el formulario toma el título que hemos puesto (La función) y le añade la preposición en seguida del nombre el wikilibro del que forma parte (Diseño).

¿Por qué? Pues porqué no puede haber en el wiki dos páginas con el mismo nombre y, para evitarlo, debemos crear títulos distintos.

Es por eso que no puedes usar el mismo título para dos capítulos del mismo wikilibro y tampoco puedes usar el mismo título para dos secciones del mismo wikilibro aunque sean de capítulos distintos.

Cambiar un título

Para cambiar un título debemos hacer dos cosas:

  1. Abrir el formulario y cambiar el título en el campo correspondiente
  2. En la propia página ir a la pestaña desplegable (la del triángulo) y elegir la opción Mover y cambiar el nombre de la página
Atención procurad que el texto que ponemos en el formulario sea el mismo que la parte correspondiente al título en el nombre de página.

Si lo que cambiamos es el título de un capítulo tendremos que preocuparnos además de ir a todas sus secciones, abrir el formulario y cambiar el campo Del capítulo para que no se pierda la relación. Y además tendremos que usar también la opción Mover para cambiar el título del capítulo en el nombre de página de la sección.

Eso es porqué el formulario genera un nombre de página la primera vez, pero cuando editamos con formulario una página ya creada no cambia ya su nombre, aunque cambiemos los campos referentes a su título o al del capítulo del que forma parte.

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.

Forzar actualización de listados

Que usemos esa tecnología de wiki semántico permite que se creen automáticamente los listados de contenidos en las portadas de wikilibros o de capítulos. También que los cambios en los wikilibros se muestren en portada.

Pero esos listados no se actualizan instantáneamente, en algunos casos pueden tardar varios minutos. Pero hay una forma de forzar la actualización de los listados: ir a la pestaña desplegable en la parte superior derecha de la página (la del triángulo) y elegir la opción Actualizar. Eso forzará a la petición semántica a actualizar la recuperación de páginas para el listado.