tutorial twiki - AERH - Universidade Federal de Campina Grande

v. jul/2007
UNIVERSIDADE FEDERAL DE CAMPINA GRANDE – UFCG
CENTRO DE CIÊNCIAS EM RECURSOS NATURAIS – CTRN
UNIDADE ACADÊMICA DE ENGENHARIA CIVIL – UAEC
ÁREA DE ENGENHARIA DE RECURSOS HÍDRICOS - AERH
Laboratório de Hidráulica II Manoel Gilberto de Barros
Tutorial TWiki
Marília Silva Dantas
Imagine você um dia poder alterar diretamente o conteúdo de uma web, sem precisar de
um programa específico, conhecimentos de programação, ou mesmo de autorização de
webmasters de plantão. Hoje isso é possível graças ao TWiki.
Através do TWiki ganhamos uma descentralização do pólo de emissão das informações,
maior liberdade de expressão, e atualização das páginas web de forma muito mais fácil, dinâmica
e democrática.
Mas o que é o TWiki?
O TWiki é uma ferramenta de escrita colaborativa na Web, que consiste em possibilitar
que várias pessoas separadas geograficamente interajam, criando conteúdo utilizando apenas
um navegador.
O que é necessário para utilizar essa ferramenta?
Para a edição em TWiki o usuário necessita apenas de um navegador Web, concedendo
a quebra das barreiras geográficas para grupos de pesquisadores que querem compartilhar suas
informações em um mesmo ambiente na Internet, de uma forma dinâmica e sem a necessidade
de software especializado.
Ao entender o que é, e o que é necessário para utilizar essa ferramenta, vamos agora
aprender a usá-la.
Como começar?
Para começar vamos aprender alguns conceitos simples, porém indispensáveis.
•
WikiName nada mais é do que o seu nome de usuário.
• WikiWord ou PalavrasWikis são nomes de tópicos. Um nome do tópico de TWiki tem
sempre um formato fixo: duas ou mais palavras com iniciais maiúsculas e escritas juntas.
Ao se criar um WikiWord, cria-se automaticamente um hiperlink para esse novo tópico,
isso facilita o manuseio das webs, pois não é necessário saber em qual diretório está o
arquivo com o tópico - você apenas digita o nome, assim como também conduz
facilmente a tópicos de interesse, já que não é necessário escrever códigos e mais
códigos para criar tal link, facilitando até mesmo, ler o texto do tópico quando este estiver
em edição.
Nosso próximo passo para usufruir dessa ferramenta é se registrar no TWiki, ou seja,
apenas usuários registrados podem editar e criar webs. Para registrar-se é necessário contatar
Campus da Universidade Federal de Campina Grande
Rua Aprígio Veloso, 882 - Bodocongó - Laboratório de Hidráulica II - Bloco BU
Campina Grande - PB
Tel.: 55 83 3310 1461 / 3310.1155
1
os administradores do TWiki local, esses lhe disponibilizará um WikiName e uma senha, que lhe
dará acesso à ferramenta.
Depois de registrado, é hora de conhecer suas ferramentas, sua “linguagem”, e seu
funcionamento.
Ferramentas de trabalho
As ferramentas de trabalho do TWiki estão localizadas sempre no fim do corpo da web
como podemos ver na figura abaixo.
Ferramentas de
trabalho
As ferramentas de trabalho são:
•
•
•
•
•
•
•
•
[Edit] – Adiciona ou modifica o tópico
[Attach image or document] – Anexa arquivos ao tópico
[Printable version] – vai para uma versão selecionada da página, preparada para
impressão
[Raw text] – Mostra o texto cru, sem converter a formatação
[More topic actions] – controles adicionais, como [Rename/move], controle de
versão e configurações da origem do tópico
[r1.3 | > | r1.2 | > | r1.1] – mostra uma versão previa do tópico ou a diferença entre
duas versões
[Total page history] – tópicos estão sob controle de revisão – [diffs] mostra o
histórico completo de mudanças do tópico, ex. quem mudou o que e quando.
[Backlinks] - pesquisa quais outros tópicos que linkam a esse link
Campus da Universidade Federal de Campina Grande
Rua Aprígio Veloso, 882 - Bodocongó - Laboratório de Hidráulica II - Bloco BU
Campina Grande - PB
Tel.: 55 83 3310 1461 / 3310.1155
2
Edição e Criação de Páginas
Para editar Tópicos TWiki é preciso entrar no modo de edição da página, que de modo
geral se acessa através do link [Edit]. O sistema solicitará então seu WikName e Senha de
usuário para a autenticação. Uma vez autenticado, aparece na tela a área de edição. É
importante que se faça uma comparação do texto no modo de edição com a página no seu
modo de exibição (use os botões Voltar e Avançar no seu navegador), para que se tenha uma
noção visual da linguagem TWiki. Daí, basta editar o conteúdo desejado e clicar no botão
[Preview Changes] na base da página para prever o resultado da edição. Caso precise corrigir
algo clique no botão voltar do navegador e após as alterações clique no [Preview Changes], de
novo. Definido o conteúdo, é só confirmar a edição clicando no botão [Save Changes] e pronto!
Para criar um novo tópico, é necessário entrar no modo de edição, da mesma forma
citada acima, e digitar um novo texto com uma WikiWord (ex: MinhaPagina). Agora segue-se o
mesmo procedimento acima (verifica-se as alterações [Preview Changes] e salva-se o tópico
[Save Changes]) O WikiWord aparecerá com uma tarja amarela e um sinal de interrogação no
final, que significa que o tópico ainda não existe, ao clicar na interrogação entra-se no modo de
edição do novo item, daí é só editar (como foi visto no parágrafo anterior).
Escrita TWiki
Embora o TWiki também aceite códigos HTML 3.2 e Javascript, este utiliza uma
“linguagem” própria, muito simples e fácil para edição de suas webs. Vale ressaltar que não é
necessário saber HTML 3.2 muito menos Javascript, essas linguagem podem ser usadas para
implementar algumas webs, mas como o foco do TWiki é disponibilizar uma interação simples e
eficaz entre os participantes de determinado grupo, é importante que o conteúdo seja exposto da
maneira mais simples possível, facilitando assim a edição e a criação das webs. Em outras
palavras a melhor “linguagem” a ser utilizada em uma web utilizada por um grupo é a linguagem
Wiki (TWiki).
Assim vejamos alguns recursos fáceis de usar com o objetivo de melhor organizar os
textos e outros elementos no ambiente de edição de uma web desenvolvida em TWiki.
•
•
•
•
•
•
•
•
•
Títulos e subtítulos podem ser formados usando ---++ antecedendo os títulos e ---+++
antecedendo os subtítulos.
Separe cada parágrafo com uma linha em branco.
Três (ou mais) hifens consecutivos expandem-se em uma linha horizontal: --Para indicar uma palavra ou frase em negrito, coloque-a entre asteriscos: *negrito*.
Para indicar uma palavra ou frase em itálico, coloque-a entre sublinhados: _itálico_.
Para criar uma lista adicione seus itens um em cada linha no formato:
[espaço][espaço][espaço][*][espaço]Texto....
Iniciar itens em uma lista numerada com [espaço][espaço][espaço][1][espaço]Texto....
O "1" (ou qualquer número) será substituído pelo número correto, em ordem. Comece
a contar espaços para o "1" do começo de uma nova linha.
Para incluir uma imagem, digite sua URL. Você também pode anexar uma imagem à
página e mostrá-la com o texto.
Para um link externo, digite a URL completa: http://twiki.org.
Em anexo segue mais “comandos” de formatação que podem ser usados para melhorar a
aparência de uma web desenvolvida em TWiki.
Anexando arquivos
Campus da Universidade Federal de Campina Grande
Rua Aprígio Veloso, 882 - Bodocongó - Laboratório de Hidráulica II - Bloco BU
Campina Grande - PB
Tel.: 55 83 3310 1461 / 3310.1155
3
O TWiki também disponibiliza a opção de anexar qualquer tipo de arquivo em suas webs,
isso significa que depois de anexados, estes podem ser abertos, baixados e visualizados.
Vejamos como utilizar esse recurso.
Anexar um arquivo no TWiki é exatamente como incluir um arquivo num email.
• Clique na ferramenta [Attach]
• Clique em Browse para procurar o arquivo
• Caso queira criar um link automaticamente para o arquivo na sua web, basta marcar a
opção Create a link to the attached file, e no caso de desejar que este arquivo não
apareça em uma tabela na web clica-se em Do not show attachment in table.
• Em seguida, clique em Upload file, e desça até o final da página e veja se seu anexo
está na listagem.
É recomendável que no caso de se anexar uma imagem que deve ser exibida junto com o
texto, marcar a opção Create a link to the attached file.
Para mover a disposição da imagem / arquivo em relação ao texto, basta editar o tópico e
posicionar a última linha (a linha contém %ATTACHURL%) onde desejar.
Essas são funcionalidades básicas do TWiki, agora o próximo passo é colocá-las em
prática.
Dicas TWiki
Abaixo segue alguns site com dicas interessantes para quem está começando a utilizar
essa nova tecnologia.
•
•
•
http://twiki.softwarelivre.org/bin/view/Arte/DicasTWiki
http://twiki.im.ufba.br/bin/view/Portugues/TWikiTutorial
http://penta2.ufrgs.br/edu/twiki/
Exemplos de Webs em TWiki
A seguir vejamos alguns exemplos de webs desenvolvidas em TWiki.
•
•
•
•
Wikipédia - http://pt.wikipedia.org/
LSD - http://www.lsd.ufcg.edu.br/
Projeto SegHidro - http://seghidro.lsd.ufcg.edu.br/
Laboratório de Hidráulica II - http://www.hidro.ufcg.edu.br/hid2/
Sites relacionados
http://pt.wikipedia.org/wiki/TWiki
http://twiki.im.ufba.br/bin/view/Portugues/TWikiTutorial
http://www.colivre.coop.br/bin/view/Tech/TutorialTWiki
http://penta2.ufrgs.br/edu/twiki/
Campus da Universidade Federal de Campina Grande
Rua Aprígio Veloso, 882 - Bodocongó - Laboratório de Hidráulica II - Bloco BU
Campina Grande - PB
Tel.: 55 83 3310 1461 / 3310.1155
4
Anexo
Comandos de Formatação TWiki
Comando de Formatação:
Parágrafos:
Linhas em branco criarão novos parágrafos.
Exemplo: Você
escreve:
1° parágrafo
2° parágrafo
Títulos:
---++ Sushi
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 ---+++ Maguro
'+' 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 TWikiVariables. 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%.
Texto em Negrito:
*Negrito*
Palavras ficam negritadas quando colocadas entre * asteriscos.
Texto em Itálico:
_Itálico_
Palavras ficam em itálico quando colocadas entre _ sublinhados.
Bold Italic:
__Italico negrito__
palavra ficam itálico negrito quando colocadas entre __
sublinhados duplos.
Fonte Fixa:
=Fonte fixa=
Palavras são mostradas em fonte fixa quando colocadas entre =
sinais de igual.
Fonte Fixa Negritada:
==Fonte fixa
Palavras são mostradas em fonte fixa negritada quando colocada negritada==
entre == sinais de igual duplos.
Nota: Certifique-se de colocar os sinais * _ = == junto às palavras, _Isso funciona_,
e.g retire os espaçamentos.
_isso não _
Modo Verbatim:
<verbatim>
Circunde trechos de código e outros textos formatados com tags
class CatAnimal {
<verbatim> e </verbatim>.
void purr() {
Nota: Use em vez disso as tags <pre> e </pre> se você quiser que
<code here>
seu código HTML seja interpretado.
}
Nota: Cada tag deve ficar em uma linha separada.
}
</verbatim>
Separador (linha horizontal):
------Ao menos três traços no início de uma linha.
Listar Itens:
* item
Três espaços e um asterisco.
Listas Aninhadas de Itens:
Seis, nove, ... espaços e um asterisco.
* level 1
* level 2
Você obtém:
1° parágrafo
2° parágrafo
Sushi
Maguro
Negrito
Itálico
Italico negrito
Fonte fixa
Fonte fixa negritada
Isso funciona, _isso
não _
class CatAnimal {
void purr() {
<code here>
}
}
•
item
• level 1
o level 2
Lista Ordenada:
1 Sushi
1. Sushi
Três espaços e um número.
1 Dim Sum
2. Dim Sum
Lista de Definição:
Sushi: Japan
Sushi
Três espaços, o termo, dois pontos, um espaço, seguido pela
Dim&nbsp;Sum: S.F.
Japan
definição.
Dim Sum
Nota: Termos com espaços não são suportados. Caso você tenha
S.F.
um termo com mais de uma palavra, separe-as por traços ou com a
entidade &nbsp; non-breaking-space.
Tabela:
| *L* | *C* | *R* |
L C R
Espaços opcionais seguidos pelas células delimitadas por barras | A2 | 2 | 2 |
A2 2
2
Campus da Universidade Federal de Campina Grande
Rua Aprígio Veloso, 882 - Bodocongó - Laboratório de Hidráulica II - Bloco BU
Campina Grande - PB
Tel.: 55 83 3310 1461 / 3310.1155
5
verticais.
| A3 | 3 | 3 |
A3 3
3
Nota: | *negrito* | células são interpretadas como cabeçalhos de
| multi span |||
multi span
tabelas.
| A4 \ | next \ | next |
A4 next next
Nota: | espaçadas | células são interpretadas como
centralizadas.
Nota: | espaçadas | células são interpretadas como alinhadas à
direita.
Nota: | colspan 2 || células são interpretadas como colunas multispan.
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:
WebNotify
WebNotify
PalavrasMaiúsculasJuntas (ou WikiWords) formarão um link
automaticamente.
Know.ReadmeFirst
ReadmeFirst
Nota: Caso deseje formar um link para um tópico em uma Web
TWiki diferente, escreva Webname.TopicName.
Links Forçados:
[[wiki syntax]]
wiki syntax
Você pode forçar a criação de links internos colocando palavras
entre colchetes duplos.
[[Main.TWiki users]]
Main.TWiki users
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:
[[WikiSyntax][syntax]] syntax
Crie um link onde você possa especificar o texto do link e a
[[http://gnu.org][GNU]] GNU
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:
[[WebHome#NotThere]] WebHome#NotThere
Você pode definir uma referência a um link dentro de um tópico
[[#MyAnchor][Jump]]
TWiki (chamado nome de âncora) e formar um link a ele. Para
Jump
definir uma âncora escreva #AnchorName no início de uma linha.
O nome de âncora deve ser uma WikiWord. Para formar link para #MyAnchor To here
To here
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:
<nop>SunOS
SunOS
Previa que um WikiWord seja linkada precedendo-a com uma tag
<nop>.
Campus da Universidade Federal de Campina Grande
Rua Aprígio Veloso, 882 - Bodocongó - Laboratório de Hidráulica II - Bloco BU
Campina Grande - PB
Tel.: 55 83 3310 1461 / 3310.1155
6