I Encontro Regional dos Estudantes de Computação de Alagoas

Manual de Referência Rápida do Twiki

Produzido por Paulo Henrique de Lima Santana para o I Encontro Regional dos Estudantes de Computação de Alagoas Baseado no material produzido por Aurélio A. Heckert para a I Semana de Capacitação em Software Livre do Governo Federal Baseado na documentação do TWiki, traduzida para Português do Brasil em http://twiki.im.ufba.br/bin/view/Portugues Documento : Versão 0.9 de 19/04/2004

TWiki Shorthand – a notação de formatação do TWiki
Comando de Formatação:
Parágrafos: Linhas em branco parágrafos. criarão novos 2° parágrafo ---++ Sushi ---+++ Maguro

Você escreve:
1° parágrafo

Você obtém:
1° parágrafo 2° parágrafo

Títulos: Ao menos três traços no início da linha, seguidos por '+' e o cabeçalho. Um '+' cria um título com nível 1( mais importante), dois '+' um título com nível 2; o nível máximo é 6. Nota: Uma
tabela de conteúdo pode ser criada automaticamente com a variável %TOC%, veja as variáveis TWiki. Qualquer texto de cabeçalho após !! é excluido do %TOC%; por exemplo, escreva ---+!! texto se você não quer listar um cabeçalho no %TOC%.

Sushi

Maguro

Texto em Negrito: Palavras ficam negritadas colocadas entre * asteriscos.

*Negrito* quando _Itálico_

Negrito

Texto em Itálico: Palavras ficam em itálico quando colocadas entre _ underscores. Bold Italic: palavra ficam _bold italic quando colocadas entre _ double-underscores. Fixed Font: Palavras são mostradas em fixed font quando colocadas entre = sinais de igual. Bold Fixed Font: Palavras são mostradas em bold fixed font quando colocada entre sinais de igual duplos. Nota: Certifique-se de colocar os sinais * _ = == junto às palavras, e.g retire os espaçamentos. Verbatim Mode: Circunde trechos de códigod e outros textos formatados com <verbatim> e tags </verbatim>.
Nota: Use em vez disso <pre> e tags </pre> se você quiser que seu código HTML seja interpretado. Nota: Cada tag deve ficar em uma linha separada.

Itálico

__Bold italic__

Bold italic

=Fixed font=

Fixed font

==Bold fixed==

Bold fixed

_Isso funciona_, _isso não _ <verbatim> class CatAnimal { void purr() { <code here> } } </verbatim>

Isso funciona, _isso não _
class CatAnimal { void purr() { <code here> } }

Separador: Ao menos três traços no início de uma linha. Listar Itens: Três espaços e um asterisco. Lista de Itens Aninhados: Seis, nove, ... espaços e um asterisco. Lista Ordenada: Três espaços e um número. Definition List: Três espaços, o termo, dois pontos, um espaço, seguido pela definição. Nota: Termos com espaços não são suportados. Caso você tenha um termo com mais de uma palavra, separe-as por traços ou com a entidade &nbsp; non-breaking-space. Tabela: Espaços opcionais seguidos pelas células delimitadas por barras verticais. | *negrito* |
A celula será do tipo Título de Tabela

-------

* Item * algo aninhado 1 Sushi 1 Dim Sum Sushi: Japan Dim&nbsp;Sum: S.F.

Item

algo aninhado

1. Sushi 2. Dim Sum Sushi Japan Dim Sum S.F.

| | | | |

*L* | *C* | *R* | A2 | 2 | 2 | A3 | 3 | 3 | multi span ||| A4 \ | next \ | next |

L A2 A3 A4

C 2 3 next

R 2 3 next

multi span

| espaçadas | o conteúdo será centralizado | espaçadas | o conteúdo será alinhado a direita | colspan 2 || células são interpretadas como colunas multi-span. Nota: Caso você tenha uma linha muito grande e deseje que ela se torne mais fácil de ler, quando você editar a tabela você pode dividí-la em linhas que terminem com uma barra invertida '\'. WikiWord Links: PalavrasMaiúsculasJuntas WikiWord formarão um link automaticamente. Nota: Caso deseje formar um link para um tópico em uma Web TWiki diferente, escreva Nomeweb.NomeTopico WebNotify Know.ReadmeFirst

WebNotify ReadmeFirst

Links Forçados: Você pode forçar a criação de links internos colocando palavras entre colchetes duplos. Nota: Texto entre colchetes pode conter espaços opcionais; o nome de tópico é formado colocando-se a letra inicial em maiúscula e removendo os espaços; i.e. [[text formatting FAQ]] forma link para o tópico TextFormattingFAQ. Você também pode referenciar a uma Web diferente e usar âncoras. Links Específicos: Crie um link onde você possa especificar o texto do link e a referância ao link separadamente, usando colchetes aninhados como [[reference][text]]. Referências a linls internos (i.e. WikiSyntax) e referências a links externos (i.e. http://TWiki.org/) são suportadas. As mesmas regras de Links Forçados se aplicam para referências a links internos. Nomes de âncora também podem ser adicionados, como [[WebHome#MyAnchor][go home]] e [[http://www.yahoo.com/#somewhere ][Yahoo!]]. Âncoras: Você pode definir uma referência a um link dentro de um tópico TWiki (chamado nome de âncora) e formar um link a ele. Para definir uma âncora escreva #AnchorName no início de uma linha. O nome de âncora deve ser uma WikiWord. Para formar link para um nome de âncora use a sintaxe [[MyTopic#MyAnchor]] . Você pode omitir o nome de tópico se quser formar um link dentro do mesmo tópico. Prevenindo um Link: Previa que uma WikiWord seja linkada precedendo-a com uma tag <nop>.

[[wiki syntax]] [[Main.TWiki users]]

wiki syntax Main.TWiki users

[[WikiSyntax][syntax]] [[http://gnu.org][GNU]]

syntax GNU

[[WebHome#NotThere]] [[#MyAnchor][Jump]] #MyAnchor To here

WebHome#NotThere Jump To here

<nop>SunOS

SunOS

Variáveis TWiki
Variable: %WIKIHOMEURL% %SCRIPTURL% %SCRIPTURLPATH% %SCRIPTSUFFIX% %PUBURL% %PUBURLPATH% %ATTACHURL% %ATTACHURLPATH% Expanded to: A URL base do script do ambiente TWiki, é o link do ícone Home no canto superior esquerdo. A URL de scripts do ambiente TWiki. O caminho da URL do script do ambiente TWiki O sufixo do script, ex: .pl, .cgi is A URL pública do ambiente TWiki Exemplo: Você pode referir à um arquivo anexado a outro tópico como %PUBURL%/%WEB%/OutroTopico/image.gif O caminho da URL pública do ambiente TWiki A URL de anexos do tópico atual. Exemplo: Caso você anexe um arquivo você pode se referir a ele como %ATTACHURL%/image.gif O caminho da URL de anexos do tópico atual.

Retorna o valor de um parâmetro de URL. Ex: %URLPARAM{"name" %URLPARAM{"skin"}% retorna ”print“ para o caso }% http://.../view/Portugues/TWikiVariables?skin=print %WIKITOOLNAME% %WIKIVERSION% %USERNAME% %WIKINAME% %WIKIUSERNAME% %MAINWEB% %TWIKIWEB% %WEB% %BASEWEB% %INCLUDINGWEB% %HOMETOPIC% %NOTIFYTOPIC% O nome da ferramenta. Ex: (IM/TWiki) (no TWiki do IM-UFBA) A versão da ferramenta Wiki. Ex: 01 Feb 2003 Seu login de usuário. Ex: guest Seu nome de usuário Wiki. O mesmo que %USERNAME% caso não for definido no tópico TWikiUsers. Ex: guest Seu %WIKINAME% incluindo o nome da web Main - sempre use assinaturas completas. Ex: Main.guest A web principal contendo TWikiUsers, OfficeLocations e TWikiGroups. O valor é Main A web contendo toda a documentação e configuração do TWiki é TWiki A web atual. Ex Main O nome da web onde os includes foram inicializados, e.g. a web do primeiro tópico dos includes aninhados. Da mesma forma que %WEB% no caso de não haver include. O nome da web do tópico que inclui o tópico atual. Assim como %WEB% no caso de não haver include. O tópico home em cada web. Normalmente: WebHome O tópico de notificação em cada web. Normalmente: WebNotify

%WIKIUSERSTOPIC% %WIKIPREFSTOPIC% %WEBPREFSTOPIC% %STATISTICSTOPIC% %TOPIC% %BASETOPIC% %INCLUDINGTOPIC% %SPACEDTOPIC%

O tópico index de todos usuários registrados. Normalmente: TWikiUsers A web do tópico de preferências. Normalmente: TWikiPreferences O tópico de preferências da web. Normalmente: WebPreferences O tópico de estatísticas da web. Normalmente: WebStatistics O nome do tópico atual. Ex: TWikiVariables O nome do tópico onde os includes são inicializados, ex. o primeiro tópico de includes aninhados. Do mesmo jeito que %TOPIC% no caso de não haver include. O nome do tópico que inclui o tópico atual. Da mesma forma que %TOPIC% no caso de não haver include. O nome do tópico atual com espaços adicionados, para pesquisa da expressão regular. O valor referenta a TWikiVariables é TWiki%20*Variables Tópico de índice da web. O "format" define o formato de um item do tópico. Ele pode incluir variáveis: A variável $name contém o nome do tópico; a variável $web contém o nome da web. Os parâmetros são: formato, separador e web: Parâmetro:
"formato"

Descrição:

Padrão:

Formato de uma linha, pode incluir as variáveis $name e "$name" $web "$name" "\n" (nova linha) Web atual

format="formato %TOPICLIST{"form (Alternativo ao de cima) " at"}% separator=", linha de separação " web="Name"

Nome da web

Examples: %TOPICLIST{" * $web.$name"}% criar uma lista bullet de todos os tópicos. %TOPICLIST{separator=", "}% cria uma lista de todos os tópicos separada por vírgula. %TOPICLIST{" <option>$name</option>"}% cria uma lista de opções (para menus drop down).

Web index, ex. lista de todas web's. Webs ocultas são excluídas ,ex. webs com uma variável de preferência NOSEARCHALL=on. O "format" define o formato de um item de web. A variável $name contém o nome da web, $qname contém o nome da web entre aspas duplas, $marker contém o marker onde a web condiz com selection. Os oarâmetros são: formato, separador e web: Parâmetro: "formato" Descrição: Padrão: Formato de uma linha, pode "$name" incluir a variável=$name= "$name" "\n" linha) (nova

format="form (Alternativo ao de cima) ato" %WEBLIST{"format "}% separator=", separador de linha "

Lista de web's separada por webs="public virgulas, public contém "public" " toadas as não ocultas Texto para $marker onde o marker="sele item condiz com selection, "selected" cted" de outro modo é igual a "" selection="% Valor atual a ser selecionado section="%W WEB%" na lista EB%" Examples: %WEBLIST{" * [[$name.WebHome]]"}% cria uma lista bullet de todas webs. %WEBLIST{"$name" webs="Trash,public" selection="Portugues" separator=" "}% Caixa de seleção (Dropdown) de todas Webs públicas + Trash Web, Web atual selecionada.

%GMTIME%

A hora GM, é Tue Apr 20 02:18:04 2004

A hora GM é formatada baseada nas variáveis de tempo. Variável: $seconds $minutes $hours $day %GMTIME{"format" $month }% $mo $year $ye Unidade: segundos minutos horas dia do mês mês com 2 digitos ano com 4 digitos ano com 2 digitos Exemplo 59 59 23 31 12 1999 99

mês no formato ISO Dec

As variáveis podem ser abreviadas a 3 caracteres. Exemplo: %GMTIME{"$day $month, $year - $hour:$min:$sec"}% é 20 Apr, 2004 - 02:18:04 %SERVERTIME% Hora do Servidor, é Mon Apr 19 23:18:04 2004 %SERVERTIME{"for Hora do Servidor formatada. mat"}% Exemplo: %SERVERTIME{"$hou:$min"}% é 23:18 %HTTP_HOST% %REMOTE_ADDR% %REMOTE_PORT% %REMOTE_USER% A variável de ambiente HTTP_HOST. Ex: www.twiki.im.ufba.br (no TWiki do IM-UFBA) A variável de ambiente REMOTE_ADDR. Ex: 200.17.147.233 A variável de ambiente REMOTE_PORT. Ex: 56529 A variável de ambiente REMOTE_USER. Inclusão, no lado do servidor. Parâmetro: Descrição: Padrão: O nome de um tópico localizado "AlgumTopico" na web atual, i.e. %INCLUDE{"WebNotify"}% %INCLUDE{"page" ...}% "Web.Topico" "http://..." Um tópico em outra web, i.e. %INCLUDE{"TWiki.SiteMap"}% Uma URL absoluta, i.e.
%INCLUDE{"http://twiki.org/"}%

Um padrão em expressão pattern="..." regular para incluir parte de um none tópico ou página rev="1.2" Inclui uma versão anterior do última tópico; N/A para URLs versão

%STARTINCLUDE%

Se presente em um tópico incluido, inicia a inclusão do texto daquele ponto até o fim, ou até o ponto da variável %STOPINCLUDE%. Uma visão normal do tópico mostra tudo, exceto a própria variável %STARTINCLUDE%. Se presente em um tópico incluido, para a inclusão do texto naquele ponto e ignora o resto do texto. Uma visão normal do tópico mostra tudo, exceto a própria variável %STOPINCLUDE%. Tabela de conteúdo do tópico atual. (TOC é acrônimo de Table of Contents) Tabela de conteúdo. Mostra um TOC gerado automaticamente baseado nos cabeçalhos de um tópico. Cabeçalhos em sintaxe TWiki ("---++ texto") e HTML ("<h2>texto<h2>") são examinados no cliente. (mas não "<H2>texto</H2>", que pode ser usado para excluir um cabeçalho do TOC.) Os parâmetros são: nome do tópico, web e profundidade:

%STOPINCLUDE% %TOC%

Parâmetro:
%TOC{"Topico"
...}%

Descrição:

Padrão: tópico atual web atual de no 6

"NomeDoTopico" nome do tópico web="Nome" depth="2" nome da web Profundidade limite cabeçalhos mostrados TOC

Exemplos: %TOC{depth="2"}% %TOC{"TWikiDocumentation" web="TWiki"}%

Busca em linha, mostra o resultado de uma busca "encaixado" em um tópico. Os parâmetros são: o termo da busca, web, escopo, ordem e muitos outros: Parâmetro: Descrição:
O termo de busca. É uma expressão regular ou é literal, dependendo do parâmetro regex. para expressões regulares é usado ";" para representar and e.g. "search;agrep" encontrará todos os tópicos que contenham search e agrep. (alternativa ao anterior) Wiki web para a busca: Uma web, uma lista de webs separada por espaços, ou all (todas) as webs. Busca pelo nome do tópico (título) ou no texto (corpo/conteúdo) do tópico Ordena o resultado da busca pelo nome do tópico, última modificação, último editor, ou um campo nomedo de um TWikiForm Limita o número de resultados retornados

Padrão:

"texto"

requerido

search="texto" web="Nome" web="Main Know" web="all" scope="topic" scope="text" order="topic" order="modified" order="editby" order="formfield (nome)"

N/A web atual texto do tópico

nome do tópico

%SEARCH{"text" ...}%

limit="all" limit="16" regex="on" reverse="on"
casesensitive="on"

Todos (all)

Busca com expressão regular busca literal também permite ";" como and Inverte o sentido da busca busca sensível ao estado (maiúscula ou minúscula) Mostrar tópico somente o título do

busca ascendente ignorar estado mostrar o resumo mostrar o resumo mostrar busca mostrar cabeçalho mostrar total resultados em tabela

nosummary="on" bookview="on" nosearch="on" noheader="on" nototal="on" header="..." format="..."

Busca BookView. e.g. mostra o texto completo do tópico Suprimir a linha de busca Suprimir cabeçalho de busca ” Topics: Changed: By: " não mostrar o número de tópicos encontrados Formatação resultado. customizada do

Exemplo comum: %SEARCH{"wiki" web="Main" scope="topic"}% Exemplo formatado: %SEARCH{"FAQ" scope="topic" nosearch="on" nototal="on" header="| *Topic: * | *Summary: * |" format="| $topic | $summary |"% (mostra o resultado em uma tabela com cabeçalho)

Busca especial de meta dados Parâmetro: Descrição: Padrão: Que propriedade da busca é requisitada? "topicmoved" se a busca é por um tópico que pode ter sido type="topicmoved" requerido movido. "parent" se a busca é por um tópico que tenha um pai %METASEARCH{...}% específico. web="%WEB%"
topic="%TOPIC%" title="Titulo"

A Wiki web da busca: Uma web, uma lista de webs separada por requerido espaço, ou all (todas) as webs. o tópico ao qual a busca se requerido relaciona o texto que colocado antes de requerido cada resultado da busca

%VAR{"NOME" web="Web"}%

Pega um valor de preferência de uma web diferente da atual. Exemplo: Para pegar %WEBBGCOLOR% da web Main escreva %VAR{"WEBBGCOLOR" web="Main"}%, é #FFFFC0

Variáveis de Preferências
Variável: %WIKIWEBMASTER% %WIKIWEBLIST% %WEBTOPICLIST% %WEBCOPYRIGHT% %WEBBGCOLOR% %NOSEARCHALL% %NEWTOPICBGCOLOR% %NEWTOPICFONTCOLOR% %EDITBOXWIDTH% %EDITBOXHEIGHT% Nível : SL SL WL SL WL WL WL SL UL SL UL SL UL O Que:
Endereço de e-mail do Webmaster (remetente dos emails de notificação) Ex: twiki@im.ufba.br (no TWiki do IM-UFBA) Lista de webs de um ambiente TWiki (no canto direito superior dos tópicos) Links comuns da web (a segunda linha dos tópicos) Notificação de direito de cópia (Copyright) (no canto direito inferior dos tópicos) Cor de fundo da web Excluir a web de uma busca web="all" (todas) (ajuste a variável para on para ocultar webs) Cor de fundo de tópicos não existentes. (UL necessita autenticação para visualizar o tópico) Cor de fonte de tópicos não existentes. (UL necessita autenticação para visualizar o tópico) O tamanho horizontal da caixa de edição, é 70

SL UL O tamanho vertical da caixa de edição, é 15

%RELEASEEDITLOCKCHECKBOX%

SL UL

O estado padrão da caixa de checagem do "Liberar edição do tópico" (UnlockT opic) do preview. A caixa estará inicialmente marcada se Set RELEASEEDITLOCKCHECKBOX = checked="checked", ou desmarcada se vazio. Se marcado, tenha certeza de clicar em Edit para fazer novas modificações; Não volte com seu navegador para editar a página, ou você correrá o risco de editar o tópico ao mesmo tempo que outra pessoa! O valor é:

%DONTNOTIFYCHECKBOX%

O estado padrão da caixa de checagem do "Pequenas mudanças, Não notifique" (DontNotify) do SL UL preview. A caixa estará inicialmente marcada se Set DONTNOTIFYCHECKBOX = checked="checked", ou desmarcada se vazio. O valor é:

%ATTACHLINKBOX%

SL UL

O estado padrão da caixa de checagem "_link_" da página de anexação. A caixa estará inicialmente marcada se definida para CHECKED, ou desmarcada se vazio. Se marcado, um link será criado para o arquivo anexado no fim do tópico. O valor é: Meta tags http-equiv para os scripts view, rdiff, attach e search*.

%HTTP_EQUIV_ON_VIEW% %HTTP_EQUIV_ON_EDIT% %HTTP_EQUIV_ON_PREVIEW% %DENYWEBCHANGE% %ALLOWWEBCHANGE% %DENYTOPICCHANGE% %ALLOWTOPICCHANGE% %DENYWEBRENAME% %ALLOWWEBRENAME% %DENYTOPICRENAME% %ALLOWTOPICRENAME% %FINALPREFERENCES%

SL

SL UL Meta tags http-equiv para o script edit. SL UL WL WL (*) (*) WL WL (*) (*) SL WL
Meta tags http-equiv para o script preview. Lista de usuários e grupos que não têm permissão de modificar tópicos na Web. Lista de usuários e grupos que têm permissão de modoficar tópicos na Web. Lista de usuários e grupos que não têm permissão de modificar o tópico atual. Lista de usuários e grupos que têm permissão de modificar o tópico atual. Lista de usuários e grupos que não têm permissão de renomear tópicos na Web. Lista de usuários e grupos que têm permissão de renomear tópicos na Web. Lista de usuários e grupos que não têm permissão de renomear o tópico atual. Lista de usuários e grupos que têm permissão de renomear o tópico atual. Lista de preferências que não tem permissão de ser sobrepostas pelo próximo nível de preferências

Formatação do %SEARCH{...}%
Nome: $web $topic $topic(20) $topic(30, />) Nome da web Nome do Tópico Nome do Tópico, "- " com hífens a cada 20 caracteres -<br Nome do Tópico, com hífens a cada 30 caracteres e com separador "-<br />" Nome do Tópico, reduzido para 40 caracteres com a indicação "..." Tópico de texto formatado O marcador TRANCADA (se houver) Mostra última atualização do tópico, como 19 Apr 2004 - 22:45 Mostra última atualização do tópico, como 2004-04-19T22:45Z Número da última revisão de tópico, como 1.4 Nome de usuário Wiki da útima modificação do tópico, como Main.JohnSmith Nome de usuário da útima modificação do tópico, como JohnSmith Sumário do tópico O valor do campo de formulário; por exemplo, $formfield(TopicClassification) pode ser convertido para PublicFAQ. Isso se aplica somente a tópicos que tenham um TWikiForm valor do campo de formulário, "caracteres " com hífens a cada 10 É convertida para:

$topic(40, ...) $text $locked $date $isodate $rev $wikiusername $username $summary $formfield(name) $formfield(name, 10) $formfield(name, 20, -<br />) $formfield(name, 30, ...)

valor do campo de formulário, com hífens a cada 20 caracteres e o separador "-<br />" valor do campo de formulário, reduzido para 30 caracteres com a indicação "..."

Uma padrão em expressão regular para extrir algum texto do tópico. Por exemplo, $pattern(reg-exp) $pattern(.*?\*.*?Email\:\s*([^\n\r]+).*) extrai o endereço de e-mail de um item de lista no formato * Email: .... $n or $n() $nop or $nop() $quot $percnt $dollar Nova linha É um "não operar". Essa variável foi removida; útil para buscas aninhadas Aspas duplas ("). Forma alternativa da \" "escapada" Simbolo de percentagem (%) Simbolo de dollar ($)

Elementos de um Molde(Template) de Formulário

● ●

molde de formulário - uma seleção de campos definindo um formulário (substitui tabela de definição de categoria) ● Uma web pode usar um ou mais moldes de formulário formulário - um tópico contendo meta dados adicionais (além do TEXTAREA freeform) que categoriza o conteúdo (substitui tabela de definição de categoria) ● Em uma web com formulários habilitados, tópicos individuais podem ter um ou nenhum formulário campo de formulário - um item nomeado em um formulário (substitui nome de item de categoria) tipo de campo - seleciona o tipo de entrada: ● select - um menu deslizante (drop-down) ou uma caixa de seleção rolavel ● checkbox - uma ou mais caixas de seleção ● checkbox+buttons - uma ou mais caixas de seleção, com os botões Set (marcar) e Clear (apagar) ● radio - um ou mais botões de rádio ● text - um campo de texto de uma linha ● textarea - uma caixa de texto; o tamanho é definido como 40x10 (colunas x linhas) valor do campo - um ou mais valores para um grupo fixo (tipos select, checkbox e radio) ou texto livre de formulário. (substitui nome de item de categoria)

Exemplo de Molde de Formulário TWiki:
Name Campo 1 Campo 2 Campo 3 Campo 4 Campo 5 Campo 6 select checkbox radio text textarea Type Size 1 3 3 20 20x5 Values opção 1, opção 2, opção 3, opção 4, opção 5 Opção 1, Opção 2, Opção 3, Opção 4, Opção 5 Opção 1, Opção 2, Opção 3 Tooltip message este é o campo 1 este é o campo 2 este é o campo 3 este é o campo 5 este é o campo 6

checkbox+buttons 3

Opção1, Opção2, Opção3, Opção4, Opção5, Opção6 este é o campo 4

Formulário resultante: