Ayuda

La mayor parte de la información aquí recogida viene de la documentación de Oddmuse siendo esto un glosario para tener agrupadas las principales cuestiones a la hora de usar y administrar esta wiki.

  1. Ayuda general al usuario
  2. Ayuda para los editores
  3. Ayuda para el administrador

Ayuda general al usuario

Qué es un wiki

Los wikis sirven para documentar de forma sencilla y además facilitan la colaboración y la búsqueda de información. Son como un gran bloc de notas donde todo el mundo puede colaborar y corregir, solo que un wiki permite hacerlo todo más rápido y fácil, de ahí su nombre porque en Hawaii Wikiwiki significa rápido.

Qué información se guarda en esta wiki

Se crearán artículos según los intereses de cada editor, por lo tanto la que les parezca interesante a los editores.

Perfiles de usuario

Existen tres niveles de acceso: visitantes, editores y administradores.

Cómo comentar

Cada página de esta wiki permite dejar comentarios. Cualquier usuario incluso los visitantes pueden comentar (siempre que esa página no esté bloqueada), para ello pulsar al final de la página en el enlace Comentarios en. Para dejar un comentario habrá que responder una pregunta sencilla, esto se hace para evitar bots spammers que dejan basura en los comentarios. Algunas páginas podrían no permitir comentarios, eso es porque se han bloqueado. El administrador es el único que puede bloquear páginas.

Abusos

Si detectas cualquier tipo de abuso, spam, etc puedes contactar con el administrador o enviar un correo a abuse arroba boimboim punto com.

Ayuda para los editores

Para editar contenido ve al pie de la página y pincha en Iniciar sesión, luego introduce la password de editor. Si estás en un ordenador público al terminar es importante que no se te olvide pinchar en Cerrar sesión.

Si no tienes claro un concepto de los aquí expuestos hay una zona de pruebas donde hacer experimentos.

Creole

Esta wiki permite usar el lenguaje de marcado Creole con el que podemos enriquecer el texto con cabeceras, enlaces, listas, etc. Esta es la plantilla oficial de Creole con los principales elementos:

Plantilla Creole

HTML en bruto: cuando Creole no es suficiente

Si Creole se queda corto se puede añadir código html directamente dentro de las etiquetas <html></html>. Por ejemplo, se podría hacer así en cualquier punto de la página:

<html>
<!-- Codigo html-->
<h3>Ejemplo de subcabecera</h3>
<blockquote>solo se que no se nada</blockquote>
<code>print "oddmuse";</code>
</html>

Enlaces

[[ruta destino|display "texto alternativo usabilidad"]]

Por ejemplo:

[[destino]]
[[destino|texto]]
[[destino|"texto" "texto alternativo"]]
[[destino#ancla]]
[[#ancla_en_misma_pagina]]

Anclas

Para definir anclas [:nombreancla] el nombre debe ser único. Cómo referenciarlas se detalla en el apartado enlaces.

Por ejemplo, un ancla y un par de enlaces al mismo:

[:nancla]
[[pagina#nancla|enlace a ancla]]
[[#nancla|ir a ancla]]

Subir y referenciar imágenes

Cómo subir imágenes

Existen dos tipos de imágenes según la forma de almacenamiento físico:

  1. página de imagen: Es una página wiki con la imagen volcada en bruto y un comentario o descripción. Normalmente tienen valor documental, es parte de la información que hay en la wiki pero en formato imagen. Cualquier editor puede crear una página de este tipo creando una nueva, pero hay que seleccionar la opción Reemplazar este texto con un archivo, luego seleccionar el archivo con la imagen a subir y añadir una descripción.
  2. fichero de imagen: Son ficheros de imágenes normalmente con extensión .png o .jpg. Tienen que guardarse dentro del directorio images. Dentro, en el directorio static si son parte del diseño y pictures para documentos de tipo imagen. Estos ficheros solo se pueden subir por el administrador ya que se necesitan permisos especiales.

Las imágenes no deben pesar más de 300 KB. Para reducir peso puedes probar a escalarla, reducirla, reducir calidad, probar con un nivel de compresión más alto... El formato png es el recomendable para esta wiki porque es libre y más avanzado, pero el formato jpg suele pesar menos, si no ves la forma de reducir el peso de la imagen puedes intentar a exportarla a jpg.

Cómo referenciar imágenes

Usar la sintaxis de Image Extension, entra para obtener información detallada ya que se pueden hacer muchas cosas como enlazar recursos externos, aplicar estilos personalizados, textos alternativos y mucho más. Por ejemplo:

[[image external: pictures/retrato.png|Alguien muy feo]]-> Mostrar una imagen del directorio de imágenes.
[[image:pagina_imagen]]-> Se visualiza una imagen que es un enlace a la página imagen.
[[image:pagina_imagen|texto alternativo]] -> Mejora la accesibilidad para aquellos agentes que no pueden ver imágenes.

El fichero css de esta wiki tiene clases para especificar posición (left, center, right) y tamaño (small, med) con image:/posicion/tamaño: Si no se especifica posición la imagen se coloca a la izquierda pero no es flotante, es decir, pueden alinearse otras imágenes, pero el texto se va a abajo. Si no se especifica tamaño se usa el original. Varios ejemplos:

[[image/left:pagina_imagen]] -> se coloca a la izquierda. Si hubiera texto quedará alrededor.
[[image/center:pagina_imagen]] -> se coloca la imagen en el centro.
[[image/right:pagina_imagen]] -> se coloca a la derecha. Si hubiera texto quedará alrededor.
[[image/small:pagina_imagen]] -> se coloca a la izquierda no flotante en tamaño pequeño.
[[image/right/med:pagina_imagen|mi gato]] -> se coloca a la derecha flotante y en tamaño mediano.

Borrar páginas

Poner en la primera línea ¡Borrada! y esperar un tiempo prudencial de unos días a que se marque como borrada.

Páginas privadas o protegidas

Los editores pueden proteger una página con una contraseña y solo las podrá visitar el que la conozca. Una página admite varias passwords y estas passwords solo funcionarán en esa página.

Para marcar una página como privada con contraseña poner #PASSWORD y la contraseña en la primera línea.

#PASSWORD PWD1 PWD2

Este ejemplo, asignaría dos passwords de acceso: PWD1 y PWD2.

Redirecciones

Se puede hacer que una página redirija a otra mediante con la etiqueta #REDIRECT.

#REDIRECT [[pagina]]

Cambiar título y subtítulo.

Por defecto se el título y nombre de una página son el mismo pero en ocasiones queremos asignar un título distinto. Esto nos vendrá bién para nombres de páginas que dan lugar a títulos poco descriptivos. Para hacer esto añadir al principio del documento:

<html> <pre class="real"> #TITLE Nuevo título #SUBTITLE Subtitulo </pre> </html> El título es el titular de la página (atributos <title> y <h1> en xhtml). Subtitle genera un párrafo adicional debajo del título (un párrafo con la clase subtitle). Ambas son opcionales por lo que se puede usar solo una de ellas.

Un caso de uso importante: se recomienda nombrar las páginas sin caracteres especiales (tildes, eñes, etc) ya que podría dar problemas a algún agente (navegadores, buscadores y otros). Un ejemplo real es la página de León se llama Leon, pero tiene asignado el título con tilde. Lo mismo ocurre con Inés que su página y usuario se llaman Ines.

Ayuda para el administrador

¿Quién es el administrador?

Solo hay un administrador principal y existe una página administrador que se redirige a su página personal, así se puede saber quién es y contactar él. Es importante actualizar esta redirección si cambia el administrador.

Instalación usando el servidor web Apache

Si tenemos un directorio reservado para CGIS e puede copiar el script allí. Otra forma que he encontrado satisfactoria es en un directorio exclusivo y habilitando CGI, luego redirigimos al nombre del fichero Oddmuse (en este caso wiki.pl), para que sea el script quien procese las peticiones. Luego Habilitamos DirectoryIndexRedirect para que apache devuelva wiki.pl en la url:

   Options +ExecCGI
   AddHandler cgi-script .pl
   DirectoryIndexRedirect on
   DirectoryIndex wiki.pl

Para procesar parámetros en URI HTTP a partir del símbolo parámetro (?) y no mediante falsos directorios (símbolo /), poner $UsePathInfo a 0.

Fichero de configuración y separación de variables

Oddmuse permite asignar sus propias variables dentro del propio script y además en un fichero externo. Si se activa el uso de fichero de configuración primero se asignan las variables dentro del script y luego se sobrescriben los valores definidos dentro del fichero de configuración. Esto es muy útil para actualizar el script a nuevas versiones sin perder la configuración del mismo.

Para activar el fichero de configuración: our $UseConfig //= 1;

Por defecto el fichero de configuración se ubica en el directorio de trabajo y se llamará config, aunque se puede cambiar mediante la variable en Oddmuse $ConfigFile o la variable de entorno $WikiConfigFile (esta última tiene prioridad).

Si necesitamos usar caracteres UTF8 (como acentos, etc), debemos poner esta línea al principio del fichero de configuración:

use utf8;
#resto de configuraciones...

Instalación de módulos y módulos más importantes

Referenciación de imágenes para los editores

Para que los usuarios puedan referenciar imágenes y páginas de imágenes se debe instalar el módulo Image Extension y además se han creado las siguientes clases CSS:

.image.right {float: right;margin-left:10px;}
.image.left {float: left;margin-right:10px;}
.small img{width:10%;}
.med img{width:20%;}
a.image.center {padding: 1em 3em;margin: 1em 33%;}

Habilitar "HTML en bruto"

Para permitir a los usuarios insertar directamente código HTML, hay que modificar el código de Oddmuse tal como explica la documentación de Oddmuse.

Para ello en el script añadir en @MyRules la función RawHtmlRule y declararla, usamos push tal como nos indica el comentario:

#Eliminar el comentario de la línea 6 si queremos que solo se pueda usar html 
#en bruto en páginas bloqueadas.
our @MyRules = (\&LinkRules, \&ListRule); # don't set this variable, add to it!
push(@MyRules, \&RawHtmlRule);
sub RawHtmlRule {
  if (#-f GetLockedPageFile($OpenPageName) and 
    m/\G\&lt;html\&gt;(.*?)\&lt;\/html\&gt;/cgs) {
    return UnquoteHtml($1);
  }
  return;
}

Gestionar abusos

Ante hosts que abusan se debe bannear añadiendo el host a la página BannedHosts (fijada en la variable $BannedHosts). También se ha puesto $BannedCanRead a 0. Se banneran por contenido aquellas entradas que coincidan con las indicadas en la página BannedContent.

también habilitar siempre $SurgeProtection (habilitada por defecto).