Manual Wiki

Visão geral

Este wiki é feito de páginas, cada página composta por:

• Um caminho.

• Um título.

• Um conteúdo.

O caminho identifica de forma única a página, e define a URL para acessá-la. Por exemplo, uma página com o caminho /lang/open é acessada com a URL http://gambaswiki.org/wiki/lang/open.

O conteúdo da página deve seguir a sintaxe descrita no capítulo 'Sintaxe Wiki' abaixo.

O título é usado para mostrar um link para uma página, e não segue a sintaxe anterior. Ele é mostrado 'assim como é'.

Quando existir um link para uma página não-existente, o texto do link é o caminho da página, mostrado em itálico.

Convenções de caminho

O caminho da página é teoricamente livre, mas deve seguir estas convenções:

• Todas as páginas relacionadas à lingua são colocadas em /lang, para palavras-chaves e funções, e em /cat, para visões gerais.

• Todas as páginas relacionadas a componentes são colocadas em /comp. O caminho de uma página componente é /comp/gb.xxx/class/symbol. O símbolo começa com um ponto se é um evento de uma classe.

• Todas as página sobre o caminho /def compõem o léxico.

• Documentos diversos devem ser postos sobre o caminho /doc.

Como editar uma página já existente

Clique no link 'Editar' no topo da página.

Uma caixa de diálogo aparece, na qual você deve entrar com seu login e senha. Esta caixa de diálogo aparece somente uma vez em cada sessão.

Então você pode editar a página e seu título seguindo a 'Sintaxe Wiki'. Não altere o título da classe, método, evento ou páginas constantes, já que elas são geradas automaticamente.

Pode ser útil salvar o conteúdo original da janela de edição em um editor convenciona, i.e. gedit (ou Bloco de Notas) através do cortar e colar.

Uma vez editado, clique no botão 'Salvar' para atualizar a página.

Como criar uma nova página

Entre com um novo endereço URL no seu navegador. O Wiki irá dizer que a página não existe, e mostrará um link 'Criar' no topo da página.

Clique no link 'Criar'.

Como deletar uma página

Edite a página que você quer deletar, e remova ambos o título e o conteúdo da página.

Como traduzir a página na sua língua

Basta editar a página, mas verifique se você está visualizando a página na língua correta, olhando na bandeirinha no canto superior esquerdo da página.

Se não há bandeira que represente a sua língua, é só me dizer. Eu irei adicioná-la.

Como traduzir as strings pré-definidas do wiki

As strings pré-definidas do wiki, i.e tudo que não é título de página ou conteúdo de página, fica localizado no script CGI de tradução do projeto que gerencia este wiki.

O fonte deste projeto está localizado no arquivo fonte Gambas, com o IDE e o componente de banco de dados. Seu nome é 'doc.cgi'. É só traduzir como qualquer outro projeto.

Páginas de imagens

Você pode fazer upload de imagens ao wiki. Uma imagem é uma página cujo último elemento do caminho, i.e. o nome do caminho, começa com dois pontos.

Por exemplo, /control/:combobox é uma imagem que representa um controle combo-box.

Para inserir uma imagem dentro de uma página normal, basta criar um link: [/control/:combobox].

Sintaxe Wiki

Eis uma breve visão geral da sintaxe que você deve usar para escrever artigos neste wiki.

Formatando caracteres

Sintaxe	Descrição	Resultado
**Negrito**	Coloca texto em negrito.	Negrito
/*Itálico*/	Coloca texto em itálico.	Itálico
=*Máquina de escrever*=	Usa uma fonte não proporcional.	Máquina de escrever
_*Sublinhado*_	Sublinha texto.	Siblinhado

Títulos, Parágrafos e Linhas

Para pular uma linha do resultado final, i.e. para começar um novo parágrafo, você deve inserir uma linha em branco.

Se você digitar...	Você obterá...
Gambas Already Means BASIC!	Gambas Already Means BASIC!
Gambas Already Means BASIC!	Gambas Already Means BASIC!

Se você terminar uma linha com um underscore, então uma quebra de linha é inserida.

Se você digitar...	Você obterá...
Gambas Already_ Means BASIC!	Gambas Already Means BASIC!

Syntaxe	Descrição	Resultado
+Título	Mostra um título grande	Título
++Título	Mostra um título menor	Título
+++Título	E assim por diante	Título
++++Título		Título
--	Linha horizontal
== <u>este é um texto *verbatim* </u>	Texto verbatim. Note que as tags html são interpretadas.	<u>Este é um texto *verbatim*</u>

Tabelas

Você pode usar os caracteres especiais em seguida somente no começo da linha.

Syntaxe	Descrição
[[=	Começa uma tabela.
]]	Termina uma tabela.
][=	Separa 2 linhas
-	Separa 2 colunas

A primeira linha é sempre os cabeçalhos. Se a primeira linha é vazia, então nenhum cabeçalho é impresso.

Se você digitar...	Você obterá...	Se você digitar...	Você obterá...
[[ Primeiro cabeçalho - Segundo cabeçalho - Terceiro cabeçalho ][ 1 - 2 - 3 ][ 4 - 5 - 6 ]]=	Primeiro cabeçalho Segundo cabeçalho Terceiro cabeçalho 1 2 3 4 5 6	[[ ][ 1 - 2 - 3 ][ 4 - 5 - 6 ]]=	1 2 3 4 5 6

Links

Este wiki possui uma característica de autolink. O único jeito de desabilitá-lo é com o caracter de escape barra invertida.

Syntaxe	Descrição	Resultado
[/lang/arithop]	Linka para um tópico	Operadores Aritméticos
[http://gambas.sourceforge.net|Gambas web site]	Linka para qualquer URL	Gambas web site
What is ASCII ?	Autolink	What is ASCII ?
What is \ASCII ?	Como desabilitar autolink	What is ASCII ?

Seções especiais

Uma seção começa com uma linha iniciando com um caracter '('+, e termina com uma linha começando com um caracter =')'.

Seções podem ser aninhadas.

Se você digitar...	Você obterá...
{syntax Esta é a sintaxe de uma função }=	Esta é a sintaxe de uma função
{example Exemplo }=	Examples Examplo
{seealso Veja também estas funções... }=	Veja também Veja também estas funções...
{box Somente uma caixa }=	Somente uma caixa
{warning Alerta! }=	Alerta!
{info Perceba este item. }=	Perceba este item.
{vb Visual Basic não funciona como o Gambas. }=	Visual Basic não funciona como o Gambas.
{tip Uma dica pode te ajudar. }=	Uma dica pode te ajudar.

• Coloque uma quebra de linha (uma linha vazia) antes e depois dessas caixas.

• Não use quebras de linhas dentro de uma caixa seealso

Comandos Especiais

Um comando especial é uma linha começando com um caracter '@'.

Comando especial	Descrição
@components	Insere a lista de todos os componentes.
@classes	Insere a lista de todas as classes do componente atual.
@symbols	Insere a lista de todos os símbolos da classe atual.
@index /root/index/path	Cria um índice de todas as páginas do caminho raiz específico. Somente as páginas de primeiro nível serão indexadas.