a2x - Online di Cloud

PROGRAM:

NAMA

a2x - Manajer toolchain untuk AsciiDoc (mengonversi file teks Asciidoc ke file lain
format)

RINGKASAN

a2x [PILIHAN] SUMBER DATA

DESKRIPSI

Manajer rantai alat DocBook yang menerjemahkan file teks AsciiDoc SUMBER DATA ke PDF,
EPUB, DVI, PS, LaTeX, XHTML (satu halaman atau potongan), halaman manual, Bantuan HTML atau teks biasa
format menggunakan asciido(1) dan aplikasi lainnya (lihat bagian PERSYARATAN). SUMBER DATA bisa
juga menjadi file DocBook dengan ekstensi .xml.

PILIHAN

-Sebuah, --atribut=ATRIBUT
set asciido(1) nilai atribut (pintasan untuk --asciidoc-opts="-A ATRIBUT" pilihan).
Opsi ini dapat ditentukan lebih dari sekali.

--asciidoc-opts=ASCIIDOC_OPTS
Tambahan asciido(1) pilihan. Opsi ini dapat ditentukan lebih dari sekali.

--conf-file=CONF_FILE
Muat file konfigurasi. Lihat bagian CONF FILES.

-D, --tujuan-dir=DESTINATION_DIR
Direktori keluaran. Default untuk SUMBER DATA direktori. Opsi ini hanya berlaku untuk
Format keluaran berbasis HTML (terpotong, epub, htmlbantuan, xhtml).

-D, --tipe dokumen=DOCTYPE
Jenis dokumen DocBook: artikel, halaman manual or Book. Jenis dokumen default adalah artikel
kecuali formatnya halaman manual (dalam hal ini defaultnya adalah halaman manual).

-B, --belakang=BELAKANG
BELAKANG adalah nama plugin backend yang diinstal. Ketika opsi ini ditentukan a2x
mencoba memuat nama file a2x-backend.py dari BELAKANG direktori plugin Kemudian
mengkonversi SUMBER DATA ke BELAKANG file output yang diformat menggunakan fungsi global
didefinisikan dalam a2x-backend.py bernama ke_BACKEND.

-F, --format=FORMAT
Format keluaran: terpotong, buku dokumen, Dvi, epub, htmlbantuan, halaman manual, pdf (Default), ps,
tex, teks, xhtml. AsciiDoc format a2x nilai atribut diatur ke FORMAT.

-H, --membantu
Cetak sintaks baris perintah dan opsi program ke stdout.

--ikon
Gunakan gambar ikon peringatan atau navigasi dalam dokumen keluaran. Perilaku default adalah
untuk menggunakan teks sebagai pengganti ikon.

--ikon-dir=PATH
Jalur (relatif terhadap file keluaran) yang berisi ikon peringatan dan navigasi. Default
untuk gambar/ikon. NS --ikon opsi tersirat jika opsi ini digunakan.

-k, --keep-artefak
Jangan hapus file build sementara.

--lynx
penggunaan lynx(1) untuk menghasilkan output berformat teks. Perilaku default adalah menggunakan w3m(1).

-L, --tidak-xmllint
Jangan periksa keluaran asciidoc dengan xmlint(1).

---epubcek
Periksa keluaran EPUB dengan periksa epub(1).

-N, --lari-kering
Jangan melakukan apa-apa hanya mencetak apa yang akan dilakukan.

-R, --sumber=SUMBERDAYA_SPEC
Tentukan sumber daya. Opsi ini dapat ditentukan lebih dari sekali. Lihat SUMBER DAYA
bagian untuk lebih jelasnya.

-M, --sumber-manifest=FILE
FILE berisi daftar sumber daya (satu per baris). Tampak FILE entri diformat
seperti --sumber argumen opsi. Variabel lingkungan dan tilde rumah
direktori diperbolehkan.

--lembar gaya=LEMBAR GAYA
Daftar yang dipisahkan spasi dari satu atau lebih nama file stylesheet CSS yang digunakan untuk menata
Output HTML yang dihasilkan oleh DocBook XSL Stylesheets. Default untuk docbook-xsl.css. itu
stylesheet diproses dalam urutan daftar. Stylesheet harus berada di tempat yang valid
lokasi file sumber daya. Berlaku untuk format HTML: xhtml, epub, terpotong, htmlbantuan
format.

-di, --bertele-tele
Cetak detail operasional ke stderr. Sebentar -v opsi menerapkan opsi verbose untuk
perintah rantai alat.

--Versi: kapan
Cetak versi program ke stdout.

--xsltproc-opts=XSLTPROC_OPTS
Tambahan xsltproc(1) pilihan. Opsi ini dapat ditentukan lebih dari sekali.

--xsl-file=XSL_FILE
Ganti lembar gaya XSL bawaan dengan lembar gaya XSL khusus XSL_FILE.

--pesolek
Gunakan FOP untuk menghasilkan PDF. Perilaku default adalah menggunakan dblatex(1). itu --pesolek Option
implisit jika opsi ini digunakan.

--fop-opts=FOP_OPTS
Tambahan pesolek(1) pilihan. Jika opsi ini ditentukan, FOP digunakan untuk menghasilkan PDF.
Opsi ini dapat ditentukan lebih dari sekali.

--dblatex-opts=DBLATEX_OPTS
Tambahan dblatex(1) pilihan. Opsi ini dapat ditentukan lebih dari sekali.

--backend-opts=KEMBALIEND_OPTS
Opsi untuk plugin backend ditentukan oleh --belakang pilihan. Opsi ini mungkin
ditentukan lebih dari satu kali.

Opsi juga dapat diatur dalam file sumber AsciiDoc. Jika SUMBER DATA berisi komentar
baris yang dimulai dengan // a2x: maka sisa baris akan diperlakukan sebagai a2x
opsi baris perintah. Sebagai contoh:

// opsi default a2x.
// a2x: -dbook --epubcheck
// Menekan riwayat revisi pada keluaran dblatex.
// a2x: --dblatex-opts "-P latex.output.revhistory=0"

· Opsi yang mencakup beberapa baris komentar seperti itu akan digabungkan.

· Nol atau lebih karakter spasi putih dapat muncul di antara yang utama // dan a2x:.

· Opsi baris perintah lebih diutamakan daripada opsi yang diatur dalam file sumber.

KELUARAN FILE

File output ditulis ke direktori yang ditentukan oleh --tujuan-dir pilihan. Jika tidak
--tujuan-dir opsi diatur file output ditulis ke SUMBER DATA direktori.

File keluaran memiliki nama yang sama dengan SUMBER DATA tetapi dengan nama file yang sesuai
ekstensi: .html untuk xhtml; .epub untuk epub; .hhp untuk htmlbantuan; .pdf untuk pdf; .teks untuk
teks, .xml untuk buku dokumen. Menurut konvensi, halaman manual tidak memiliki ekstensi .man (bagian halaman manual
nomor saja). Nama direktori HTML yang dipotong memiliki ekstensi .chunked; Bantuan HTML terpotong
nama direktori memiliki ekstensi bantuan .html.

File yang ada dengan nama yang sama ditimpa.

Selain menghasilkan file HTML, xhtml, epub, terpotong dan htmlbantuan format memastikan
file sumber daya disalin ke lokasi direktori tujuan yang benar.

SUMBER DAYA

Sumber daya adalah file (biasanya CSS dan gambar) yang diperlukan oleh keluaran berbasis HTML
(xhtml, epub, terpotong, htmlbantuan format). a2x memindai file HTML yang dihasilkan dan membangun a
daftar file CSS dan gambar yang diperlukan. File sumber daya tambahan dapat ditentukan
secara eksplisit menggunakan --sumber .

a2x mencari file sumber daya di lokasi berikut dalam urutan berikut:

1. Itu SUMBER DATA direktori.

2. Direktori sumber daya yang ditentukan oleh --sumber opsi (dicari secara rekursif).

3. Direktori sumber daya yang ditentukan oleh --sumber-manifest opsi (dicari secara rekursif
dalam urutan mereka muncul di file manifes).

4. Gambar stok dan direktori stylesheet di asciido(1) file konfigurasi
direktori (dicari secara rekursif).

5. Direktori tujuan.

Ketika file sumber daya ditemukan, file tersebut disalin ke direktori tujuan relatif yang benar.
Subdirektori tujuan yang hilang dibuat secara otomatis.

Ada dua mekanisme berbeda untuk menentukan sumber daya tambahan:

1. Direktori sumber daya yang akan dicari secara rekursif untuk file sumber daya yang hilang.

2. File sumber daya yang akan disalin ke direktori tujuan keluaran.

Sumber daya ditentukan dengan --sumber nilai opsi yang dapat berupa salah satu dari berikut
format:


[= ]
. =

Dimana:


Menentukan direktori (mutlak atau relatif terhadap SUMBER DATA) yang dicari
secara rekursif untuk file sumber daya yang hilang. Untuk menghilangkan ambiguitas, nama
harus diakhiri dengan karakter pemisah direktori.


Menentukan file sumber daya (mutlak atau relatif terhadap SUMBER DATA) yang mana yang akan
disalin ke . Jika tidak ditentukan maka itu adalah
sama dengan .


Menentukan tujuan file sumber yang disalin. NS jalan adalah
relatif terhadap direktori tujuan (jalur absolut tidak diperbolehkan). Lokasinya
dari direktori tujuan tergantung pada output FORMAT (Lihat KELUARAN FILE
bagian untuk rincian):

terpotong, htmlhelp
Direktori keluaran yang dipotong.

epub
Direktori OEBPS yang diarsipkan.

xhtml
Hasil DESTINATION_DIR.

. =
Saat menambahkan sumber daya ke file EPUB, tipe mime disimpulkan dari
file> ekstensi, jika mimetype tidak dapat ditebak terjadi kesalahan. NS
. = sintaks sumber daya dapat digunakan untuk secara eksplisit mengatur mimetypes. adalah
ekstensi nama file, adalah tipe MIME yang sesuai.

Contoh opsi sumber daya:

--sumber daya ../gambar/
--sumber daya dok/README.txt=README.txt
--sumber ~/gambar/harimau.png=gambar/harimau.png
--sumber daya .ttf=application/x-font-ttf

CONTOH

a2x -f pdf doc/source-highlight-filter.txt
Menghasilkan file doc/source-highlight-filter.pdf.

a2x -f xhtml -D ../doc --ikon -r ../gambar/ tim.txt
Membuat file HTML ../doc/team.html, menggunakan ikon peringatan dan menelusuri secara rekursif
../images/ direktori untuk sumber daya yang hilang.

a2x -f halaman manual doc/asciidoc.1.txt
Buat halaman manual doc/asciidoc.1.

PERSYARATAN

a2x menggunakan program-program berikut:

· asciido: http://asciidoc.org/

· xsltproc: (semua format kecuali teks): http://xmlsoft.org/XSLT/

· DocBook XSL lembar gaya (semua format kecuali teks):
http://docbook.sourceforge.net/projects/xsl/

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

· PESOLEK (format pdf — generator file PDF alternatif): http://xmlgraphics.apache.org/fop/

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

· lynx (format teks — pembuat file teks alternatif): http://lynx.isc.org/

· periksa epub (format epub — validator file EPUB): http://code.google.com/p/epubcheck/

Lihat juga file README terbaru.

KONF FILE

File konfigurasi berisi kode Python yang dapat dieksekusi yang menimpa global
parameter konfigurasi di a2x.py. File konfigurasi opsional dimuat di
urutan berikut:

1. a2x.conf dari direktori yang berisi a2x.py dapat dieksekusi.

2. a2x.conf dari direktori konfigurasi global AsciiDoc. Lewati langkah ini jika kita
mengeksekusi salinan yang diinstal secara lokal (non-sistem luas).

3. a2x.conf dari direktori konfigurasi AsciiDoc $HOME/.asciidoc.

4. Itu CONF_FILE ditentukan dalam --conf-file .

Berikut adalah nilai opsi file konfigurasi default:

# Kamus variabel lingkungan opsional diteruskan ke
# menjalankan program. Jika disetel ke Tidak ada yang ada
# lingkungan digunakan.
ENV = Tidak ada

# Eksekusi eksternal.
ASCIIDOC = 'asciidoc'
XSLTPROC = 'xsltproc'
DBLATEX = 'dblatex' # pembuatan pdf.
FOP = 'fop' # generasi pdf (--fop opsi).
W3M = 'w3m' # pembuatan teks.
LYNX = 'lynx' # pembuatan teks (jika tidak ada w3m).
XMLLINT = 'xmllint' # Setel ke '' untuk menonaktifkan.
EPUBCHECK = 'epubcheck' # Setel ke '' untuk menonaktifkan.
# Opsi default eksternal yang dapat dieksekusi.
ASCIIDOC_OPTS = ''
DBLATEX_OPTS = ''
FOP_OPTS = ''
XSLTPROC_OPTS = ''

Gunakan a2x online menggunakan layanan onworks.net