docbook2x-man - Online sa Cloud

PROGRAMA:

NAME

docbook2x-man - I-convert ang DocBook sa mga man page

SINOPSIS

docbook2x-man [pagpipilian] xml-dokumento

DESCRIPTION

docbook2x-man kino-convert ang ibinigay na DocBook XML na dokumento sa mga man page. Bilang default, ang lalaki
ang mga pahina ay ilalabas sa kasalukuyang direktoryo.

Tanging ang refentry na nilalaman sa dokumento ng DocBook ang na-convert. (Upang i-convert ang nilalaman
sa labas ng isang refentry, kinakailangan ang pag-customize ng stylesheet. Tingnan ang docbook2X package para sa
mga detalye.)

Ang docbook2x-man Ang command ay isang wrapper script para sa dalawang hakbang na proseso ng conversion. Tingnan ang
seksyong “PROSESO NG CONVERSION” sa ibaba para sa mga detalye.

Opsyon

Ang mga magagamit na opsyon ay mahalagang ang unyon ng mga opsyon mula sa db2x_xsltproc(1) at
db2x_manxmlNa (1).

Ang ilang karaniwang ginagamit na mga opsyon ay nakalista sa ibaba:

--encoding=pag-encode
Itinatakda ang pag-encode ng character ng output.

--string-param parametro=halaga
Nagtatakda ng parameter ng stylesheet (mga opsyon na nakakaapekto sa hitsura ng output). Tingnan mo
"Mga parameter ng stylesheet" sa ibaba para sa mga parameter na maaaring itakda.

--sgml Tumanggap ng SGML source na dokumento bilang input sa halip na XML.

--solinks
Gumawa ng mga stub page para sa mga alternatibong pangalan para sa isang output man page.

STYLESHEET MGA PARAMETERS
uppercase-heading
Maikli. Gawing uppercase ang mga heading?

default pagtatakda ng. 1 (boolean true)

Ang mga heading sa nilalaman ng man page ay dapat o hindi dapat naka-uppercase.

manvolnum-cite-numeral-only
Maikli. Ang pagsipi ng seksyon ng man page ay dapat gamitin lamang ang numero

default pagtatakda ng. 1 (boolean true)

Kapag nagbabanggit ng iba pang mga man page, ang seksyon ng man-page ay ibinibigay kung ano, o mayroong
mga titik na tinanggal mula dito, binabanggit lamang ang bilang ng seksyon (hal. seksyon 3x
nagiging 3). Tinutukoy ng opsyong ito kung aling istilo.

quotes-sa-literal
Maikli. Ipakita ang mga panipi sa literal na mga elemento?

default pagtatakda ng. 0 (boolean false)

Kung totoo, mag-render ng mga literal na elemento na may mga quote sa paligid nito.

palabas-komento
Maikli. Ipakita ang mga elemento ng komento?

default pagtatakda ng. 1 (boolean true)

Kung totoo, ang mga komento ay ipapakita, kung hindi, sila ay pinipigilan. Mga komento dito
ay tumutukoy sa elemento ng komento, na papalitan ng pangalan ng pangungusap sa DocBook V4.0, hindi
Mga komentong XML (<-- tulad nito -->) na hindi magagamit.

function-paren
Maikli. Bumuo ng mga panaklong pagkatapos ng isang function?

default pagtatakda ng. 0 (boolean false)

Kung totoo, ang pag-format ng a isasama ng elemento ang nabuong panaklong.

xref-on-link
Maikli. Dapat bang bumuo ng cross-reference ang link?

default pagtatakda ng. 1 (boolean true)

Hindi mai-render ng mga man page ang hypertext links na ginawa ng link. Kung nakatakda ang opsyong ito,
pagkatapos ay nagre-render ang stylesheet ng cross reference sa target ng link. (Ito ay maaaring
bawasan ang kalat). Kung hindi, ang nilalaman lamang ng link ang nai-render at ang aktwal
ang link mismo ay hindi pinapansin.

header-3
Maikli. Pangatlong header na teksto

default pagtatakda ng. (blangko)

Tinutukoy ang teksto ng ikatlong header ng isang man page, karaniwang ang petsa para sa
pahina ng tao. Kung walang laman, ang nilalaman ng petsa para sa refentry ay ginagamit.

header-4
Maikli. Pang-apat na header na teksto

default pagtatakda ng. (blangko)

Tinutukoy ang teksto ng ikaapat na header ng isang man page. Kung walang laman, ang refmiscinfo
ginagamit ang nilalaman para sa refentry.

header-5
Maikli. Ikalimang header na teksto

default pagtatakda ng. (blangko)

Tinutukoy ang teksto ng ikalimang header ng isang man page. Kung walang laman, ang 'manual na pangalan',
ibig sabihin, ginagamit ang pamagat ng aklat o reference na lalagyan.

default-manpage-section
Maikli. Default na seksyon ng man page

default pagtatakda ng. 1

Karaniwang isinasaad ng pinagmumulan ng dokumento ang mga seksyon na dapat pag-aari ng bawat man page
sa (na may manvolnum sa refmeta). Kung sakaling ang pinagmulang dokumento ay hindi nagsasaad ng man-
mga seksyon ng pahina, tinutukoy ng opsyong ito ang default.

custom-localization-file
Maikli. URI ng XML na dokumentong naglalaman ng custom na data ng localization

default pagtatakda ng. (blangko)

Tinutukoy ng parameter na ito ang URI ng isang XML na dokumento na naglalarawan ng mga pagsasalin ng teksto
(at iba pang impormasyong tukoy sa lokal) na kailangan ng stylesheet upang maproseso
ang dokumento ng DocBook.

Ang mga pagsasalin ng text na itinuro ng parameter na ito ay palaging override ang default na text
mga pagsasalin (mula sa panloob na parameter localization-file). Kung isang partikular
Ang pagsasalin ay wala rito, ang kaukulang default na pagsasalin ay ginagamit bilang a
umurong.

Pangunahin ang parameter na ito para sa pagpapalit ng ilang partikular na character na bantas na ginamit sa
pag-format ng pinagmulang dokumento. Ang mga setting para sa mga bantas na character ay madalas
partikular sa pinagmumulan ng dokumento, ngunit maaari ding umasa sa lokal.

Upang hindi gumamit ng mga custom na pagsasalin ng text, iwanan ang parameter na ito bilang walang laman na string.

custom-l10n-data
Maikli. XML na dokumentong naglalaman ng custom na data ng localization

default pagtatakda ng. dokumento($custom-localization-file)

Tinutukoy ng parameter na ito ang XML na dokumento na naglalarawan ng mga pagsasalin ng teksto (at
iba pang impormasyong tukoy sa lokal) na kailangan ng stylesheet upang maproseso ang
Dokumento ng DocBook.

Ang parameter na ito ay panloob sa stylesheet. Upang tumuro sa isang panlabas na XML na dokumento
na may URI o pangalan ng file, dapat mong gamitin ang parameter ng custom-localization-file
sa halip.

Gayunpaman, sa loob ng isang custom na stylesheet (hindi on ang linya ng utos) ang parameter na ito ay maaaring
itinakda sa XPath expression document(''), na magiging sanhi ng mga custom na pagsasalin
direktang naka-embed sa loob ng custom na stylesheet na babasahin.

may-akda-ibang-pangalan-sa-gitna
Maikli. Ang ibang pangalan ba sa may-akda ay isang gitnang pangalan?

default pagtatakda ng. 1

Kung totoo, lumilitaw ang ibang pangalan ng isang may-akda sa pagitan ng unang pangalan at apelyido.
Kung hindi, ang ibang pangalan ay pinigilan.

HALIMBAWA

$ docbook2x-man --solinks manpages.xml
$ docbook2x-man --solinks --encoding=utf-8//TRANSLIT manpages.xml
$ docbook2x-man --string-param header-4="Free Recode 3.6" document.xml
.fi

KONVERSYON PROCESS

Pag-convert sa lalaki mga pahina
Ang mga dokumento ng DocBook ay na-convert sa mga man page sa dalawang hakbang:

1. Ang pinagmulan ng DocBook ay kino-convert ng isang XSLT stylesheet sa isang intermediate na XML na format,
Man-XML.

Ang Man-XML ay mas simple kaysa sa DocBook at mas malapit sa format ng man page; ito ay inilaan upang
gawing mas madali ang trabaho ng mga stylesheet.

Ang stylesheet para sa layuning ito ay nasa xslt/man/docbook.xsl. Para sa portable, ito
dapat palaging tinutukoy ng sumusunod na URI:

http://docbook2x.sourceforge.net/latest/xslt/man/docbook.xsl

Patakbuhin ang stylesheet na ito gamit ang db2x_xsltprocNa (1).

Pag-customize. Maaari mo ring i-customize ang output sa pamamagitan ng paglikha ng iyong sariling XSLT stylesheet —
pagbabago ng mga parameter o pagdaragdag ng mga bagong template — at pag-import xslt/man/docbook.xsl.

2. Ang Man-XML ay na-convert sa aktwal na mga man page sa pamamagitan ng db2x_manxmlNa (1).

Ang docbook2x-man Awtomatikong ginagawa ng command ang parehong mga hakbang, ngunit kung may mga problemang mangyari, ikaw
makikita ang mga error nang mas malinaw kung gagawin mo ang bawat hakbang nang hiwalay:

$ db2x_xsltproc -s tao mydoc.xml -o mydoc.mxml
$ db2x_manxml mydoc.mxml
.fi

Inilalarawan ang mga opsyon sa stylesheet ng conversion sa
ang mga man-pages stylesheet
sanggunian.

Dalisay XSLT Conversion.
Isang kahalili sa db2x_manxml Ang Perl script ay ang XSLT
stylesheet sa
xslt/backend/db2x_manxml.xsl.
Gumaganap ang stylesheet na ito ng katulad na function
ng pag-convert ng Man-XML sa aktwal na mga man page.
Ito ay kapaki-pakinabang kung nais mo ang isang purong XSLT
solusyon sa conversion ng man-page.
Siyempre, ang kalidad ng conversion gamit ang stylesheet na ito
hindi kailanman magiging kasinghusay ng Perl db2x_manxml,
at mas mabagal ang takbo nito.
Sa partikular, ang purong XSLT na bersyon
kasalukuyang hindi sumusuporta sa mga talahanayan sa man page,
ngunit ginagawa nito ang Perl na katapat nito.

Katangian itakda Conversion
Kapag nagsasalin ng XML sa mga legacy na format na nakabatay sa ASCII na may mahinang suporta para sa Unicode, gaya ng
man pages at Texinfo, palaging may problema na Unicode characters sa source
kailangan ding isalin ang dokumento kahit papaano.

Ang isang diretsong character set conversion mula sa Unicode ay hindi sapat, dahil ang
Ang target na set ng character, karaniwang US-ASCII o ISO Latin-1, ay hindi naglalaman ng mga karaniwang character
gaya ng mga gitling at mga panipi ng direksyon na malawakang ginagamit sa mga dokumentong XML. Pero
pinapayagan ng mga formatter ng dokumento (man at Texinfo) ang mga naturang character na maipasok ng isang markup
pagtakas: halimbawa, \(lq para sa kaliwang direksyong quote ". At kung isang markup-level escape
ay hindi magagamit, maaaring gumamit ng ASCII transliteration: halimbawa, gamit ang ASCII
mas mababa sa sign < para sa anggulong panipi ⟨.

Kaya't ang problema sa karakter ng Unicode ay malulutas sa dalawang hakbang:

1. utf8trans(1), isang programang kasama sa docbook2X, nagmamapa ng mga character na Unicode sa antas ng markup
mga pagtakas o transliterasyon.

Dahil hindi kinakailangang may nakapirming, opisyal na pagmamapa ng mga karakter ng Unicode,
utf8trans mababasa sa mga mapping ng character na nababago ng user na ipinahayag sa mga text file at
ilapat ang mga ito. (Hindi tulad ng karamihan sa mga character set converter.)

In charmaps/man/roff.charmap at charmaps/man/texi.charmap ay mga mapa ng character na maaaring
gamitin para sa man-page at Texinfo conversion. Ang mga programa db2x_manxml(1) at
db2x_texixml(1) ilalapat ang mga mapa ng character na ito, o isa pang mapa ng character na tinukoy ni
ang gumagamit, awtomatiko.

2. Ang natitirang bahagi ng Unicode text ay na-convert sa ilang iba pang set ng character (encoding). Para sa
halimbawa, ang isang French na dokumento na may accented na mga character (tulad ng é) ay maaaring ma-convert sa
ISO Latin 1.

Ang hakbang na ito ay inilapat pagkatapos utf8trans character mapping, gamit ang iconv(1) pag-encode
tool sa conversion. pareho db2x_manxml(1) at db2x_texixml(1) maaaring tumawag iconv(1)
awtomatikong kapag gumagawa ng kanilang output.

Gamitin ang docbook2x-man online gamit ang mga serbisyo ng onworks.net