TXT2TAGS

Aug, 2010

NOM
SYNOPSIS
DESCRIPTION
BALISES
OPTIONS
FICHIERS SOURCE
CONFIGURATIONS
COMMANDES
MACROS
EXEMPLES
FICHIERS
ENVIRONNEMENT
AUTEUR
BOGUES
COPYRIGHT

NOM

txt2tags - outil de conversion et de formatage de texte

SYNOPSIS

txt2tags [options] [FICHIER...]

DESCRIPTION

txt2tags lit un fichier texte avec des balises minimales et peut le convertir en : ASCII Art, AsciiDoc, Creole, DocBook, DokuWiki, Google Code Wiki, HTML, LaTeX, Lout, MagicPoint, Man page, MoinMoin, PageMaker, Plain Text, PmWiki, SGML, Wikipedia et XHTML.

Cette page de man a été créée grâce à txt2tags depuis un simple fichier textuel. Le même fichier texte a été également converti en HTML pour la version en ligne de ce manuel.

UNE source, des sorties MULTIPLES - http://txt2tags.org

BALISES

  Entête               Les 3 premières lignes du fichier source
  Titre                = mots =
  Titre numéroté       + mots +
  Commentaires         % commentaires
  Ligne de séparation  -----------------------...
  Ligne plus épaisse   =======================...
  Image                [fichier.jpg]
  Liens                [label url]
  
  Gras                 **mots**
  Italique             //mots//
  Souligné             __mots__
  Barré                --mots--
  Monospaced           ``mots``
  Raw                  ""mots""
  Tagged               ''mots''
  
  Paragraphe           mots
  Citation             <TAB>mots
  Liste                - mots
  Liste numérotée      + mots
  Liste de définitions : mots
  Table                | cellule1 | cellule2 | cellule3...
  
  Ligne verbatim       ``` mots
  Ligne raw            """ mots
  Ligne tagged         ''' mots
  
  Bloc verbatim        ```
                       lignes
                       ```
  Bloc raw             """
                       lignes
                       """
  Bloc tagged          '''
                       lignes
                       '''

OPTIONS

--art-chars=MOTIF: Utilise le MOTIF pour définir les caractères du mode ASCII Art, respectivement pour les coins, les bordures, les côtés, les barres 1 et 2, les niveaux 2, niveaux 3, niveaux 4 et niveau 5. Le motif par défaut est +-|-==-^". Cette option est uniquement valable pour la cible ASCII Art.
-C, --config-file=FICHIER: Lit la configuration depuis le fichier extérieur FICHIER. La configuration doit être de la forme %!mot-clé:valeur. Se référer à la section CONFIGURATIONS pour plus de détails.
--css-sugar: Améliore l'utilisation de feuilles CSS par rapport au code HTML/XHTML généré. Les attributs éventuels des balises sont retirés, les balises de présentation sont évités, l'entête est composé de balises H1, H2 et H3, de nouveaux DIVs sont créés : #header, #body, .toc.
--css-inside: Insère le contenu du fichier CSS dans l'entête HTML/XHTML. Utilisez --style pour spécifier le fichier CSS à inclure.
--dump-config: Affiche toute la configuration trouvée et sort.
--dump-source: Affiche la source du document, avec toutes les inclusions (%!include) éventuelles.
--encoding=CODE: Définit l'encodage de la sortie utilisé par le document source vers CODE. Par exemple UTF-8, iso-8859-1, etc.
--gui: Appelle l'interface graphique Tk.
-h, --help: Affiche l'aide et sort.
-H, --no-headers: Supprime les entêtes, les titres et les pieds de page de la sortie. Seul le contenu (body) sera affiché.
--headers: Montre les entêtes, les titres et les pieds de page dans la sortie. ACTIVÉ par défaut.
--height=NOMBRE: Définit la hauteur de sortie à NOMBRE de lignes. Cette option est uniquement utilisée par la cible ASCI ART (-t art), en utilisant également l'option --slides.
-i, --infile=FICHIER: Définit FICHIER comme fichier d'entrée pour le document source. Utilisez '-' pour lire la source depuis STDIN.
--mask-email: Masque les courriels contre les robots spammeurs. Retire @ et les points. Ainsi l'adresse foo@bar.com devient <foo (a) bar com>.
-n, --enum-title: Numérote automatiquement les titres. Ils seront préfixés par 1, 1.1, 1.1.1, ...
--no-dump-config: Annule l'affichage de configuration via --dump-config.
--no-dump-source: Annule l'affichage de la source via --dump-source.
--no-encoding: Annule la configuration d'encodage.
--no-enum-title: Annule la numérotation automatique des titres.
--no-infile: Annule toutes les déclarations précédentes de fichiers d'entrée.
--no-targets: Annule l'action --targets.
--no-mask-email: Annule l'action de masquer les courriels.
--no-outfile: Annule la précédente déclaration de fichier de sortie.
--no-quiet: Affiche les messages, annule l'option --quiet.
--no-rc: Ne lit pas le fichier de configuration utilisateur ~/.txt2tagsrc.
--no-slides: N'utilise pas les slides (-t art).
--no-style: Supprime la déclaration de style.
--no-toc: N'ajoute pas de table des matières au document de sortie.
--no-toc-only: Annule l'action de --toc-only.
-o, --outfile=FICHIER: Génère le nom FICHIER en tant que fichier de sortie. Utilisez '-' pour envoyer le résultat vers STDOUT.
-q, --quiet: Mode silencieux, supprime toutes les sorties (sauf les erreurs).
--rc: Lit le fichier de configuration utilisateur ~/.txt2tagsrc. ACTIVÉ par défaut.
--slides: Formate la sortie en tant que slide de présentation. Cette option est uniquement utilisée par la cible ASCII Art.
--style=FICHIER: Utilise FICHIER en tant que fichier de style pour le document. Utilisé pour définir les fichiers CSS pour les documents HTML/XHTML et les paquets pour LaTeX. Cette option peut être appelée à plusieurs reprises pour inclure de multiples fichiers.
-t, --target=TYPE: Choisit la cible document de sortie en la définissant à TYPE. Des cibles courantes sont : html, xhtml, tex, man, txt. Utilisez l'option --targets pour lister toutes les cibles disponibles.
--targets: Affiche une liste de toutes les cibles disponibles, et sort.
--toc: Ajoute une table des matières (Table of Contents ; TOC), générée automatiquement, au document de sortie, entre son entête et son contenu. Vous pouvez également spécifier la place de cette table des matières en utilisant la macro %%TOC.
--toc-level=NOMBRE: Assigne le niveau maximum de la table des matières à NOMBRE. Tous les titres au-delà de NOMBRE ne seront pas inclus dans la table des matières.
--toc-only: Affiche la table des matières et sort.
-v, --verbose: Affiche les messages d'information durant la conversion. Cette option peut être appelée à plusieurs reprises pour augmenter le nombre de messages affichés.
-V, --version: Affiche la version du programme et sort.
--width=NOMBRE: Assigne la largeur de sortie à NOMBRE de colonnes. Cette option est uniquement utilisée par la cible ASCII Art.

FICHIERS SOURCE

Les fichiers source sont généralement identifiés par l'extension .t2t (par exemple mon_fichier.t2t). Vous pouvez avoir trois zones dans vos sources :

Entête (optionel): Les trois premières lignes du fichier. Laissez la première ligne vide si vous n'avez pas besoin d'entêtes. Utilisé dans le document pour le titre, l'auteur, la version, et la date.
Configuration (optionel): Commence juste après l'entête (4ème ou 2nde ligne) et se termine quand le corps du texte débute. Utilisé pour les configurations, dans le format %!mot-clé:valeur.
Corps: Commence à la première ligne de texte valide (pas de commentaire ou de configuration), après la zone d'entête et continue jusqu'à la fin du document. Utilisé pour le contenu du document proprement dit.

CONFIGURATIONS

Les configurations vous permettent de personnaliser txt2tags, elles sont similaires aux options. Elles peuvent être utilisées : dans la zone de configurations du document source, dans un fichier ~/.txt2tagsrc, dans un fichier extérieur appelé avec l'option --config-file.

%!target

Définit le format de sortie, de la même manière que --target. Par exemple :

  %!target: html

%!options(target)

Définit les options par défaut de chaque cible. Vous devez utiliser la même syntaxe qu'en ligne de commande. Par exemple :

  %!options(html): --toc --toc-level 3 --css-sugar

%!includeconf

Inclut une configuration à partir d'un fichier externe, de la même manière que --config-file. Par exemple :

  %!includeconf: myconfig.t2t

%!style

Définit un fichier de style pour le document, de la même manière que --style. Peut être appelée à plusieurs reprises. Par exemple :

  %!style: colors.css

%!encoding

Définit l'encodage de la cible, de la même manière que --encoding. Par exemple :

  %!encoding: UTF-8

%!preproc

Filtre de recherche et remplacement utilisé pour modifier le corps de la source AVANT les remplacements habituels de txt2tags. La fonction de recherche utilise les expressions rationnelles (regex) de Python. Par exemple :

  %!preproc:  "JJS"  "John J. Smith"

%!postproc

Filtre de recherche et remplacement utilisé pour modifier le document généré APRÈS les remplacements habituels de txt2tags. La fonction de recherche utilise les expressions rationnelles (regex) de Python. Par exemple :

  %!postproc(html):  "<B>"  "<STRONG>"

Si le même mot apparaît plusieurs fois, le dernier trouvé sera celui utilisé (à l'exception des options, preproc et postproc, qui sont cumulatifs). Les mots-clés non-valides sont ignorés. L'ordre de priorité est : fichier ~/.txt2tagsrc, zone de configuration du document, option --config-file passée en ligne de commandes.

COMMANDES

Les commandes font diverses tâches durant la conversion. Elles doivent être placées dans le corps du document.

%!csv: fichier.csv: Inclut un fichier externe CSV file en tant que tableau.
%!include: fichier.t2t: Inclut un fichier txt2tags dans le document.
%!include: ``fichier.txt``: Inclut un fichier texte (verbatim) dans le document.
%!include: ''fichier.html'': Inclut un fichier html dans le document.

MACROS

Les macros sont des raccourcis pratiques pour insérer du contenu dynamique dans votre document. Elles doivent être placées dans le corps du document source. À l'exception de %%toc, toutes les macros peuvent être personnalisées avec des directives spécifiques, comme %Y ou %f. Voir le guide complet de txt2tags pour plus de détails.

%%date: Insère la date actuelle. Le format par défaut est %%date(%Y%m%d), ce qui donne AAAAMMJJ.
%%infile: Insère le chemin du fichier source. Le format par défaut est %%infile(%f). Utile pour inclure des bas de page de type [Voir la source %%infile].
%%mtime: Insère la date de modification du fichier source. Le format par défaut est %%date(%Y%m%d), ce qui donne AAAAMMJJ.
%%outfile: Insère le chemin du fichier de sortie. Le format par défaut est %%outfile(%f). Utile pour une description de type "C'est le fichier manpage-fr.html".
%%toc: Indique où sera placée la table des matières. Vous pouvez même l'appeler à de multiples reprises. Notez que vous devez également utiliser l'option --toc.

EXEMPLES

txt2tags -t html fichier.t2t

Conversion HTML, vers le fichier fichier.html.

txt2tags -t html -o - fichier.t2t

Conversion HTML, envoie le résultat vers STDOUT.

txt2tags -t html --toc fichier.t2t

Conversion HTML, incluant une table des matières automatiquement générée.

txt2tags -t html --toc --toc-level 2 -n fichier.t2t

Conversion HTML, avec une table des matières de niveau deux et des titres numérotés.

txt2tags --toc-only fichier.t2t

Affiche juste la table des matières dans le terminal, aucune conversion ne sera faite.

txt2tags -t html --css-sugar --style base.css --style ui.css fichier.t2t

Convertion HTML, préparant le code résultant à être utilisé avec des CSS, et incluant également deux fichiers CSS externes.

txt2tags -t art --slides --width 80 --height 25 -o - fichier.t2t | more

Crée une présentation en ASCII Art, prête à être visualisée dans un terminal en 80x25.

(echo ; echo "**bold**") | txt2tags -t html -H -

Test rapide en une ligne avec entrée depuis la console STDIN.

txt2tags -t html -o - fichier.t2t | tidy > fichier.html

Envoie le résultat vers STDOUT, puis ajuste le code avec un programme externe avant de sauvegarder le résultat dans un fichier externe.

FICHIERS

~/.txt2tagsrc: Fichier de configuration par défaut de l'utilisateur.

ENVIRONNEMENT

T2TCONFIG: Si cette variable d'environnement n'est pas nulle, elle définit alors le chemin complet pour la configuration par défaut de l'utilisateur.

AUTEUR

Aurelio Jargas <<verde (a) aurelio net>>

Page de man traduite en français par Eric Forgeot <http://esclinux.tk>, en réutilisant parfois le travail original de Claude Hiebel <<chiebel (a) free fr>>

BOGUES

http://bugs.txt2tags.org