a2x - Online in der Cloud

PROGRAMM:

NAME/FUNKTION

a2x - Ein Toolchain-Manager für AsciiDoc (konvertiert Asciidoc-Textdateien in eine andere Datei
Formate)

ZUSAMMENFASSUNG

a2x [OPTIONAL] QUELLE_DATEI

BESCHREIBUNG

Ein DocBook-Toolchain-Manager, der eine AsciiDoc-Textdatei übersetzt QUELLE_DATEI zu PDF,
EPUB, DVI, PS, LaTeX, XHTML (einzelne Seite oder aufgeteilt), man-Seite, HTML-Hilfe oder Nur-Text
Formate mit ASCII(1) und andere Anwendungen (siehe Abschnitt VORAUSSETZUNGEN). QUELLE_DATEI kann
auch eine DocBook-Datei mit der Erweiterung .xml sein.

OPTIONAL

-a, --Attribut=ATTRIBUT
Sept ASCII(1) Attributwert (Kürzel für --asciidoc-opts="-ein ATTRIBUT" Möglichkeit).
Diese Option kann mehrmals angegeben werden.

--asciidoc-opts=ASCIIDOC_OPTS
Zusätzliche ASCII(1) Optionen. Diese Option kann mehrmals angegeben werden.

--conf-Datei=CONF_FILE
Konfigurationsdatei laden. Siehe Abschnitt KONF-DATEIEN.

-D, --destination-dir=DESTINATION_DIR
Ausgabe Verzeichnis. Standardmäßig auf QUELLE_DATEI Verzeichnis. Diese Option gilt nur für
HTML-basierte Ausgabeformate (zerkleinert, epub, html-Hilfe, xhtml).

-D, --doctype=DOCTYPE
DocBook-Dokumenttyp: Artikel, Manpage or buchen. Der Standarddokumenttyp ist Artikel
es sei denn, das Format ist Manpage (in diesem Fall ist es standardmäßig Manpage).

-B, - Backend=BACKEND
BACKEND ist der Name eines installierten Backend-Plugins. Wenn diese Option angegeben ist a2x
versucht einen Dateinamen zu laden a2x-backend.py von dem BACKEND Plugin-Verzeichnis Es dann
konvertiert die QUELLE_DATEI zum BACKEND formatierte Ausgabedatei mit einer globalen Funktion
definiert in a2x-backend.py namens an_BACKEND.

-F, --Format=FORMAT
Ausgabeformate: zerkleinert, docbook, Dvi, epub, html-Hilfe, Manpage, pdf (Standard), ps,
tex, Text, xhtml. Das ASCIIDoc a2x-Format Attributwert ist auf . gesetzt FORMAT.

-H, --help
Befehlszeilensyntax und Programmoptionen nach stdout ausgeben.

--Symbole
Verwenden Sie Ermahnungs- oder Navigationssymbolbilder in Ausgabedokumenten. Das Standardverhalten ist
um Text anstelle von Symbolen zu verwenden.

--icons-dir=PATH
Ein Pfad (relativ zu den Ausgabedateien), der Warn- und Navigationssymbole enthält. Standardeinstellungen
zu Bildern/Symbolen. Die --Symbole Option ist implizit, wenn diese Option verwendet wird.

-k, --Keep-Artefakte
Löschen Sie keine temporären Build-Dateien.

--Luchs
Verwenden Sie die Luchs(1) um eine textformatierte Ausgabe zu generieren. Das Standardverhalten ist zu verwenden w3m(1).

-L, --no-xmlint
Überprüfen Sie die ASCII-Ausgabe nicht mit xmlint(1).

---epubcheck
Überprüfen Sie die EPUB-Ausgabe mit epubcheck(1).

-nicht, --Probelauf
Tun Sie nichts, drucken Sie einfach aus, was getan worden wäre.

-R, --Ressource=RESOURCE_SPEC
Geben Sie eine Ressource an. Diese Option kann mehrmals angegeben werden. Siehe die WISSENSDATENBANK
Abschnitt für weitere Details.

-M, --Ressourcenmanifest=FILE
FILE enthält eine Liste von Ressourcen (eine pro Zeile). Manifest FILE Einträge sind formatiert
so wie --Ressource Optionsargumente. Umgebungsvariablen und Tilde-Startseite
Verzeichnisse sind erlaubt.

- Stylesheet=STILBLATT
Eine durch Leerzeichen getrennte Liste mit einem oder mehreren CSS-Stylesheet-Dateinamen, die zum Stylen verwendet werden
Von DocBook XSL Stylesheets generierte HTML-Ausgabe. Standardmäßig auf docbook-xsl.cssdem „Vermischten Geschmack“. Seine
Stylesheets werden in Listenreihenfolge verarbeitet. Die Stylesheets müssen sich in einem gültigen
Speicherort der Ressourcendatei. Gilt für HTML-Formate: xhtml, epub, zerkleinert, html-Hilfe
Formate.

-in, - ausführlich
Drucken Sie die Betriebsdetails auf stderr. Eine Sekunde -v Option wendet die ausführliche Option auf . an
Toolchain-Befehle.

--Version
Programmversion auf stdout drucken.

--xsltproc-opts=XSLTPROC_OPTS
Zusätzliche xsltproc(1) Optionen. Diese Option kann mehrmals angegeben werden.

--xsl-Datei=XSL_DATEI
Überschreiben Sie das integrierte XSL-Stylesheet mit dem benutzerdefinierten XSL-Stylesheet XSL_DATEI.

--Geck
Verwenden Sie FOP, um PDFs zu generieren. Das Standardverhalten ist zu verwenden dblatex(1)dem „Vermischten Geschmack“. Seine --Geck zu erhalten
ist implizit, wenn diese Option verwendet wird.

--fop-opts=FOP_OPTS
Zusätzliche Geck(1) Optionen. Wenn diese Option angegeben ist, wird FOP zum Generieren von PDFs verwendet.
Diese Option kann mehrmals angegeben werden.

--dblatex-opts=DBLATEX_OPTS
Zusätzliche dblatex(1) Optionen. Diese Option kann mehrmals angegeben werden.

--backend-opts=BACKEND_OPTS
Optionen für das Backend-Plugin, das von der - Backend Möglichkeit. Diese Option kann sein
mehr als einmal angegeben.

Optionen können auch in der AsciiDoc-Quelldatei festgelegt werden. Wenn QUELLE_DATEI enthält einen Kommentar
Zeile beginnend mit // a2x: dann wird der Rest der Zeile behandelt als a2x
Befehlszeilenoptionen. Zum Beispiel:

// a2x-Standardoptionen.
// a2x: -dbook --epubcheck
// Revisionsverlauf in dblatex-Ausgaben unterdrücken.
// a2x: --dblatex-opts "-P latex.output.revhistory=0"

· Optionen, die mehrere solcher Kommentarzeilen umfassen, werden verkettet.

· Zwischen den führenden . können null oder mehr Leerzeichen erscheinen // und a2x:.

· Befehlszeilenoptionen haben Vorrang vor den in der Quelldatei festgelegten Optionen.

AUSGABE DATEIEN

Ausgabedateien werden in das Verzeichnis geschrieben, das durch die --destination-dir Möglichkeit. Wenn nein
--destination-dir Option ist gesetzt Ausgabedateien werden in die geschrieben QUELLE_DATEI Verzeichnis.

Ausgabedateien haben denselben Namen wie die QUELLE_DATEI aber mit einem passenden Dateinamen
Erweiterung: .html für xhtml; .epub für epub; .hhp für html-Hilfe; .pdf für pdf; .text für
Text, .xml für docbook. Konventionsgemäß haben Manpages keine .man-Erweiterung (Manpage-Abschnitt
nur Nummer). Chunked HTML-Verzeichnisnamen haben die Erweiterung .chunked; Chunked HTML-Hilfe
Verzeichnisnamen haben die Erweiterung .htmlhelp.

Vorhandene Dateien mit gleichem Namen werden überschrieben.

Neben der Generierung von HTML-Dateien ist die xhtml, epub, zerkleinert und html-Hilfe Formate gewährleisten
Ressourcendateien werden an die richtigen Speicherorte des Zielverzeichnisses kopiert.

WISSENSDATENBANK

Ressourcen sind Dateien (normalerweise CSS und Bilder), die für HTML-basierte Ausgaben erforderlich sind
(xhtml, epub, zerkleinert, html-Hilfe Formate). a2x scannt die generierten HTML-Dateien und erstellt a
Liste der erforderlichen CSS- und Bilddateien. Zusätzliche Ressourcendateien können angegeben werden
explizit mit dem --Ressource .

a2x sucht nach Ressourcendateien an den folgenden Speicherorten in der folgenden Reihenfolge:

1. Das QUELLE_DATEI Verzeichnis.

2. Ressourcenverzeichnisse, die von der --Ressource Option (rekursiv gesucht).

3. Ressourcenverzeichnisse, die von der --Ressourcenmanifest Option (rekursiv gesucht
in der Reihenfolge, in der sie in der Manifestdatei erscheinen).

4. Die Archivbilder- und Stylesheet-Verzeichnisse im ASCII(1) Konfigurationsdateien
Verzeichnisse (rekursiv durchsucht).

5. Das Zielverzeichnis.

Wenn eine Ressourcendatei gefunden wird, wird sie in das richtige relative Zielverzeichnis kopiert.
Fehlende Ziel-Unterverzeichnisse werden automatisch erstellt.

Es gibt zwei verschiedene Mechanismen zum Angeben zusätzlicher Ressourcen:

1. Ein Ressourcenverzeichnis, das rekursiv nach fehlenden Ressourcendateien durchsucht wird.

2. Eine Ressourcendatei, die in das Ausgabezielverzeichnis kopiert wird.

Ressourcen werden mit . angegeben --Ressource Optionswerte, die einer der folgenden sein können
Formate:


[= ]
. =

Wo:


Gibt ein Verzeichnis an (absolut oder relativ zum QUELLE_DATEI) was gesucht wird
rekursiv für fehlende Ressourcendateien. Um Mehrdeutigkeiten zu beseitigen, Name
sollte mit einem Verzeichnistrennzeichen enden.


Gibt eine Ressourcendatei an (absolut oder relativ zur QUELLE_DATEI) was sein wird
kopiert nach . Wenn ist nicht angegeben, dann ist es die
genauso wie die .


Gibt das Ziel der kopierten Quelldatei an. Die Weg ist
relativ zum Zielverzeichnis (absolute Pfade sind nicht erlaubt). Der Standort
des Zielverzeichnisses ist abhängig von der Ausgabe FORMAT (Siehe AUSGABE DATEIEN
Abschnitt für Details):

chunked, htmlhelp
Das unterteilte Ausgabeverzeichnis.

epub
Das archivierte OEBPS-Verzeichnis.

xhtml
Der Ausgang DESTINATION_DIR.

. =
Beim Hinzufügen von Ressourcen zu EPUB-Dateien wird der Mimetyp aus dem
file> extension, wenn der Mimetyp nicht erraten werden kann, tritt ein Fehler auf. Die
. = Ressourcensyntax kann verwendet werden, um Mimetypen explizit festzulegen. ist
die Dateinamenerweiterung, ist der entsprechende MIME-Typ.

Beispiele für Ressourcenoptionen:

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

Beispiele:

a2x -f pdf doc/source-highlight-filter.txt
Erzeugt die Datei doc/source-highlight-filter.pdf.

a2x -f xhtml -D ../doc --icons -r ../images/team.txt
Erstellt eine HTML-Datei ../doc/team.html, verwendet Ermahnungssymbole und durchsucht rekursiv die
../images/ Verzeichnis für fehlende Ressourcen.

a2x -f Manpage doc/asciidoc.1.txt
Generieren Sie die Manpage doc/asciidoc.1.

VORAUSSETZUNGEN

a2x verwendet folgende Programme:

· Asciidoc: http://asciidoc.org/

· xsltproc: (alle Formate außer Text): http://xmlsoft.org/XSLT/

· DocBook XSL Stylesheets (alle Formate außer Text):
http://docbook.sourceforge.net/projects/xsl/

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

· FOP (pdf-Format – alternativer PDF-Dateigenerator): http://xmlgraphics.apache.org/fop/

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

· Luchs (Textformat – alternativer Textdateigenerator): http://lynx.isc.org/

· epubcheck (epub-Format – EPUB-Dateivalidator): http://code.google.com/p/epubcheck/

Siehe auch die neueste README-Datei.

CONF DATEIEN

Eine Konfigurationsdatei enthält ausführbaren Python-Code, der die globalen
Konfigurationsparameter in a2x.py. Optionale Konfigurationsdateien werden im . geladen
folgende Reihenfolge:

1. a2x.conf aus dem Verzeichnis mit den a2x.py ausführbar.

2. a2x.conf aus dem globalen Konfigurationsverzeichnis von AsciiDoc. Überspringe diesen Schritt, wenn wir es sind
Ausführen einer lokal installierten (nicht systemweiten) Kopie.

3. a2x.conf aus dem Konfigurationsverzeichnis von AsciiDoc $HOME/.asciidoc.

4. Das CONF_FILE angegeben in der --conf-Datei .

Hier sind die Standardwerte der Konfigurationsdateioptionen:

# Optionales Umgebungsvariablen-Wörterbuch übergeben an
# Programme ausführen. Wenn auf Keine gesetzt, wird das vorhandene
# Umgebung wird verwendet.
ENV = Keine

# Externe ausführbare Dateien.
ASCIIDOC = 'asciidoc'
XSLTPROC = 'xsltproc'
DBLATEX = 'dblatex' # pdf-Generierung.
FOP = 'fop' # PDF-Generierung (Option --fop).
W3M = 'w3m' # Textgenerierung.
LYNX = 'lynx' # Textgenerierung (wenn kein w3m).
XMLLINT = 'xmllint' # Zum Deaktivieren auf '' setzen.
EPUBCHECK = 'epubcheck' # Zum Deaktivieren auf '' setzen.
# Standardoptionen für externe ausführbare Dateien.
ASCIIDOC_OPTS = ''
DBLATEX_OPTS = ''
FOP_OPTS = ''
XSLTPROC_OPTS = ''

a2x online mit den onworks.net-Diensten nutzen