a2x - Trực tuyến trên đám mây

CHƯƠNG TRÌNH:

TÊN

a2x - Trình quản lý chuỗi công cụ cho AsciiDoc (chuyển đổi tệp văn bản Asciidoc sang tệp khác
định dạng)

SYNOPSIS

a2x [LỰA CHỌN] NGUỒN_FILE

MÔ TẢ

Trình quản lý chuỗi công cụ DocBook dịch tệp văn bản AsciiDoc NGUỒN_FILE sang PDF,
EPUB, DVI, PS, LaTeX, XHTML (một trang hoặc phân đoạn), trang người, Trợ giúp HTML hoặc văn bản thuần túy
định dạng sử dụng asciidoc(1) và các ứng dụng khác (xem phần YÊU CẦU). NGUỒN_FILE có thể
cũng là một tệp DocBook có phần mở rộng .xml.

LỰA CHỌN

-một, --thuộc tính=THUỘC TÍNH
Thiết lập asciidoc(1) giá trị thuộc tính (phím tắt cho --asciidoc-opt="-Một THUỘC TÍNH" Tùy chọn).
Tùy chọn này có thể được chỉ định nhiều lần.

--asciidoc-opt=ASCIIDOC_OPTS
thêm vào asciidoc(1) tùy chọn. Tùy chọn này có thể được chỉ định nhiều lần.

--conf-tệp=CONF_FILE
Tải tệp cấu hình. Xem phần CONF FILES.

-NS, --destination-dir=DESTINATION_DIR
Thư mục đầu ra. Mặc định là NGUỒN_FILE danh mục. Tùy chọn này chỉ áp dụng cho
Các định dạng đầu ra dựa trên HTML (phân khúc, epub, htmltrợ giúp, xhtml).

-NS, --doctype=DOCTYPE
Loại tài liệu DocBook: bài viết , trang chủ or cuốn sách. Loại tài liệu mặc định là bài viết
trừ khi định dạng là trang chủ (trong trường hợp đó nó mặc định là trang chủ).

-NS, --phụ trợ=QUAY LẠI
QUAY LẠI là tên của một plugin phụ trợ đã được cài đặt. Khi tùy chọn này được chỉ định a2x
cố gắng tải một tên tệp a2x-backend.py từ QUAY LẠI thư mục plugin Nó sau đó
chuyển đổi NGUỒN_FILE đến một QUAY LẠI tệp đầu ra được định dạng bằng cách sử dụng một hàm toàn cầu
được định nghĩa trong a2x-backend.py gọi là tới_BACKEND.

-NS, --định dạng=FORMAT
Định dạng đầu ra: phân khúc, sách giáo khoa, dvi, epub, htmltrợ giúp, trang chủ, pdf (Mặc định), ps,
tex, văn bản, xhtml. AsciiDoc định dạng a2x giá trị thuộc tính được đặt thành FORMAT.

-NS, --Cứu giúp
In cú pháp dòng lệnh và các tùy chọn chương trình ra stdout.

--biểu tượng
Sử dụng lời khuyên hoặc hình ảnh biểu tượng điều hướng trong tài liệu đầu ra. Hành vi mặc định là
để sử dụng văn bản thay cho các biểu tượng.

--icons-dir=PATH
Một đường dẫn (liên quan đến các tệp đầu ra) có chứa các biểu tượng lời khuyên và điều hướng. Mặc định
sang hình ảnh / biểu tượng. Các --biểu tượng tùy chọn ẩn nếu tùy chọn này được sử dụng.

-k, - lưu giữ hiện vật
Không xóa các tệp xây dựng tạm thời.

--Linh miêu
Sử dụng Linh miêu(1) để tạo đầu ra có định dạng văn bản. Hành vi mặc định là sử dụng w3m(1).

-L, --no-xmlint
Không kiểm tra đầu ra asciidoc với xmllint(1).

--- epubcheck
Kiểm tra đầu ra EPUB với kiểm tra epub(1).

-N, - chạy thử
Đừng làm bất cứ điều gì chỉ in những gì sẽ được thực hiện.

-NS, --nguồn=TÀI NGUYÊN_SPEC
Chỉ định một tài nguyên. Tùy chọn này có thể được chỉ định nhiều lần. Xem TÀI NGUYÊN
để biết thêm chi tiết.

-NS, - nguồn-tệp kê khai=FILE
FILE chứa một danh sách tài nguyên (một tài nguyên trên một dòng). Rõ ràng FILE mục nhập được định dạng
giống như --nguồn đối số tùy chọn. Biến môi trường và dấu ngã nhà
thư mục được cho phép.

- bảng tính=KIỂU DÁNG
Danh sách được phân tách bằng dấu cách gồm một hoặc nhiều tên tệp biểu định kiểu CSS được sử dụng để tạo kiểu
Đầu ra HTML được tạo bởi DocBook XSL Stylesheets. Mặc định là docbook-xsl.css. Các
bảng định kiểu được xử lý theo thứ tự danh sách. Các bảng định kiểu phải nằm trong một
vị trí tệp tài nguyên. Áp dụng cho các định dạng HTML: xhtml, epub, phân khúc, htmltrợ giúp
định dạng.

-v, --dài dòng
In chi tiết hoạt động sang stderr. Một giây -v tùy chọn áp dụng tùy chọn dài dòng cho
các lệnh chuỗi công cụ.

--phiên bản
In phiên bản chương trình ra stdout.

--xsltproc-opts=XSLTPROC_OPTS
thêm vào xsltproc(1) tùy chọn. Tùy chọn này có thể được chỉ định nhiều lần.

--xsl-tệp=XSL_FILE
Ghi đè biểu định kiểu XSL tích hợp sẵn bằng biểu định kiểu XSL tùy chỉnh XSL_FILE.

--fop
Sử dụng FOP để tạo tệp PDF. Hành vi mặc định là sử dụng dblatex(1). Các --fop tùy chọn
là ngầm định nếu tùy chọn này được sử dụng.

--fop-opts=FOP_OPTS
thêm vào fop(1) tùy chọn. Nếu tùy chọn này được chỉ định, FOP được sử dụng để tạo các tệp PDF.
Tùy chọn này có thể được chỉ định nhiều lần.

--dblatex-opts=DBLATEX_OPTS
thêm vào dblatex(1) tùy chọn. Tùy chọn này có thể được chỉ định nhiều lần.

--backend-opt=QUAY LẠIEND_OPTS
Các tùy chọn cho plugin phụ trợ được chỉ định bởi --phụ trợ Lựa chọn. Tùy chọn này có thể là
được chỉ định nhiều hơn một lần.

Các tùy chọn cũng có thể được đặt trong tệp nguồn AsciiDoc. Nếu như NGUỒN_FILE chứa một bình luận
dòng bắt đầu bằng // a2x: thì phần còn lại của dòng sẽ được coi là a2x
các tùy chọn dòng lệnh. Ví dụ:

// tùy chọn mặc định a2x.
// a2x: -dbook --epubcheck
// Loại bỏ lịch sử sửa đổi trong đầu ra dblatex.
// a2x: --dblatex-opts "-P latex.output.revhistory = 0"

· Các tùy chọn kéo dài nhiều dòng bình luận như vậy sẽ được nối với nhau.

· Không hoặc nhiều ký tự khoảng trắng có thể xuất hiện giữa đầu // và a2x:.

· Các tùy chọn dòng lệnh được ưu tiên hơn các tùy chọn được thiết lập trong tệp nguồn.

OUTPUT CÁC TẬP TIN

Các tệp đầu ra được ghi vào thư mục được chỉ định bởi --destination-dir Lựa chọn. Nếu không
--destination-dir tùy chọn được thiết lập các tệp đầu ra được ghi vào NGUỒN_FILE thư mục.

Các tệp đầu ra có cùng tên với NGUỒN_FILE nhưng với một tên tệp thích hợp
extension: .html cho xhtml; .epub cho epub; .hp cho htmltrợ giúp; .pdf cho pdf; .text cho
văn bản, .xml cho sách giáo khoa. Theo quy ước, các trang chủ không có phần mở rộng .man (phần trang người đàn ông
số chỉ). Các tên thư mục HTML được phân tách có phần mở rộng .chunked; Trợ giúp HTML phân đoạn
tên thư mục có đuôi .htmlgiúp đỡ.

Các tệp hiện có cùng tên sẽ bị ghi đè.

Ngoài việc tạo các tệp HTML, xhtml, epub, phân khúc và htmltrợ giúp định dạng đảm bảo
các tệp tài nguyên được sao chép đến các vị trí thư mục đích chính xác của chúng.

TÀI NGUYÊN

Tài nguyên là các tệp (thường là CSS và hình ảnh) được yêu cầu bởi các đầu ra dựa trên HTML
(xhtml, epub, phân khúc, htmltrợ giúp định dạng). a2x quét các tệp HTML đã tạo và xây dựng
danh sách các tệp hình ảnh và CSS được yêu cầu. Các tệp tài nguyên bổ sung có thể được chỉ định
rõ ràng bằng cách sử dụng --nguồn tùy chọn.

a2x tìm kiếm các tệp tài nguyên ở các vị trí sau theo thứ tự sau:

1. Các NGUỒN_FILE thư mục.

2. Các thư mục tài nguyên được chỉ định bởi --nguồn tùy chọn (tìm kiếm đệ quy).

3. Các thư mục tài nguyên được chỉ định bởi - nguồn-tệp kê khai tùy chọn (tìm kiếm đệ quy
theo thứ tự chúng xuất hiện trong tệp kê khai).

4. Các thư mục hình ảnh và bảng định kiểu trong kho asciidoc(1) tệp cấu hình
thư mục (tìm kiếm đệ quy).

5. Thư mục đích.

Khi một tệp tài nguyên được tìm thấy, nó sẽ được sao chép vào đúng thư mục đích tương đối.
Các thư mục con đích bị thiếu được tạo tự động.

Có hai cơ chế riêng biệt để chỉ định các tài nguyên bổ sung:

1. Một thư mục tài nguyên sẽ được tìm kiếm đệ quy cho các tệp tài nguyên bị thiếu.

2. Một tệp tài nguyên sẽ được sao chép vào thư mục đích đầu ra.

Tài nguyên được chỉ định với --nguồn giá trị tùy chọn có thể là một trong những giá trị sau
định dạng:


[= ]
. =

Địa điểm:


Chỉ định một thư mục (tuyệt đối hoặc liên quan đến NGUỒN_FILE) được tìm kiếm
đệ quy cho các tệp tài nguyên bị thiếu. Để loại bỏ sự mơ hồ, Tên
nên kết thúc bằng ký tự phân cách thư mục.


Chỉ định một tệp tài nguyên (tuyệt đối hoặc liên quan đến NGUỒN_FILE) sẽ là
sao chép vào . Nếu như không được chỉ định thì nó là
giống như .


Chỉ định đích của tệp nguồn được sao chép. Các con đường là
liên quan đến thư mục đích (đường dẫn tuyệt đối không được phép). Địa điểm
của thư mục đích phụ thuộc vào kết quả đầu ra FORMAT (Xem OUTPUT CÁC TẬP TIN
phần để biết chi tiết):

chunked, htmltrợ giúp
Thư mục đầu ra phân khúc.

epub
Thư mục OEBPS đã lưu trữ.

xhtml
Đầu ra DESTINATION_DIR.

. =
Khi thêm tài nguyên vào tệp EPUB, kiểu mimetype được suy ra từ
tệp> phần mở rộng, nếu không thể đoán được kiểu mimetype thì sẽ xảy ra lỗi. Các
. = cú pháp tài nguyên có thể được sử dụng để thiết lập rõ ràng các kiểu mimetype. Là
phần mở rộng tên tệp, là kiểu MIME tương ứng.

Ví dụ về tùy chọn tài nguyên:

- nguồn ../images/
--resource doc / README.txt = README.txt
--nguồn ~ / images / tiger.png= images / tiger.png
--resource .ttf = application / x-font-ttf

VÍ DỤ

a2x -f pdf doc / source-highlight-filter.txt
Tạo tệp doc / source-highlight-filter.pdf.

a2x -f xhtml -D ../doc --icons -r ../images/ team.txt
Tạo tệp HTML ../doc/team.html, sử dụng các biểu tượng lời khuyên và tìm kiếm đệ quy
../images/ thư mục cho bất kỳ tài nguyên nào bị thiếu.

a2x -f manpage doc / asciidoc.1.txt
Tạo manpage doc / asciidoc.1.

YÊU CẦU

a2x sử dụng các chương trình sau:

· Asciidoc: http://asciidoc.org/

· xsltproc: (tất cả các định dạng ngoại trừ văn bản): http://xmlsoft.org/XSLT/

· DocBook XSL Biểu định kiểu (tất cả các định dạng ngoại trừ văn bản):
http://docbook.sourceforge.net/projects/xsl/

· dblatex (định dạng pdf, dvi, ps, tex): http://dblatex.sourceforge.net/

· FOP (định dạng pdf - trình tạo tệp PDF thay thế): http://xmlgraphics.apache.org/fop/

· w3m (định dạng văn bản): http://w3m.sourceforge.net/index.en.html

· Linh miêu (định dạng văn bản - trình tạo tệp văn bản thay thế): http://lynx.isc.org/

· kiểm tra epub (định dạng epub - trình xác thực tệp EPUB): http://code.google.com/p/epubcheck/

Xem thêm tệp README mới nhất.

CONF CÁC TẬP TIN

Tệp cấu hình chứa mã Python thực thi được ghi đè toàn cục
tham số cấu hình trong a2x.py. Các tệp cấu hình tùy chọn được tải trong
làm theo nguyên tắc:

1. a2x.conf từ thư mục chứa a2x.py thực thi.

2. a2x.conf từ thư mục cấu hình chung AsciiDoc. Bỏ qua bước này nếu chúng ta
thực thi một bản sao được cài đặt cục bộ (không phải trên toàn hệ thống).

3. a2x.conf từ thư mục cấu hình AsciiDoc $ HOME / .asciidoc.

4. Các CONF_FILE được chỉ định trong --conf-tệp tùy chọn.

Dưới đây là các giá trị tùy chọn tệp cấu hình mặc định:

# Từ điển biến môi trường tùy chọn được chuyển đến
# đang thực thi chương trình. Nếu được đặt thành Không thì hiện có
# môi trường được sử dụng.
ENV = Không có

# Các tệp thực thi bên ngoài.
ASCIIDOC = 'asciidoc'
XSLTPROC = 'xsltproc'
DBLATEX = 'dblatex' # tạo pdf.
FOP = 'fop' # tạo pdf (tùy chọn --fop).
W3M = 'w3m' # tạo văn bản.
LYNX = 'lynx' # tạo văn bản (nếu không có w3m).
XMLLINT = 'xmllint' # Đặt thành '' để tắt.
EPUBCHECK = 'epubcheck' # Đặt thành '' để tắt.
# Tùy chọn mặc định có thể thực thi bên ngoài.
ASCIIDOC_OPTS = ''
DBLATEX_OPTS = ''
FOP_OPTS = ''
XSLTPROC_OPTS = ''

Sử dụng a2x trực tuyến bằng các dịch vụ onworks.net