docbook2x-man - Online di Cloud

PROGRAM:

NAMA

docbook2x-man - Konversikan DocBook ke halaman manual

RINGKASAN

docbook2x-man [Pilihan] xml-dokumen

DESKRIPSI

docbook2x-man mengonversi dokumen XML DocBook yang diberikan menjadi halaman manual. Secara default, pria itu
halaman akan menjadi output ke direktori saat ini.

Hanya konten refentry dalam dokumen DocBook yang dikonversi. (Untuk mengonversi konten
di luar refentry, kustomisasi stylesheet diperlukan. Lihat paket docbook2X untuk
detailnya.)

The docbook2x-man command adalah skrip pembungkus untuk proses konversi dua langkah. Lihat
bagian “PROSES KONVERSI” di bawah ini untuk detailnya.

PILIHAN

Opsi yang tersedia pada dasarnya adalah gabungan opsi dari db2x_xsltproc(1) dan
db2x_manxml(1).

Beberapa opsi yang umum digunakan tercantum di bawah ini:

--enkode=encoding
Mengatur pengkodean karakter dari output.

--string-param parameter=nilai
Menetapkan parameter stylesheet (opsi yang memengaruhi tampilan output). Lihat
“Parameter stylesheet” di bawah ini untuk parameter yang dapat diatur.

--sgml Terima dokumen sumber SGML sebagai masukan, bukan XML.

--solink
Buat halaman rintisan untuk nama alternatif untuk halaman manual keluaran.

LEMBAR GAYA PARAMETER
judul huruf besar
Brief. Membuat judul huruf besar?

Default pengaturan. 1 (boolean benar)

Judul dalam konten halaman manual harus atau tidak boleh ditulis dengan huruf besar.

manvolnum-mengutip-angka-saja
Brief. Kutipan bagian halaman manual hanya boleh menggunakan nomor

Default pengaturan. 1 (boolean benar)

Saat mengutip halaman manual lain, bagian halaman manual diberikan apa adanya, atau memiliki
huruf-huruf dilucuti darinya, hanya menyebutkan nomor bagian (misalnya bagian 3x
menjadi 3). Opsi ini menentukan gaya mana.

kutipan-pada-literal
Brief. Tampilkan kutipan pada elemen literal?

Default pengaturan. 0 (boolean salah)

Jika benar, render elemen literal dengan tanda kutip di sekitarnya.

tunjukkan-komentar
Brief. Tampilkan elemen komentar?

Default pengaturan. 1 (boolean benar)

Jika benar, komentar akan ditampilkan, jika tidak maka akan ditekan. Komentar di sini
mengacu pada elemen komentar, yang akan diganti namanya menjadi komentar di DocBook V4.0, bukan
Komentar XML (<-- seperti ini -->) yang tidak tersedia.

fungsi-parens
Brief. Hasilkan tanda kurung setelah fungsi?

Default pengaturan. 0 (boolean salah)

Jika benar, format a elemen akan menyertakan tanda kurung yang dihasilkan.

xref-on-link
Brief. Haruskah tautan menghasilkan referensi silang?

Default pengaturan. 1 (boolean benar)

Halaman manual tidak dapat merender tautan hypertext yang dibuat oleh tautan. Jika opsi ini disetel,
kemudian stylesheet membuat referensi silang ke target tautan. (Ini mungkin
mengurangi kekacauan). Jika tidak, hanya konten tautan yang dirender dan yang sebenarnya
tautan itu sendiri diabaikan.

tajuk-3
Brief. Teks tajuk ketiga

Default pengaturan. (kosong)

Menentukan teks dari header ketiga halaman manual, biasanya tanggal untuk
halaman manual. Jika kosong, konten tanggal untuk refentry digunakan.

tajuk-4
Brief. Teks tajuk keempat

Default pengaturan. (kosong)

Menentukan teks dari header keempat halaman manual. Jika kosong, refmiscinfo
konten untuk refentry digunakan.

tajuk-5
Brief. Teks tajuk kelima

Default pengaturan. (kosong)

Menentukan teks dari header kelima halaman manual. Jika kosong, 'nama manual',
yaitu judul buku atau wadah referensi yang digunakan.

default-manpage-bagian
Brief. Bagian halaman manual default

Default pengaturan. 1

Dokumen sumber biasanya menunjukkan bagian yang harus dimiliki oleh setiap halaman manual
ke (dengan manvolnum di refmeta). Dalam hal dokumen sumber tidak menunjukkan man-
bagian halaman, opsi ini menentukan default.

file-lokalisasi-kustom
Brief. URI dokumen XML yang berisi data pelokalan khusus

Default pengaturan. (kosong)

Parameter ini menentukan URI dokumen XML yang menjelaskan terjemahan teks
(dan informasi spesifik lokal lainnya) yang diperlukan oleh stylesheet untuk diproses
dokumen DocBook.

Terjemahan teks yang ditunjukkan oleh parameter ini selalu menimpa teks default
terjemahan (dari file lokalisasi parameter internal). Jika tertentu
terjemahan tidak ada di sini, terjemahan default yang sesuai digunakan sebagai
mundur.

Parameter ini terutama untuk mengubah karakter tanda baca tertentu yang digunakan dalam
memformat dokumen sumber. Pengaturan untuk karakter tanda baca sering
khusus untuk dokumen sumber, tetapi juga dapat bergantung pada lokal.

Untuk tidak menggunakan terjemahan teks khusus, biarkan parameter ini sebagai string kosong.

kustom-l10n-data
Brief. Dokumen XML yang berisi data pelokalan khusus

Default pengaturan. document($file-lokalisasi-kustom)

Parameter ini menentukan dokumen XML yang menjelaskan terjemahan teks (dan
informasi spesifik lokal lainnya) yang dibutuhkan oleh stylesheet untuk memproses
dokumen DocBook.

Parameter ini internal ke stylesheet. Untuk menunjuk ke dokumen XML eksternal
dengan URI atau nama file, Anda harus menggunakan parameter custom-localization-file
sebagai gantinya.

Namun, di dalam lembar gaya khusus (tidak on itu baris perintah) parameter ini dapat menjadi
atur ke dokumen ekspresi XPath (''), yang akan menyebabkan terjemahan khusus
langsung disematkan di dalam lembar gaya khusus untuk dibaca.

penulis-nama lain-di-tengah
Brief. Apakah nama lain dalam penulis adalah nama tengah?

Default pengaturan. 1

Jika benar, nama lain penulis muncul di antara nama depan dan nama belakang.
Jika tidak, nama lain akan ditekan.

CONTOH

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

KONVERSI PROSES

Konversi untuk pria halaman
Dokumen DocBook dikonversi ke halaman manual dalam dua langkah:

1. Sumber DocBook diubah oleh stylesheet XSLT menjadi format XML perantara,
Manusia-XML.

Man-XML lebih sederhana daripada DocBook dan lebih dekat dengan format halaman manual; itu dimaksudkan untuk
membuat pekerjaan stylesheet lebih mudah.

Lembar gaya untuk tujuan ini ada di xslt/man/docbook.xsl. Untuk portabilitas, ini
harus selalu dirujuk oleh URI berikut:

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

Jalankan stylesheet ini dengan db2x_xsltproc(1).

Menyesuaikan. Anda juga dapat menyesuaikan output dengan membuat stylesheet XSLT Anda sendiri —
mengubah parameter atau menambahkan template baru — dan mengimpor xslt/man/docbook.xsl.

2. Man-XML dikonversi ke halaman manual yang sebenarnya dengan db2x_manxml(1).

The docbook2x-man perintah melakukan kedua langkah secara otomatis, tetapi jika terjadi masalah, Anda
dapat melihat kesalahan lebih jelas jika Anda melakukan setiap langkah secara terpisah:

$ db2x_xsltproc -sman dok saya.xml -o dok saya.mxml
$ db2x_manxml dok saya.mxml
.fi

Opsi untuk lembar gaya konversi dijelaskan dalam
lembar gaya halaman manual
referensi.

Murni XSLT Konversi.
Sebuah alternatif dari db2x_manxml Skrip Perl adalah XSLT
lembar gaya di
xslt/backend/db2x_manxml.xsl.
Stylesheet ini melakukan fungsi serupa
mengonversi Man-XML ke halaman manual yang sebenarnya.
Ini berguna jika Anda menginginkan XSLT murni
solusi untuk konversi halaman manual.
Tentu saja, kualitas konversi menggunakan stylesheet ini
tidak akan pernah sebagus Perl db2x_manxml,
dan berjalan lebih lambat.
Khususnya, versi XSLT murni
saat ini tidak mendukung tabel di halaman manual,
tetapi rekan Perl-nya melakukannya.

Karakter set Konversi
Saat menerjemahkan XML ke format berbasis ASCII lama dengan dukungan yang buruk untuk Unicode, seperti:
halaman manual dan Texinfo, selalu ada masalah bahwa karakter Unicode di sumbernya
dokumen juga harus diterjemahkan entah bagaimana.

Konversi set karakter langsung dari Unicode tidak cukup, karena
kumpulan karakter target, biasanya US-ASCII atau ISO Latin-1, tidak mengandung karakter umum
seperti tanda hubung dan tanda kutip arah yang banyak digunakan dalam dokumen XML. Tetapi
pemformat dokumen (man dan Texinfo) memungkinkan karakter tersebut dimasukkan dengan markup
escape: misalnya, \(lq untuk kutipan arah kiri “. Dan jika escape level markup
tidak tersedia, transliterasi ASCII dapat digunakan: misalnya, menggunakan ASCII
tanda kurang dari < untuk tanda kutip sudut .

Jadi masalah karakter Unicode dapat diselesaikan dalam dua langkah:

1. utf8trans(1), program yang disertakan dalam docbook2X, memetakan karakter Unicode ke level markup
lolos atau transliterasi.

Karena belum tentu ada pemetaan resmi karakter Unicode yang tetap,
utf8trans dapat membaca dalam pemetaan karakter yang dapat dimodifikasi pengguna yang dinyatakan dalam file teks dan
menerapkannya. (Tidak seperti kebanyakan konverter set karakter.)

In charmaps/man/roff.charmap dan charmaps/man/texi.charmap adalah peta karakter yang mungkin
digunakan untuk halaman manual dan konversi Texinfo. Program-programnya db2x_manxml(1) dan
db2x_texixml(1) akan menerapkan peta karakter ini, atau peta karakter lain yang ditentukan oleh
pengguna, secara otomatis.

2. Sisa teks Unicode dikonversi ke beberapa set karakter lain (encoding). Untuk
misalnya, dokumen Prancis dengan karakter beraksen (seperti é) dapat dikonversi menjadi
ISO Latin 1.

Langkah ini diterapkan setelah utf8trans pemetaan karakter, menggunakan iconv(1) pengkodean
alat konversi. Keduanya db2x_manxml(1) dan db2x_texixml(1) dapat menelepon iconv(1)
secara otomatis ketika menghasilkan output mereka.

Gunakan docbook2x-man online menggunakan layanan onworks.net