docbook2x-texi - Online di Cloud

PROGRAM:

NAMA

docbook2x-texi - Konversikan DocBook ke Texinfo

RINGKASAN

docbook2x-texi [Pilihan] xml-dokumen

DESKRIPSI

docbook2x-texi mengonversi dokumen XML DocBook yang diberikan menjadi satu atau lebih dokumen Texinfo.
Secara default, dokumen Texinfo ini akan menjadi output ke direktori saat ini.

Grafik docbook2x-texi 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 untuk db2x_xsltproc(1) dan
db2x_texixml(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.

LEMBAR GAYA PARAMETER
keterangan-tampilan-sebagai-judul
Brief. Gunakan markup heading untuk teks kecil?

Default pengaturan. 0 (boolean salah)

Jika benar, konten judul di beberapa objek (formal) dirender dengan Texinfo
@menuju perintah.

Jika salah, keterangan diberikan sebagai paragraf yang ditekankan.

tautan-gunakan-pxref
Brief. Terjemahkan tautan menggunakan @pxref

Default pengaturan. 1 (boolean benar)

Jika benar, tautan diterjemahkan dengan hypertext diikuti dengan referensi silang di
tanda kurung.

Jika tidak, konten hypertext berfungsi sebagai nama referensi silang yang ditandai menggunakan
@ref. Biasanya info menampilkan kontrak ini dengan buruk.

eksplisit-node-nama
Brief. Bersikeras pada nama simpul Texinfo yang dibuat secara manual

Default pengaturan. 0 (boolean salah)

Elemen dalam dokumen sumber dapat memengaruhi pembuatan nama simpul Texinfo
menentukan baik xreflabel, atau untuk elemen sectioning, sebuah judul dengan
role='texinfo-node' di *wadah informasi.

Namun, untuk sebagian besar dokumen sumber, nama simpul Texinfo eksplisit tidak
tersedia, dan stylesheet mencoba untuk menghasilkan yang masuk akal sebagai gantinya, misalnya dari
judul normal suatu elemen. Nama yang dihasilkan mungkin tidak optimal. Jika ini
opsi diatur dan stylesheet perlu menghasilkan nama, peringatan dikeluarkan dan
menghasilkan-id selalu digunakan untuk nama.

Ketika ekstensi hashtable tidak tersedia, stylesheet tidak dapat memeriksa node
tabrakan nama, dan dalam hal ini, mengatur opsi ini dan menggunakan node eksplisit
nama dianjurkan.

Opsi ini tidak disetel (yaitu salah) secara default.
Note

Fallback mutlak untuk menghasilkan nama node menggunakan fungsi XSLT
menghasilkan-id, dan stylesheet selalu mengeluarkan peringatan dalam hal ini terlepas dari
pengaturan nama-simpul eksplisit.

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-sinopsis-dekorasi
Brief. Hiasi elemen FuncSynopsis?

Default pengaturan. 1 (boolean benar)

Jika benar, elemen FuncSynopsis akan didekorasi (misalnya tebal atau miring). NS
dekorasi dikendalikan oleh fungsi yang dapat didefinisikan ulang dalam kustomisasi
lapisan.

fungsi-parens
Brief. Hasilkan tanda kurung setelah fungsi?

Default pengaturan. 0 (boolean salah)

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

nama-tampilan refentry
Brief. Keluarkan tajuk NAME sebelum 'RefName'?

Default pengaturan. 1 (boolean benar)

Jika benar, judul bagian "NAME" ditampilkan sebelum daftar 'RefName's.

manvolnum-in-xref
Brief. Keluarkan manvolnum sebagai bagian dari referensi silang refentry?

Default pengaturan. 1 (boolean benar)

jika benar, manvolnum digunakan saat referensi silang referensi, baik dengan xref
atau citerefentry.

lebih suka objek teks
Brief. Lebih suka objek teks daripada objek gambar?

Default pengaturan. 1 (boolean benar)

Jika benar, objek teks dalam objek media lebih disukai daripada objek gambar apa pun.

(Tentu saja, untuk format keluaran selain Texinfo, Anda biasanya ingin memilih format
imageobject, tetapi Info adalah format teks saja.)

Selain nilai benar dan salah, parameter ini dapat diatur ke 2 untuk
menunjukkan bahwa teks dan gambar harus menjadi output. Anda mungkin ingin melakukannya
ini karena beberapa pemirsa Texinfo dapat membaca gambar. Perhatikan bahwa Texinfo @image
perintah memiliki mekanisme sendiri untuk beralih antara teks dan output gambar — tetapi kami
jangan gunakan ini di sini.

Defaultnya benar.

dekorasi semantik
Brief. Gunakan markup semantik semantik Texinfo?

Default pengaturan. 1 (boolean benar)

Jika benar, markup semantik semantik dari DocBook diterjemahkan ke dalam (paling dekat)
Setara dengan Texasinfo. Ini adalah default.

Namun, karena format Info terbatas pada teks biasa, semantik inline
markup sering dibedakan dengan menggunakan tanda kutip eksplisit, yang mungkin tidak terlihat bagus.
Anda dapat mengatur opsi ini ke false untuk menekannya. (Untuk kontrol yang lebih baik atas
pemformatan sebaris, Anda dapat menggunakan lembar gaya Anda sendiri.)

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.

berkas keluaran
Brief. Nama file Info

Default pengaturan. (kosong)

Parameter ini menentukan nama file Info akhir, mengesampingkan pengaturan di
dokumen itu sendiri dan pemilihan otomatis dalam stylesheet. Jika dokumen
adalah satu set, parameter ini tidak berpengaruh.
penting

Do tidak sertakan ekstensi .info pada namanya.

(Perhatikan bahwa parameter ini tidak ada hubungannya dengan nama Texi-XML keluaran oleh
Prosesor XSLT tempat Anda menjalankan stylesheet ini.)

direktori-kategori
Brief. Kategorisasi dokumen di direktori Info

Default pengaturan. (kosong)

Ini diatur ke kategori di mana dokumen harus berada di bawah direktori Info
dari file Info yang diinstal. Misalnya, Perintah Umum.
Note

Kategori juga dapat diatur langsung di dokumen sumber. Tetapi jika parameter ini
tidak kosong, maka selalu menimpa pengaturan di dokumen sumber.

deskripsi-direktori
Brief. Deskripsi dokumen di direktori Info

Default pengaturan. (kosong)

Ini adalah deskripsi singkat dari dokumen yang muncul di direktori Info dari
file Info yang diinstal. Misalnya, Program Plotting Interaktif.
Note

Deskripsi menu juga dapat diatur langsung di dokumen sumber. Tapi jika ini
parameter tidak kosong, maka selalu menimpa pengaturan di sumber
dokumen.

kategori-indeks
Brief. Indeks Texinfo untuk digunakan

Default pengaturan. cp

Indeks Texinfo untuk indexterm dan indeks ditentukan menggunakan atribut role. Jika
elemen di atas tidak memiliki peran, maka default ditentukan oleh parameter ini
digunakan.

Indeks yang telah ditentukan sebelumnya adalah:

c, indeks konsep cp

f, fn Indeks fungsi

v, vr Indeks variabel

k, indeks keystroke ky

p, pg Indeks program

d, tp Indeks tipe data

Indeks yang ditentukan pengguna belum didukung.

qanda-defaultlabel
Brief. Menyetel default untuk label default pada QandASet.

Default pengaturan.

Jika tidak ada atribut defaultlabel yang ditentukan pada QandASet, nilai ini akan digunakan. Dia
harus menjadi salah satu nilai legal untuk atribut defaultlabel.

qandaset-menghasilkan-toc
Brief. Apakah Daftar Isi dibuat untuk QandASets?

Default pengaturan.

Jika benar, ToC dibuat untuk QandASets.

CONTOH

$ docbook2x-texi tdg.xml
$ docbook2x-texi --encoding=utf-8//TRANSLIT tdg.xml
$ docbook2x-texi --string-param semantik-dekorasi=0 tdg.xml
.fi

KONVERSI PROSES

Konversi untuk Info Teks
Dokumen DocBook dikonversi ke Texinfo dalam dua langkah:

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

Texi-XML lebih sederhana daripada DocBook dan lebih mendekati format Texinfo; itu dimaksudkan untuk
membuat pekerjaan stylesheet lebih mudah.

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

http://docbook2x.sourceforge.net/latest/xslt/texi/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/texi/docbook.xsl.

2. Texi-XML dikonversi ke file Texinfo yang sebenarnya dengan db2x_texixml(1).

Grafik docbook2x-texi 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 -s teks dok saya.xml -o dok saya.txml
$ db2x_texixml dok saya.txml
.fi

Opsi untuk lembar gaya konversi dijelaskan
di lembar gaya Texinfo
referensi.

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-texi online menggunakan layanan onworks.net