REGRAS DO TXT2TAGS
------------------

primero, as convenes
  INI = incio da linha
  FIM = fim da linha
  TAB = o caractere TAB, o \t


---------------------------------------------------------------------
cabealho          linha1 \n linha2 \n linha3

 - as primeiras 3 linhas do arquivo fonte
 - essas linhas sero as 3 primeiras linhas do documento final,
   bem diferenciadas do texto normal, ou sero colocadas sozinhas
   na primeira pgina (se for paginvel)
 - o contedo dos cabealhos  livre, mas o seguinte formato 
   recomendado para a maioria dos documentos:
     linha 1: ttulo do documento
     linha 2: nome do autor e/ou e-mail
     linha 3: data e/ou verso do documento (lembre do %%date)
 - o cabealho tem apenas texto, as marcas no so interpretadas
 - deixe a primeira linha em branco para definir um cabealho vazio
   (bom para testes na linha de comando)
 - deixe a segunda e a terceira linha em branco para omitir partes do
   cabealho

---------------------------------------------------------------------
ttulo             <igual>palavras<igual>

 - sinais de igual BALANCEADOS ao redor, = assim =
 - o nmero de sinais de igual indica se  ttulo, subttulo, subsub...
 - ==== isso  um subsubsubttulo ====
 -    ==    espaos antes ou depois das marcas so opcionais       ==
 - o mximo  de 4 subttulos, =====assim=====
 - outras marcas como negrito e itlico no so interpretadas nos ttulos
 - === sinais no balanceados no fazem um ttulo =
 - o ttulo NO  pode ser multilinha ==como
                            esse==
 - ttulos podem receber ncoras, = assim =[ancora]
   para criar um link para uma ncora, crie um [link #ancora] como de
   costume

---------------------------------------------------------------------
ttulo numerado    <mais>palavras<mais>

 - sinais de mais BALANCEADOS ao redor, + assim +
 - o nmero de sinais de mais indica se  ttulo, subttulo, subsub...
 - ++++ isso  um subsubsubttulo ++++
 -    ++    espaos antes ou depois das marcas so opcionais       ++
 - o mximo  de 4 subttulos, +++++assim+++++
 - outras marcas como negrito e itlico no so interpretadas nos ttulos
 - +++ sinais no balanceados no fazem um ttulo +
 - o ttulo numerado NO  pode ser multilinha ==como
                            esse==
 - ncoras tambm podem ser usadas em ttulos numerados

---------------------------------------------------------------------
pargrafo

 - os pargrafos so demilitados por linhas em branco
 - outras estruturas como lista, citao ou tabela fecham um pargrafo

---------------------------------------------------------------------
comentrio         <INI><porcentagem>comentrios

 - uma linha que comea com o sinal de porcentagem, % assim
 - o % deve estar no incio da linha, sem espaos antes
 - como comentrios, eles no so mostrados no texto final
 - NO so multilinha, ento cada linha comentada deve comear com %
 - til para lembretes e avisos

---------------------------------------------------------------------
negrito         <asterisco><asterisco>palavras<asterisco><asterisco>

 - dois asteriscos ao redor, **assim**
 - NO  multilinha **como
                    esse**
 - NO colocar espaos nas marcas, ** assim **

---------------------------------------------------------------------
itlico            <barra><barra>palavras<barra><barra>

 - duas barras ao redor, //assim//
 - como o negrito, NO  multilinha e NO pode ter espaos nas marcas

---------------------------------------------------------------------
sublinhado         <sublinha><sublinha>palavras<sublinha><sublinha>

 - dois sublinhas ao redor, __assim__
 - como o negrito, NO  multilinha e NO pode ter espaos nas marcas

---------------------------------------------------------------------
monoespaado       <crase><crase>palavras<crase><crase>

 - crases (acento grave) ao redor, ``assim``
 - outras marcas NO so interpretadas dentro do monoespaado
 - como o negrito, NO  multilinha e NO pode ter espaos nas marcas

---------------------------------------------------------------------
linha pr-formatada   <INI><crase><crase><crase><espao>palavras

 - uma linha iniciada por 3 crases e um espao, ``` assim
 - as crases devem estar no incio da linha, sem espaos antes
 - coloque um espao aps as crases para separ-las do texto
 - outras marcas NO so interpretadas dentro da linha pr-formatada
 - a linha pr-formatada NO  multilinha,  claro

---------------------------------------------------------------------
rea pr-formatada <INI><crase><crase><crase><FIM>
                   linhas
                   <INI><crase><crase><crase><FIM>

 - uma linha com exatamente 3 crases
 - seguida das linhas j formatadas
 - seguidas por outra linha com exatamente 3 crases
 - NO  permitido colocar espaos antes ou depois das crases
 - marcas NO so interpretadas dentro da rea pr-formatada

---------------------------------------------------------------------
linha horizontal   <hfen><hfen><hfen><hfen><hfen><hfen>...
                   <sublinha><sublinha><sublinha><sublinha>...
                   <igual><igual><igual><igual><igual><igual>...

 - uma linha com pelos menos 20 hfens, sublinhas ou sinais de igual
 - espaos opcionais podem ser colocados no incio ou fim da linha
 - qualquer outro caractere invalida a marca
 - se o primeiro caractere for um sinal de igual, a linha vai ser
   grossa, ou indicar uma pausa em formatos temporais como o mgp

---------------------------------------------------------------------
links              url ou email
links (explicito)  <abre-colchete>nome url<fecha-colchete>

 - um endereo de internet vlido: URL, ftp, news ou email
 - estas entidades so detectadas automaticamente, sem marcao
 - o protocolo (http, https, ftp)  opcional, www.assim.com
 - tambm  possvel dar nomes a um link, [clique aqui www.assim.com]
 - se o documento final no usa links, eles so somente sublinhados

---------------------------------------------------------------------
citao            <INI><TAB>palavras

 - uma linha que comea com um TAB
 - mais TABs no incio indicam uma citao mais profunda (se permitido)
 - no h profundidade mxima (em alguns documentos sim)
 - embelezadores como negrito e itlico so permitidos dentro de citaes,
   mas outras estruturas como listas, ttulo ou comentrios no.

---------------------------------------------------------------------
lista              <INI><hfen><espao>palavras

 - uma linha que comea com um hfem seguido de exatamente um espao,
   - assim
 - o primeiro caractere da lista NO pode ser um espao, -  assim
 - espaos opcionais (espaos, no TABs) no incio da linha indicam
   sublistas
 - no h profundidade mxima (em alguns documentos sim)
 - as sublistas terminam quando  encontrado um item da lista me
 - a lista termina com duas linhas em branco consecutivas

---------------------------------------------------------------------
lista numerada     <INI><mais><espao>palavras

 - uma linha que comea com um sinal de mais seguido de exatamente um
   espao, + assim
 - o primeiro caractere da lista NO pode ser um espao, +  assim
 - as mesmas regras da lista normal se aplicam  numerada

---------------------------------------------------------------------
lista de termos    <INI><dois-pontos><espao>palavras

 - uma linha que comea com dois-pontos seguido de exatamente um
   um espao, seguido de palavras (o termo):
   : assim
 - o primeiro caractere do termo pode ser um espao, :   assim
 - as mesmas regras da lista normal se aplicam  de termos

---------------------------------------------------------------------
imagem             <abre-colchete>arquivo.XXX<fecha-colchete>

 - um nome de arquivo colocado entre colchetes, [assim.jpg]
 - o nome do arquivo de termninar com .PNG, .jpg, .GIF, ...
 - smbolos so permitidos no nome do arquivo, [assim!~1.jpg]
 - NO  permitido espaos no nome do arquivo, [assim nao.gif]
 - NO  permitido espaos nos colchetes, [ assim.gif ]
 - o documento final deve ter suporte a imagens
 - a posio da marca na linha define o alinhamento da imagem:
   [esquerda.GIF] blablabla [centro.GIF] blablabla [direita.GIF]

---------------------------------------------------------------------
data (iso)         <porcentagem><porcentagem>date
data (c/formato)   <porcentagem><porcentagem>date(formato)

 - dois sinais de porcentagem seguidos pela palavra "date"
 - macro rpida para a data atual no formato ISO aaaammdd
 - a data aceita um formato especial, com %Y, %m, %d e amigos
 - til para o cabealho e versionamento
 - sinal de que o txt2tags est ficando BLOAT...

---------------------------------------------------------------------
tabela             <pipe><espao>campo1<space><pipe><espao>campo2...

 - uma barra vertical (pipe) no incio, identifica uma linha de tabela
 - dois pipes no incio, identificam uma linha de ttulo da tabela
 - espaos antes do primeiro pipe indicam que a tabela  centralizada
 - os campos so separados pela string ' | '
 - um | no final da primeira linha da tabela indica que ela ter borda
 - um | no final das outras linhas so ignorados (estticos apenas)
 - o espaamento interno define o alinhamento de cada campo
 - documentos que alinham colunas e no campos (como o sgml e o
   LaTeX), baseiam-se no alinhamento da primeira linha.
 - embelezadores so interpretados dentro de tabelas
 - fora comentrios, qualquer linha que no comece com | fecha a tabela

---------------------------------------------------------------------
protegido           <aspas><aspas>palavras<aspas><aspas>

 - duas aspas duplas ao redor, ""assim""
 - usado para "proteger" um texto da converso (passa como est)
 - marcas no so interpretadas dentro do protegido
 - NO  multilinha

---------------------------------------------------------------------
linha protegida     <INI><aspas><aspas><aspas><espao>palavras

 - uma linha iniciada por 3 aspas e um espao, """ assim
 - as aspas devem estar no incio da linha, sem espaos antes
 - coloque um espao aps as aspas para separ-las do texto
 - outras marcas NO so interpretadas dentro da linha protegida
 - a linha protegida NO  multilinha,  claro

---------------------------------------------------------------------
rea protegida     <INI><aspas><aspas><aspas><FIM>
                   linhas
                   <INI><aspas><aspas><aspas><FIM>

 - uma linha com exatamente 3 aspas
 - seguida das linhas j formatadas
 - seguidas por outra linha com exatamente 3 aspas
 - NO  permitido colocar espaos antes ou depois das aspas
 - marcas NO so interpretadas dentro da rea protegida

---------------------------------------------------------------------
configurao        <INI><porcentagem><exclamao>nome: valor

- um comentrio especial no incio da linha, como %!nome: valor
-  possvel atrelar a configurao a um destino especfico, no
  formato %!chave(destino): valor
- alguns nomes vlidos: options, encoding, style, preproc, postproc
- uma configurao com um nome invlido  considerada um comentrio

---------------------------------------------------------------------
comando de insero <INI><porcentagem><exclamao>include: arquivo

- um comentrio especial no incio da linha, com a palavra 'include'
-  possvel atrelar um destino ao comando, como em
  %!include(destino): arquivo
- h trs tipos de insero:
  - %!include:   arquivo.t2t   -- insere o corpo de um .t2t
  - %!include: ``arquivo.txt`` -- insere um texto j formatado
  - %!include: ''arquivo.xxx'' -- insere um texto j convertido

---------------------------------------------------------------------

Aurelio Marinho Jargas
http://txt2tags.sf.net
