Regras de Formatação

Este documento descreve as sintaxes das regras de formatação de texto que são reconhecidas por este motor Wiki. Para testar as regras, use a caixa de areia (SandBox).

As regras básicas de formatação permitem aos utilizadores iniciados uma rápida aprendizagem da sintaxe mínima essencial a uma boa edição de conteúdo. Por isso, referem-se à formatação de texto, de fontes e parágrafos, listas e ligações.

Nota: É possível combinar qualquer uma das regras básicas de formatação de texto.

Nota: Para forçar uma nova linha no meio de um texto é necessário duas barras (back-slashes) e um espaço em branco. Para forçar uma nova linha no fim do texto, sem que se force um novo parágrafo, basta terminar a linha com duas barras (back-slashes). No entanto, deve-se evitar forçar novas linhas, através de uma composição mais clara e precisa do texto, repartido por parágrafos.

Nota: Para ver os footnotes, tem que deslocar-se até ao fim da página. Procure por este texto: Os footnotes ficam ao fundo da página.2)

Text ItálicoText Itálico - Item numa Lista Ordenada ==== Listas ==== - Item numa Lista Ordenada

1. Item numa Lista Ordenada
2. Item numa Lista Ordenada
3. Item numa Lista Ordenada
4. Item numa Lista Ordenada

São suportadas listas ordenadas e não ordenadas. Para criar um item da lista é preciso indentar o texto com dois espaços em branco e usar um dos prefixos seguintes:

• - (hífen) para lista ordenada.
• * (asterisco) para lista não ordenada.

Os níveis de indentação seguintes são criados acrescentando-se sucessivamente mais dois espaços em branco antes do prefixo. Por exemplo:

1. Item 1 da Lista Ordenada
2. Item 2 da Lista Ordenada
   1. Sub-Item 1 do Item 2 da Lista Ordenada
   2. Sub-Item 2 do Item 2 da Lista Ordenada
3. Item 3 da Lista Ordenada
4. Item 4 da Lista Ordenada
   1. Sub-Item 1 do Item 4 da Lista Ordenada
   2. Sub-Item 2 do Item 4 da Lista Ordenada
5. Item 5 da Lista Ordenada

  - Item 1 da Lista Ordenada                
  - Item 2 da Lista Ordenada                
    - Sub-Item 1 do Item 2 da Lista Ordenada
    - Sub-Item 2 do Item 2 da Lista Ordenada
  - Item 3 da Lista Ordenada                
  - Item 4 da Lista Ordenada                
    - Sub-Item 1 do Item 4 da Lista Ordenada
    - Sub-Item 2 do Item 4 da Lista Ordenada
  - Item 5 da Lista Ordenada                

• Item 1 da Lista Não Ordenada
• Item 2 da Lista Não Ordenada
  • Sub-Item 1 do Item 2 da Lista Não Ordenada
  • Sub-Item 2 do Item 2 da Lista Não Ordenada
• Item 3 da Lista Não Ordenada
• Item 4 da Lista Não Ordenada
  • Sub-Item 1 do Item 4 da Lista Não Ordenada
  • Sub-Item 2 do Item 4 da Lista Não Ordenada
• Item 5 da Lista Não Ordenada

  * Item 1 da Lista Não Ordenada  
  * Item 2 da Lista Não Ordenada
    * Sub-Item 1 do Item 2 da Lista Não Ordenada
    * Sub-Item 2 do Item 2 da Lista Não Ordenada
  * Item 3 da Lista Não Ordenada
  * Item 4 da Lista Não Ordenada
    * Sub-Item 1 do Item 4 da Lista Não Ordenada
    * Sub-Item 2 do Item 4 da Lista Não Ordenada
  * Item 5 da Lista Não Ordenada

Pode-se separar o conteúdo com linhas horizontais. A regra de formatação a aplicar são 4 hífens ----, como por exemplo assim:

Este parágrafo está separado do anterior por linha horizontal.

É possível criarem-se vários tipos de ligações (links) entre documentos, sejam páginas internas ou externas ao WikiSite.

Atenção: As ligações a secções internas usam o nome do cabeçalho. Se o nome mudar a ligação torna-se inválida, pelo que poderá acontecer existirem ligações em documentos para secções que já não existem ou mudaram de nome. Nota: As ligações internas são usadas para nomear as páginas (WikiPages). São por isso convertidas para minúsculas automaticamente. Não são permitidos caracteres especiais, os espaços em branco são traduzidos em underscores (_) e os hífens são mantidos (-). Os grupos categorizam as páginas com assuntos comuns. São usados nos FreeLinks, sendo separados da ligação por dois pontos (:). As ligações para páginas existentes são mostradas numa cor diferente das ligações para páginas não existentes. Por exemplo: esta página existe enquanto que esta página não existe. Nota: As ligações do tipo CamelCase não são criadas automaticamente, a não ser que a opção para tal seja activada pelo WikiSiteAdmin.

As ligações externas são reconhecidas automaticamente. São suportadas as seguintes:

• www.google.com - www.google.com
• HTTP - http://www.google.com - http://www.google.com
• e-mail - <someone@somwhere.not.here> - someone@somwhere.not.here

Nota: Para dar uma descrição a uma ligação externa, é necessário usar a regra de ligação [[...]], por exemplo [[http://www.google.com | Google]] - Google.

São suportadas ligações InterWiki. Estas ligações são ligações práticas a outros Sites Wiki.
Uma ligação InterWiki é composta pela abreviatura da ligação externa, pelo caracter maior-que (>) e pela página a ligar.
Por exemplo, para ligar a uma página na WikiPedia sobre Wikis: [[wp>Wiki]] - Wiki.

São suportadas ligações a pastas partilhadas por sistemas Windows.
Uma ligação Windows é composta por duas barras (back-slashes) dentro dos parêntesis rectos.
Por exemplo, para aceder à pasta HOME da máquina OXYGEN: [[\\sistema\pasta]] - \\sistema\pasta. Pode-se também seguir a regra de descrição da ligação, usando [[\\sistema\pasta | texto]].

Nota: Por razões de segurança, a navegação directa para ligações de pastas partilhadas só funciona através do Microsoft Internet Explorer. Atenção que este tipo de ligações só faz sentido em redes homogéneas, como por exemplo numa intranet empresarial.

As regras avançadas são para utilizadores mais experientes, pois apesar de não darem mais ênfase ao conteúdo permitem que a apresentação e navegação pelo mesmo seja mais amigável.

As secções são separadas por cabeçalhos. Não precisam de ser cabeçalhos do mesmo nível. As secções são úteis para repartir o conteúdo de um documento ao longo da página, pois permitem que se edite somente o conteúdo de uma secção em vez de obrigar sempre à edição de todo o conteúdo. Isto é mais prático, principalmente quando se está a ler e vê-se um texto que precisa de ser emendado. Basta editar a secção que contém o texto em vez de ter que procurar por todo o conteúdo do documento pela localização desse texto.

Existem 5 níveis de cabeçalhos. O nível mais alto (H1) usa 6 sinais de igual ======, o próximo (H2) usa 5 sinais de igual ===== e assim sucessivamente até ao nível mais baixo (H5) que usa 2 sinais de igual ==.

Se existirem mais do 2 níveis no documento, então é gerada automaticamente uma tabela de conteúdos. Para desactivar esta tabela de conteúdos, a primeira linha do documento tem que ter ~~NOTOC~~. Para ver exemplos de páginas com secções, aceda a esta página com tabela de conteúdos ou a esta página sem tabela de conteúdos.

As regras para criação de tabelas são muito simples. Existem apenas dois símbolos separadores de células a saber:

• ^ indica que a célula é uma célula de cabeçalho.
• | indica que a célula é uma célula normal.

Além disso, pode-se ter células que se espalhem por mais do que uma coluna. Não se pode ter células que se espalhem por mais que uma linha, no entanto. Alguns exemplos:

^ Cabeçalho 1      ^ Cabeçalho 2      ^ Cabeçalho 3      ^
| Linha 1 Coluna 1 | Linha 1 Coluna 2 | Linha 1 Coluna 3 |
| Linha 2 Coluna 1 | colspan (através de duas barras)   ||
| Linha 3 Coluna 1 | Linha 3 Coluna 2 | Linha 3 Coluna 3 |

Nota: ter atenção que o número de separadores de células é sempre o mesmo, por cada linha da tabela. Ver o exemplo acima para a célula da linha 2 e coluna 2 + 3.

^              ^ Cabeçalho B1 ^ Cabeçalho C1 ^
^ Cabeçalho A2 | Célula B2    | Célula C2    |
| Cabeçalho A3 | Célula B3:C3               ||
| Cabeçalho A4 | Célula B4    | Célula B4    |

A partir da versão acima da versão 2005-01-16, é também possível alinhar o conteúdo da célula. Basta para isso usar dois ou mais espaços em branco entre o separador da célula e o texto a alinhar. Por exemplo:

^  Tabela com Alinhamento (> 2005-01-16)   ^^^
|      direita |    centro    | esquerda     |
|    centro    | esquerda     |    centro    |
| esquerda     |      direita |      direita |

As imagens podem ser ficheiros externos ou internos, e são incluídas através de parêntesis curvos. Opcionalmente, pode-se especificar as dimensões da imagem. Exemplos:

Sintaxe	Resultado	Descrição
{{http://wikipedia.sourceforge.net/Mediawiki.png}}		Imagem externa ao SiteWiki.
{{WikiInfo:ImageExample.png}}		Imagem em tamanho real, alinhada à esquerda.
{{ WikiInfo:ImageExample.png}}		Imagem em tamanho real, alinhada à direita.
{{ WikiInfo:ImageExample.png }}		Imagem em tamanho real, centrada.
{{WikiInfo:ImageExample.png?100}}		Imagem com 100 pixeis de largura.
{{WikiInfo:ImageExample.png?100x100}}		Imagem com 100 pixeis por 100 pixeis.
{{WikiInfo:ImageExample.png | Legenda}}		Imagem com legenda (tooltip ou caption).

Nota: Uma imagem também pode ser a descrição de uma ligação, bastando para isso combinar as duas regras de formatação. Por exemplo: . Atenção que a única regra de formatação permitida na descrição de uma ligação é a regra de formatação para imagens. Se o nome do ficheiro especificado (interno ou externo) não tiver como extensão uma extensão conhecida para imagens (*.gif, *.png, *.jpg) então é apresentada uma ligação ao ficheiro, em vez da imagem.

Este motor converte emoticons (smileys) comuns nos seus equivalentes gráficos:

Emoticon	Gráfico
8-)
8-O
:-(
:-)
=)
:-/
:-\
:-?
:-D
:-P
:-O
:-X
:-|
;-)
^_^
:?:
:!:
LOL
FIXME
DELETEME

Também pode converter simples códigos em texto para as suas correctas entidades tipográficas. Por exemplo:

→ ← ↔ ⇒ ⇐ ⇔ » « – — 640×480 © ™ ®
“Alguém disse: ‘este motor Wiki é excelente!’…”

  -> <- <-> => <= <=> >> << -- --- 640x480 (c) (tm) (r)\\
  "Alguém disse: 'este motor Wiki é excelente!'..."

Este motor Wiki, graças à inclusão do GeSHi - Generic Syntax Highlighter, pode também destacar código-fonte em certas e determinadas linguagens. Para isso, o motor Wiki entrega ao GeSHi o código a ser formatado com cores, através da regra <code «language»>...</code>. Por exemplo, para formatar o seguinte código-fonte em Java:

/** 
 * The HelloWorldApp class implements an application that
 * simply displays "Hello World!" to the standard output.
 */
class HelloWorldApp {
    public static void main(String[] args) {
        System.out.println("Hello World!"); //Display the string.
    }
}

Nota: aceda ao site do GeSHi para saber quais as linguagens suportadas pelo sistema. Em resumo: bash, c, cpp, css, html4strict, java, javascript, pascal, perl, php-brief, php, python, sql, xml, entre muitas outras.

É possível, mas não recomendável, embeber código puro em HTML ou PHP, através das tags <html>...</html> e <php>..</php>. Por exemplo:

Este <font color="red" size="+1">fonte está maior e em vermelho</font>, por estar envolvido entre tags HTML, que permite o uso de código HTML puro.

<html>
Este <font color="red" size="+1">fonte está maior e em vermelho</font>, por estar envolvido entre tags HTML, que permite o uso de código HTML puro.
</html>

echo 'Um logo gerado com recurso a PHP:';
echo '<img src="' . $_SERVER['PHP_SELF'] . '?=' . php_logo_guid() . '" alt="PHP Logo !" />';

<php>
echo 'Um logo gerado com recurso a PHP:';
echo '<img src="' . $_SERVER['PHP_SELF'] . '?=' . php_logo_guid() . '" alt="PHP Logo !" />';
</php>

Para fazer com que um bloco de conteúdo não seja transformado por regras de formatação, deve-se começar o bloco com 2 espaços em branco, sem serem seguidos por uma bullet (* ou -). Outra forma de fazer o mesmo é envolver o bloco entre as tags <code>...bloco...</code>. Por exemplo:

Este bloco está identado com dois espaços em branco.
Por isso, as **regras** de __formatação__ não são usadas.

• No entanto, a regra de lista pode ser formatada, neste caso.

Todo o texto é preservado   {{ sem }}   alterações, mesmo as ligações [[http://wiki.splitbrain.org]].
http://wiki.splitbrain.org

  Este bloco está envolvido por tags code.../code.
  Por isso, as **regras** de __formatação__ não são usadas.

  * Por isso, nem mesmo a regra de lista é formatada.

  Todo o texto é preservado   {{ sem }}   alterações, mesmo as ligações [[http://wiki.splitbrain.org]].

Para impedir que o parser Wiki nem mesmo indente um bloco, ou seja, para impedir que um determinado bloco seja interpretado pelo parser Wiki deve-se envolver o bloco entre as tags nowiki ou dupla-percentagem. Por exemplo:

Este texto contém **regras** que são __totalmente__ :!: ignoradas pelo parser Wiki.\\ Assim, entre as tags nowiki, nem mesmo os endereços são formatados, como por exemplo: http://wiki.splitbrain.org. Este bloco está envolvido por tags <code>...</code>. Por isso, as **regras** de __formatação__ não são usadas. * Por isso, nem mesmo a regra de lista é formatada. Todo o texto é preservado {{ sem }} alterações, mesmo as ligações [[http://wiki.splitbrain.org]].

<code>Este código não está formatado...</code>