a2x - Online in de cloud

PROGRAMMA:

NAAM

a2x - Een toolchain-manager voor AsciiDoc (converteert Asciidoc-tekstbestanden naar een ander bestand)
formaten)

KORTE INHOUD

a2x [OPTIES] BRON BESTAND

PRODUCTBESCHRIJVING

Een DocBook toolchain manager die een AsciiDoc tekstbestand vertaalt BRON BESTAND naar pdf,
EPUB, DVI, PS, LaTeX, XHTML (enkele pagina of chunked), man-pagina, HTML Help of platte tekst
formaten met behulp van asciidoc(1) en andere toepassingen (zie sectie VEREISTEN). BRON BESTAND wel
ook een DocBook-bestand zijn met de extensie .xml.

OPTIES

-een, --attribuut=ATTRIBUUT
Zet de asciidoc(1) attribuutwaarde (snelkoppeling voor --asciidoc-opteert="-een ATTRIBUUT" keuze).
Deze optie kan meerdere keren worden opgegeven.

--asciidoc-opteert=ASCIIDOC_OPTS
Extra asciidoc(1) opties. Deze optie kan meerdere keren worden opgegeven.

--conf-bestand=CONF_FILE
Configuratiebestand laden. Zie het gedeelte CONF-BESTANDEN.

-NS, --bestemmingsmap=DESTINATION_DIR
Uitvoermap. Standaard ingesteld op BRON BESTAND map. Deze optie is alleen van toepassing op:
Op HTML gebaseerde uitvoerformaten (in stukken gesneden, epub, htmlhelp, xhtml).

-NS, --doctype=DOCTYPE
DocBook-documenttype: dit artikel, manpagina or boek. Standaard documenttype is dit artikel
tenzij het formaat is manpagina (in dat geval staat het standaard op manpagina).

-B, --achterkant=ACHTERKANT
ACHTERKANT is de naam van een geïnstalleerde backend-plug-in. Wanneer deze optie is opgegeven a2x
pogingen om een ​​bestandsnaam te laden a2x-backend.py van het ACHTERKANT plugin directory Het dan
converteert de BRON BESTAND een ACHTERKANT geformatteerd uitvoerbestand met een globale functie
gedefinieerd in a2x-backend.py Dit betekent dat we onszelf en onze geliefden praktisch vergiftigen. naar_BACKEND.

-F, --formaat=FORMAT
Uitvoerformaten: in stukken gesneden, documentenboek, dvi, epub, htmlhelp, manpagina, pdf (Standaard) ps,
tex, tekst, xhtml. De AsciiDoc a2x-formaat attribuutwaarde is ingesteld op FORMAT.

-H, --help
Print opdrachtregelsyntaxis en programma-opties naar stdout.

--iconen
Gebruik waarschuwings- of navigatiepictogramafbeeldingen in uitvoerdocumenten. Het standaardgedrag is
om tekst te gebruiken in plaats van pictogrammen.

--iconen-dir=PATH
Een pad (ten opzichte van uitvoerbestanden) met waarschuwings- en navigatiepictogrammen. Standaardinstellingen
naar afbeeldingen/pictogrammen. De --iconen optie is impliciet als deze optie wordt gebruikt.

-k, --keep-artefacten
Verwijder geen tijdelijke buildbestanden.

--lynx
Te gebruiken lynx(1) om tekst opgemaakte uitvoer te genereren. Het standaardgedrag is om w3m(1).

-L, --geen-xmllint
Controleer asciidoc-uitvoer niet met xmllint(1).

---epubcheck
Controleer de EPUB-uitvoer met epubcheck(1).

-N, --oefening
Doe niets, print gewoon wat er zou zijn gedaan.

-R, --bron=RESOURCE_SPEC
Geef een bron op. Deze optie kan meerdere keren worden opgegeven. Zie de KENNISDATABASE
sectie voor meer details.

-M, --resource-manifest=FILE
FILE bevat een lijst met bronnen (één per regel). Manifest FILE inzendingen zijn opgemaakt
net als --bron optie argumenten. Omgevingsvariabelen en tilde home
mappen zijn toegestaan.

--stijlblad=STIJLBLAD
Een door spaties gescheiden lijst van een of meer CSS-stijlbladbestandsnamen die worden gebruikt om op te maken
HTML-uitvoer gegenereerd door DocBook XSL Stylesheets. Standaard ingesteld op docbook-xsl.css. De
stylesheets worden in lijstvolgorde verwerkt. De stylesheets moeten in een geldig
locatie van het bronbestand. Geldt voor HTML-indelingen: xhtml, epub, in stukken gesneden, htmlhelp
formaten.

-in, --uitgebreid
Druk operationele details af naar stderr. Een seconde -v optie past de uitgebreide optie toe op
toolchain commando's.

--versie
Print de programmaversie naar stdout.

--xsltproc-opts=XSLTPROC_OPTS
Extra xsltproc(1) opties. Deze optie kan meerdere keren worden opgegeven.

--xsl-bestand=XSL_FILE
Overschrijf de ingebouwde XSL-stylesheet met de aangepaste XSL-stylesheet XSL_FILE.

--modegek
Gebruik FOP om PDF's te genereren. Het standaardgedrag is om dblatex(1). De --modegek optie
is impliciet als deze optie wordt gebruikt.

--fop-opteert=FOP_OPTS
Extra modegek(1) opties. Als deze optie is opgegeven, wordt FOP gebruikt om PDF's te genereren.
Deze optie kan meerdere keren worden opgegeven.

--dblatex-opt=DBLATEX_OPTS
Extra dblatex(1) opties. Deze optie kan meerdere keren worden opgegeven.

--backend-opteert=BACKEND_OPTS
Opties voor de backend-plug-in gespecificeerd door de --achterkant optie. Deze optie kan zijn:
meer dan eens opgegeven.

Opties kunnen ook worden ingesteld in het AsciiDoc-bronbestand. Indien BRON BESTAND bevat een opmerking
regel die begint met // a2x: dan wordt de rest van de regel behandeld als a2x
opdrachtregelopties. Bijvoorbeeld:

// a2x standaardopties.
// a2x: -dbook --epubcheck
// Onderdruk revisiegeschiedenis in dblatex-uitgangen.
// a2x: --dblatex-opts "-P latex.output.revhistory=0"

· Opties die meerdere van dergelijke commentaarregels overspannen, worden aaneengeschakeld.

· Er kunnen nul of meer witruimtetekens verschijnen tussen de voorloop // en a2x:.

· Opdrachtregelopties hebben voorrang op opties die in het bronbestand zijn ingesteld.

OUTPUT FILES

Uitvoerbestanden worden geschreven naar de map die is opgegeven door de --bestemmingsmap optie. Als Nee
--bestemmingsmap optie is ingesteld uitvoerbestanden worden weggeschreven naar de BRON BESTAND directory.

Uitvoerbestanden hebben dezelfde naam als de BRON BESTAND maar met een geschikte bestandsnaam
extensie: .html voor xhtml; .epub voor epub; .hhp voor htmlhelp; .pdf voor pdf; .tekst voor
tekst, .xml voor documentenboek. Volgens afspraak hebben manpages geen .man-extensie (manpaginasectie)
alleen nummer). Chunked HTML-directorynamen hebben de extensie .chunked; hulp in stukjes HTML
directorynamen hebben de extensie .htmlhelp.

Bestaande bestanden met dezelfde naam worden overschreven.

Naast het genereren van HTML-bestanden, xhtml, epub, in stukken gesneden en htmlhelp formaten zorgen voor
bronbestanden worden gekopieerd naar de juiste bestemmingsmaplocaties.

KENNISDATABASE

Bronnen zijn bestanden (meestal CSS en afbeeldingen) die vereist zijn voor op HTML gebaseerde uitvoer
(xhtml, epub, in stukken gesneden, htmlhelp formaten). a2x scant de gegenereerde HTML-bestanden en bouwt een
lijst met vereiste CSS- en afbeeldingsbestanden. Extra bronbestanden kunnen worden opgegeven
expliciet met behulp van de --bron optie.

a2x zoekt naar bronbestanden op de volgende locaties in de volgende volgorde:

1. De BRON BESTAND directory.

2. Resource-directories gespecificeerd door de --bron optie (recursief gezocht).

3. Resource-directories gespecificeerd door de --resource-manifest optie (recursief gezocht)
in de volgorde waarin ze in het manifestbestand staan).

4. De stock afbeeldingen en stylesheets directories in de asciidoc(1) configuratiebestanden
mappen (recursief gezocht).

5. De doelmap.

Wanneer een bronbestand wordt gevonden, wordt het gekopieerd naar de juiste relatieve doelmap.
Ontbrekende bestemmingssubmappen worden automatisch aangemaakt.

Er zijn twee verschillende mechanismen voor het specificeren van aanvullende bronnen:

1. Een bronnenmap die recursief wordt doorzocht op ontbrekende bronbestanden.

2. Een bronbestand dat naar de uitvoerbestemmingsmap wordt gekopieerd.

Bronnen worden gespecificeerd met --bron optiewaarden die een van de volgende kunnen zijn:
formaten:


[= ]
. =

Waar:


Specificeert een directory (absoluut of relatief aan de BRON BESTAND) waarnaar wordt gezocht
recursief voor ontbrekende bronbestanden. Om onduidelijkheid weg te nemen, naam
moet eindigen met een directoryscheidingsteken.


Specificeert een bronbestand (absoluut of relatief aan de BRON BESTAND) wat zal zijn
gekopieerd naar . Indien is niet gespecificeerd, dan is het de
hetzelfde als de .


Specificeert de bestemming van het gekopieerde bronbestand. De pad is
ten opzichte van de doelmap (absolute paden zijn niet toegestaan). De locatie
van de doelmap is afhankelijk van de uitvoer FORMAT (Zie de OUTPUT FILES
sectie voor details):

chunked, htmlhelp
De gesegmenteerde uitvoermap.

epub
De gearchiveerde OEBPS-directory.

xhtml
De uitgang DESTINATION_DIR.

. =
Bij het toevoegen van bronnen aan EPUB-bestanden wordt het mimetype afgeleid uit de
file> extensie, als het mimetype niet kan worden geraden, treedt er een fout op. De
. = resource syntax kan worden gebruikt om mimetypes expliciet in te stellen. is
de bestandsnaamextensie, is het corresponderende MIME-type.

Voorbeelden van resourceopties:

--bron ../afbeeldingen/
--resource doc/README.txt=README.txt
--bron ~/images/tijger.png=afbeeldingen/tijger.png
--resource .ttf=applicatie/x-font-ttf

Voorbeelden

a2x -f pdf doc/bron-highlight-filter.txt
Genereert doc/source-highlight-filter.pdf-bestand.

a2x -f xhtml -D ../doc --icons -r ../images/team.txt
Maakt HTML-bestand ../doc/team.html, gebruikt waarschuwingspictogrammen en zoekt recursief de
../images/ directory voor ontbrekende bronnen.

a2x -f manpagina doc/asciidoc.1.txt
Genereer doc/asciidoc.1 manpage.

VEREISTEN

a2x gebruikt de volgende programma's:

· Asciidoc: http://asciidoc.org/

· xsltproc: (alle formaten behalve tekst): http://xmlsoft.org/XSLT/

· DocBook XSL Stijlbladen (alle formaten behalve tekst):
http://docbook.sourceforge.net/projects/xsl/

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

· MODEGEK (pdf-formaat — alternatieve PDF-bestandsgenerator): http://xmlgraphics.apache.org/fop/

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

· Lynx (tekstformaat — generator voor alternatieve tekstbestanden): http://lynx.isc.org/

· epubcheck (epub-formaat — EPUB-bestandsvalidator): http://code.google.com/p/epubcheck/

Zie ook het laatste README-bestand.

CONF FILES

Een configuratiebestand bevat uitvoerbare Python-code die de globale
configuratieparameters in a2x.py. Optionele configuratiebestanden worden geladen in de
volgorde:

1. a2x.conf uit de map met de a2x.py uitvoerbaar.

2. a2x.conf uit de globale configuratiemap van AsciiDoc. Sla deze stap over als we dat zijn
het uitvoeren van een lokaal geïnstalleerde (niet-systeembrede) kopie.

3. a2x.conf uit de AsciiDoc $HOME/.asciidoc configuratiemap.

4. De CONF_FILE gespecificeerd in de --conf-bestand optie.

Dit zijn de standaardwaarden voor de configuratiebestandsopties:

# Optioneel woordenboek met omgevingsvariabelen doorgegeven aan
# programma's uitvoeren. Indien ingesteld op Geen de bestaande
# omgeving wordt gebruikt.
ENV = Geen

# Externe uitvoerbare bestanden.
ASCIIDOC = 'asciidoc'
XSLTPROC = 'xsltproc'
DBLATEX = 'dblatex' # pdf-generatie.
FOP = 'fop' # pdf generatie (--fop optie).
W3M = 'w3m' # tekstgeneratie.
LYNX = 'lynx' # tekstgeneratie (indien geen w3m).
XMLLINT = 'xmllint' # Zet op '' om uit te schakelen.
EPUBCHECK = 'epubcheck' # Zet op '' om uit te schakelen.
# Externe uitvoerbare standaardopties.
ASCIIDOC_OPTS = ''
DBLATEX_OPTS = ''
FOP_OPTS = ''
XSLTPROC_OPTS = ''

Gebruik a2x online met onworks.net-services