Formatação de Texto TWiki

TWiki Editing Shorthand

1° parágrafo

2° parágrafo

---++ Sushi

---+++ Maguro

*Negrito*

_Itálico_

__Italico negrito__

=Fonte fixa=

==Fonte fixa negritada==

_Isso funciona_,
_isso não _

<verbatim>
class CatAnimal {
  void purr() {
    <code here>
  }
}
</verbatim>

class CatAnimal {
  void purr() {
    <code here>
  }
}

-------

   * item bolota

      * Coisa aninhada

   1 Sushi
   1 Dim Sum

   Sushi: Japan
   Dim Sum: S.F.

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

WebNotify

Know.ReadmeFirst

[[wiki syntax]]

[[Main.TWiki users]]

[[WikiSyntax][syntax]]

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

[[WebHome#NotThere]]

[[#MyAnchor][Jump]]

#MyAnchor To here

<nop>SunOS

Usando HTML

Você pode utilizar sem problemas qualquer tag HTML que desejar - no entanto, existem algumas usabilidades e considerações técnicas a serem lembradas.

HTML e a Usabilidade do TWiki

• Em páginas de colaboração, é preferível que NÃO se use HTML, mas que se use TWiki shorthand - isso torna o texto organizado e fácil de editar.
• NOTA: O TWiki é projetado para trabalhar com um grande conjunto de navegadores e plataformas, mantendo compatibilidade com HTML 3.2 na instalação padrão - adicionando HTML puro, particularmente tags de navegadores específicos (ou qualquer outra marcação que não seja comum a todos), reduzirá a compatibilidade projetada.

Renderização HTML do TWiki

• O TWiki converte a notação shorthand em XHTML 1.0 para visualização. Pra copiar uma página totalmente codificada em HTML, simplesmente veja o fonte em seu navegador e salve o conteúdo.
  • Se você precisa salvar HTML freqüentemente, você poderia avaliar o TWiki:Plugins/GenHTMLAddon - isso irá "gerar um diretório contendo versões renderizadas de uma seleção de páginas TWiki junto com qualquer arquivo anexado."
• NOTA: Os simbolos < e > das tags HTML devem estar na mesma linha, ou a tag será quebrada.
  • Essa característica possibilita que você entre com os simbolos < e > sem fechamento - como um símbolo de menor-que ou maior-que - e ter isso automaticamente renderizado como se tivesse inserido o caracter HTML <, ex: a > b
  • Se você está colando um texto HTML pré-formatado e notou problemas, cheque o arquivo em um processador de textos sem quebra de linhas. Também, salve sem quebras súbitas de linha no texto, em seu programa de edição de HTML.

Hiperlinks

A habilidade de criar links sem nenhuma formatação é provida pelo núcleo do TWiki, possibilitada por WikiWords. Novas regras de linkagem TWiki são simples extensões da sintaxe que provêem um novo conjunto de opções flexíveis.

Links Internos

• GoodStyle é uma WikiWord que forma um link para o tópico GoodStyle, localizado na web Foswiki atual.

• NotExistingYet? é um tópico cuja criação ainda não terminou, ou seja, ele acaba de ser criado, mas não tem conteúdo. Para terminar a criação do tópico, inserindo conteúdo nele, clique no sinal de ? (Experimente clicar na interrogação nesse tópico, mas depois cancele - criar o tópico estragaria esse exemplo )

Links Externos

• http://..., https://..., ftp://..., gopher://..., news://..., file://..., telnet://... e mailto:...@... produzem um link automaticamente.

• Endereços de Email como nome@dominio.com também produzem um link automaticamente.

• [[Colchetes]] permitem que você crie facilmente links não-WikiWord.
  • Você pode escrever também [[http://yahoo.com Yahoo home page]] como uma maneira mais fácil de fazer links externos com um texto descritivos para o link, como em Yahoo home page.

Variáveis TWiki

Variáveis são nomes limitados por sinais % que são expandidos para o código.

• %TOC% : Gera automaticametne uma lista do conteúdo de um tópico baseado nos cabeçalhos. Veja o topo dessa página para um exemplo.

• %WEB% : A página atual, ou seja Portugues.

• %TOPIC% : O nome do tópico atual é TextFormattingRules.

• %ATTACHURL% : A URL do arquivo anexo ao tópico atual. Exemplo de uso: Se você anexa um arquivo a um tópico você pode se referir a ele como em %ATTACHURL%/image.gif para mostrar a URL para o arquivo ou imagem no seu texto.

• %INCLUDE{"SomeTopic"}% : Inclui o conteúdo de outro tópico. A valor Foswiki da web atual é a web padrão. Exemplo: %INCLUDE{"TWiki.SiteMap"}%

• %SEARCH{"sushi"}% : Busca inline mostrando os resultados embutidos em um tópico. FormattedSearch te dá controle sobre a formatação, usado para criaraplicações web-based.

• TWikiPreferences define variáveis válidas para todo o site. Entre outras:
  • Quebra de linha: Escreva %BR% para iniciar uma nova linha
  • Texto Colorido: Escreva: %RED% Red %ENDCOLOR% e %BLUE% blue %ENDCOLOR% colors para obter as cores: Red e blue .
  • Gráficos de Documentação: Escreva: %H% Help, %T% Tip, %X% Alert para obter: Help, Tip, Alert. Para mais informações veja TWikiDocGraphics?.

• Existem muitas outras variáveis, veja em TWikiVariables.

Extensões para Formatação com TWikiPlugins

Plugins fornecem capacidades adicionais de formatação de texto e podem expandir a funcionalidade do Foswiki em muitas outra áreas. Por exemplo, o opcional SpreadSheetPlugin permite que você crie um spreadsheet com as mesmas notações básicas usadas em tabelas TWiki.

Os plugins disponiveis estão na web Plugins em TWiki.org. Os plugins atualmente habilitados, nesta instalação do TWiki, são listados por: %PLUGINDESCRIPTIONS%:

• TWikiCompatibilityPlugin (Foswiki-1.0.9, $Rev: 6017 (2010-01-11) $): add TWiki personality to Foswiki
• SpreadSheetPlugin (10 Nov 2009, $Rev: 5484 (2009-11-10) $): Add spreadsheet calculations like "$SUM($ABOVE())" to Foswiki tables and other topic text
• AttachContentPlugin (2.3.2, $Rev: 7552 (2010-05-26) $): Saves dynamic topic text to an attachment
• BeautifierPlugin (Dakar, $Rev: 15560 (12 Dec 2008) $): Highlights and formats code fragments
• CalendarPlugin (12 Aug 2009, $Rev: 5432 (2009-11-04) $): Show a monthly calendar with highlighted events
• CommentPlugin (12 Sep 2009, $Rev: 4843 (2009-09-11) $): Quickly post comments to a page without an edit/preview/save cycle
• DateFieldPlugin (Dakar, 15317): Adds a date type for use in forms
• DirectedGraphPlugin (1.8, $Rev: 6986 (2010-03-29) $): Draw graphs using the GraphViz utility
• EditTablePlugin (4.34, $Rev: 5854 (2009-12-23) $): Edit tables using edit fields, date pickers and drop down boxes
• FilterPlugin (2.03, $Rev: 8284 (2010-07-23) $): Substitute and extract information from content by using regular expressions
• GoogleAnalyticsPlugin (2.1.1, 4729): Adds Google Analytics javascript code to specified pages
• HttpsRedirectPlugin (v1.0, $Rev: 3728 (2009-04-28) $): Redirect authenticated users to HTTPS url.
• ImageGalleryPlugin (5.10, $Rev: 6295 (2010-02-12) $): Displays image gallery with auto-generated thumbnails from attachments
• ImagePlugin (2.31, $Rev: 6307 (2010-02-12) $): Control the display and alignment of images using an easy syntax
• InterwikiPlugin (20 Sep 2009, $Rev: 5022 (2009-09-20) $): Link ExternalSite?:Page text to external sites based on aliases defined in a rules topic
• JQueryPlugin (3.51, $Rev: 20090710 (2009-07-10) $): jQuery JavaScript library for Foswiki
• MathModePlugin (4.01, $Rev: 4640 (2009-08-10) $): Include LaTeX formatted math in your Foswiki pages
• PreferencesPlugin (20 Sep 2009, $Rev: 5037 (2009-09-20) $): Allows editing of preferences using fields predefined in a form
• RedirectPlugin (1.1, $Rev: 7923 (2010-06-26) $): Create a redirect to another topic or website.
• RenderListPlugin (2.2, $Rev: 5042 (2009-09-20) $): Render bullet lists in a variety of formats
• SlideShowPlugin (02 Aug 2008, $Rev: 2742 (2009-02-26) $): Create web based presentations based on topics with headings.
• SlidyPlugin (Dakar, $Rev: 15566 (12 Dec 2008) $): Create web based presentations based on topics with headings; operate presentation like an ordinary PowerPoint presentation.
• SmiliesPlugin (20 Sep 2009, $Rev: 5046 (2009-09-20) $): Render smilies like as icons
• TablePlugin (1.044, $Rev: 5755 (2009-12-08) $): Control attributes of tables and sorting of table columns
• TagMePlugin (02 Mar 2010, $Rev: 6613 (2010-03-02) $): Tag wiki content collectively to find content by keywords
• TopicTranslationsPlugin (1.0, $Rev: 7814 (2010-06-15) $): Manages a topic's translations into several languages.
• TwistyPlugin (1.5.3, $Rev: 4751 (2009-09-02) $): Twisty section Javascript library to open/close content dynamically
• ZonePlugin (2.1, $Rev: 6966 (2010-03-28) $): Gather content of a page in named zones while rendering it

Verifique o estado atual do plugin e os ajustes para este site em TWikiPreferences.

Erros comuns de Edição

As regras de formatação TWiki são bastante simples de usar e rápidas de digitar. Porém, existem certas coisas em que se deve prestar atenção, pegas na FAQ de Formatação de Texto:

• Q: Texto envolto entre < e > não é mostrado. Como posso mostrá-lo como ele é?
  • A: Os caracteres '<' and '>' têm um significado especial em HTML, eles definem tags HTML. Você precisa escapar deles, então escreva '<' em vez de '<', e '>' em vez de '>'.
    Exemplo: Digite 'prog <filename>' para obter 'prog <filename>'.
  • A: Os caracteres < e > têm significado especial em HTML, eles definem suas tags. Você precisa escapar deles, então escreva "<" no lugar de "<" e ">" no lugar de ">".
    Exemplo: digite "programa <nomedoarquivo>" para ter "programa <nomedoarquivo>".

• Q: Porque o caracter "&" não aparece algumas vezes?
  • A: O caracter "&" tem significado especial em HTML, ele inicia o que é chamado de entidade de caracter, i.e. "©" é o © caracter de copyright. Você precisa escapar do "&" para vê-lo como ele é, então escreva "&" no lugar de "&".
    Exemplo: Escreva "Isso & aquilo" para ter "Isso & aquilo".

-- MikeMannix? - 02 Dec 2001
-- PeterThoeny? - 01 Feb 2003