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

CHƯƠNG TRÌNH:

TÊN

dtplite - Bộ xử lý đánh dấu DocTools nhẹ

SYNOPSIS

dtplite -o đầu ra ?tùy chọn? định dạng tập tin đầu vào

dtplite xác nhận tính hợp lệ tập tin đầu vào

dtplite -o đầu ra ?tùy chọn? định dạng thư mục đầu vào

dtplite - hợp nhất -o đầu ra ?tùy chọn? định dạng thư mục đầu vào

_________________________________________________________________________________________________

MÔ TẢ

Ứng dụng được mô tả bởi tài liệu này, dtplite, là sự kế thừa của cực kỳ
đơn giản mpmở rộng. Ảnh hưởng đến chức năng của nó bởi dtp bộ xử lý doctools nó là nhiều
mạnh hơn mpmở rộng, nhưng vẫn dễ sử dụng; chắc chắn dễ dàng hơn dtp với nó
vô số lệnh con và tùy chọn.

dtplite dựa trên gói tiến sĩ, giống như hai bộ xử lý còn lại.

SỬ DỤNG CÁC TRƯỜNG HỢP
dtplite đã được viết với ba trường hợp sử dụng sau đây.

[1] Xác thực một tài liệu, tức là kiểm tra xem nó có được viết hợp lệ không
định dạng tiến sĩ. Chế độ này cũng có thể được sử dụng để tải phiên bản sơ bộ của
đầu ra được định dạng cho một tài liệu, để hiển thị trong trình duyệt, nroff, v.v.,
cho phép hiệu đính định dạng.

[2] Tạo tài liệu được định dạng cho một gói duy nhất, tức là tất cả
trang, cộng với mục lục và chỉ mục từ khóa.

[3] Một phần mở rộng của phương thức hoạt động trước đây, một phương pháp để dễ dàng tạo ra
một cây tài liệu cho một số gói và đặc biệt là một bảng thống nhất của
nội dung và chỉ mục từ khóa.

Ngoài những điều trên, chúng tôi cũng muốn sử dụng các tính năng tùy chỉnh được cung cấp bởi
HTML định dạng. Đây không phải là định dạng duy nhất mà ứng dụng có thể tạo, nhưng
chúng tôi dự đoán nó sẽ được sử dụng phổ biến nhất và nó là một trong số ít nó cung cấp
móc tùy biến.

Chúng tôi cho phép người gọi chỉ định chuỗi đầu trang, chuỗi chân trang, biểu định kiểu và dữ liệu cho
một thanh liên kết điều hướng ở đầu tài liệu đã tạo. Trong khi tất cả đều có thể được đặt là
miễn là công cụ định dạng cung cấp một tham số công cụ thích hợp (Xem phần
LỰA CHỌN) hai phần cuối cùng có quy trình xử lý nội bộ làm cho chúng trở nên đặc trưng cho HTML.

COMMAND ĐƯỜNG DÂY
dtplite -o đầu ra ?tùy chọn? định dạng tập tin đầu vào
Đây là biểu mẫu cho ca sử dụng [1]. Các lựa chọn sẽ được giải thích sau, trong phần
LỰA CHỌN.

con đường đầu ra (trong)
Đối số này chỉ định nơi ghi tài liệu được tạo. Nó có thể là
đường dẫn đến một tệp hoặc thư mục, hoặc -. Giá trị cuối cùng khiến ứng dụng
ghi tài liệu đã tạo vào tiêu chuẩn.

Nếu đầu ra không tồn tại thì [file dirname $ output] phải tồn tại và
phải là một thư mục có thể ghi. Tài liệu đã tạo sẽ được ghi vào một
tệp trong thư mục đó và tên của tệp đó sẽ được lấy từ
tập tin đầu vào, Các định dạngvà giá trị được cung cấp cho tùy chọn -ext (nếu có).

(đường dẫn | tay cầm) định dạng (trong)
Đối số này chỉ định công cụ định dạng để sử dụng khi xử lý
đầu vào, và do đó là định dạng của tài liệu được tạo. Xem phần M FORU ĐƠN
cho các khả năng được ứng dụng công nhận.

con đường tập tin đầu vào (trong)
Đối số này chỉ định đường dẫn đến tệp để xử lý. Nó phải tồn tại,
phải đọc được và được viết bằng tiến sĩ định dạng.

dtplite xác nhận tính hợp lệ tập tin đầu vào
Đây là một biểu mẫu đơn giản hơn cho ca sử dụng [1]. Định dạng "xác thực" không tạo ra đầu ra
ở tất cả, chỉ kiểm tra cú pháp được thực hiện. Như đặc điểm kỹ thuật của một đầu ra
tệp hoặc các tùy chọn khác không cần thiết và bị bỏ qua.

dtplite -o đầu ra ?tùy chọn? định dạng thư mục đầu vào
Đây là biểu mẫu cho ca sử dụng [2]. Nó khác với biểu mẫu cho ca sử dụng [1] bởi
có các tài liệu đầu vào được chỉ định thông qua một thư mục thay vì một tệp. Các
các đối số khác giống hệt nhau, ngoại trừ đầu ra, bây giờ phải là con đường dẫn đến
một thư mục hiện có và có thể ghi.

Các tài liệu đầu vào là tất cả các tệp trong thư mục đầu vào hoặc bất kỳ thư mục con nào của nó
được công nhận bởi fileutil :: fileType như chứa văn bản trong tiến sĩ định dạng.

dtplite - hợp nhất -o đầu ra ?tùy chọn? định dạng thư mục đầu vào
Đây là biểu mẫu cho ca sử dụng [3]. Sự khác biệt duy nhất đối với biểu mẫu cho trường hợp sử dụng [2]
là tùy chọn bổ sung - hợp nhất.

Mỗi lệnh gọi như vậy sẽ hợp nhất các tài liệu được tạo ra từ quá trình xử lý đầu vào
tài liệu dưới thư mục đầu vào hoặc bất kỳ thư mục con nào của nó tới các tệp trong
đầu ra. Bằng cách này, có thể từng bước xây dựng sự thống nhất
tài liệu cho bất kỳ số lượng gói nào. Lưu ý rằng cần phải chạy qua
tất cả các gói hai lần để có được các tham chiếu chéo hoàn toàn chính xác (đối với các định dạng
hỗ trợ họ).

LỰA CHỌN
Phần này mô tả tất cả các tùy chọn có sẵn cho người dùng ứng dụng, với
ngoại lệ của các tùy chọn -o và - hợp nhất. Hai điều này đã được mô tả trong phần
COMMAND ĐƯỜNG DÂY.

-loại trừ chuỗi
Tùy chọn này chỉ định mẫu loại trừ (toàn cầu). Bất kỳ tệp nào được xác định là trang chủ
để xử lý loại đối sánh nào bị bỏ qua. Tùy chọn có thể được cung cấp
nhiều lần, mỗi lần sử dụng thêm một mẫu bổ sung vào danh sách loại trừ.

-ext chuỗi
Nếu tên của tệp đầu ra phải bắt nguồn từ tên của tệp đầu vào thì nó
sẽ sử dụng tên của định dạng làm tiện ích mở rộng theo mặc định. Tùy chọn này ở đây sẽ
ghi đè điều này, tuy nhiên, buộc nó phải sử dụng chuỗi dưới dạng phần mở rộng của tệp. Tùy chọn này
bị bỏ qua nếu tên của tệp đầu ra được chỉ định đầy đủ thông qua tùy chọn -o.

Khi được sử dụng nhiều lần, chỉ định nghĩa cuối cùng là có liên quan.

-cái đầu hồ sơ
Tùy chọn này có thể được sử dụng nếu và chỉ khi được chọn định dạng cung cấp một động cơ
tham số có tên "tiêu đề". Nó lấy nội dung của tệp được chỉ định và gán
chúng đến tham số đó, cho bất kỳ mục đích sử dụng nào của động cơ. Công cụ HTML sẽ chèn
văn bản ngay sau thẻ . Nếu có các nút điều hướng (xem tùy chọn
-nav bên dưới), sau đó HTML được tạo cho chúng được nối vào dữ liệu tiêu đề
bắt nguồn từ đây trước khi gán tham số cuối cùng.

Khi được sử dụng nhiều lần, chỉ định nghĩa cuối cùng là có liên quan.

-chân trang hồ sơ
Như -cái đầu, ngoại trừ điều đó: Mọi nút điều hướng đều bị bỏ qua,
tham số công cụ bắt buộc được đặt tên là "footer" và dữ liệu được chèn ngay trước
tag .

Khi được sử dụng nhiều lần, chỉ định nghĩa cuối cùng là có liên quan.

-Phong cách hồ sơ
Tùy chọn này có thể được sử dụng nếu và chỉ khi được chọn định dạng cung cấp một động cơ
tham số có tên "meta". Khi được chỉ định, nó sẽ tạo ra một đoạn mã HTML
tuyên bố hồ sơ dưới dạng biểu định kiểu cho tài liệu đã tạo và gán nó cho
thông số. Công cụ HTML sẽ chèn inot này vào tài liệu, chỉ sau
tag .

Khi xử lý một thư mục đầu vào, tệp biểu định kiểu được sao chép vào đầu ra
thư mục và HTML được tạo sẽ tham chiếu đến bản sao, để làm cho kết quả nhiều hơn
khép kín. Khi xử lý một tệp đầu vào, chúng tôi không có vị trí để sao chép
biểu định kiểu đến và vì vậy chỉ cần tham chiếu nó như được chỉ định.

Khi được sử dụng nhiều lần, chỉ định nghĩa cuối cùng là có liên quan.

-toc con đường
Tùy chọn này chỉ định một tệp tài liệu để sử dụng cho mục lục thay vì
tạo ra của riêng chúng tôi.

Khi được sử dụng nhiều lần, chỉ định nghĩa cuối cùng là có liên quan.

-pre + toc đường dẫn nhãn | văn bản

-post + toc đường dẫn nhãn | văn bản
Tùy chọn này chỉ định các tệp tài liệu bổ sung (hoặc văn bản) để sử dụng trong điều hướng
quán ba.

Định vị và xử lý nhiều mục đích sử dụng giống như đối với các tùy chọn -prenav và -postnav,
xem bên dưới.

-nav url nhãn

-prenav url nhãn
Sử dụng tùy chọn này để chỉ định một nút điều hướng với nhãn để hiển thị và url đến
liên kết đến. Tùy chọn này có thể được sử dụng nếu và chỉ khi được chọn định dạng cung cấp một
tham số động cơ có tên "tiêu đề". HTML được tạo cho điều này được thêm vào
bất kỳ dữ liệu nào chúng tôi nhận được từ tùy chọn -cái đầu trước khi nó được chèn vào
các tài liệu.

Khi được sử dụng nhiều lần, tất cả các định nghĩa được thu thập và thanh điều hướng
được tạo, với định nghĩa đầu tiên được hiển thị ở cạnh bên trái và định nghĩa cuối cùng
rẽ phải.

Url có thể là tương đối. Trong trường hợp đó, nó được giả định là liên quan đến
các tệp (TOC và chỉ mục Từ khóa) và sẽ được chuyển đổi để tất cả những người khác vẫn liên kết
đúng.

-postnav url nhãn
Sử dụng tùy chọn này để chỉ định một nút điều hướng với nhãn để hiển thị và url đến
liên kết đến. Tùy chọn này có thể được sử dụng nếu và chỉ khi được chọn định dạng cung cấp một
tham số động cơ có tên "tiêu đề". HTML được tạo cho điều này được thêm vào
bất kỳ dữ liệu nào chúng tôi nhận được từ tùy chọn -cái đầu trước khi nó được chèn vào
các tài liệu.

Khi được sử dụng nhiều lần, tất cả các định nghĩa được thu thập và thanh điều hướng
được tạo, với định nghĩa cuối cùng được hiển thị ở cạnh bên phải và định nghĩa đầu tiên
bên trái.

Url có thể là tương đối. Trong trường hợp đó, nó được giả định là liên quan đến
các tệp (TOC và chỉ mục Từ khóa) và sẽ được chuyển đổi để tất cả những người khác vẫn liên kết
đúng.

M FORU ĐƠN
Lúc đầu định dạng đối số sẽ được coi là đường dẫn đến tệp tcl chứa mã
cho công cụ định dạng được yêu cầu. Đối số sẽ được coi là tên của một trong số
các định dạng xác định trước được liệt kê bên dưới nếu và chỉ khi đường dẫn không tồn tại.

Chú thích a giới hạn: Nếu coi định dạng là đường dẫn đến tập lệnh tcl triển khai
engine đã thành công, thì tập lệnh này phải triển khai không chỉ API engine cho
tiến sĩ, tức là doctools_api, Nhưng đối với doc_api và docidx_api cũng. Nếu không
tạo mục lục và chỉ mục từ khóa sẽ không thành công.

Danh sách các định dạng được xác định trước, tức là như được cung cấp bởi gói tiến sĩ:

ăn trộm Bộ xử lý tạo ra đầu ra * roff, định dạng tiêu chuẩn cho các trang unix.

html Bộ xử lý tạo ra đầu ra HTML, để trình duyệt web sử dụng và hiển thị. Cái này
động cơ hiện là động cơ duy nhất cung cấp các thông số động cơ khác nhau cần thiết
cho các tùy chỉnh bổ sung của đầu ra.

tmml Bộ xử lý tạo đầu ra TMML, Ngôn ngữ đánh dấu trang Tcl, một dẫn xuất
của XML.

mủ cao su Bộ xử lý tạo ra đầu ra LaTeX.

wiki Bộ xử lý tạo đánh dấu Wiki như được hiểu bởi wiki.

Bộ xử lý trích xuất thông tin được cung cấp bởi trang_bắt đầu. Định dạng này là
được sử dụng nội bộ để trích xuất dữ liệu meta mà từ đó cả mục lục và
chỉ mục từ khóa có nguồn gốc từ.

vô giá trị Bộ xử lý không tạo ra bất kỳ đầu ra nào. Điều này tương đương với xác nhận tính hợp lệ.

MỤC CẤU TRÚC
Trong phần này, chúng tôi mô tả cấu trúc thư mục được tạo bởi ứng dụng trong
đầu ra khi xử lý tất cả các tài liệu trong một thư mục đầu vào. Nói cách khác, đây chỉ là
liên quan đến các trường hợp sử dụng [2] và [3].

[2] Cấu trúc thư mục sau được tạo khi xử lý một tập hợp dữ liệu đầu vào
các tài liệu. Phần mở rộng tệp được sử dụng dành cho đầu ra trong HTML, nhưng điều đó không liên quan
vào cấu trúc và chỉ được sử dụng để có tên tệp thích hợp.

đầu ra /
toc.html
index.html
các tập tin/
path / to / FOO.html

Dòng cuối cùng trong ví dụ hiển thị tài liệu được tạo cho tệp FOO nằm tại

inputdirectory / path / to / FOO

[3] Khi hợp nhất nhiều gói thành một tập hợp tài liệu thống nhất, thư mục được tạo
cấu trúc sâu hơn một chút:

đầu ra
.toc
.idx
.tocdoc
.idxdoc
.xrf
toc.html
index.html
FOO1 /
...
FOO2 /
toc.html
các tập tin/
path / to / BAR.html

Mỗi thư mục FOO1, ... chứa các tài liệu được tạo cho gói
FOO1, ... và tuân theo cấu trúc được hiển thị cho trường hợp sử dụng [2]. Ngoại lệ duy nhất là
rằng không có chỉ mục cho mỗi gói.

Tập tài liệu ".toc"".idx", Và".xrf"chứa trạng thái bên trong của toàn bộ
đầu ra và sẽ được đọc và cập nhật bởi lần gọi tiếp theo. Nội dung của chúng sẽ không
được ghi lại. Loại bỏ các tệp này khi tất cả các gói muốn cho đầu ra đã được
được xử lý, tức là khi đầu ra hoàn tất.

Tập tài liệu ".tocdoc", Và".idxdoc", là các tệp trung gian trong doctoc và docidx
đánh dấu, tương ứng, chứa mục lục chính và chỉ mục từ khóa cho
tập hợp các tài liệu trước khi chuyển đổi sang định dạng đầu ra đã chọn. họ đang
vẫn giữ nguyên vị trí, tức là không bị xóa, để phục vụ cho việc trình diễn tài liệu và docidx
đánh dấu.

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