Formatos de la Wiki

Enlaces

Enlaces de Redmine

Redmine permite hipervínculos entre los temas, de cambios y las páginas wiki de formato wiki se utiliza en cualquier lugar.

  • Enlace a un tema: #124 (muestra #124, el enlace está tachado si la petición está cerrada)
  • Enlace a cambios: r758 (muestra r758)
  • Enlace a cambios con ID no numérico: commit:c6f4d0fd (muestra c6f4d0fd).

Enalces de la Wiki:

  • [[Guía]] se muestra un enlace a la página denominada "Guía": Guía
  • [[Guía#leer-mas]] lleva a "leer más". Los encabezados toman automáticamente los anclajes para que puedan ser referidos: Guía
  • [[Guía|Manual de Usuario]] se muestra un enlace a la misma página, pero con un texto diferente: Manual de Usuario

También puede vincular a las páginas de un wiki de otro proyecto:

  • [[sandbox:alguna página]] muestra el enlace a la página llamada "alguna página" de la Wiki Sandbox
  • [[sandbox:]] se muestra un enlace a la página principal de la Wiki Sandbox

Los Enlaces de la Wiki son mostrados en rojo si la página aún no existe: Página no existente.

Enlaces a otros recursos:

  • Documentos:
    • documento#17 (enlace al documento con id 17)
    • documento:Saludos (enlace al documento con el título "Saludos")
    • document:"Algún documento" (comillas dobles deben ser usadas cuando el título del documento contenga espacios)
  • Versiones:
    • version#3 (enlace a la versión con id 3)
    • version:1.0.0 (enlace a la versión llamada "1.0.0")
    • version:"1.0 beta 2"(comillas dobles deben ser usadas cuando la versión contenga espacios)
  • Adjuntos:
    • attachment:archivo.zip (enlace al adjunto llamado archivo.zip)
    • Por ahora solamente se puede hacer referencia a adjuntos en el mismo item.
  • Archivos del Repositorio
    • source:algun/archivo – Enlace a el archivo ubicado en /algun/archivo en el repositorio del proyecto
    • source:algun/archivo@52 – Enlace a la revisión 52 del archivo
    • source:algun/archivo#L120 – Enlace a la línea 120 del archivo
    • source:algun/archivo@52#L120 – Enlace a la línea 120 de la revisión 52 del archivo
    • export:algun/archivo – Forzar la bajada del archivo

Escape:

  • Se puede prevenir que los enlaces sean analizados anteponiento el signo de exclamación: !

Enlaces externos

URLs HTTP y direcciones de correo electrónico se convierten automáticamente en enlaces:

http://www.redmine.org, someone@foo.bar

displays: http://www.redmine.org,

Si desea mostrar un texto específico en lugar de la URL, puede utilizar la sintaxis estándar:

"Redmine web site":http://www.redmine.org

muestra: Redmine web site


Formato de texto

Para cosas como encabezados, negrita, listas, tablas, Redmine soporta la sintaxis Textile. Ver http://www.textism.com/tools/textile/ para información sobre el uso de cualquiera de éstas características. Algunos ejemplos son incluídos abajo pero hay muchas más opciones.
Estilo de la fuente

Acrónimos

JPL(Juan Pérez López)

Muestra: JPL

Estilo de fuentes

* *negrita*
* _itálica_
* _*negrita itálica*_
* +subrayada+
* -tachada-
* Plano ^superíndice^
* Plano ~subíndice~
* @Elimina formatos@

Muestra:

  • negrita
  • itálica
  • negrita itálica
  • subrayada
  • tachada
  • Plano superíndice
  • Plano subíndice
  • Elimina formatos

Imágenes en línea

  • !imagen_url! muestra una imágen que está en la dirección imagen_url (sintaxis textile)
  • !>imagen_url! idem a la anterior pero alineada a la derecha
  • Título de la imágen muestra una imagen con un atributo alt/título

Si hay una imagen adjunta la página de la wiki, se puede visualizar en línea con el siguiente comando y el nombre del archivo: !nombre_archivo.png!

Encabezados

h1. Título
h2. Subtítulo
h3. Subsubtítulo

Redmine asigna un ancla a cada uno de los encabezados para que puedan ser enlazados con "#Título", "#Subtítulo", etc.

Párrafos

p. alineación izquierda

  p(. sangría izquierda 1 espacio

    p((. sangría izquierda 2 espacios
    así como para las líneas siguientes

                                                                                   p>. alineación derecha
                                                                        p)))>. alineación derecha 3 espacios

                           p=. alineación Centrada

Predefinido

Para escapar de la sintaxis de la wiki:

<pre> *Your text won't become bold* </pre>

Display:

 *Your text won't become bold* 

Tabulaciones

Empezar el párrafo con bq.

bq. Rails es un completo framework para el desarrollo de respaldo de base de datos de aplicaciones web de acuerdo con el patrón 
Model-View-Control. Para ir a producción, todo lo que necesitas es añadir una base de datos y un servidor web.

Muestra:

Rails es un completo framework para el desarrollo de respaldo de base de datos de aplicaciones web de acuerdo con el patrón Model-View-Control. Para ir a producción, todo lo que necesitas es añadir una base de datos y un servidor web.

Tablas

|_.UserID|_.Name|_.Group|_. attribute list |
|\3=.IT               |<. align left|
|1|Artur Pirozhkov |/2.Users |>. align right|
|2|Vasya Rogov        |=. center |
|3|John Smith |Admin
               (root)|^. valign top |
|4|-          |Nobody
               (anonymous)|~. valign bottom|

Muestra (todos los espacios múltiples se sustituyen por un sólo espacio):

UserID Name Group attribute list
IT align left
1 Artur Pirozhkov Users align right
2 Vasya Rogov center
3 John Smith Admin
(root)
valign top
4 - Nobody
(anonymous)
valign bottom

Tabla de contenidos

{{toc}} ⇒ alineada a la izquierda
{{>toc}} ⇒ alineada a la derecha


Macros

Redmine tiene los siguientes macros por defecto:

hello_world

Ejemplo macro.

include

Incluye una página de la wiki. Ejemplo:

{{include(Foo)}}

macro_list

Muestra la lista de todos los macros disponibles incluyendo la descripción si está disponible.


Resaltado de código

El resaltado de código se basa en CodeRay, una rápida librería de resaltado escrita completamente en Ruby. Actualmente soporta c, html, javascript, rhtml, ruby, scheme, xml.

Se puede resaltar el código en la página de la wiki usando ésta sintaxis:

<pre><code class="ruby">
  Insertar el código aquí.
</code>

Ejemplo:

# The Greeter class
class Greeter
  def initialize(name)
    @name = name.capitalize
  end

  def salute
    puts "Hello #{@name}!" 
  end
end