/doc/Portuguese/manpage-pt.t2t

http://txt2tags.googlecode.com/ · Unknown · 380 lines · 257 code · 123 blank · 0 comment · 0 complexity · 76d13be4f30074ba667b60bfaa26f368 MD5 · raw file

  1. TXT2TAGS
  2. Ago, 2010
  3. %!target: man
  4. %!encoding: UTF-8
  5. %!postproc(man): ' \(#\w+\)' ''
  6. %!options(html): --mask-email --toc
  7. %!postproc(html): <HEAD> '<HEAD>\n<STYLE>body{margin:3em;} pre{background:#ffc;}</STYLE>'
  8. %% LOG
  9. %% 02 jul 2004 netmask: traduzido para o português
  10. %% 20 jul 2004 jic : incluído: área de configuração, mais marcas, áreas;
  11. %% reorganização
  12. %% 20 jul 2004 netmask: revisão da tradução
  13. %% 22 jul 2004 aurelio: pequenas correções
  14. %% 28 dez 2004 aurelio: atualização para v2.2
  15. %% 30 out 2010 aurelio: atualização para v2.6 (reescrita)
  16. = NOME =[nome]
  17. txt2tags - ferramenta para formatar e converter textos
  18. = SINOPSE =[sinopse]
  19. **txt2tags** [//opções//] [//ARQUIVO//...]
  20. = DESCRIÇÃO =[descricao]
  21. O **txt2tags** um arquivo texto com poucas marcações e o converte para:
  22. //ASCII Art//,
  23. //AsciiDoc//,
  24. //Creole//,
  25. //DocBook//,
  26. //DokuWiki//,
  27. //Google Code Wiki//,
  28. //HTML//,
  29. //LaTeX//,
  30. //Lout//,
  31. //MagicPoint//,
  32. //Man page//,
  33. //MoinMoin//,
  34. //PageMaker//,
  35. //Plain Text//,
  36. //PmWiki//,
  37. //SGML//,
  38. //Wikipedia// e
  39. //XHTML//.
  40. % TRANSLATOR: please keep the alphabetical order of this list.
  41. Esta 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.
  42. UM arquivo fonte, VÁRIOS destinos - http://txt2tags.org
  43. = SINTAXE =[sintaxe]
  44. ```
  45. Cabeçalhos As 3 primeiras linhas do arquivo fonte
  46. Título = palavras =
  47. Título numerado + palavras +
  48. Comentário % comentários
  49. Linha de separação -----------------------...
  50. Linha destacada =======================...
  51. Imagem [arquivo.jpg]
  52. Link [nome url]
  53. Negrito **palavras**
  54. Itálico //palavras//
  55. Sublinhado __palavras__
  56. Riscado --palavras--
  57. Monoespaçado ``palavras``
  58. Texto protegido ""palavras""
  59. Texto com tags ''palavras''
  60. Parágrafo palavras
  61. Citação <TAB>palavras
  62. Lista - palavras
  63. Lista numerada + palavras
  64. Lista de definição : palavras
  65. Tabela | cel1 | cel2 | cel3...
  66. Linha formatada ``` palavras
  67. Linha protegida """ palavras
  68. Linha com tags ''' palavras
  69. Área formatada ```
  70. linhas
  71. ```
  72. Área protegida """
  73. linhas
  74. """
  75. Área com tags '''
  76. linhas
  77. '''
  78. ```
  79. = OPÇÕES =[opcoes]
  80. : **--art-chars**=//STRING//
  81. Define //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.
  82. : **-C**, **--config-file**=//ARQUIVO//
  83. Lê 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.
  84. : **--css-sugar**
  85. Prepara 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//.
  86. : **--css-inside**
  87. Insere o conteúdo do arquivo CSS no cabeçalho do documento HTML/XHTML. Use ``--style`` para indicar o arquivo CSS a ser lido.
  88. : **--dump-config**
  89. Exibe todas as configurações encontradas e sai.
  90. : **--dump-source**
  91. Exibe os fontes do documento, com os arquivos incluídos (``%!include``) expandidos.
  92. : **--encoding**=//CÓDIGO//
  93. Informa 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.
  94. : **--gui**
  95. Carrega a interface gráfica (Tk).
  96. : **-h**, **--help**
  97. Exibe o texto de ajuda e sai.
  98. : **-H**, **--no-headers**
  99. Suprime os cabeçalhos e o rodapé do documento. Apenas o Corpo do documento será mostrado.
  100. : **--headers**
  101. Exibe os cabeçalhos e o rodapé no documento. Esta opção é usada por padrão.
  102. : **--height**=//N//
  103. Define 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``.
  104. : **-i**, **--infile**=//ARQUIVO//
  105. Define //ARQUIVO// como arquivo fonte. Use '-' para ler os dados de STDIN.
  106. : **--mask-email**
  107. Esconde 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>.
  108. : **-n**, **--enum-title**
  109. Enumera todos os títulos automaticamente, nos formatos 1, 1.1, 1.1.1, ...
  110. : **--no-dump-config**
  111. Cancela a ação ``--dump-config``.
  112. : **--no-dump-source**
  113. Cancela a ação ``--dump-source``.
  114. : **--no-encoding**
  115. Remove a configuração de codificação.
  116. : **--no-enum-title**
  117. Desativa a numeração automática de títulos.
  118. : **--no-infile**
  119. Remove as definições anteriores do arquivo fonte.
  120. : **--no-targets**
  121. Cancela a ação ``--targets``.
  122. : **--no-mask-email**
  123. Desativa o disfarce de emails.
  124. : **--no-outfile**
  125. Remove as definições anteriores sobre o arquivo de destino.
  126. : **--no-quiet**
  127. Mostras as mensagens, desativando a opção ``--quiet``.
  128. : **--no-rc**
  129. Não lê o arquivo configuração do usuário em ~/.txt2tagsrc.
  130. : **--no-slides**
  131. Desliga os slides.
  132. : **--no-style**
  133. Remove todas as configurações de estilo.
  134. : **--no-toc**
  135. Remove o Sumário automático.
  136. : **--no-toc-only**
  137. Desativa a opção ``--toc-only``.
  138. : **-o**, **--outfile**=//ARQUIVO//
  139. Define //ARQUIVO// como arquivo de destino. Use '-' para mandar o resultado para STDOUT.
  140. : **-q**, **--quiet**
  141. Modo silencioso, não mostra nada na saída, exceto os erros.
  142. : **--rc**
  143. Lê a configuração do usuário em ~/.txt2tagsrc. Esta opção é usada por padrão.
  144. : **--slides**
  145. Formata a saída como uma apresentação de slides. Esta opção é utilizada somente pelo formato ASCII Art.
  146. : **--style**=//ARQUIVO//
  147. Utiliza //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.
  148. : **-t**, **--target**=//FORMATO//
  149. Define 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.
  150. : **--targets**
  151. Mostra a lista completa de todos os formatos disponíveis e sai.
  152. : **--toc**
  153. Inclui 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``.
  154. : **--toc-level**=//N//
  155. Define 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.
  156. : **--toc-only**
  157. Exibe o Sumário do documento e sai.
  158. : **-v**, **--verbose**
  159. Exibe 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.
  160. : **-V**, **--version**
  161. Exibe a versão do programa e sai.
  162. : **--width**=//N//
  163. Define a largura da saída para //N// colunas. Esta opção é utilizada somente pelo formato ASCII Art.
  164. :
  165. = ARQUIVO FONTE =[fonte]
  166. Um 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:
  167. : **Cabeçalho**
  168. As 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.
  169. : **Configuração**
  170. Inicia 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``.
  171. : **Corpo**
  172. Começ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.
  173. :
  174. = CONFIGURAÇÕES =[config]
  175. Você 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``.
  176. : **%!target**
  177. Define o formato de saída, igual faz a opção ``--target``. Exemplo:
  178. ``` %!target: html
  179. : **%!options(target)**
  180. Define as opções de cada formato. No valor você deve colocar as opções de linha de comando. Exemplo:
  181. ``` %!options(html): --toc --toc-level 3 --css-sugar
  182. : **%!includeconf**
  183. Lê as configurações a partir de um arquivo externo, igual faz a opção ``--config-file``. Exemplo:
  184. ``` %!includeconf: minhaconfig.t2t
  185. : **%!style**
  186. Define 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:
  187. ``` %!style: cores.css
  188. : **%!encoding**
  189. Define a codificação do texto, igual faz a opção ``--encoding``. Exemplo:
  190. ``` %!encoding: UTF-8
  191. : **%!preproc**
  192. Filtro 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:
  193. ``` %!preproc: "FSS" "Fulano da Silva Sauro"
  194. : **%!postproc**
  195. Filtro 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:
  196. ``` %!postproc(html): "<B>" "<STRONG>"
  197. :
  198. Se 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``.
  199. = COMANDOS =[comandos]
  200. Os comandos são executados durante a conversão do documento. Eles devem ser colocados dentro do Corpo do arquivo fonte.
  201. : **%!csv: arquivo.csv**
  202. Gera uma tabela a partir de um arquivo externo CSV.
  203. : **%!include: arquivo.t2t**
  204. Inclui um arquivo fonte txt2tags no documento.
  205. : **%!include: ""``arquivo.txt``""**
  206. Inclui um arquivo texto no documento.
  207. : **%!include: ""''arquivo.html''""**
  208. Inclui um arquivo pronto no documento, ele não é modificado.
  209. :
  210. = MACROS =[macros]
  211. As 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.
  212. : **""%%date""**
  213. Insere a data atual. O formato padrão é ``%%date(%Y%m%d)``, que fica AAAAMMDD.
  214. : **""%%infile""**
  215. Insere o nome do arquivo fonte. O formato padrão é ``%%infile(%f)``. Útil para links de rodapé, como ``[Veja os fontes %%infile]``.
  216. : **""%%mtime""**
  217. Insere a data de modificação do arquivo fonte. O formato padrão é ``%%date(%Y%m%d)``, que fica AAAAMMDD.
  218. : **""%%outfile""**
  219. Insere 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".
  220. : **""%%toc""**
  221. Especifica 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.
  222. :
  223. = EXEMPLOS =[exemplos]
  224. : ``txt2tags -t html arquivo.t2t``
  225. Converte para HTML, gravando o resultado em arquivo.html.
  226. : ``txt2tags -t html -o - arquivo.t2t``
  227. Converte para HTML, mandando o resultado para STDOUT.
  228. : ``txt2tags -t html --toc arquivo.t2t``
  229. Converte para HTML, com Sumário automático (Table Of Contents).
  230. : ``txt2tags -t html --toc --toc-level 2 -n arquivo.t2t``
  231. Converte para HTML, com Sumário de dois níveis e títulos numerados.
  232. : ``txt2tags --toc-only arquivo.t2t``
  233. Apenas mostra o Sumário, nenhuma conversão é feita.
  234. : ``txt2tags -t html --css-sugar --style base.css --style ui.css arquivo.t2t``
  235. Converte para HTML, com código preparado para usar CSS e também inclui dois arquivos CSS externos.
  236. : ``txt2tags -t art --slides --width 80 --height 25 -o - arquivo.t2t | more``
  237. Cria uma apresentação de slides em ASCII Art, pronta para ser mostrada em um terminal de tamanho 80x25 (colunas e linhas).
  238. : ``(echo ; echo "**bold**") | txt2tags -t html -H -``
  239. Mostra como testar o programa rapidamente usando a STDIN como fonte.
  240. : ``txt2tags -t html -o - arquivo.t2t | tidy > arquivo.html``
  241. Manda os resultados para STDOUT e refina o código gerado usando um programa externo (tidy) antes de salvar o arquivo HTML final.
  242. :
  243. = ARQUIVOS =[arquivos]
  244. : ~/.txt2tagsrc
  245. A localização padrão para o arquivo com as configurações do usuário.
  246. :
  247. = AMBIENTE =[ambiente]
  248. : T2TCONFIG
  249. Se definida, esta variável guarda o caminho completo para o arquivo de configuração do usuário.
  250. :
  251. = AUTOR =[autor]
  252. Aurélio Marinho Jargas <verde@aurelio.net>
  253. trabalharam neste manual José Inácio Coelho <jic@technologist.com> e Mauricio Teixeira <mteixeira@webset.net>.
  254. = BUGS =[bugs]
  255. http://bugs.txt2tags.org
  256. = COPYRIGHT =[copyright]
  257. Copyright (C) 2001-%%date(%Y) Aurelio Jargas, GNU GPL v2