Linux Certif

Toute la documentation sur la certification Linux LPI

txt2tags

NOME

txt2tags - ferramenta para formatar e converter textos

SINOPSE

txt2tags [OPК├O]... [ARQUIVO]...

DESCRIК├O

O txt2tags ж uma ferramenta GPL de conversсo de formatos escrita em Python que gera documentos em HTML, XHTML, SGML, LaTeX, Lout, Man Page, MoinMoin, Wikipedia, DokuWiki, Google Code Wiki, MagicPoint e PageMaker a partir de um Щnico arquivo de texto com algumas marcaушes.

O usuрrio sз precisa conhecer algumas marcas usadas pelo txt2tags, e escrever textos normais. O programa faz todo o trabalho sujo, adicionando as tags complicadas e lidando com as pegadinhas dos documentos de destino.

O mesmo arquivo texto pode ser convertido para todos os formatos disponьveis, sem a necessidade de qualquer alteraусo. Esta ж a finalidade do txt2tags: UM arquivo fonte, V┴RIOS destinos.

Visite a pрgina do programa em http://txt2tags.sourceforge.net.

OPКНES

 -C, --config-file

lЖ a configuraусo de um arquivo externo (igual ao %!includeconf)

     --css-sugar

insere tags compatьveis com CSS em destinos HTML e XHTML

     --css-inside

insere o conteЩdo do arquivo CSS no documento HTML/XHTML

     --dump-config

exibe todas as configuraушes encontradas e sai

     --dump-source

exibe os fontes do documento, com os includes expandidos

     --encoding

informa a codificaусo de destino (utf-8, iso-8859-1, etc)

     --gui

carrega a interface grрfica escrita em TK

 -h, --help

exibe o texto de ajuda e sai

 -H, --no-headers

suprime os cabeуalhos, tьtulo e rodapж

     --headers

exibe os cabeуalhos, tьtulo e rodapж (padrсo LIGADO)

 -i, --infile=ARQUIVO

define ARQUIVO como arquivo fonte ('-' para STDIN)

     --mask-email

esconde os e-mails dos robЗs de SPAM. x@y.z vira <x (a) y z>

 -n, --enum-title

numera todos os tьtulos como 1, 1.1, 1.1.1, etc

     --no-dump-config

desativa a opусo de exibir as configuraушes

     --no-dump-source

desativa a opусo de exibir os fontes

     --no-encoding

exclui a configuraусo de codificaусo

     --no-enum-title

desativa a auto-numeraусo de tьtulos

     --no-infile

exclui as definiушes anteriores do arquivo fonte

     --no-mask-email

exibe os e-mails, desativando a opусo --mask-email

     --no-outfile

exclui as definiушes anteriores sobre o arquivo de destino

     --no-quiet

mostras as mensagens, desativando a opусo --quiet

     --no-rc

nсo lЖ o arquivo configuraусo do usuрrio em ~/.txt2tagsrc

     --no-style

exclui as configuraушes de estilo

     --no-toc

nсo inclui o sumрrio (Table of Contents) no documento de destino

     --no-toc-only

desativa a opусo --toc-only

 -o, --outfile=ARQUIVO

define ARQUIVO como destino ('-' para STDOUT)

 -q, --quiet

modo silencioso, nсo mostra nada na saьda (exceto os erros)

     --rc

lЖ a configuraусo do usuрrio em ~/.txt2tagsrc (padrсo LIGADO)

     --style=ARQUIVO

utiliza ARQUIVO como estilo do documento (como o CSS do Html)

-t, --target=TIPO

define o tipo do documento de destino. atualmente suportados: html, xhtml, sgml, tex, lout, man, mgp, wiki, gwiki, doku, moin, pm6, txt

     --toc

inclui o sumрrio (Table of Contents) no documento de destino

     --toc-level=N

define o nьvel mрximo (profundidade) do ═ndice para N

     --toc-only

exibe o ═ndice do documento e sai

 -v, --verbose

exibe mensagens informativas durante a conversсo

 -V, --version

exibe a versсo do programa e sai

Normalmente a saьda convertida ж gravada em 'arquivo.<tipo>'. Utilize --outfile para forуar um nome para o arquivo de saьda. Se o arquivo de entrada ж '-', lЖ de STDIN. Se o arquivo de saьda ж '-', envia a saьda para STDOUT.

ESTRUTURA

Um arquivo fonte txt2tags pode ter trЖs рreas:

Cabeуalho

As primeiras trЖs linhas. Sсo usadas para identificaусo do documento. Se nсo for necessрrio, o cabeуalho pode ser suprimido pela configuraусo no-header.

Configuraусo

Inicia a partir da quarta linha. Todas as configuraушes tЖm o formato %!chave: valor. As configuraушes tambжm podem ser realizadas por arquivos de configuraусo ou linha de comando.

Corpo

O verdadeiro documento! ╔ a Щnica рrea necessрria para que se tenha um documento txt2tags vрlido.

CONFIGURAКНES

O Txt2tags pode ser personalizado por mжtodos internos e externos. Os meios externos podem ser de um arquivo chamado .txt2tagsrc ou importado de outro arquivo txt2tags. O jeito interno ж feito por comandos incluьdos na рrea de configuraусo do fonte. Ambas formas usam a mesma sintaxe:

%!target:

define o formato destino (target) principal

%!options(target):

define as opушes de cada destino

%!include: file.t2t

inclui um arquivo txt2tags no documento

%!include: ``arquivo.txt``

inclui um arquivo texto no documento

%!include: ''arquivo.html''

inclui um arquivo literal no documento, ipsis literis

%!style:

para indicar um arquivo CSS (Cascading Style Sheets) para os destinos XHTML e HTML ou carregar um mзdulo \usepackage no destino TEX

%!encoding:

para indicar um conjunto de caracteres (como iso-8859-1) para usuрrios de lьngua nсo-inglesa

%!includeconf:

usado para incluir configuraушes a partir de um arquivo externo

%!guicolors:

configuraушes de cores para a interface grрfica (tk/tcl)

%!preproc:

filtros personalizados (macros) que serсo processados ANTES da avaliaусo do documento

%!postproc:

filtros personalizados (macros) que serсo processados APМS a avaliaусo do documento

REGRAS DAS CONFIGURAКНES

•

As configuraушes sсo vрlidas somente dentro da ┴rea de Configuraусo, e serсo consideradas comentрrios simples se forem encontradas no Corpo do documento.

•

Se a mesma palavra-chave aparece mais de uma vez na ┴rea de Configuraусo, apenas a Щltima serр usada. Exceусo: options, preproc e postproc, que sсo acumulativas.

•

Uma linha de configuraусo com uma palavra-chave invрlida serр considerada um comentрrio.

•

Estas configuraушes tЖm precedЖncia sobre o arquivo txt2tagsrc, mas nсo sobre as opушes de linha de comando.

SINTAXE

Uma sintaxe de marcas bem simples ж utilizada no arquivo fonte (o arquivo de texto puro) para identificar as estruturas e a formataусo. Aqui estр a lista completa:

Bрsico

   Cabeуalhos        As 3 primeiras linhas do arquivo fonte
   Tьtulo            = palavras =
   Tьtulo numerado   + palavras +
   Parрgrafo         palavras
 

Embelezadores

   Negrito           **palavras**
   Itрlico           //palavras//
   Sublinhado        __palavras__
   Riscado           --palavras--
   Monoespaуado      ``palavras``
 

Text Blocks

   Citaусo             <TAB>palavras
   Lista               - palavras
   Lista numerada      + palavras
   Lista de definiусo  : palavras
   Linha formatada     ``` palavras
   ┴rea formatada      ```<Quebra> linhas <Quebra>```
   Linha protegida     """ palavras
   ┴rea protegida      """<Quebra> linhas <Quebra>"""
   Tabela              | cel1 | cel2 | cel3...
 

Outros

   Linha de separaусo  -----------------------...
   Linha destacada     =======================...
   Links               [nome url]
   Imagem              [arquivo.XXX]
   Texto protegido     ""palavras""
   Comentрrio          % comentрrios
 

EXEMPLOS

Supondo que vocЖ criou um arquivo marcado chamado arquivo.t2t, vamos nos divertir fazendo algumas conversшes.

Converte para HTML, gravando em arquivo.html

$ txt2tags -t html arquivo.t2t

Similar ao anterior, usando redirecionamento

$ txt2tags -t html -o - arquivo.t2t > arquivo.html

Incluindo o ═ndice

$ txt2tags -t html --toc arquivo.t2t

Incluindo o ═ndice e tьtulos numerados

$ txt2tags -t html --toc --enum-title arquivo.t2t

Exibiусo rрpida do conteЩdo

$ txt2tags --toc-only arquivo.t2t

Teste rрpido de uma linha vindo de STDIN

$ echo -e "\n**negrito**" | txt2tags -t html -H -

MACROS

%%date

Representa a data atual, usando o formato YYYYMMDD. Tambжm ж possьvel mudar o formato da data usando a seguinte sintaxe: %%date(formato).

%%infile

Representa o nome do arquivo fonte. O formato pode ser especificado usando a seguinte sintaxe: %%infile(formato).

┌til para colocar um link para os fontes, no final do documento, como em [Veja os fontes %%infile]. Assim, vocЖ pode mudar o nome do arquivo, e o link nсo ficarр quebrado.

%%mtime

Representa a data de modificaусo do arquivo fonte. Os mesmos formatos usados na macro %%date tambжm sсo aceitos.

%%outfile

Representa o nome do arquivo de saьda. O formato pode ser especificado usando a seguinte sintaxe: %%outfile(formato).

┌til para mencionar o prзprio arquivo, como em "Este ж o arquivo manpage-pt.man". Assim, vocЖ pode mudar o nome do arquivo, mas ele sempre aparecerр corretamente no documento.

%%toc

A macro %%toc indica em que local do documento deve ser inserido o sumрrio (Table Of Contents). VocЖ pode utilizр-la em qualquer parte do documento, inclusive mais de uma vez.

NOTA: A %%toc sз serр aplicada se a opусo --toc for utilizada.

AUTOR

O txt2tags foi criado e ж mantido por Aurжlio Marinho Jargas <verde@aurelio.net>

Esta Pрgina de Manual foi escrita por Josж Inрcio Coelho <jic@technologist.com> como um arquivo texto, e convertida para o formato de manual no txt2tags!

A traduусo deste manual para o portuguЖs foi feita por Mauricio Teixeira <mteixeira@webset.net>

LICENКA

Copyright (C) 2001, 2002, 2003, 2004, 2005, 2006, 2007, 2008 Aurжlio Marinho Jargas

Este programa ж livre. Veja nos arquivos fonte as condiушes de cзpia. N├O H┴ garantia, nem de COMERCIALIZAК├O nem de ADEQUAК├O A QUALQUER PROPМSITO.