txt2tags

Autres langues

Langue: fr

Version: 145598 (fedora - 04/07/09)

Section: 1 (Commandes utilisateur)

NOM

txt2tags - outil de conversion et de mise au format

SYNOPSIS

txt2tags [OPTION]... [FILE]...

DESCRIPTION

txt2tags est un outil de conversion GPL יcrit en Python qui gיnטre des documents en HTML, XHTML, SGML, LaTeX, Man Page, MoinMoin, MagicPoint et PageMaker א partir d'un simple fichier texte avec un minimum de marques.

L'utilisateur a juste besoin de savoir un minimum de marques simples de txt2tags, et comment יcrire des fichiers texte. Le programme fait tout le travail, ajoutant les marques compliquיes et se dיbrouillant avec les problטmes du fichier de sortie.

Le mךme fichier texte peut ךtre converti dans tous les formats cible, sans aucune יdition supplיmentaire. C'est le rפle de txt2tags : UNE source, des sorties MULTIPLES.

NOTE: le noyau de la version 2.0 de txt2tags a יtי complטtement rייcrit. Si vous ךtes utilisateur d'une version prיcיdente, vous pouvez ךtre obligי de rייcrire une partie de vos vieux documents.

Visitez la page de base du programme א : http://txt2tags.sourceforge.net.

OPTIONS


     --css-sugar
insיrer CSS-friendly tags pour les cibles HTML and XHTML

     --css-inside
insיrer le contenu du fichier CSS dans l'entךte HTML/XHTML

     --dump-config
imprimer toute la configuration trouvיe et sortir

     --encoding
choisir l'encodage de la sortie (utf-8, iso-8859-1, etc)

     --gui
appeler l'interface graphique Tk

 -h--help
imprimer les informations d'aide et sortir

 -H--no-headers
suppression des informations d'entךte, de titre, de pied et sortir

     --headers
montrer les informations d'entךte, de titre et de pied (actif par dיfaut)

 -i--infile=FILE
choisir FILE comme fichier d'entrיe ('-' pour STDIN)

     --mask-email
masquer les email des robots scanneurs. x@y.z devient <x (a) y z>

 -n--enum-title
numיroter les titres : 1, 1.1, 1.1.1, etc

     --no-encoding
supprimer la configuration d'encodage

     --no-enum-title
supprimer la numיrotation automatique des titres

     --no-infile
supprimer la dיclaration de fichier d'entrיe

     --no-mask-email
dיmasque les emails, supprime l'option --mask-email

     --no-outfile
supprime la dיclaration prיcיdente de fichier de sortie

     --no-quiet
imprime les messages supprime l'option --quiet

     --no-rc
ne pas lire le fichier de configuration utilisateur ~/.txt2tagsrc

     --no-style
supprimer la dיclaration de style

     --no-toc
ne pas ajouter de table des matiטres au document de sortie

     --no-toc-only
supprimer l'option --toc-only

 -o--outfile=FILE
gיnיrer le fichier de sortie FILE ('-' pour STDOUT)

 -q--quiet
mode silencieux, supprime toutes les sorties (sauf les erreurs)

     --rc
lire la configuration utilisateur ~/.txt2tagsrc (actif par dיfaut)

     --style=FILE
utiliser FILE comme style de document (comme Html CSS)
-t, --target
choisit le type de document de sortie, options actuelles : html, xhtml, sgml, tex, lout, man, mgp, moin, pm6, txt

     --toc
ajouter la table des matiטres au document de sortie

     --toc-level=N
mettre le niveau maximum de la table des matiטres א N

     --toc-only
imprime la table des matiטres et sort

 -v--verbose
imprime les message d'information pendant la conversion

 -V--version
imprime la version du programme et sort

Par dיfaut la sortie convertie est sauvיe dans 'file.<type>'. Utiliser --outfile pour forcer le nom du fichier de sortie. Si le fichier d'entrיe est '-', on lit א partir de STDIN. Si le fichier de sortie est '-', la sortie se fait sur STDOUT.

STRUCTURE

Le fichier source txt2tags peut comporter trois zones.

Entךte
Les trois premiטres lignes. Elles sont utilisיes pour l'identification du document. Si vous n'avez pas besoin de l'entךte, vous devez laisser ces trois lignes libres ou utiliser l'option no-header.
Configuration
Dיmarre א la quatriטme ligne. Toutes les lignes ont la forme %!keyword: valeur. Les configurations peuvent aussi ךtre faites par un fichier de configuration ou א la ligne de commande.
Corps
La vraie partie du document. Seule cette partie est obligatoire pour avoir un fichier txt2tags valide.

CONFIGURATION

txt2tags peut ךtre personnalisי de l'extיrieur ou de l'intיrieur. De l'extיrieur par un fichier .txt2tagsrc ou par un fichier importי d'un autre fichier txt2tags. La personnalisation interne est faite par des commandes de configuration spיciales dans le document source. Tous les deux utilisent la mךme syntaxe :

%!target:
dיfinit la cible principale
%!options(target):
dיfinit les options de chaque cible
%!include: file.t2t
inclut un fichier txt2tags
%!include: ``file.txt``
inclut un fichier texte dans le document
%!include: ''file.html''
inclut un fichier tel qu'il est
%!style:
dיfinit un fichier CSS (Cascading Style Sheet) pour les cibles XHTML et HTML ou pour charger des modules dans la cible TEX (par \usepackage)
%!encoding:
choisit l'encodage de la cible (comme iso-8859-1) pour les traductions i18n
%!includeconf:
inclut une configuration א partir d'un fichier externe
%!guicolors:
configuration des couleurs pour l'interface GUI (Tk/Tcl)
%!preproc:
vos filtres personnels (macro) qui seront effectuיs AVANT le traitement
%!postproc:
vos filtres personnels (macro) qui seront effectuיs APRES le traitement

REGLES POUR LA CONFIGURATION

les configurations ne sont valides que dans la zone de configuration et sont considיrיs comme des commentaires dans le corps du document. Une exception est include qui est valide dans le corps.
si le mךme mot clef apparaמt plus d'une fois dans la zone de configuration, le dernier trouvי est celui utilisי. Exceptions : options, preproc et postproc, qui peuvent ךtre cumulatifs.
Une ligne de configuration avec un mot clef invalide est considיrיe comme du commentaire.
Ces configurations ont prioritי sur le fichier .txt2tagsrc, mais pas sur les options de la ligne de commande.

SYNTAXE

Un syntaxe simple de marques est utilisיe dans le document source (le fichier texte) pour identifier les structures et la mise au format. Voici la liste complטte :

Basique

   Entךte            Les 3 premiטres lignes su fichier source
   Titre             = mots =
   Titre numיrotי    + mots +
   Paragraphe        mots
 

Enjoliveurs

   Gras              **mots**
   Italique          //mots//
   Soulignי          __mots__
   Machine א יcrire  ``mots``
 

Blocs de texte

   Quote                   <TAB>mots
   Liste                   - mots
   Liste numיrotיe         + mots
   Liste de dיfinitions    : mots
   Ligne verbatim          ``` mots
   Zone verbatim           ```<retour א la ligne> lignes <retour א la ligne>```
   Ligne brute             """ mots
   Zone brute              """<retour א la ligne> lignes <retour א la ligne>"""
   Table                   | cellule1 | cellule2 | cellule3...
 

Autres

   Ligne de sיparation    -----------------------...
   Ligne plus יpaisse     =======================...
   Liens                 [label url]
   Image                 [<nom de fichier>.jpg]
   Texte brut            ""mots""
   Commentaire           % commentaires
 

Lire le User Guide de tx2tags (dans le rיpertoire de la documentation) pour une description dיtaillיe de chaque marque.

EXEMPLES

Considיrons que vous avez יcrit un fichier marquי `file.t2t`, voyons comment opיrer pour la conversion.

Conversion vers HTML dans le fichier file.html
$ txt2tags -t html file.t2t
Mךme travail, mais en utilisant une redirection
$ txt2tags -t html -o - file.t2t > file.html
Et en ajoutant une table des matiטres (TDM)
$ txt2tags -t html --toc file.t2t
Avec une TDM et des titres numיrotיs
$ txt2tags -t html --toc --enum-title file.t2t
Que la TDM
$ txt2tags --toc-only file.t2t
Utilisation de l'interface graphique
$ txt2tags --gui file.t2t
Post-conversion avec un filtre externe
$ txt2tags -t html -o- file.t2t | sed -f myfilter.sed > file.html
Test sur une ligne avec entrיe א partir de STDIN
$ echo -e "\n**bold**" | txt2tags -t html -H -

TRUCS

Il y a quelques trucs agrיables qui font de txt2tags un excellent outil pour la documentation.

Ancres
Les titres peuvent avoir des liens avec des ancres pour vous permettre d'y aller directement, si la cible l'autorise.
   Titre             = mots =[ancre]
   Titre numיrotיs   + mots +[ancre]
 
Fichiers multiples
txt2tags peut traiter plus d'un fichier א la fois comme : txt2tags *.t2t

MACROS

%%date
Permet d'inclure la date courante, dans le format YYYYMMDD. Un format optionnel peut ךtre dיfini en utilisant la syntaxe : %%date(format-string).
%%infile
Utilisי pour obtenir des informations sur le fichier source. Une mise au format optionnelle peut ךtre spיcifiיe par la syntaxe : %%infile(format-string). Un lien utile dans le pied de page comme [voir le fichier source %%infile], ainsi vous pouvez changer le nom du fichier et la rיfיrence sera mise א jour.
%%mtime
Donne les informations sur la date de modification du fichier. Il utilise le mךme format que la macro %%date.
%%outfile
Utilisי pour obtenir des informations sur le fichier converti. Une mise au format optionnelle est spיcifiיe par la syntaxe %%outfile(format-string). Ainsi pour indiquer "Ceci est le fichier de sortie manpage-fr.man ". Vous pouvez changer le nom du ficher et sa rיfיrence sera mise א jour.
%%toc
La macro %%toc spיcifie oש la TDM va ךtre insיrיe. Vous pouvez la mettre n'importe oש dans le document.

NOTE: %%toc ne sera dיveloppיe qu'avec l'option --toc.

AUTEUR

Ecrit et maintenu par Aurelio Jargas <verde@aurelio.net>

Cette page de manuel a יtי יcrite par Jose Inacio Coelho <jic@technologist.com> comme un fichier texte, puis converti au format man par txt2tags!

Traduit par Claude Hiebel <chiebel@free.fr>.

Copyright (C) 2001, 2002, 2003, 2004, 2005 Aurelio Jargas

This is free software; see the source for copying condpuis converti au format man par NO warranty; not even for MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.