Manual del Wiki

Visión general

Este wiki se compone de páginas, y cada una de ellas se compone de:

• Una ruta o path.

• Un título.

• Un contenido.

La ruta únicamente identifica la página y define el URL para acceder a ella. Por ejemplo, una página con la ruta /lang/open se accesa mediante el URL http://gambaswiki.org/wiki/lang/open.

Aunque la documentación de Gambas esta ordenada como un arbol, no hay un botón para "subir" en todos los documentos. Para ir un nivel arriba, use la barra de dirección de su navegador, y borre la ultima palabra. Por ejemplo de la página http://gambaswiki.org/wiki/lang/open cambie a http://gambaswiki.org/wiki/lang.

Los contenidos de la página deben seguir la sintaxis descrita en el capítulo siguiente 'La Sintaxis del Wiki'.

El título se usa para mostrar un enlace a una página, y no sigue la sintaxis previa. Se muestra 'tal cual'

Cuando hay un enlace a una página inexistente, el texto del enlace aparece en itálica.

Convenciones acerca de la ruta

La página es, teóricamente libre, pero debe seguir estas convenciones:

• Todas las páginas relacionadas con el idioma están en /lang, para palabras clave y funciones, y en /cat, para la visión general.

• Todas las páginas relativas a componentes están en /comp. La ruta de la página de un componente es /comp/gb.xxx/class/symbol. El símbolo empieza con un punto si se trata de un evento de clase.

• Todas las páginas a partir de la ruta /def constituyen el léxico.

• El resto de documentos pueden ir a partir de la ruta /doc.

Cómo editar una página existente

Haz clic en el enlace 'Edit' en la parte superior de la página.

Aparecerá una caja de diálogo en la que deberás entrar tu usuario y tu contraseña. Este diálogo aparecerá una vez por sesión.

Ya puedes editar la página y su título siguiendo la 'Sintaxis del Wiki'. No cambies el título de la clase, método, evento o constante de página, ya que se genera automáticamente.

Puede resultar útil guardar el contenido original de la ventana de edición en un editor, como gedit (o Bloc de notas) cortando y pegando.

Una vez editado, haz click en el botón 'Save' para actualizar la página.

Cómo crear una página nueva

Entra el URL de la nueva página en tu navegador. El Wiki te dirá que la página no existe, y mostrará un enlace 'Create' en la parte superior de la hoja.

Haz click en el enlace 'Create'.

Cómo borrar una página

Edita la página que quieras borrar, y presiona el botón "Borrar".

Como traducir una página a tu idioma

Basta con editar la página, pero comprueba que estás viéndola en el idioma correcto, cuando veas la pequeña bandera en el extremo superior izquierdo de la página.

Si no hay una bandera que represente tu idioma, basta con que me lo comuniques y la añadiré.

Cómo traducir las cadenas predefinidas del wiki

Las cadenas predefinidas del wiki, como por ejemplo todo lo que no es un título de página o un contenido, están guardadas en el script CGI que gestiona este wiki.

El código fuente de este proyecto está en el archivo fuente Gambas, con el IDE y el componente de base de datos. Su nombre es 'doc.cgi'. Basta con traducir como cualquier otro proyecto y mandarme la traducción.

Página Imagen

Tu puedes subir imagenes al wiki. Una imagen es una página donde el ultimo elemento de la ruta por ejemplo el nombre, empieza con el simbolo de dos puntos ":".

Por ejemplo, /control/:combobox es una imagen que representa un control combo-box.

Para insertar una imagen dentro de una página normal, solo haga un enlace: [/control/:combobox].

Enlaces Simbolicos

Las páginas cuyo título empieza con el simbolo de '@' es un vinculo hacia otra página. La ruta hacia la página enlazada es especificado justo después del símbolo de '@'.

Por ejemplo, la página /edit/cat/methoddecl esta enlazada a la página Declaración de Métodos, y el titulo de la página /cat/methoddecl es @/lang/methoddecl.

Sintaxis del Wiki

A continuación puedes ver una breve visión general de la sintaxis que tienes que usar para escribir artículos en este wiki.

Formato de caracteres

Sintaxis	Descripción	Resultado
**Bold**	Muestra el texto en negrita.	Bold
/*Italic*/	Muestra el texto en cursiva.	Italic
=*TypeWriter*=	Usa una fuente no proporcional.	TypeWriter
_*Underline*_	Subraya el texto.	Underline

Titulos, Párrafos y Lineas

Para saltar una línea en el resultado final, por ejemplo para empezar un nuevo párrafo, tienes que insertar una línea en blanco.

Si tecleas...	Obtienes...
Gambas Already Means BASIC!	Gambas Already Means BASIC!
Gambas Already Means BASIC!	Gambas Already Means BASIC!

Si acabas una línea con un guión bajo, se inserta un salto de línea.

Si tecleas...	Obtienes...
Gambas Already_ Means BASIC!	Gambas Already Means BASIC!

Sintaxis	Descripción	Result
+Title	Muestra un título grande.	Title
++Title	Muestra un título menor.	Title
+++Title	Etcétera...	Title
++++Title		Title
--	Línea horizontal
== <u>This is *verbatim* text</u>	Texto Verbatim. Nota que no se interpretan las marcas HTML.	<u>This is *verbatim* text</u>

Tablas

Puedes usar los siguientes caracteres especiales sólo al principio de una línea.

Sintaxis	Descripción
[[=	Empieza una tabla.
]]	Acaba una tabla.
][=	Separa dos líneas.
-	Separa dos columnas.

La primera línea es siempre el título. Si la primera línea está en blanco, no se imprime título.

Si tecleas...	Obtienes...	Si tecleas...	Obtienes...
[[ First header - Second header - Third header ][ 1 - 2 - 3 ][ 4 - 5 - 6 ]]=	First header Second header Third header 1 2 3 4 5 6	[[ ][ 1 - 2 - 3 ][ 4 - 5 - 6 ]]=	1 2 3 4 5 6

Enlaces

Este wiki tiene la caracteristica de autoenlazarce. La única manera de desactivarlo es con el caracter barra invertida!

Sintaxis	Descripción	Result
[/lang/arithop]	Enlaza con un tema	Operadores Aritméticos
[http://gambas.sourceforge.net|Gambas web site]	Enlazar a una URL	Gambas web site
What is ASCII ?	Autoenlace	What is ASCII ?
What is \ASCII ?	Cómo desactivar Autoenlaces	What is ASCII ?

Secciones especiales

Una sección empieza con una línea con un carácter '{', y acaba la línea con un carácter '}'.

Las secciones se pueden anidar.

Si tecleas...	Obtienes...	Notas
{syntax Esta es la sintaxis de una función }=	Esta es la sintaxis de una función
{example Ejemplo }=	Examples Ejemplo
{seealso Mira también estas funciones... }=	Véase también Mira también estas funciones...
{box Una caja }=	Una caja	En esta sección, todos los caracteres especiales como: /, _, etc.. son interpretados.
{code Para ejemplos de código }=	Para ejemplos de código	En esta sección, todos los caracteres especiales como: /, _, etc.. son mostrados, no interpretados.
{warning Cuidado! }=	Cuidado!
{info Ten en cuenta este punto. }=	Ten en cuenta este punto.
{vb Visual Basic no trabaja como Gambas. }=	Visual Basic no trabaja como Gambas.
{tip Un tip puede ayudarte. }=	Un tip puede ayudarte.

Comandos especiales

Un comando especial es una línea que empieza con una carácter '@'.

Comando especial	Descripción
@components	Inserta la lista de todos los componentes.
@classes	Inserta la lista de todas las clases del componente en curso.
@symbols	Inserta la lista de todos los símbolos de la clase en curso.
@index /root/index/path	Crea un índice de todas las páginas de la ruta raíz especificada. Sólo se indexan las páginas de primer nivel.
@title-index	Crea un índice de todos los títulos incluidos en la página. Títulos dentro de secciones o tablas son ignorados. Note que este comando especial debe ser insertado antes de algún titulo, usualmente al principio de la página.