1. Introdução
t2tmake é um programa criado para facilitar a tarefa dos usuários do txt2tags. Foi desenvolvido em Ruby.
1.1. Facilidades
Entre as facilidades, é possível destacar:
- Processamento apenas dos arquivos alterados, possibilitando que o usuário efetue as alterações sem se preocupar quais os arquivos deverão ser processados (também é possível efetuar a conversão em todos os arquivos, independente de terem ou não sidos alterados)
- Permite o processamento recursivo, isto é, pode processar os arquivos de um diretório e seus subdiretórios.
- Pode gerar um arquivo registrando apenas os que foram convertidos, facilitando no momento da atualização do destino (atualizar um site automaticamente com base nas alterações, por exemplo).
- Permite excluir o processamento de arquivos especificados (arquivos apenas para a inclusão de cabeçalhos, rodapés ou procedimentos definidos pelo usuário).
- Permite que os procedimentos especificados pelo usuário estejam agrupados em um arquivo, centralizando e facilitando a operação (não é necessário memorizar os parâmetros enviados para o t2tmake para um diretório/procedimento específico)
- Pode gerar automáticamente os subdiretórios conforme o tipo de arquivo gerado pelo txt2tags, facilitando a organização.
- etc
2. Sintaxe
Existem dois modos principais. O primeiro é informando os parâmetros diretamente na linha de comando. Em alguns casos é a opção mais simples. Em outros, esta operação pode gerar um certo desconforto pelo número de parâmetros. Para estes casos, o usuário poderá armazenar a seqüência dos parâmetros em um arquivo e utilizar apenas o parâmetro -b.
2.1. Linha de comando
- -t, --type=TARGET
-
Permite especificar o tipo de arquivo que será gerado pelo txt2tags (html,xhtml,sgml,tex,man,mgp,moin,pm6,txt)
- -e, --ext=EXT
-
Informa a extensão dos arquivos que serão gerados (você pode forçar uma extensão php, por exemplo)
- -r, --recusive
-
Será feito o processamento recursivamente, isto é, em todos os subdiretórios. Se não for informada, apenas o diretório atual será processado.
- -s, --sdir=DIR
-
Especifica o diretório onde os arquivos que serão processados se encontam. Em caso de omissão, o diretório atual será utilizado.
- -d, --ddir=DIR
-
Especifica o diretório destino, isto é, onde os arquivos resultantes do processamento pelo txt2tags serão gravados. Em caso de omissão, será criado um subdiretório que terá como nome um sublinhado mais o tipo de arquivo que será gravado. Por exemplo, se for informado -t html, os arquivos
.html gerados pelo txt2tags serão gravados no subdiretório _html.
- -l, --log[=FILE]
-
Será gerado um arquivo contendo os arquivos gerados pelo txt2tags. Se o arquivo não for especificado, um arquivo com o nome
t2tmake.log será gerado no diretório destino.
- --L10N
-
Gera os arquivos conforme localização para o Apache. Se o nome do arquivo original for
index-en.t2t, o nome do arquivo destino será index;html.en. Assim, conforme a linguagem especificada pelo navegador, o Apache retorna o mais adequado. Se nenhum se enquadrar, será mostrada uma página com os arquivos disponíveis para que o usuário escolha a linguagem mais familiar.
- -a, --all
-
Força o processamento de todos os arquivos, independente de terem ou não sido modificados em relação a última geração.
- -c, --clean
-
Apaga todos os arquivos destinos antes do processamento.
- -f, --flags=x,y,z,...
-
Envia os parâmetros diretamente para o txt2tags. Por exemplo
-f--css-suggar, enviará --css-suggar na linha de comando para o txt2tags. É possível especificar diversos parâmetros, mas os mesmos deverão estar separados por vígula e não pode conter espaços. Se você necessitar de espaço, utilize o sublinhado.
- -k, --skip=f1,f2,...
-
Informa um ou mais arquivos que deverão ser pulados (ignorados) no diretório fonte. Útil quando o usuário possui arquivos utilizados no include do txt2tags e possuem a a extensão .t2t. As mesmas restrições quanto a separação e utilização de espaços do parâmetro anterios
-f. Coringas (*, ?) tanbém não são aceitos.
- -b, --batch=[LABEL[,FILE]]
-
Informa a utilização de um arquivo de lotes (batch). Para meiores informações, veja o tópico sobre Arquivo de lotes. Se não for informado nenhum parâmetro, o nome do arquivo será t2tmake.conf e deverá se encontrar no diretório
home do usuário (~ para o Linux e valor da variável HOME no Windows). Se o rótulo (label) não for especificado, será procurado pelo nome do diretório atual no arquivo de lotes. Se o rótulo não existir no arquivo, será mostrado ao usuário uma listagem dos rótulos disponíveis.
- -h, --help
-
Mostra informações sobre a utilização dos parâmetros no t2tmake
- -V, --version
-
Informa a versão do t2tmake
2.2. Arquivo de lotes
Um arquivo de lotes é apenas um arquivo texto contendo um ou mais rótulos (labels) seguido por uma serie de parâmetros que deverão ser enviados para o programa em substituição à linha de comandos. O arquivo deverá seguir o seguinte formato:
- Cada seção deverá estar entre colchetes [] e o nome não deverá possuir espaçoes. Por exemplo, -bt2t-make refere-se a uma seção cuja a entrada está como "["t2t-make"]" no arquivo de lotes.
- As seções deverão ser separadas por uma ou mais linhas em branco.
- Após cada rótilo que identifica uma seção, devem seguir os parâmetros conforme especificados para a linha de comando. Para facilitar a visualização, apenas um parâmetro por linha.
- Para a especificação de caminhos com espaços (mais comuns no Windows), coloque o mesmo entre aspas.
Como pode ser visto no exmplo abaixo, o arquivo é bem simples. Pelamordedeus, não me venha com XML. Definitivamente o XML não foi feito para esta tarefa (pelo menos só serviria para atrapalhar)
2.2.1. Exemplo
Um exemplo de arquivo de lotes poderia ser:
[txt2tags]
--L10N
--type html
--sdir "F:/txt2tags/site"
--ddir "C:/Arquivos de programas/Apache Group/Apache/htdocs/txt2tags-win"
[ruby-ptbr]
--type html
--ext inc
--sdir "C:/guaracy/Ruby/site"
--ddir "C:/Arquivos de programas/Apache Group/Apache/htdocs/ruby-ptbr"
-r
[t2tmake]
--type html
--ddir .
-f--css-suggar,--style=color.css,--toc,-n
-r
3. Histórico
3.0.1. 24/07/2004
Versão 1.1 (desenvolvimento)
- correções diversas
- inclusão do parâmetro -f (flags)
- inclusão do parâmetro -k (skip)
- diretório padrão do t2tmake.conf
- label padrão como sendo nome do diretório atual
- ajustes no parâmetro --clean
3.0.2. ../07/2004
Versão 1.0 (parte do pacote do txt2tags)
4. Download
4.1. Ruby
Para executar o programa, você deverá ter instalado em seu computador o Ruby na versão 1.8 ou superior.
4.1.1. Linux
Se você usa o Linux, provavelmente um pacote para a sua distribuição estará disponível em alguns dos CDs ou em diretório apropriado. Caso não encontre, primeiro coloque na lista de bugs da sua distribuição :-) depois baixe os fontes, e proceda conforme o usual para a compilação, e instalação (geralmente /configure, make, make install).
4.1.2. Windows
Se você ainda não possui o Ruby instalado no seu computador, basta baixar o programa de instalação existente no site Rubyforge. É só executar que tudo será instalado automaticamente para você. Para uma melhor instalação, você deverá possuir direitos para alterações no registro (apenas para registrar a extensão .rb e .rbw).
4.2. t2tmake.rb
Basta baixar o t2tmake.rb e salvá-lo em um diretório que está no seu path (para facilitar a execução).