Provided by:
txt2tags_2.6-3_all 
NOME
txt2tags - ferramenta para formatar e converter textos
SINOPSE
txt2tags [op,c~oes] [ARQUIVO...]
DESCRI,C~AO
O txt2tags le um arquivo texto com poucas marcacoes e o converte para:
ASCII Art, AsciiDoc, Creole, DocBook, DokuWiki, Google Code Wiki, HTML,
LaTeX, Lout, MagicPoint, Man page, MoinMoin, PageMaker, Plain Text,
PmWiki, SGML, Wikipedia e XHTML.
Esta pagina de manual foi criada pelo txt2tags a partir de um arquivo
de texto. Este mesmo arquivo de texto tambem e convertido para HTML e
colocado no site do programa para consulta.
UM arquivo fonte, VARIOS destinos - http://txt2tags.org
SINTAXE
Cabecalhos As 3 primeiras linhas do arquivo fonte
Titulo = palavras =
Titulo numerado + palavras +
Comentario % comentarios
Linha de separacao -----------------------...
Linha destacada =======================...
Imagem [arquivo.jpg]
Link [nome url]
Negrito **palavras**
Italico //palavras//
Sublinhado __palavras__
Riscado --palavras--
Monoespacado ``palavras``
Texto protegido ""palavras""
Texto com tags ''palavras''
Paragrafo palavras
Citacao <TAB>palavras
Lista - palavras
Lista numerada + palavras
Lista de definicao : palavras
Tabela | cel1 | cel2 | cel3...
Linha formatada ``` palavras
Linha protegida """ palavras
Linha com tags ''' palavras
Area formatada ```
linhas
```
Area protegida """
linhas
"""
Area com tags '''
linhas
'''
OP,C~OES
--art-chars=STRING
Define STRING como a lista de caracteres usados para fazer os
enfeites do ASCII Art, nesta ordem: canto, borda, lado, linha1,
linha2, nivel2, nivel3, nivel4, nivel5. O valor padrao da string
e +-|-==-^". Esta opcao e utilizada somente pelo formato ASCII
Art.
-C, --config-file=ARQUIVO
Le a configuracao a partir do arquivo externo ARQUIVO. A
configuracao deve estar no formato %!nome:valor. Veja o topico
CONFIGURACOES para mais detalhes.
--css-sugar
Prepara o codigo HTML/XHTML para ser usado com arquivos CSS. Os
atributos das tags sao removidos, tags de formatacao sao
evitadas, o cabecalho e composto pelas tags H1, H2 e H3, novos
DIVs sao criados: #header, #body, .toc.
--css-inside
Insere o conteudo do arquivo CSS no cabecalho do documento
HTML/XHTML. Use --style para indicar o arquivo CSS a ser lido.
--dump-config
Exibe todas as configuracoes encontradas e sai.
--dump-source
Exibe os fontes do documento, com os arquivos incluidos
(%!include) expandidos.
--encoding=C'ODIGO
Define a codificacao do arquivo para C'ODIGO. Alguns exemplos sao
UTF-8 e iso-8859-1.
--gui
Carrega a interface grafica (Tk).
-h, --help
Exibe o texto de ajuda e sai.
-H, --no-headers
Suprime os cabecalhos e o rodape do documento. Apenas o Corpo do
documento sera mostrado.
--headers
Exibe os cabecalhos e o rodape no documento. Esta opcao e usada
por padrao.
--height=N
Define a altura da saida para N linhas. Esta opcao e utilizada
somente pelo formato ASCII Art, quando tambem utilizada a opcao
--slides.
-i, --infile=ARQUIVO
Define ARQUIVO como arquivo fonte. Use '-' para ler os dados de
STDIN.
--mask-email
Esconde os e-mails dos robos de SPAM. Os pontos e o @ sao
removidos. O endereco foo@bar.com vira <foo (a) bar com>.
-n, --enum-title
Enumera todos os titulos automaticamente, nos formatos 1, 1.1,
1.1.1, ...
--no-dump-config
Cancela a acao --dump-config.
--no-dump-source
Cancela a acao --dump-source.
--no-encoding
Remove a configuracao de codificacao.
--no-enum-title
Desativa a numeracao automatica de titulos.
--no-infile
Remove as definicoes anteriores do arquivo fonte.
--no-targets
Cancela a acao --targets.
--no-mask-email
Desativa o disfarce de emails.
--no-outfile
Remove as definicoes anteriores sobre o arquivo de destino.
--no-quiet
Mostras as mensagens, desativando a opcao --quiet.
--no-rc
Nao le o arquivo configuracao do usuario em ~/.txt2tagsrc.
--no-slides
Desliga os slides.
--no-style
Remove todas as configuracoes de estilo.
--no-toc
Remove o Sumario automatico.
--no-toc-only
Desativa a opcao --toc-only.
-o, --outfile=ARQUIVO
Define ARQUIVO como arquivo de destino. Use '-' para mandar o
resultado para STDOUT.
-q, --quiet
Modo silencioso, nao mostra nada na saida, exceto os erros.
--rc
Le a configuracao do usuario em ~/.txt2tagsrc. Esta opcao e
usada por padrao.
--slides
Formata a saida como uma apresentacao de slides. Esta opcao e
utilizada somente pelo formato ASCII Art.
--style=ARQUIVO
Utiliza ARQUIVO como estilo do documento. E usado para incluir
arquivos CSS em documentos HTML, e pacotes para o LaTeX. Esta
opcao pode ser usada mais de uma vez caso voce precise incluir
dois ou mais arquivos.
-t, --target=FORMATO
Define o formato do documento de destino. Alguns formatos
populares sao: html, xhtml, tex, man, txt. Use a opcao --targets
para ver a lista completa com todos os formatos disponiveis.
--targets
Mostra a lista completa de todos os formatos disponiveis e sai.
--toc
Inclui um Sumario automatico (Table of Contents) no documento de
destino, entre o cabecalho e o corpo. Voce tambem pode indicar
onde o Sumario deve ser colocado, usando a macro %%TOC.
--toc-level=N
Define o nivel maximo (profundidade) do Sumario para N. Os
titulos abaixo do nivel N nao serao incluidos no Sumario.
--toc-only
Exibe o Sumario do documento e sai.
-v, --verbose
Exibe mensagens informativas durante a conversao. Utilize-a duas
ou mais vezes na linha de comando para aumentar o numero de
mensagens a serem mostradas.
-V, --version
Exibe a versao do programa e sai.
--width=N
Define a largura da saida para N colunas. Esta opcao e utilizada
somente pelo formato ASCII Art.
ARQUIVO FONTE
Um arquivo fonte do txt2tags geralmente usa a extensao .t2t, como por
exemplo: trabalho.t2t. Voce pode ter tres areas distintas em seus
fontes:
Cabe,calho
As primeiras tres linhas. Sao usadas para identificacao do
documento, como titulo, autor, versao e data. Se voce nao quiser
usar cabecalhos, deixe a primeira linha em branco.
Configura,c~ao
Inicia logo apos o cabecalho (4a ou 2a linha) e termina quando o
Corpo se inicia. Esta area e usada para configuracoes no formato
%!nome:valor.
Corpo Comeca na primeira linha de texto (que nao seja um comentario ou
uma configuracao) logo apos o cabecalho e vai ate o fim do
documento. E usada para guardar o conteudo do documento.
CONFIGURA,C~OES
Voce pode personalizar o txt2tags usando configuracoes. Elas sao
parecidas com as opcoes de linha de comando e podem ser usadas nos
seguintes locais: na area Configuracao do seu arquivo fonte, no arquivo
~/.txt2tagsrc ou ainda em um arquivo externo chamado com a opcao
--config-file.
%!target
Define o formato de saida, igual faz a opcao --target. Exemplo:
%!target: html
%!options(target)
Define as opcoes de cada formato. No valor voce deve colocar as
opcoes de linha de comando. Exemplo:
%!options(html): --toc --toc-level 3 --css-sugar
%!includeconf
Le as configuracoes a partir de um arquivo externo, igual faz a
opcao --config-file. Exemplo:
%!includeconf: minhaconfig.t2t
%!style
Define um arquivo de estilos para o documento, igual faz a opcao
--style. Pode ser usada varias vezes para definir mais de um
arquivo. Exemplo:
%!style: cores.css
%!encoding
Define a codificacao do texto, igual faz a opcao --encoding.
Exemplo:
%!encoding: UTF-8
%!preproc
Filtro de entrada (estilo troque "isso" por "aquilo") usado para
alterar o Corpo do documento ANTES do txt2tags processa-lo. Voce
pode usar as expressoes regulares do Python. Exemplo:
%!preproc: "FSS" "Fulano da Silva Sauro"
%!postproc
Filtro de saida (estilo troque "isso" por "aquilo") usado para
alterar o documento de saida DEPOIS da conversao feita pelo
txt2tags. Voce pode usar as expressoes regulares do Python.
Exemplo:
%!postproc(html): "<B>" "<STRONG>"
Se a mesma configuracao for usada mais de uma vez, somente a ultima
sera utilizada. As excecoes sao: options, preproc e postproc, que sao
cumulativas. Configuracoes com nomes invalidos serao ignoradas. A ordem
de processamento e: ~/.txt2tagsrc, area Configuracao do arquivo fonte,
opcao --config-file.
COMANDOS
Os comandos sao executados durante a conversao do documento. Eles devem
ser colocados dentro do Corpo do arquivo fonte.
%!csv: arquivo.csv
Gera uma tabela a partir de um arquivo externo CSV.
%!include: arquivo.t2t
Inclui um arquivo fonte txt2tags no documento.
%!include: ``arquivo.txt``
Inclui um arquivo texto no documento.
%!include: ''arquivo.html''
Inclui um arquivo pronto no documento, ele nao e modificado.
MACROS
As macros sao uteis para inserir conteudos dinamicos em seu documento,
como a data atual, por exemplo. Exceto a %%toc, todas as macros podem
ser personalizadas com curingas tipo %Y e %f. Veja o Guia do Usuario
para saber mais detalhes.
%%date Insere a data atual. O formato padrao e %%date(%Y%m%d), que fica
AAAAMMDD.
%%infile
Insere o nome do arquivo fonte. O formato padrao e %%infile(%f).
Util para links de rodape, como [Veja os fontes %%infile].
%%mtime
Insere a data de modificacao do arquivo fonte. O formato padrao
e %%date(%Y%m%d), que fica AAAAMMDD.
%%outfile
Insere o nome do arquivo de saida. O formato padrao e
%%outfile(%f). Util para mencionar o proprio documento, como em
"Este e o arquivo manpage-pt.man".
%%toc Especifica o lugar onde sera colocado o Sumario (Table Of
Contents). Voce pode utiliza-la em qualquer parte do documento,
inclusive mais de uma vez. A opcao --toc tambem deve ser usada
para esta que esta macro funcione.
EXEMPLOS
txt2tags -t html arquivo.t2t
Converte para HTML, gravando o resultado em arquivo.html.
txt2tags -t html -o - arquivo.t2t
Converte para HTML, mandando o resultado para STDOUT.
txt2tags -t html --toc arquivo.t2t
Converte para HTML, com Sumario automatico (Table Of Contents).
txt2tags -t html --toc --toc-level 2 -n arquivo.t2t
Converte para HTML, com Sumario de dois niveis e titulos
numerados.
txt2tags --toc-only arquivo.t2t
Apenas mostra o Sumario, nenhuma conversao e feita.
txt2tags -t html --css-sugar --style base.css --style ui.css
arquivo.t2t
Converte para HTML, com codigo preparado para usar CSS e tambem
inclui dois arquivos CSS externos.
txt2tags -t art --slides --width 80 --height 25 -o - arquivo.t2t | more
Cria uma apresentacao de slides em ASCII Art, pronta para ser
mostrada em um terminal de tamanho 80x25 (colunas e linhas).
(echo ; echo "**bold**") | txt2tags -t html -H -
Mostra como testar o programa rapidamente usando a STDIN como
fonte.
txt2tags -t html -o - arquivo.t2t | tidy > arquivo.html
Manda os resultados para STDOUT e refina o codigo gerado usando
um programa externo (tidy) antes de salvar o arquivo HTML final.
ARQUIVOS
~/.txt2tagsrc
A localizacao padrao para o arquivo com as configuracoes do
usuario.
AMBIENTE
T2TCONFIG
Se definida, esta variavel guarda o caminho completo para o
arquivo de configuracao do usuario.
AUTOR
Aurelio Marinho Jargas <verde@aurelio.net>
Ja trabalharam neste manual Jose Inacio Coelho <jic@technologist.com> e
Mauricio Teixeira <mteixeira@webset.net>.
BUGS
http://bugs.txt2tags.org
COPYRIGHT
Copyright (C) 2001-2010 Aurelio Jargas, GNU GPL v2
Ago, 2010 TXT2TAGS(1)