doclifter - Online di Cloud

PROGRAM:

NAMA

doclifter - terjemahkan permintaan troff ke dalam DocBook

RINGKASAN

dokter angkat kaki [-e encoding] [-H file petunjuk] [-q] [-x] [-v] [-w] [-V] [-D token=ketik] [-SAYA path]
[-SAYA path] fillet...

DESKRIPSI

dokter angkat kaki menerjemahkan dokumen yang ditulis dalam makro troff ke DocBook. Subset struktural dari
permintaan di pria(7) mdoc(7) ms(7) me(7) mm(7), dan troff(1) didukung.

Terjemahan membawa seluruh struktur dokumen asli di bagian,
subbagian, dan tingkat paragraf. Sinopsis fungsi Command dan C diterjemahkan menjadi
Markup DocBook, bukan hanya tampilan kata demi kata. Tabel (markup TBL) diterjemahkan menjadi
Markup tabel DocBook. Diagram PIC diterjemahkan ke dalam SVG. Informasi tingkat troff yang
mungkin memiliki implikasi struktural dipertahankan dalam komentar XML.

Jika memungkinkan, makro perubahan font diterjemahkan ke dalam markup struktural. dokter angkat kaki
mengenali pola stereotip markup dan konten (seperti penggunaan huruf miring dalam a
FILES untuk menandai nama file) dan mengangkatnya. Sarana untuk mengedit, menambah, dan menyimpan semantik
petunjuk tentang penyorotan didukung.

Beberapa klise dikenali dan diangkat ke markup struktural bahkan tanpa penyorotan.
Pola yang dikenali mencakup hal-hal seperti URL, alamat email, referensi halaman manual, dan
daftar program C.

labelnya . The dan .ti permintaan dilewatkan dengan keluhan. Mereka menunjukkan
markup tingkat presentasi yang dokter angkat kaki tidak dapat diterjemahkan ke dalam struktur; keluaran akan
membutuhkan pemasangan tangan.

labelnya .ta diteruskan dengan keluhan kecuali jika segera diikuti oleh teks
baris berisi tab, dalam hal ini rentang baris berikut yang berisi tab diangkat
ke meja.

Dalam kondisi tertentu, dokter angkat kaki bahkan dapat mengangkat halaman manual dan teks yang diformat
keluaran yang dihasilkan oleh lynx(1) dari HTML. Jika tidak menemukan makro di input, tetapi menemukan a
Header bagian NAME, mencoba menafsirkan teks biasa sebagai halaman manual (melewati
header dan footer boilerplate dihasilkan oleh lynx(1)). Terjemahan diproduksi dengan cara ini
akan cenderung kehilangan fitur struktural, tetapi fallback ini cukup baik untuk pria sederhana
halaman.

dokter angkat kaki tidak melakukan pekerjaan yang sempurna, hanya pekerjaan yang sangat bagus. Poles akhir seharusnya
diterapkan oleh manusia yang mampu mengenali pola yang terlalu halus untuk komputer. Tetapi
dokter angkat kaki akan hampir selalu menghasilkan terjemahan yang cukup baik untuk digunakan sebelumnya
peretasan tangan.

Lihat bagian Pemecahan Masalah untuk diskusi tentang cara mengatasi konversi dokumen
masalah.

PILIHAN

Jika dipanggil tanpa argumen dokter angkat kaki bertindak sebagai filter, menerjemahkan input sumber troff pada
input standar ke markup DocBook pada output standar. Jika dipanggil dengan argumen, masing-masing
file argumen diterjemahkan secara terpisah (tetapi petunjuk dipertahankan, lihat di bawah); akhiran
.xml diberikan ke output yang diterjemahkan.

-h
Beri nama file tempat informasi tentang petunjuk semantik yang dikumpulkan selama analisis harus
tertulis.

-D
-D memungkinkan Anda untuk mengirim petunjuk. Ini mungkin berguna, misalnya, jika dokter angkat kaki is
salah mengurai sinopsis karena tidak mengenali token sebagai perintah. Petunjuk ini adalah
digabungkan setelah petunjuk dalam sumber input telah dibaca.

-I
-I opsi menambahkan argumennya ke jalur sertakan yang digunakan saat docfilter mencari
inklusi. Jalur sertakan awalnya hanya direktori saat ini.

-e
-e memungkinkan Anda untuk mengatur bidang pengkodean yang akan dipancarkan dalam XML keluaran. Dia
default ke ISO-8859-1 (Latin-1).

-q
Biasanya, permintaan itu dokter angkat kaki tidak bisa menafsirkan (biasanya karena mereka
tingkat presentasi) diteruskan ke komentar XML dalam output. Opsi -q
menekan ini. Itu juga menekan daftar makro. Pesan tentang permintaan yang
tidak dikenali atau tidak dapat diterjemahkan ke kesalahan standar apa pun keadaannya
pilihan ini. Opsi ini dimaksudkan untuk mengurangi kekacauan saat Anda yakin memiliki a
angkat bersih dokumen dan ingin kehilangan warisan troff.

-x
Opsi -x meminta itu dokter angkat kaki dihasilkan DocBook versi 5 xml yang kompatibel
konten, daripada keluaran default DocBook versi 4.4. Inklusi dan entitas
mungkin tidak ditangani dengan benar dengan sakelar ini diaktifkan.

-v
Opsi -v membuat dokter angkat kaki ribut tentang apa yang dilakukannya. Ini terutama berguna untuk
debug.

-w
Aktifkan pemeriksaan portabilitas yang ketat. Beberapa contoh -w meningkatkan keketatan.
Lihat bagian yang disebut “PEMERIKSAAN PORTABILITAS”.

-V
Dengan opsi ini, program mengeluarkan pesan versi dan keluar.

TRANSLATION ATURAN

Secara keseluruhan, Anda dapat mengharapkan bahwa perubahan font akan diubah menjadi makro Penekanan dengan Remap
atribut yang diambil dari nama font troff. Nama font dasar adalah R, I, B, U, CW, dan SM.

Troff dan karakter khusus paket makro yang lolos dipetakan ke dalam entitas karakter ISO.

Ketika dokter angkat kaki bertemu dengan .begitu direktif, ia mencari file. Jika bisa dibaca
akses ke file, dan buka, dan file seluruhnya terdiri dari baris perintah dan
komentar, maka itu disertakan. Jika salah satu dari kondisi ini gagal, referensi entitas untuk
itu dihasilkan.

dokter angkat kaki melakukan penguraian khusus ketika mengenali tampilan seperti yang dihasilkan oleh
.DS/.DE. Itu berulang kali mencoba mengurai dulu sinopsis fungsi, dan kemudian teks biasa mati
apa yang tersisa di layar. Dengan demikian, sebagian besar prototipe fungsi C inline akan diangkat ke
markup terstruktur.

Beberapa catatan tentang terjemahan tertentu:

Pria Terjemahan
dokter angkat kaki melakukan pekerjaan dengan baik di sebagian besar halaman manual, Ia tahu tentang perpanjangan UR/UE/UN dan URL
permintaan yang didukung di Linux. Jika ada .UR permintaan hadir, itu akan menerjemahkan ini tetapi
tidak membungkus URL di luarnya dengan tag Ulink. Ia juga tahu tentang perpanjangan .L (harfiah)
markup font dari Bell Labs Versi 8, dan teman-temannya.

.TH makro digunakan untuk menghasilkan bagian RefMeta. Jika ada, tanggal/sumber/manual
argumen (lihat pria(7)) dibungkus dalam pasangan tag RefMiscInfo dengan atribut kelas tersebut.
Perhatikan bahwa dokter angkat kaki tidak mengubah tanggal.

dokter angkat kaki melakukan penguraian khusus ketika mengenali bagian sinopsis. Itu berulang kali
mencoba mengurai dulu sinopsis fungsi, lalu sinopsis perintah, dan kemudian teks biasa mati
apa yang tersisa di bagian.

Makro man berikut diterjemahkan ke dalam tag penekanan dengan atribut remap: .B, .I,
.L, .DUA, .BR, .BL, .IB, .IR, .IL, .RB, .RI, .RL, .LB, .LI, .LR, .SB, .SM. Beberapa stereotip
pola yang melibatkan makro ini dikenali dan diubah menjadi markup semantik.

Makro berikut diterjemahkan ke dalam jeda paragraf: .LP, .pp, .P, .HP, Dan
bentuk argumen tunggal dari .AKU P.

Bentuk dua argumen dari .AKU P diterjemahkan baik sebagai VariableList (biasanya) atau
ItemizedList (jika tag adalah troff bullet atau karakter persegi).

Makro berikut diterjemahkan secara semantik: .NS,.SS, .TP, .UR, .EU, .PBB, .IX. Sebuah .PBB
telepon dulu .NS or .SS menetapkan ID untuk bagian baru.

\*R, \*(Tm, \*(lq, dan \*(rq simbol diterjemahkan.

Makro berikut (murni tingkat presentasi) diabaikan: .PD,.DT.

.RS/.ULANG makro diterjemahkan secara berbeda tergantung pada apakah mereka mendahului atau tidak
daftar markup. Kapan .RS terjadi sebelum .TP or .AKU P hasilnya adalah daftar bersarang. Sebaliknya,
itu .RS/.ULANG pair diterjemahkan ke dalam pasangan tag Blockquote.

.DS/.DARI bukan bagian dari set makro manusia yang didokumentasikan, tetapi dikenali karena muncul
dengan beberapa frekuensi pada halaman manual lama dari Unix lama.

Makro ekstensi tertentu yang awalnya didefinisikan di bawah Ultrix diterjemahkan secara struktural,
termasuk yang kadang-kadang muncul di halaman manual Linux dan lainnya
Unix sumber terbuka. .MANTAN/.ee (dan sinonimnya .Mantan/.Ee), .Ds/.De,

.NT/.NE, .PN, dan .NONA diterjemahkan secara struktural.

Makro ekstensi berikut yang digunakan oleh distribusi X juga dikenali dan
diterjemahkan secara struktural: .FD, .FN, .DI DALAM, .ZN, .hN, dan .C{/.C} .TA dan .DI DALAM permintaan adalah
diabaikan.

Saat makro pria aktif, apa saja .pp definisi makro yang berisi permintaan .pp akan
diabaikan. dan semua contoh dari .pp digantikan dengan .pp. Demikian pula, .Tp akan diganti
dengan .TP. Ini adalah cara yang paling tidak menyakitkan untuk menghadapi beberapa yang sering ditemui
definisi pembungkus stereotip yang sebaliknya akan menyebabkan masalah interpretasi yang serius

Area masalah yang diketahui dengan terjemahan man:

· Penggunaan yang aneh dari .TP. Ini terkadang akan menghasilkan XML yang tidak valid dan terkadang menghasilkan a
Komentar FIXME dalam XML yang dihasilkan (pesan peringatan juga akan masuk ke kesalahan standar).

· Dapat diperdebatkan bagaimana pria itu makro .HP dan .AKU P tanpa tag harus diterjemahkan. Kita
memperlakukan mereka sebagai istirahat paragraf biasa. Kita bisa secara visual mensimulasikan gantung
paragraf dengan markup daftar, tetapi ini bukan terjemahan struktural.

Pod2man Terjemahan
dokter angkat kaki mengenali makro ekstensi yang dihasilkan oleh pod2man (.NS, .sp, .Aku p, .Vb, .Ve)
dan menerjemahkannya secara struktural.

Hasil mengangkat halaman yang dihasilkan oleh pod2man harus diperiksa dengan cermat oleh bola mata,
terutama rendering sinopsis perintah dan fungsi. Pod2man menghasilkan bukan
markup sesat; dokter angkat kakiPerjuangan untuk mengurainya terkadang sia-sia.

Jika memungkinkan, buat DocBook Anda dari sumber POD. Ada modul pod2docbook aktif
CPAN yang melakukan ini.

Tkman Terjemahan
dokter angkat kaki mengenali makro ekstensi yang digunakan oleh sistem dokumentasi Tcl/Tk: .AP,
.SEBAGAI, .BS, .MENJADI, .CS, .CE, .DS, .DARI, .JADI, .SE, .UL, .VS, .PERGILAH. itu .AP, .CS, .CE, .JADI, .SE,
.UL, .QW dan .PQ makro diterjemahkan secara struktural.

Mandok Terjemahan
dokter angkat kaki harus dapat melakukan pekerjaan yang sangat baik pada sebagian besar mdoc(7) halaman, karena makro ini
paket mengekspresikan banyak struktur semantik.

Masalah yang diketahui dengan terjemahan mandoc: Semua .Bd/.Ed blok tampilan diterjemahkan sebagai
Pasangan tag LiteralLayout .

Ms Terjemahan
dokter angkat kaki melakukan pekerjaan dengan baik di sebagian besar halaman ms. Satu titik lemah yang harus diwaspadai adalah
pembuatan tag Penulis dan Afiliasi. Heuristik yang digunakan untuk menambang informasi ini
dari .AU bagian bekerja untuk penulis yang memformat nama mereka dengan cara biasa untuk
Inggris (misalnya "ME Lesk", "Eric S. Raymond") tetapi cukup rapuh.

Agar dokumen dikenali sebagai berisi markup ms, dokumen tersebut harus memiliki ekstensi .ms.
Ini menghindari masalah dengan positif palsu.

.TL, .AU, .AI, dan .AE makro berubah menjadi metainformasi artikel dengan cara yang diharapkan.
.pp, .LP, .NS, dan .NH makro berubah menjadi paragraf dan struktur bagian. yang ditandai
bentuk .AKU P diterjemahkan sebagai VariableList (biasanya) atau ItemizedList (jika tag
adalah troff bullet atau karakter persegi); versi yang tidak ditandai diperlakukan seperti biasa
jeda paragraf.

.DS/.DARI pair diterjemahkan ke pasangan tag LiteralLayout . NS .FS/.FE pasangan adalah
diterjemahkan ke pasangan tag Catatan Kaki. NS .QP/.QS/.QE permintaan mendefinisikan BlockQuotes.

.UL perubahan font dipetakan ke U. .SM dan .LG menjadi langkah ukuran plus atau minus numerik
ditambahkan ke atribut Remap.

.B1 dan .B2 makro kotak diterjemahkan ke pasangan tag Sidebar.

Semua makro yang terkait dengan footer halaman, mode multikolom, dan penyimpanan diabaikan (.ND, .DI SANA,
1C, 2C, .MC, .BX, .KS, .KE, .KF). Itu .R, .RS, dan .ULANG makro juga diabaikan.

Me Terjemahan
Penerjemahan dokumen saya cenderung menghasilkan hasil kasar yang membutuhkan banyak
peretasan tangan. Formatnya memiliki sedikit struktur yang dapat digunakan, dan dokumen yang tertulis di dalamnya cenderung
gunakan banyak makro troff tingkat rendah; kedua sifat ini cenderung membingungkan dokter angkat kaki.

Agar dokumen dikenali mengandung markup saya, dokumen tersebut harus memiliki ekstensi .me.
Ini menghindari masalah dengan positif palsu.

Makro berikut diterjemahkan ke dalam jeda paragraf: .lp, .pp. itu .aku p makro adalah
diterjemahkan ke dalam Daftar Variabel. NS .bp makro diterjemahkan ke dalam ItemizedList. NS .np
makro diterjemahkan ke dalam OrderedList.

Font b, i, dan r dipetakan ke tag penekanan dengan atribut B, I, dan R Remap. NS
.rb ("nyata tebal") font diperlakukan sama dengan .b.

.Q(/.Q) diterjemahkan secara struktural.

Sebagian besar permintaan lainnya diabaikan.

Mm Terjemahan
Dokumen Memorandum Macro diterjemahkan dengan baik, karena makro ini membawa banyak struktur
informasi. Aturan terjemahan disesuaikan untuk gaya Memorandum atau Rilis Kertas;
informasi yang terkait dengan gaya huruf eksternal akan disimpan dalam komentar.

Agar dokumen dikenali mengandung markup mm, dokumen tersebut harus memiliki ekstensi .mm.
Ini menghindari masalah dengan positif palsu.

Makro sorotan berikut diterjemahkan ke dalam tag Penekanan: .B, .I, .R, .DUA, .BR,
.IB, .IR, .RB, .RI.

Makro berikut diterjemahkan secara struktural: .AE, .AF, .AL, .RL, .APLIKASI, .APPSK, .SEBAGAI,
.PADA, .AU, .B1, .B2, .MENJADI, .BL, .ML, .BS, .BVL, .VL, .DARI, .DL .DS, .FE, .FS, .H, .HU, .IA,
.YAITU, .IND, .LB, .LC, .LE, .LI, .P, .RF, .SM, .TL, .VERBOFF, .VERBON, .WA, .KAMI.

Makro berikut diabaikan:

.)E, 1C, 2C, .AST, .AV, .AVL, .MENUTUPI, .COVEND, .EF, .EH, .EDP, .EPIK, .FC, .FD, .HC,
.HM, .GETR, .DAPATKAN, .HM, .INITI, .INITR, .INDP, .ISODATE, .MT, .NS, .ND, .DARI, .OH, .OP,
.PGFORM, .PGNH, .PE, .PF, .PH, .RP, .S, .SA, .SP, .SG, .SK, .TAB, .TB, .TC, .VM, .TOILET.

Makro berikut menghasilkan peringatan: .EC, .MANTAN, .FG, .GETHN, .GETPN, .GETR, .DAPATKAN, .LT,
.LD, .LO, .PINDAH, .MULB, .MULN, .BAGAL, .NCOL, .nP, .PIC, .RD, .RS, .ULANG, .SETR

.BS/.MENJADI dan .IA/.YAITU pasangan dilewatkan. Teks di dalamnya mungkin perlu dihapus
atau dipindahkan.

Argumen tanda dari .ML diabaikan; daftar id berikut diformat seperti biasa
Daftar Item.

Isi dari .DS/.DARI or .DF/.DARI akan berubah menjadi tampilan Layar. Argumen
mengontrol pemformatan tingkat presentasi diabaikan.

wkwk Terjemahan
Makro mwww adalah perpanjangan dari makro man yang didukung oleh kasar(1) untuk memproduksi web
halaman.

URL, FTP, MINYAK, FTP, IMAGE, MENANDAI tag diterjemahkan secara struktural. NS HTMLINDEX,
WARNA TUBUH, LATAR BELAKANG, HTML, dan GARIS tag diabaikan.

TBL Terjemahan
Semua fitur struktural tabel TBL diterjemahkan, termasuk horizontal dan
rentang vertikal dengan 's' dan '^'. Format 'l', 'r', dan 'c' didukung; kemudian'
format kolom dirender sebagai 'r'. Kelanjutan baris dengan T{ dan T} ditangani dengan benar.
Begitu juga .TH.

memperluas, kotak, kotak ganda, kotak semua, pusat, meninggalkan, dan benar pilihan yang didukung. GNU
sinonim bingkai dan bingkai ganda juga diakui. Tapi perbedaan antara lajang dan
aturan ganda dan kotak hilang.

Kelanjutan tabel (.T&) tidak didukung.

Jika baris teks pertama yang tidak kosong tepat sebelum tabel dicetak tebal, itu adalah
diartikan sebagai judul untuk tabel dan tabel tersebut dihasilkan menggunakan tabel dan judul.
Jika tidak, tabel diterjemahkan dengan informaltable.

Sebagian besar perintah TBL tingkat presentasi lainnya diabaikan. Kualifikasi format 'b' adalah
diproses, tetapi penentu ukuran dan lebar titik tidak.

pic Terjemahan
Bagian PIC diterjemahkan ke SVG. doclifter memanggil gambar2plot(1) untuk mencapai
ini; Anda harus menginstal utilitas itu agar terjemahan PIC berfungsi.

persamaan Terjemahan
Bagian EQN difilter ke MathML yang disematkan dengan persamaan -TMathML jika memungkinkan, jika tidak
melewati terlampir dalam tag LiteralLayout. Setelah pernyataan delim terlihat,
pembatas eqn inline diterjemahkan ke dalam instruksi pemrosesan XML. Pengecualian: sebaris
persamaan eqn yang terdiri dari satu karakter diterjemahkan ke Penekanan dengan Peran
atribut eqn.

Trof Terjemahan
Terjemahan troff dimaksudkan hanya untuk mendukung interpretasi set makro. Bukan itu
mandiri yang bermanfaat.

.nf dan .fi makro ditafsirkan sebagai batas tata letak literal. Panggilan ke .begitu
makro menyebabkan penyertaan atau diterjemahkan ke dalam penyertaan entitas XML (lihat di atas).
Panggilan ke .ul dan .cu makro menyebabkan baris berikut dibungkus dalam tag Penekanan
dengan atribut Remap "U". Panggilan ke .ft menghasilkan penekanan awal atau akhir yang sesuai
tag. Panggilan ke .tr menyebabkan terjemahan karakter pada output. Panggilan ke .bp menghasilkan a
Tag BeginPage (hanya dalam teks berparagraf). Panggilan ke .sp menghasilkan jeda paragraf (dalam
teks berparagraf saja). Panggilan ke .ti bungkus baris berikut dalam BlockQuote Ini adalah
hanya permintaan troff yang kami terjemahkan ke DocBook. Emulasi troff lainnya ada
karena paket makro menggunakannya secara internal untuk memperluas makro menjadi elemen yang mungkin
struktural.

Permintaan yang berkaitan dengan definisi makro dan string (.ds, .sebagai, . De, .saya, .rm, .rn, .em) adalah
diproses dan diperluas. NS .aku g makro juga diproses.

Makro bersyarat (.jika, .yaitu, .el) ditangani. Kondisi bawaan o, n, t, e, dan c
dievaluasi seolah-olah untuk nroff pada halaman satu dokumen. m, d, dan r troff
kondisional juga ditafsirkan. Perbandingan string dievaluasi oleh tekstual lurus
perbandingan. Semua ekspresi numerik bernilai benar.

Permintaan groff yang diperpanjang cc, c2, ab, dari, do, tidak, dan kembali dan bergeser adalah
ditafsirkan. Nya .PSPIC ekstensi diterjemahkan ke dalam MediaObject.

.tm makro menulis argumennya ke kesalahan standar (dengan -t). Itu .sore laporan makro tentang
makro dan string yang ditentukan. Fasilitas ini dapat membantu dalam men-debug terjemahan Anda.

Beberapa urutan pelarian troff diangkat:

1. Pelarian \e dan \\ menjadi garis miring terbalik, \. titik, dan \- tanda hubung.

2. Troff lolos \^, \`, \' \&, \0, dan \| diangkat ke ISO khusus yang setara
karakter spasi.

3. A \ diikuti oleh spasi diterjemahkan ke entitas ruang non-breaking ISO.

4. A \~ juga diterjemahkan ke entitas ruang non-breaking ISO; benar ini harus menjadi
ruang yang tidak bisa digunakan untuk linebreak tetapi membentang seperti whitespace biasa selama
penyesuaian baris, tetapi tidak ada entitas ISO atau Unicode untuk itu.

5. Gerakan vertikal setengah garis \u dan \d lolos, ketika dipasangkan, menjadi
yg ditulis di atas or tanda tangan tag.

6. Pelarian \c ditangani sebagai kelanjutan baris. dalam keadaan di mana itu penting
(misalnya untuk token-paste).

7. Pelarian \f untuk perubahan font diterjemahkan dalam berbagai cara yang bergantung pada konteks. Pertama,
dokter angkat kaki mencari klise yang melibatkan perubahan font yang memiliki makna semantik, dan
mengangkat ke tag struktural. Jika tidak bisa melakukan itu, itu menghasilkan tag Penekanan.

8. Ekstensi \m[] diterjemahkan ke dalam rentang frasa dengan atribut remap yang membawa
warna. Catatan: Stylesheet biasanya tidak akan merender ini!

9. Beberapa penggunaan permintaan \o diterjemahkan: berpasangan dengan huruf diikuti oleh salah satu dari
karakter ` ' : ^ o ~ diterjemahkan untuk menggabungkan bentuk dengan diakritik akut,
kuburan, umlaut, sirkumfleksa, cincin, dan tilde masing-masing jika sesuai Latin-1
atau karakter Latin-2 ada sebagai literal ISO.

Pelarian lain selain ini akan menghasilkan peringatan atau kesalahan.

Semua permintaan troff lainnya diabaikan tetapi diteruskan ke komentar XML. Beberapa (seperti
.ini) juga memicu pesan peringatan.

KEMAMPUAN MEMERIKSA

Saat pemeriksaan portabilitas diaktifkan, dokter angkat kaki memancarkan peringatan portabilitas tentang markup
yang dapat ditanganinya tetapi yang akan menghancurkan berbagai pemirsa dan juru bahasa lainnya.

1. Pada level 1, ia akan memperingatkan tentang konstruksi yang akan rusak man2html(1), (C
program yang didistribusikan dengan Linux pria(1), bukan Perl . yang lebih tua dan kurang mampu
naskah). Turunan dekat dari kode ini digunakan di GNOME yelp. Ini harus menjadi
tingkat portabilitas minimum yang Anda tuju, dan sesuai dengan apa yang direkomendasikan di
itu groff_man(7) halaman manual.

2. Pada level 2, ia akan memperingatkan tentang konstruksi yang akan merusak portabilitas kembali ke
Alat klasik Unix (termasuk nama makro panjang dan referensi mesin terbang dengan \[]).

SEMANTIK ANALISIS

dokter angkat kaki menyimpan dua daftar petunjuk semantik yang diambil dari menganalisis sumber
dokumen (terutama dari perintah parsing dan sinopsis fungsi). Daftar lokal
meliputi:

· Nama-nama fungsi argumen formal

· Nama opsi perintah

Petunjuk lokal digunakan untuk menandai halaman individual tempat mereka dikumpulkan. NS
daftar global meliputi:

· Nama-nama fungsi

· Nama-nama perintah

· Nama tipe pengembalian fungsi

If dokter angkat kaki diterapkan ke beberapa file, daftar global disimpan dalam memori. Kamu bisa
membuang laporan petunjuk global di akhir proses dengan -h pilihan. Format dari
petunjuknya adalah sebagai berikut:

.\" | tandai sebagai

dimana adalah item teks dan adalah teks markup DocBook yang seharusnya
dibungkus dengan kapan pun itu muncul baik disorot atau sebagai kata yang dikelilingi oleh spasi putih
dalam teks sumber.

Petunjuk yang berasal dari file sebelumnya juga diterapkan ke file yang lebih baru. Perilaku ini mungkin
berguna saat mengangkat koleksi dokumen yang berlaku untuk pustaka fungsi atau perintah.
Apa yang seharusnya lebih berguna adalah fakta bahwa file petunjuk dibuang dengan -h bisa menjadi salah satunya
mengajukan argumen ke dokter angkat kaki; kode mendeteksi kasus khusus ini dan tidak menulis XML
output untuk file seperti itu. Jadi, prosedur yang baik untuk mengangkat perpustakaan besar adalah dengan menghasilkan
file petunjuk dengan menjalankan pertama, memeriksanya untuk menghapus positif palsu, dan menggunakannya sebagai
input pertama ke putaran kedua.

Dimungkinkan juga untuk menyertakan file petunjuk secara langsung dalam file sumber troff. Ini mungkin
berguna jika Anda ingin memperkaya file secara bertahap sebelum mengonversi ke XML.

PEMECAHAN MASALAH

dokter angkat kaki mencoba memperingatkan tentang masalah yang dapat didiagnosis tetapi tidak dapat diperbaiki dengan sendirinya.
Ketika dikatakan "cari FIXME", lakukan itu di XML yang dihasilkan; markup di sekitar token itu
mungkin salah.

Kadang-kadang (kurang dari 2% dari waktu) dokter angkat kaki akan menghasilkan markup DocBook yang tidak valid bahkan
dari markup troff yang benar. Biasanya ini hasil dari konstruksi aneh di sumbernya
halaman, atau panggilan makro yang berada di luar kemampuan dokter angkat kakiprosesor makro untuk mendapatkan
Baik. Berikut beberapa hal yang harus diperhatikan, dan cara memperbaikinya:

Salah format Command sinopsis.
Jika Anda mendapatkan pesan yang mengatakan "command synopsis parse failed", coba tulis ulang sinopsisnya
di sumber halaman manual Anda. Penyebab kegagalan yang paling umum adalah pengelompokan [] yang tidak seimbang, a
bug yang bisa sangat sulit untuk diperhatikan oleh bola mata. Untuk membantu dengan ini, kesalahan
pesan menyertakan nomor token dalam tanda kurung yang menunjukkan token mana yang gagal diurai.

Untuk informasi lebih lanjut, gunakan opsi -v. Ini akan memicu dump yang memberi tahu Anda apa yang
sinopsis perintah tampak seperti setelah pra-pemrosesan, dan tunjukkan token mana yang diurai
gagal (baik dengan nomor token dan tanda sisipan disisipkan di tumpukan sinopsis
token). Coba tulis ulang sinopsis di sumber halaman manual Anda. Penyebab paling umum dari
kegagalan adalah pengelompokan yang tidak seimbang [], bug yang bisa sangat sulit diperhatikan oleh bola mata.
Untuk membantu dengan ini, dump token kesalahan mencoba memasukkan '$' pada titik terakhir
peningkatan kedalaman bersarang, tetapi kode yang melakukan ini rawan kegagalan.

Membingungkan makro panggilan.
Beberapa penulis halaman manual menggantikan permintaan standar (seperti .pp, .NS dan .TP) dengan versi
yang melakukan hal yang berbeda di tidak dan troff lingkungan. Ketika dokter angkat kaki mencoba untuk mengatasinya
dan biasanya melakukan pekerjaan dengan baik, kebiasaan [nt]roff sangat banyak dan panggilan makro yang membingungkan
terkadang menghasilkan XML yang buruk. Gejala umum dari masalah seperti itu tidak tertutup
Penekanan tag.

Salah format daftar sintaks.
Pengurai halaman manual dapat dikacaukan oleh .TP konstruksi yang memiliki tag header tetapi tidak ada
tubuh berikut. Jika XML yang dihasilkan tidak memvalidasi, dan masalahnya tampaknya adalah:
tag listitem salah tempat, coba gunakan opsi verbose (-v). Ini akan mengaktifkan nomor baris
peringatan yang dapat membantu Anda mengatasi masalah tersebut.

Bagian bersarang masalah dengan SS.
Pesan "kemungkinan kesalahan bersarang bagian" berarti bahwa program telah melihat dua yang berdekatan
judul subbagian. Di halaman manual, subbagian tidak memiliki argumen yang mendalam, jadi dokter angkat kaki
tidak dapat memastikan bagaimana subbagian harus disarangkan. Setiap judul subbagian di antara
garis yang ditunjukkan dan awal dari bagian tingkat atas berikutnya mungkin salah dan memerlukan
mengoreksi dengan tangan.

Buruk keluaran dengan tidak dokter angkat kaki kesalahan pesan
Jika Anda menerjemahkan halaman yang menggunakan makro yang ditentukan pengguna, dan doclifter gagal untuk
mengeluh tentang hal itu tetapi Anda mendapatkan hasil yang buruk, hal pertama yang harus dilakukan adalah menyederhanakan atau menghilangkan
makro yang ditentukan pengguna. Ganti dengan permintaan stok jika memungkinkan.

MENINGKATKAN TRANSLATION KUALITAS

Ada beberapa konstruksi yang merupakan ide bagus untuk diperiksa dengan tangan setelah mengangkat halaman.

Lihat di dekat tag BlockQuote. Permintaan indentasi sementara troff (.ti) diterjemahkan menjadi
pembungkus BlockQuote di sekitar baris berikut. Terkadang LiteralLayout atau ProgramListing
akan menjadi terjemahan yang lebih baik, tapi dokter angkat kaki tidak memiliki cara untuk mengetahui hal ini.

Tidak mungkin untuk secara jelas mendeteksi kandidat untuk membungkus tag opsi DocBook
dalam menjalankan teks. Jika Anda peduli, Anda harus memeriksanya dan memperbaikinya dengan tangan.

Gunakan doclifter online menggunakan layanan onworks.net