/doc/French/manpage-fr.t2t
Unknown | 372 lines | 250 code | 122 blank | 0 comment | 0 complexity | 74d0dc25c0f2ffe26def36b06cd4645f MD5 | raw file
1TXT2TAGS 2 3Aug, 2010 4 5%!target: man 6%!encoding: UTF-8 7 8%!postproc(man): ' \(#\w+\)' '' 9 10%!options(html): --mask-email --toc 11%!postproc(html): <HEAD> '<HEAD>\n<STYLE>body{margin:3em;} pre{background:#ffc;}</STYLE>' 12 13 14= NOM =[nom] 15 16txt2tags - outil de conversion et de formatage de texte 17 18= SYNOPSIS =[synopsis] 19 20**txt2tags** [//options//] [//FICHIER//...] 21 22= DESCRIPTION =[description] 23 24**txt2tags** lit un fichier texte avec des balises minimales et peut le convertir en : 25//ASCII Art//, 26//AsciiDoc//, 27//Creole//, 28//DocBook//, 29//DokuWiki//, 30//Google Code Wiki//, 31//HTML//, 32//LaTeX//, 33//Lout//, 34//MagicPoint//, 35//Man page//, 36//MoinMoin//, 37//PageMaker//, 38//Plain Text//, 39//PmWiki//, 40//SGML//, 41//Wikipedia// et 42//XHTML//. 43% TRANSLATOR: please keep the alphabetical order of this list. 44 45Cette 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. 46 47UNE source, des sorties MULTIPLES - http://txt2tags.org 48 49 50= BALISES =[balises] 51 52``` 53Entête Les 3 premières lignes du fichier source 54Titre = mots = 55Titre numéroté + mots + 56Commentaires % commentaires 57Ligne de séparation -----------------------... 58Ligne plus épaisse =======================... 59Image [fichier.jpg] 60Liens [label url] 61 62Gras **mots** 63Italique //mots// 64Souligné __mots__ 65Barré --mots-- 66Monospaced ``mots`` 67Raw ""mots"" 68Tagged ''mots'' 69 70Paragraphe mots 71Citation <TAB>mots 72Liste - mots 73Liste numérotée + mots 74Liste de définitions : mots 75Table | cellule1 | cellule2 | cellule3... 76 77Ligne verbatim ``` mots 78Ligne raw """ mots 79Ligne tagged ''' mots 80 81Bloc verbatim ``` 82 lignes 83 ``` 84Bloc raw """ 85 lignes 86 """ 87Bloc tagged ''' 88 lignes 89 ''' 90``` 91 92= OPTIONS =[options] 93 94: **--art-chars**=//MOTIF// 95Utilise 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. 96 97: **-C**, **--config-file**=//FICHIER// 98Lit 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 #configurations] pour plus de détails. 99 100: **--css-sugar** 101Amé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//. 102 103: **--css-inside** 104Insère le contenu du fichier CSS dans l'entête HTML/XHTML. Utilisez ``--style`` pour spécifier le fichier CSS à inclure. 105 106: **--dump-config** 107Affiche toute la configuration trouvée et sort. 108 109: **--dump-source** 110Affiche la source du document, avec toutes les inclusions (``%!include``) éventuelles. 111 112: **--encoding**=//CODE// 113Définit l'encodage de la sortie utilisé par le document source vers //CODE//. Par exemple UTF-8, iso-8859-1, etc. 114 115: **--gui** 116Appelle l'interface graphique Tk. 117 118: **-h**, **--help** 119Affiche l'aide et sort. 120 121: **-H**, **--no-headers** 122Supprime les entêtes, les titres et les pieds de page de la sortie. Seul le contenu (body) sera affiché. 123 124: **--headers** 125Montre les entêtes, les titres et les pieds de page dans la sortie. ACTIVÉ par défaut. 126 127: **--height**=//NOMBRE// 128Dé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``. 129 130: **-i**, **--infile**=//FICHIER// 131Définit //FICHIER// comme fichier d'entrée pour le document source. Utilisez '-' pour lire la source depuis STDIN. 132 133: **--mask-email** 134Masque les courriels contre les robots spammeurs. Retire @ et les points. Ainsi l'adresse ""foo@bar.com"" devient <foo (a) bar com>. 135 136: **-n**, **--enum-title** 137Numérote automatiquement les titres. Ils seront préfixés par 1, 1.1, 1.1.1, ... 138 139: **--no-dump-config** 140Annule l'affichage de configuration via ``--dump-config``. 141 142: **--no-dump-source** 143Annule l'affichage de la source via ``--dump-source``. 144 145: **--no-encoding** 146Annule la configuration d'encodage. 147 148: **--no-enum-title** 149Annule la numérotation automatique des titres. 150 151: **--no-infile** 152Annule toutes les déclarations précédentes de fichiers d'entrée. 153 154: **--no-targets** 155Annule l'action ``--targets``. 156 157: **--no-mask-email** 158Annule l'action de masquer les courriels. 159 160: **--no-outfile** 161Annule la précédente déclaration de fichier de sortie. 162 163: **--no-quiet** 164Affiche les messages, annule l'option ``--quiet``. 165 166: **--no-rc** 167Ne lit pas le fichier de configuration utilisateur ~/.txt2tagsrc. 168 169: **--no-slides** 170N'utilise pas les slides (-t art). 171 172: **--no-style** 173Supprime la déclaration de style. 174 175: **--no-toc** 176N'ajoute pas de table des matières au document de sortie. 177 178: **--no-toc-only** 179Annule l'action de ``--toc-only``. 180 181: **-o**, **--outfile**=//FICHIER// 182Génère le nom //FICHIER// en tant que fichier de sortie. Utilisez '-' pour envoyer le résultat vers STDOUT. 183 184: **-q**, **--quiet** 185Mode silencieux, supprime toutes les sorties (sauf les erreurs). 186 187: **--rc** 188Lit le fichier de configuration utilisateur ~/.txt2tagsrc. ACTIVÉ par défaut. 189 190: **--slides** 191Formate la sortie en tant que slide de présentation. Cette option est uniquement utilisée par la cible ASCII Art. 192 193: **--style**=//FICHIER// 194Utilise //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. 195 196: **-t**, **--target**=//TYPE// 197Choisit 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. 198 199: **--targets** 200Affiche une liste de toutes les cibles disponibles, et sort. 201 202: **--toc** 203Ajoute 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``. 204 205: **--toc-level**=//NOMBRE// 206Assigne 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. 207 208: **--toc-only** 209Affiche la table des matières et sort. 210 211: **-v**, **--verbose** 212Affiche les messages d'information durant la conversion. Cette option peut être appelée à plusieurs reprises pour augmenter le nombre de messages affichés. 213 214: **-V**, **--version** 215Affiche la version du programme et sort. 216 217: **--width**=//NOMBRE// 218Assigne la largeur de sortie à //NOMBRE// de colonnes. Cette option est uniquement utilisée par la cible ASCII Art. 219: 220 221= FICHIERS SOURCE =[source] 222 223Les 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 : 224 225: **Entête** (optionel) 226Les 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. 227 228: **Configuration** (optionel) 229Commence juste après l'entête (4ème ou 2nde ligne) et se termine quand le corps du texte débute. 230Utilisé pour les configurations, dans le format ``%!mot-clé:valeur``. 231 232: **Corps** 233Commence à 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. 234: 235 236= CONFIGURATIONS =[configurations] 237 238Les 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``. 239 240: **%!target** 241Définit le format de sortie, de la même manière que ``--target``. Par exemple : 242``` %!target: html 243 244: **%!options(target)** 245Définit les options par défaut de chaque cible. Vous devez utiliser la même syntaxe qu'en ligne de commande. Par exemple : 246``` %!options(html): --toc --toc-level 3 --css-sugar 247 248: **%!includeconf** 249Inclut une configuration à partir d'un fichier externe, de la même manière que ``--config-file``. Par exemple : 250``` %!includeconf: myconfig.t2t 251 252: **%!style** 253Définit un fichier de style pour le document, de la même manière que ``--style``. Peut être appelée à plusieurs reprises. Par exemple : 254``` %!style: colors.css 255 256: **%!encoding** 257Définit l'encodage de la cible, de la même manière que ``--encoding``. Par exemple : 258``` %!encoding: UTF-8 259 260: **%!preproc** 261Filtre 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 : 262``` %!preproc: "JJS" "John J. Smith" 263 264: **%!postproc** 265Filtre 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 : 266``` %!postproc(html): "<B>" "<STRONG>" 267: 268 269Si 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. 270 271 272= COMMANDES =[commandes] 273 274Les commandes font diverses tâches durant la conversion. Elles doivent être placées dans le corps du document. 275 276: **%!csv: fichier.csv** 277Inclut un fichier externe CSV file en tant que tableau. 278 279: **%!include: fichier.t2t** 280Inclut un fichier txt2tags dans le document. 281 282: **%!include: ""``fichier.txt``""** 283Inclut un fichier texte (verbatim) dans le document. 284 285: **%!include: ""''fichier.html''""** 286Inclut un fichier html dans le document. 287: 288 289= MACROS =[macros] 290 291Les 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. 292 293: **""%%date""** 294Insère la date actuelle. Le format par défaut est ``%%date(%Y%m%d)``, ce qui donne AAAAMMJJ. 295 296: **""%%infile""** 297Insè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]``. 298 299: **""%%mtime""** 300Insère la date de modification du fichier source. Le format par défaut est ``%%date(%Y%m%d)``, ce qui donne AAAAMMJJ. 301 302: **""%%outfile""** 303Insè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 %%outfile". 304 305: **""%%toc""** 306Indique 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``. 307: 308 309= EXEMPLES =[exemples] 310 311: ``txt2tags -t html fichier.t2t`` 312 313Conversion HTML, vers le fichier fichier.html. 314 315: ``txt2tags -t html -o - fichier.t2t`` 316 317Conversion HTML, envoie le résultat vers STDOUT. 318 319: ``txt2tags -t html --toc fichier.t2t`` 320 321Conversion HTML, incluant une table des matières automatiquement générée. 322 323: ``txt2tags -t html --toc --toc-level 2 -n fichier.t2t`` 324 325Conversion HTML, avec une table des matières de niveau deux et des titres numérotés. 326 327: ``txt2tags --toc-only fichier.t2t`` 328 329Affiche juste la table des matières dans le terminal, aucune conversion ne sera faite. 330 331: ``txt2tags -t html --css-sugar --style base.css --style ui.css fichier.t2t`` 332 333Convertion HTML, préparant le code résultant à être utilisé avec des CSS, et incluant également deux fichiers CSS externes. 334 335: ``txt2tags -t art --slides --width 80 --height 25 -o - fichier.t2t | more`` 336 337Crée une présentation en ASCII Art, prête à être visualisée dans un terminal en 80x25. 338 339: ``(echo ; echo "**bold**") | txt2tags -t html -H -`` 340 341Test rapide en une ligne avec entrée depuis la console STDIN. 342 343: ``txt2tags -t html -o - fichier.t2t | tidy > fichier.html`` 344 345Envoie le résultat vers STDOUT, puis ajuste le code avec un programme externe avant de sauvegarder le résultat dans un fichier externe. 346: 347 348= FICHIERS =[fichiers] 349 350: ~/.txt2tagsrc 351Fichier de configuration par défaut de l'utilisateur. 352: 353 354= ENVIRONNEMENT =[environnement] 355 356: T2TCONFIG 357Si cette variable d'environnement n'est pas nulle, elle définit alors le chemin complet pour la configuration par défaut de l'utilisateur. 358: 359 360= AUTEUR =[auteur] 361 362Aurelio Jargas <verde@aurelio.net> 363 364Page de man traduite en français par Eric Forgeot <http://esclinux.tk>, en réutilisant parfois le travail original de Claude Hiebel <chiebel@free.fr> 365 366= BOGUES =[bogues] 367 368http://bugs.txt2tags.org 369 370= COPYRIGHT =[copyright] 371 372Copyright (C) 2001-%%date(%Y) Aurelio Jargas, GNU GPL v2