a2x - En ligne dans le Cloud

PROGRAMME:

Nom

a2x - Un gestionnaire de chaîne d'outils pour AsciiDoc (convertit les fichiers texte Asciidoc en un autre fichier
formats)

SYNOPSIS

a2x [OPTIONS] FICHIER SOURCE

DESCRIPTION

Un gestionnaire de chaîne d'outils DocBook qui traduit un fichier texte AsciiDoc FICHIER SOURCE en PDF,
EPUB, DVI, PS, LaTeX, XHTML (page unique ou fragmenté), page de manuel, aide HTML ou texte brut
format à l'aide ascidoc(1) et d'autres applications (voir la section CONDITIONS REQUISES). FICHIER SOURCE Vous pouvez
également être un fichier DocBook avec une extension .xml.

OPTIONS

-une, --attribut=ATTRIBUT
Ensemble ascidoc(1) valeur d'attribut (raccourci pour --asciidoc-opts="-une ATTRIBUT" option).
Cette option peut être spécifiée plusieurs fois.

--asciidoc-opts=ASCIIDOC_OPTS
Supplémentaire ascidoc(1) option. Cette option peut être spécifiée plusieurs fois.

--conf-fichier=CONF_FILE
Chargez le fichier de configuration. Voir la section FICHIERS CONF.

-RÉ, --dir-destination=DESTINATION_DIR
Répertoire de sortie. Par défaut à FICHIER SOURCE annuaire. Cette option ne s'applique qu'aux
Formats de sortie HTML (chunked, epub, htmlaide, xhtml).

-ré, --doctype=DOCTYPE
Type de document DocBook : article, page de manuel or livre. Le type de document par défaut est article
sauf si le format est page de manuel (auquel cas il est par défaut page de manuel).

-b, --back-end=BACK-END
BACK-END est le nom d'un plugin backend installé. Lorsque cette option est spécifiée a2x
tente de charger un nom de fichier a2x-backend.py du BACK-END répertoire du plugin Il puis
convertit le FICHIER SOURCE à BACK-END fichier de sortie formaté à l'aide d'une fonction globale
défini dans a2x-backend.py appelé à_BACKEND.

-F, --format=Format
Formats de sortie: chunked, docbook, Dvi, epub, htmlaide, page de manuel, pdf (Par défaut), ps,
Texas, texte, xhtml. L'AsciiDoc format a2x la valeur de l'attribut est définie sur Format.

-h, --Aidez-moi
Imprimez la syntaxe de la ligne de commande et les options du programme sur stdout.

--Icônes
Utilisez des images d'avertissement ou d'icône de navigation dans les documents de sortie. Le comportement par défaut est
d'utiliser du texte à la place des icônes.

--icons-dir=PATH
Un chemin (relatif aux fichiers de sortie) contenant des icônes d'avertissement et de navigation. Valeurs par défaut
aux images/icônes. Les --Icônes option est implicite si cette option est utilisée.

-k, --garder-artefacts
Ne supprimez pas les fichiers de construction temporaires.

--Lynx
Utilisez lynx(1) pour générer une sortie au format texte. Le comportement par défaut consiste à utiliser w3m(1).

-L, --no-xmllint
Ne pas vérifier la sortie asciidoc avec xmlint(1).

--- epubcheck
Vérifiez la sortie EPUB avec vérification de publication(1).

-n, - à sec
Ne faites rien, imprimez simplement ce qui aurait été fait.

-r, --Ressource=RESOURCE_SPEC
Spécifiez une ressource. Cette option peut être spécifiée plusieurs fois. Voir le RESSOURCES
section pour plus de détails.

-m, --ressource-manifest=DOSSIER
DOSSIER contient une liste de ressources (une par ligne). Manifeste DOSSIER les entrées sont formatées
juste comme --Ressource arguments d'options. Variables d'environnement et tilde home
les répertoires sont autorisés.

--feuille de style=FICHE DE STYLE
Une liste délimitée par des espaces d'un ou plusieurs noms de fichier de feuille de style CSS qui sont utilisés pour le style
Sortie HTML générée par les feuilles de style DocBook XSL. Par défaut à docbook-xsl.cssL’
les feuilles de style sont traitées dans l'ordre de la liste. Les feuilles de style doivent résider dans un
emplacement du fichier de ressources. S'applique aux formats HTML : xhtml, epub, chunked, htmlaide
formats.

-dans, --verbeux
Imprimer les détails opérationnels sur stderr. Une seconde -v option applique l'option verbeuse à
commandes de la chaîne d'outils.

--version
Imprimer la version du programme sur stdout.

--xsltproc-opts=XSLTPROC_OPTS
Supplémentaire xsltproc(1) option. Cette option peut être spécifiée plusieurs fois.

--xsl-fichier=XSL_FILE
Remplacer la feuille de style XSL intégrée par la feuille de style XSL personnalisée XSL_FILE.

--dandy
Utilisez FOP pour générer des PDF. Le comportement par défaut consiste à utiliser dblatex(1)L’ --dandy option
est implicite si cette option est utilisée.

--opt-fop=FOP_OPTS
Supplémentaire dandy(1) option. Si cette option est spécifiée, FOP est utilisé pour générer des PDF.
Cette option peut être spécifiée plusieurs fois.

--dblatex-opts=DBLATEX_OPTS
Supplémentaire dblatex(1) option. Cette option peut être spécifiée plusieurs fois.

--backend-options=RETOUREND_OPTS
Options pour le plugin backend spécifié par le --back-end option. Cette option peut être
spécifié plus d'une fois.

Les options peuvent également être définies dans le fichier source AsciiDoc. Si FICHIER SOURCE contient un commentaire
ligne commençant par // a2x : alors le reste de la ligne sera traité comme a2x
options de ligne de commande. Par exemple:

// options par défaut a2x.
// a2x : -dbook --epubcheck
// Supprime l'historique des révisions dans les sorties dblatex.
// a2x : --dblatex-opts "-P latex.output.revhistory=0"

· Les options couvrant plusieurs de ces lignes de commentaires seront concaténées.

· Zéro ou plusieurs caractères d'espace blanc peuvent apparaître entre le début // et a2x :.

· Les options de ligne de commande sont prioritaires sur les options définies dans le fichier source.

SORTIE DES DOSSIERS

Les fichiers de sortie sont écrits dans le répertoire spécifié par le --dir-destination option. Sinon
--dir-destination l'option est définie les fichiers de sortie sont écrits dans le FICHIER SOURCE répertoire.

Les fichiers de sortie ont le même nom que le FICHIER SOURCE mais avec un nom de fichier approprié
extension : .html pour xhtml; .epub pour epub; .hhp pour htmlaide; .pdf pour pdf; .texte pour
texte, .xml pour docbook. Par convention, les pages de manuel n'ont pas d'extension .man (section page de manuel
Chiffre seulement). Les noms de répertoire HTML chunked ont une extension .chunked ; Aide HTML fragmentée
les noms de répertoire ont une extension .htmlhelp.

Les fichiers existants de même nom sont écrasés.

En plus de générer des fichiers HTML, le xhtml, epub, chunked et htmlaide les formats garantissent
les fichiers de ressources sont copiés dans leurs emplacements de répertoire de destination corrects.

RESSOURCES

Les ressources sont des fichiers (généralement CSS et images) requis par les sorties HTML
(xhtml, epub, chunked, htmlaide formats). a2x scanne les fichiers HTML générés et construit un
liste des fichiers CSS et image requis. Des fichiers de ressources supplémentaires peuvent être spécifiés
en utilisant explicitement le --Ressource option.

a2x recherche les fichiers de ressources aux emplacements suivants dans l'ordre suivant :

1. le FICHIER SOURCE répertoire.

2. Les répertoires de ressources spécifiés par le --Ressource option (recherchée récursivement).

3. Les répertoires de ressources spécifiés par le --ressource-manifest option (recherchée récursivement
dans l'ordre où ils apparaissent dans le fichier manifeste).

4. Les répertoires d'images de stock et de feuilles de style dans le ascidoc(1) fichiers de configuration
répertoires (recherchés récursivement).

5. Le répertoire de destination.

Lorsqu'un fichier de ressources est trouvé, il est copié dans le répertoire de destination relatif correct.
Les sous-répertoires de destination manquants sont créés automatiquement.

Il existe deux mécanismes distincts pour spécifier des ressources supplémentaires :

1. Un répertoire de ressources qui sera recherché récursivement pour les fichiers de ressources manquants.

2. Un fichier de ressources qui sera copié dans le répertoire de destination de sortie.

Les ressources sont spécifiées avec --Ressource valeurs d'option qui peuvent être l'une des suivantes
formats:


[= ]
. =

Où? :


Spécifie un répertoire (absolu ou relatif au FICHIER SOURCE) qui est recherché
récursivement pour les fichiers de ressources manquants. Pour lever l'ambiguïté, le Nom
doit se terminer par un caractère séparateur de répertoire.


Spécifie un fichier de ressources (absolu ou relatif au FICHIER SOURCE) qui sera
copié sur . Si n'est pas spécifié alors c'est le
même que le .


Spécifie la destination du fichier source copié. Les le chemin est
par rapport au répertoire de destination (les chemins absolus ne sont pas autorisés). L'emplacement
du répertoire de destination dépend de la sortie Format (voir le SORTIE DES DOSSIERS
section pour plus de détails):

fragmenté, htmlhelp
Le répertoire de sortie fragmenté.

epub
Le répertoire OEBPS archivé.

xhtml
La sortie DESTINATION_DIR.

. =
Lors de l'ajout de ressources aux fichiers EPUB, le type MIME est déduit du
file>, si le type MIME ne peut pas être deviné, une erreur se produit. Les
. = La syntaxe de ressource peut être utilisée pour définir explicitement des types MIME. est
l'extension du nom de fichier, est le type MIME correspondant.

Exemples d'options de ressources :

--ressource ../images/
--resource doc/README.txt=README.txt
--Ressource ~/images/tigre.png=images/tigre.png
--resource .ttf=application/x-font-ttf

EXEMPLES

a2x -f pdf doc/source-highlight-filter.txt
Génère le fichier doc/source-highlight-filter.pdf.

a2x -f xhtml -D ../doc --icons -r ../images/ team.txt
Crée un fichier HTML ../doc/team.html, utilise des icônes d'avertissement et recherche récursivement le
../images/ répertoire pour toutes les ressources manquantes.

a2x -f page de manuel doc/asciidoc.1.txt
Générez la page de manuel doc/asciidoc.1.

EXIGENCES

a2x utilise les programmes suivants :

· Asciidox: http://asciidoc.org/

· xsltproc: (tous formats sauf texte) : http://xmlsoft.org/XSLT/

· DocBook XSL Feuilles de style (tous formats sauf texte) :
http://docbook.sourceforge.net/projects/xsl/

· dblatex (formats pdf, dvi, ps, tex) : http://dblatex.sourceforge.net/

· DANDY (format pdf — générateur de fichier PDF alternatif) : http://xmlgraphics.apache.org/fop/

· w3m (format texte) : http://w3m.sourceforge.net/index.en.html

· Lynx (format texte — générateur de fichier texte alternatif) : http://lynx.isc.org/

· vérification de publication (format epub — validateur de fichier EPUB) : http://code.google.com/p/epubcheck/

Voir aussi le dernier fichier README.

CONF DES DOSSIERS

Un fichier de configuration contient du code Python exécutable qui remplace le
paramètres de configuration dans a2x.py. Les fichiers de configuration facultatifs sont chargés dans le
ordre suivant :

1. a2x.conf du répertoire contenant le a2x.py exécutable

2. a2x.conf du répertoire de configuration globale AsciiDoc. Sautez cette étape si nous sommes
l'exécution d'une copie installée localement (non à l'échelle du système).

3. a2x.conf du répertoire de configuration AsciiDoc $HOME/.asciidoc.

4. le CONF_FILE spécifié dans le --conf-fichier option.

Voici les valeurs par défaut des options du fichier de configuration :

# Dictionnaire de variables d'environnement facultatif passé à
# exécuter des programmes. S'il est défini sur Aucun, l'existant
# environnement est utilisé.
ENV = Aucun

# Exécutables externes.
ASCIIDOC = 'asciidoc'
XSLTPROC = 'xsltproc'
DBLATEX = 'dblatex' # génération de pdf.
FOP = 'fop' # génération de pdf (option --fop).
W3M = 'w3m' # génération de texte.
LYNX = 'lynx' # génération de texte (si pas de w3m).
XMLLINT = 'xmllint' # Définir sur '' pour désactiver.
EPUBCHECK = 'epubcheck' # Définir sur '' pour désactiver.
# Options par défaut de l'exécutable externe.
ASCIIDOC_OPTS = ''
DBLATEX_OPTS = ''
FOP_OPTS = ''
XSLTPROC_OPTS = ''

Utilisez a2x en ligne en utilisant les services onworks.net