dtplite - Online sa Cloud

PROGRAMA:

NAME

dtplite - Magaang DocTools Markup Processor

SINOPSIS

dtplite -o output ?mga pagpipilian? format inputfile

dtplite patunayan inputfile

dtplite -o output ?mga pagpipilian? format inputdirectory

dtplite -pagsanib -o output ?mga pagpipilian? format inputdirectory

_________________________________________________________________________________________________

DESCRIPTION

Ang application na inilarawan ng dokumentong ito, dtplite, ay ang kahalili sa lubhang
simple mpexpand. Naimpluwensyahan sa paggana nito ng dtp doctools processor ito ay marami
mas malakas kaysa sa mpexpand, gayunpaman ay madaling gamitin; tiyak na mas madali kaysa dtp kasama nito
napakaraming mga subcommand at mga pagpipilian.

dtplite ay batay sa pakete doctools, tulad ng iba pang dalawang processor.

GAMITIN KASO
dtplite ay isinulat nang nasa isip ang sumusunod na tatlong kaso ng paggamit.

[1] Pagpapatunay ng isang dokumento, ibig sabihin, pagsuri kung ito ay nakasulat sa wastong
format ng doctools. Magagamit din ang mode na ito para makakuha ng paunang bersyon ng
naka-format na output para sa isang dokumento, para sa pagpapakita sa isang browser, nroff, atbp.,
na nagpapahintulot sa pag-proofread ng pag-format.

[2] Pagbuo ng naka-format na dokumentasyon para sa isang pakete, ibig sabihin, lahat ng
mga manpage, kasama ang isang talaan ng mga nilalaman at isang index ng mga keyword.

[3] Isang extension ng nakaraang mode ng operasyon, isang paraan para sa madaling henerasyon ng
isang puno ng dokumentasyon para sa ilang mga pakete, at lalo na ng isang pinag-isang talahanayan ng
nilalaman at index ng keyword.

Higit pa sa itaas ay gusto rin naming gamitin ang mga tampok sa pagpapasadya na ibinigay ng
HTML formatter. Hindi lamang ito ang format na dapat magawa ng application, ngunit
inaasahan namin na ito ang pinakakaraniwang ginagamit, at isa ito sa iilan na nagbibigay
mga kawit sa pagpapasadya.

Pinapayagan namin ang tumatawag na tumukoy ng header string, footer string, stylesheet, at data para sa
isang bar ng mga link sa nabigasyon sa tuktok ng nabuong dokumento. Habang ang lahat ay maaaring itakda bilang
hangga't nagbibigay ang formatting engine ng naaangkop na parameter ng engine (Tingnan ang seksyon
Opsyon) ang huling dalawa ay may panloob na pagpoproseso na ginagawa silang tiyak sa HTML.

COMMAND LINE
dtplite -o output ?mga pagpipilian? format inputfile
Ito ang form para sa use case [1]. Ang pagpipilian ipapaliwanag mamaya, sa seksyon
Opsyon.

landas output (sa)
Tinutukoy ng argumentong ito kung saan isusulat ang nabuong dokumento. Maaari itong maging ang
path sa isang file o direktoryo, o -. Ang huling halaga ay nagiging sanhi ng aplikasyon sa
isulat ang nabuong dokumentado sa stdout.

Kung ang output ay hindi umiiral kung gayon ang [file dirname $output] ay kailangang umiral at
dapat na isang nakasulat na direktoryo. Ang nabuong dokumento ay isusulat sa a
file sa direktoryo na iyon, at ang pangalan ng file na iyon ay magmula sa
inputfile, ang format, at ang halaga na ibinigay sa opsyon -ext (kung naroroon).

(landas|handle) format (sa)
Tinutukoy ng argumentong ito ang formatting engine na gagamitin kapag pinoproseso ang
input, at sa gayon ang format ng nabuong dokumento. Tingnan ang seksyon FORMATS
para sa mga posibilidad na kinikilala ng aplikasyon.

landas inputfile (sa)
Tinutukoy ng argumentong ito ang landas patungo sa file na ipoproseso. Dapat itong umiral,
dapat na nababasa, at nakasulat sa doctools format.

dtplite patunayan inputfile
Ito ay isang mas simpleng form para sa use case [1]. Ang "validate" na format ay hindi bumubuo ng output
sa lahat, tanging mga pagsusuri sa syntax ang ginagawa. Tulad nito ang pagtutukoy ng isang output
file o iba pang mga opsyon ay hindi kinakailangan at iwanan.

dtplite -o output ?mga pagpipilian? format inputdirectory
Ito ang form para sa use case [2]. Ito ay naiiba sa form para sa use case [1] sa pamamagitan ng
pagkakaroon ng mga dokumento ng input na tinukoy sa pamamagitan ng isang direktoryo sa halip na isang file. Ang
iba pang mga argumento ay magkapareho, maliban sa output, na ngayon ay dapat na ang landas patungo sa
isang umiiral at maisusulat na direktoryo.

Ang mga dokumento ng pag-input ay nasa lahat ng mga file inputdirectory o alinman sa mga subdirectory nito
na kinilala ng fileutil::fileType bilang naglalaman ng teksto sa doctools format.

dtplite -pagsanib -o output ?mga pagpipilian? format inputdirectory
Ito ang form para sa use case [3]. Ang tanging pagkakaiba sa form para sa use case [2]
ay ang karagdagang opsyon -pagsanib.

Ang bawat naturang tawag ay pagsasamahin ang mga nabuong dokumento na nagmumula sa pagproseso ng input
mga dokumento sa ilalim inputdirectory o alinman sa mga subdirectory nito sa mga file sa ilalim
output. Sa ganitong paraan posible na unti-unting buuin ang pinag-isang
dokumentasyon para sa anumang bilang ng mga pakete. Tandaan na ito ay kinakailangan upang tumakbo sa pamamagitan ng
lahat ng mga pakete nang dalawang beses upang makakuha ng ganap na tamang mga cross-reference (para sa mga format
pagsuporta sa kanila).

Opsyon
Inilalarawan ng seksyong ito ang lahat ng mga opsyon na magagamit ng user ng application, kasama ang
pagbubukod sa mga pagpipilian -o at -pagsanib. Ang dalawang ito ay inilarawan na, sa seksyon
COMMAND LINE.

- ibukod pisi
Tinutukoy ng opsyong ito ang pattern na ibukod (glob). Anumang mga file na tinukoy bilang mga manpage
upang iproseso kung aling tumutugma sa pattern ng pagbubukod ay hindi papansinin. Ang pagpipilian ay maaaring ibigay
maraming beses, bawat paggamit ay nagdaragdag ng karagdagang pattern sa listahan ng mga pagbubukod.

-ext pisi
Kung ang pangalan ng isang output file ay kailangang magmula sa pangalan ng isang input file ito
gagamit ng pangalan ng format bilang extension bilang default. Ang pagpipiliang ito dito ay
i-override ito gayunpaman, pinipilit itong gamitin pisi bilang extension ng file. Ang pagpipiliang ito
ay binabalewala kung ang pangalan ng output file ay ganap na tinukoy sa pamamagitan ng opsyon -o.

Kapag ginamit nang maraming beses ang huling kahulugan lamang ang may kaugnayan.

-header file
Magagamit ang opsyong ito kung at kung napili lang format nagbibigay ng makina
parameter na pinangalanang "header". Kinukuha nito ang mga nilalaman ng tinukoy na file at italaga
sa parameter na iyon, para sa anumang paggamit ng makina. Ipapasok ang HTML engine
ang teksto pagkatapos lamang ng tag . Kung mayroong mga navigation button (tingnan ang opsyon
-nav sa ibaba), pagkatapos ay ang HTML na nabuo para sa kanila ay idaragdag sa data ng header
na nagmumula dito bago ang huling pagtatalaga sa parameter.

Kapag ginamit nang maraming beses ang huling kahulugan lamang ang may kaugnayan.

-footer file
katulad -header, maliban sa: Ang anumang mga navigation button ay binabalewala, ang katumbas
ang kinakailangang parameter ng engine ay pinangalanang "footer", at ang data ay ipinasok bago
ang tag .

Kapag ginamit nang maraming beses ang huling kahulugan lamang ang may kaugnayan.

-Style file
Magagamit ang opsyong ito kung at kung napili lang format nagbibigay ng makina
parameter na pinangalanang "meta". Kapag tinukoy, bubuo ito ng isang piraso ng HTML code
nagdedeklara ng file bilang stylesheet para sa nabuong dokumento at italaga iyon sa
ang parameter. Ilalagay ito ng HTML engine sa dokumento, pagkatapos lamang ng
mga tag .

Kapag nagpoproseso ng isang direktoryo ng input ang stylesheet file ay kinokopya sa output
direktoryo at ang nabuong HTML ay magre-refer sa kopya, upang maging higit pa ang resulta
may sarili. Kapag nagpoproseso ng input file wala kaming lokasyon para kopyahin ang
stylesheet sa at kaya i-reference lamang ito bilang tinukoy.

Kapag ginamit nang maraming beses ang huling kahulugan lamang ang may kaugnayan.

-toc landas
Tinutukoy ng opsyong ito ang isang doctoc file na gagamitin para sa talaan ng mga nilalaman sa halip na
pagbuo ng sariling atin.

Kapag ginamit nang maraming beses ang huling kahulugan lamang ang may kaugnayan.

-pre+toc label na landas|teksto

-post+toc label na landas|teksto
Tinutukoy ng opsyong ito ang mga karagdagang doctoc file (o mga text) na gagamitin sa pag-navigate
bar.

Ang pagpoposisyon at paghawak ng maraming gamit ay tulad ng para sa mga opsyon -prenav at -postnav,
tingnan sa ibaba.

-nav url ng label

-prenav url ng label
Gamitin ang opsyong ito para tumukoy ng navigation button gamit ang etiketa upang ipakita at ang url sa
link sa. Magagamit ang opsyong ito kung at kung napili lang format nagbibigay ng isang
parameter ng engine na pinangalanang "header". Ang HTML na nabuo para dito ay idinagdag sa
anumang data na nakuha namin mula sa opsyon -header bago ito ipasok sa nabuo
mga dokumento.

Kapag ginamit nang maraming beses lahat ng mga kahulugan ay kinokolekta at isang navigation bar ay
nilikha, na ang unang kahulugan ay ipinapakita sa kaliwang gilid at ang huling kahulugan
sa kanan.

Ang url ay maaaring maging kamag-anak. Sa kasong iyon, ito ay ipinapalagay na may kaugnayan sa pangunahing
file (TOC at Keyword index), at babaguhin para sa lahat ng iba pa na mag-link pa rin
maayos.

-postnav url ng label
Gamitin ang opsyong ito para tumukoy ng navigation button gamit ang etiketa upang ipakita at ang url sa
link sa. Magagamit ang opsyong ito kung at kung napili lang format nagbibigay ng isang
parameter ng engine na pinangalanang "header". Ang HTML na nabuo para dito ay idinagdag sa
anumang data na nakuha namin mula sa opsyon -header bago ito ipasok sa nabuo
mga dokumento.

Kapag ginamit nang maraming beses lahat ng mga kahulugan ay kinokolekta at isang navigation bar ay
nilikha, na ang huling kahulugan ay ipinapakita sa kanang gilid at ang unang kahulugan
sa kaliwa.

Ang url ay maaaring maging kamag-anak. Sa kasong iyon, ito ay ipinapalagay na may kaugnayan sa pangunahing
file (TOC at Keyword index), at babaguhin para sa lahat ng iba pa na mag-link pa rin
maayos.

FORMATS
Sa una ang format Ang argumento ay ituturing bilang isang landas sa isang tcl file na naglalaman ng code
para sa hiniling na formatting engine. Ang argumento ay ituturing bilang pangalan ng isa sa
ang mga paunang-natukoy na format na nakalista sa ibaba kung at kung wala lang ang path.

nota a limitasyon: Kung tinatrato ang format bilang landas sa tcl script na nagpapatupad ng
naging matagumpay ang engine, pagkatapos ay kailangang ipatupad ng script na ito hindi lamang ang engine API para sa
doctools, ibig sabihin doctools_api, ngunit para sa dococ_api at docidx_api din. Kung hindi man ang
mabibigo ang pagbuo ng talaan ng mga nilalaman at ng index ng keyword.

Listahan ng mga paunang natukoy na format, ibig sabihin, ayon sa ibinigay ng package doctools:

nroff Ang processor ay bumubuo ng *roff output, ang karaniwang format para sa unix manpages.

html Ang processor ay bumubuo ng HTML na output, para sa paggamit at pagpapakita ng mga web browser. Ito
engine ay kasalukuyang nag-iisang nagbibigay ng iba't ibang mga parameter ng engine na kinakailangan
para sa karagdagang pagpapasadya ng output.

tmml Ang processor ay bumubuo ng TMML output, ang Tcl Manpage Markup Language, isang derivative
ng XML.

LaTeX Ang processor ay bumubuo ng LaTeX output.

wiki Ang processor ay bumubuo ng Wiki markup ayon sa pagkakaunawa ni wikit.

listahan Kinukuha ng processor ang impormasyong ibinigay ng manpage_begin. Ang format na ito ay
ginamit sa loob upang kunin ang meta data kung saan ang parehong talaan ng nilalaman at
keyword index ay nagmula sa.

walang halaga Ang processor ay hindi bumubuo ng anumang output. Ito ay katumbas ng patunayan.

DIRECTORY Mga istruktura
Sa seksyong ito inilalarawan namin ang mga istruktura ng direktoryo na nabuo ng application sa ilalim
output kapag pinoproseso ang lahat ng mga dokumento sa isang inputdirectory. Sa madaling salita, ito ay lamang
nauugnay sa mga kaso ng paggamit [2] at [3].

[2] Ang sumusunod na istraktura ng direktoryo ay nilikha kapag nagpoproseso ng isang set ng input
mga dokumento. Ang extension ng file na ginamit ay para sa output sa HTML, ngunit hindi iyon nauugnay
sa istraktura at ginamit lamang upang magkaroon ng wastong mga pangalan ng file.

output/
toc.html
index.html
mga file/
path/to/FOO.html

Ang huling linya sa halimbawa ay nagpapakita ng dokumentong nabuo para sa isang file na FOO na matatagpuan sa

inputdirectory/path/to/FOO

[3] Kapag pinagsasama ang maraming pakete sa isang pinag-isang hanay ng mga dokumento ang nabuong direktoryo
ang istraktura ay medyo mas malalim:

output
.toc
.idx
.tocdoc
.idxdoc
.xrf
toc.html
index.html
FOO1/
...
FOO2/
toc.html
mga file/
path/to/BAR.html

Ang bawat isa sa mga direktoryo na FOO1, ... ay naglalaman ng mga dokumentong nabuo para sa pakete
FOO1, ... at sumusunod sa istrukturang ipinapakita para sa use case [2]. Ang tanging exception ay
na walang per-package index.

Ang mga papeles ".toc"".idx", At".xrf" naglalaman ng panloob na katayuan ng kabuuan
output at babasahin at ia-update sa susunod na invokasyon. Ang kanilang mga nilalaman ay hindi
maidokumento. Alisin ang mga file na ito kapag ang lahat ng mga pakete na nais para sa output ay naging
naproseso, ibig sabihin, kapag ang output ay kumpleto na.

Ang mga papeles ".tocdoc", At".idxdoc", ay mga intermediate na file sa doctoc at docidx
markup, ayon sa pagkakabanggit, na naglalaman ng pangunahing talaan ng mga nilalaman at index ng keyword para sa
ang hanay ng mga dokumento bago ang kanilang conversion sa napiling format ng output. Sila ay
iniwan sa lugar, ibig sabihin, hindi tinanggal, upang magsilbing demonstrasyon ng doctoc at docidx
markup.

Gamitin ang dtplite online gamit ang mga serbisyo ng onworks.net