/doc/Portuguese/manpage-pt.t2t
Unknown | 380 lines | 257 code | 123 blank | 0 comment | 0 complexity | 76d13be4f30074ba667b60bfaa26f368 MD5 | raw file
1TXT2TAGS 2 3Ago, 2010 4 5%!target: man 6%!encoding: UTF-8 7 8%!postproc(man): ' \(#\w+\)' '' 9 10%!options(html): --mask-email --toc 11%!postproc(html): <HEAD> '<HEAD>\n<STYLE>body{margin:3em;} pre{background:#ffc;}</STYLE>' 12 13%% LOG 14%% 02 jul 2004 netmask: traduzido para o português 15%% 20 jul 2004 jic : incluído: área de configuração, mais marcas, áreas; 16%% reorganização 17%% 20 jul 2004 netmask: revisão da tradução 18%% 22 jul 2004 aurelio: pequenas correções 19%% 28 dez 2004 aurelio: atualização para v2.2 20%% 30 out 2010 aurelio: atualização para v2.6 (reescrita) 21 22 23= NOME =[nome] 24 25txt2tags - ferramenta para formatar e converter textos 26 27= SINOPSE =[sinopse] 28 29**txt2tags** [//opções//] [//ARQUIVO//...] 30 31= DESCRIÇÃO =[descricao] 32 33O **txt2tags** lê um arquivo texto com poucas marcações e o converte para: 34//ASCII Art//, 35//AsciiDoc//, 36//Creole//, 37//DocBook//, 38//DokuWiki//, 39//Google Code Wiki//, 40//HTML//, 41//LaTeX//, 42//Lout//, 43//MagicPoint//, 44//Man page//, 45//MoinMoin//, 46//PageMaker//, 47//Plain Text//, 48//PmWiki//, 49//SGML//, 50//Wikipedia// e 51//XHTML//. 52% TRANSLATOR: please keep the alphabetical order of this list. 53 54Esta página de manual foi criada pelo **txt2tags** a partir de um arquivo de texto. Este mesmo arquivo de texto também é convertido para HTML e colocado no site do programa para consulta. 55 56UM arquivo fonte, VÁRIOS destinos - http://txt2tags.org 57 58 59= SINTAXE =[sintaxe] 60 61``` 62Cabeçalhos As 3 primeiras linhas do arquivo fonte 63Título = palavras = 64Título numerado + palavras + 65Comentário % comentários 66Linha de separação -----------------------... 67Linha destacada =======================... 68Imagem [arquivo.jpg] 69Link [nome url] 70 71Negrito **palavras** 72Itálico //palavras// 73Sublinhado __palavras__ 74Riscado --palavras-- 75Monoespaçado ``palavras`` 76Texto protegido ""palavras"" 77Texto com tags ''palavras'' 78 79Parágrafo palavras 80Citação <TAB>palavras 81Lista - palavras 82Lista numerada + palavras 83Lista de definição : palavras 84Tabela | cel1 | cel2 | cel3... 85 86Linha formatada ``` palavras 87Linha protegida """ palavras 88Linha com tags ''' palavras 89 90Área formatada ``` 91 linhas 92 ``` 93Área protegida """ 94 linhas 95 """ 96Área com tags ''' 97 linhas 98 ''' 99``` 100 101= OPÇÕES =[opcoes] 102 103: **--art-chars**=//STRING// 104Define //STRING// como a lista de caracteres usados para fazer os enfeites do ASCII Art, nesta ordem: canto, borda, lado, linha1, linha2, nível2, nível3, nível4, nível5. O valor padrão da string é +-|-==-^". Esta opção é utilizada somente pelo formato ASCII Art. 105 106: **-C**, **--config-file**=//ARQUIVO// 107Lê a configuração a partir do arquivo externo //ARQUIVO//. A configuração deve estar no formato //%!nome:valor//. Veja o tópico [CONFIGURAÇÕES #config] para mais detalhes. 108 109: **--css-sugar** 110Prepara o código HTML/XHTML para ser usado com arquivos CSS. Os atributos das tags são removidos, tags de formatação são evitadas, o cabeçalho é composto pelas tags H1, H2 e H3, novos DIVs são criados: //#header//, //#body//, //.toc//. 111 112: **--css-inside** 113Insere o conteúdo do arquivo CSS no cabeçalho do documento HTML/XHTML. Use ``--style`` para indicar o arquivo CSS a ser lido. 114 115: **--dump-config** 116Exibe todas as configurações encontradas e sai. 117 118: **--dump-source** 119Exibe os fontes do documento, com os arquivos incluídos (``%!include``) expandidos. 120 121: **--encoding**=//CÓDIGO// 122Informa a codificação usada no arquivo fonte. Alguns exemplos são UTF-8 e iso-8859-1. A codificação não é alterada durante a conversão, então o arquivo de destino terá a mesma codificação do arquivo fonte. 123 124: **--gui** 125Carrega a interface gráfica (Tk). 126 127: **-h**, **--help** 128Exibe o texto de ajuda e sai. 129 130: **-H**, **--no-headers** 131Suprime os cabeçalhos e o rodapé do documento. Apenas o Corpo do documento será mostrado. 132 133: **--headers** 134Exibe os cabeçalhos e o rodapé no documento. Esta opção é usada por padrão. 135 136: **--height**=//N// 137Define a altura da saída para //N// linhas. Esta opção é utilizada somente pelo formato ASCII Art, quando também utilizada a opção ``--slides``. 138 139: **-i**, **--infile**=//ARQUIVO// 140Define //ARQUIVO// como arquivo fonte. Use '-' para ler os dados de STDIN. 141 142: **--mask-email** 143Esconde os e-mails dos robôs de SPAM. Os pontos e o @ são removidos. O endereço ""foo@bar.com"" vira <foo (a) bar com>. 144 145: **-n**, **--enum-title** 146Enumera todos os títulos automaticamente, nos formatos 1, 1.1, 1.1.1, ... 147 148: **--no-dump-config** 149Cancela a ação ``--dump-config``. 150 151: **--no-dump-source** 152Cancela a ação ``--dump-source``. 153 154: **--no-encoding** 155Remove a configuração de codificação. 156 157: **--no-enum-title** 158Desativa a numeração automática de títulos. 159 160: **--no-infile** 161Remove as definições anteriores do arquivo fonte. 162 163: **--no-targets** 164Cancela a ação ``--targets``. 165 166: **--no-mask-email** 167Desativa o disfarce de emails. 168 169: **--no-outfile** 170Remove as definições anteriores sobre o arquivo de destino. 171 172: **--no-quiet** 173Mostras as mensagens, desativando a opção ``--quiet``. 174 175: **--no-rc** 176Não lê o arquivo configuração do usuário em ~/.txt2tagsrc. 177 178: **--no-slides** 179Desliga os slides. 180 181: **--no-style** 182Remove todas as configurações de estilo. 183 184: **--no-toc** 185Remove o Sumário automático. 186 187: **--no-toc-only** 188Desativa a opção ``--toc-only``. 189 190: **-o**, **--outfile**=//ARQUIVO// 191Define //ARQUIVO// como arquivo de destino. Use '-' para mandar o resultado para STDOUT. 192 193: **-q**, **--quiet** 194Modo silencioso, não mostra nada na saída, exceto os erros. 195 196: **--rc** 197Lê a configuração do usuário em ~/.txt2tagsrc. Esta opção é usada por padrão. 198 199: **--slides** 200Formata a saída como uma apresentação de slides. Esta opção é utilizada somente pelo formato ASCII Art. 201 202: **--style**=//ARQUIVO// 203Utiliza //ARQUIVO// como estilo do documento. É usado para incluir arquivos CSS em documentos HTML, e pacotes para o LaTeX. Esta opção pode ser usada mais de uma vez caso você precise incluir dois ou mais arquivos. 204 205: **-t**, **--target**=//FORMATO// 206Define o formato do documento de destino. Alguns formatos populares são: //html//, //xhtml//, //tex//, //man//, //txt//. Use a opção ``--targets`` para ver a lista completa com todos os formatos disponíveis. 207 208: **--targets** 209Mostra a lista completa de todos os formatos disponíveis e sai. 210 211: **--toc** 212Inclui um Sumário automático (Table of Contents) no documento de destino, entre o cabeçalho e o corpo. Você também pode indicar onde o Sumário deve ser colocado, usando a macro ``%%TOC``. 213 214: **--toc-level**=//N// 215Define o nível máximo (profundidade) do Sumário para //N//. Os títulos abaixo do nível //N// não serão incluídos no Sumário. 216 217: **--toc-only** 218Exibe o Sumário do documento e sai. 219 220: **-v**, **--verbose** 221Exibe mensagens informativas durante a conversão. Utilize-a duas ou mais vezes na linha de comando para aumentar o número de mensagens a serem mostradas. 222 223: **-V**, **--version** 224Exibe a versão do programa e sai. 225 226: **--width**=//N// 227Define a largura da saída para //N// colunas. Esta opção é utilizada somente pelo formato ASCII Art. 228: 229 230= ARQUIVO FONTE =[fonte] 231 232Um arquivo fonte do **txt2tags** geralmente usa a extensão //.t2t//, como por exemplo: ``trabalho.t2t``. Você pode ter três áreas distintas em seus fontes: 233 234: **Cabeçalho** 235As primeiras três linhas. São usadas para identificação do documento, como título, autor, versão e data. Se você não quiser usar cabeçalhos, deixe a primeira linha em branco. 236 237: **Configuração** 238Inicia logo após o cabeçalho (4ª ou 2ª linha) e termina quando o Corpo se inicia. Esta área é usada para configurações no formato ``%!nome:valor``. 239 240: **Corpo** 241Começa na primeira linha de texto (que não seja um comentário ou uma configuração) logo após o cabeçalho e vai até o fim do documento. É usada para guardar o conteúdo do documento. 242: 243 244= CONFIGURAÇÕES =[config] 245 246Você pode personalizar o txt2tags usando configurações. Elas são parecidas com as opções de linha de comando e podem ser usadas nos seguintes locais: na área Configuração do seu arquivo fonte, no arquivo ``~/.txt2tagsrc`` ou ainda em um arquivo externo chamado com a opção ``--config-file``. 247 248: **%!target** 249Define o formato de saída, igual faz a opção ``--target``. Exemplo: 250``` %!target: html 251 252: **%!options(target)** 253Define as opções de cada formato. No valor você deve colocar as opções de linha de comando. Exemplo: 254``` %!options(html): --toc --toc-level 3 --css-sugar 255 256: **%!includeconf** 257Lê as configurações a partir de um arquivo externo, igual faz a opção ``--config-file``. Exemplo: 258``` %!includeconf: minhaconfig.t2t 259 260: **%!style** 261Define um arquivo de estilos para o documento, igual faz a opção ``--style``. Pode ser usada várias vezes para definir mais de um arquivo. Exemplo: 262``` %!style: cores.css 263 264: **%!encoding** 265Define a codificação do texto, igual faz a opção ``--encoding``. Exemplo: 266``` %!encoding: UTF-8 267 268: **%!preproc** 269Filtro de entrada (estilo troque "isso" por "aquilo") usado para alterar o Corpo do documento ANTES do txt2tags processá-lo. Você pode usar as expressões regulares do Python. Exemplo: 270``` %!preproc: "FSS" "Fulano da Silva Sauro" 271 272: **%!postproc** 273Filtro de saída (estilo troque "isso" por "aquilo") usado para alterar o documento de saída DEPOIS da conversão feita pelo txt2tags. Você pode usar as expressões regulares do Python. Exemplo: 274``` %!postproc(html): "<B>" "<STRONG>" 275: 276 277Se a mesma configuração for usada mais de uma vez, somente a última será utilizada. As exceções são: options, preproc e postproc, que são cumulativas. Configurações com nomes inválidos serão ignoradas. A ordem de processamento é: ``~/.txt2tagsrc``, área Configuração do arquivo fonte, opção ``--config-file``. 278 279 280= COMANDOS =[comandos] 281 282Os comandos são executados durante a conversão do documento. Eles devem ser colocados dentro do Corpo do arquivo fonte. 283 284: **%!csv: arquivo.csv** 285Gera uma tabela a partir de um arquivo externo CSV. 286 287: **%!include: arquivo.t2t** 288Inclui um arquivo fonte txt2tags no documento. 289 290: **%!include: ""``arquivo.txt``""** 291Inclui um arquivo texto no documento. 292 293: **%!include: ""''arquivo.html''""** 294Inclui um arquivo pronto no documento, ele não é modificado. 295: 296 297= MACROS =[macros] 298 299As macros são úteis para inserir conteúdos dinâmicos 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 Usuário para saber mais detalhes. 300 301: **""%%date""** 302Insere a data atual. O formato padrão é ``%%date(%Y%m%d)``, que fica AAAAMMDD. 303 304: **""%%infile""** 305Insere o nome do arquivo fonte. O formato padrão é ``%%infile(%f)``. Útil para links de rodapé, como ``[Veja os fontes %%infile]``. 306 307: **""%%mtime""** 308Insere a data de modificação do arquivo fonte. O formato padrão é ``%%date(%Y%m%d)``, que fica AAAAMMDD. 309 310: **""%%outfile""** 311Insere o nome do arquivo de saída. O formato padrão é ``%%outfile(%f)``. Útil para mencionar o próprio documento, como em "Este é o arquivo %%outfile". 312 313: **""%%toc""** 314Especifica o lugar onde será colocado o Sumário (Table Of Contents). Você pode utilizá-la em qualquer parte do documento, inclusive mais de uma vez. A opção ``--toc`` também deve ser usada para esta que esta macro funcione. 315: 316 317= EXEMPLOS =[exemplos] 318 319: ``txt2tags -t html arquivo.t2t`` 320 321Converte para HTML, gravando o resultado em arquivo.html. 322 323: ``txt2tags -t html -o - arquivo.t2t`` 324 325Converte para HTML, mandando o resultado para STDOUT. 326 327: ``txt2tags -t html --toc arquivo.t2t`` 328 329Converte para HTML, com Sumário automático (Table Of Contents). 330 331: ``txt2tags -t html --toc --toc-level 2 -n arquivo.t2t`` 332 333Converte para HTML, com Sumário de dois níveis e títulos numerados. 334 335: ``txt2tags --toc-only arquivo.t2t`` 336 337Apenas mostra o Sumário, nenhuma conversão é feita. 338 339: ``txt2tags -t html --css-sugar --style base.css --style ui.css arquivo.t2t`` 340 341Converte para HTML, com código preparado para usar CSS e também inclui dois arquivos CSS externos. 342 343: ``txt2tags -t art --slides --width 80 --height 25 -o - arquivo.t2t | more`` 344 345Cria uma apresentação de slides em ASCII Art, pronta para ser mostrada em um terminal de tamanho 80x25 (colunas e linhas). 346 347: ``(echo ; echo "**bold**") | txt2tags -t html -H -`` 348 349Mostra como testar o programa rapidamente usando a STDIN como fonte. 350 351: ``txt2tags -t html -o - arquivo.t2t | tidy > arquivo.html`` 352 353Manda os resultados para STDOUT e refina o código gerado usando um programa externo (tidy) antes de salvar o arquivo HTML final. 354: 355 356= ARQUIVOS =[arquivos] 357 358: ~/.txt2tagsrc 359A localização padrão para o arquivo com as configurações do usuário. 360: 361 362= AMBIENTE =[ambiente] 363 364: T2TCONFIG 365Se definida, esta variável guarda o caminho completo para o arquivo de configuração do usuário. 366: 367 368= AUTOR =[autor] 369 370Aurélio Marinho Jargas <verde@aurelio.net> 371 372Já trabalharam neste manual José Inácio Coelho <jic@technologist.com> e Mauricio Teixeira <mteixeira@webset.net>. 373 374= BUGS =[bugs] 375 376http://bugs.txt2tags.org 377 378= COPYRIGHT =[copyright] 379 380Copyright (C) 2001-%%date(%Y) Aurelio Jargas, GNU GPL v2