hypertocp - Online di Cloud

PROGRAM:

NAMA

hypertoc - menghasilkan daftar isi untuk dokumen HTML

VERSION

versi 3.20

RINGKASAN

hypertoc --help | --halaman manual | --man_help | --manusia

hipertok [--bak tali ] [ --debug ] [ --entrysep tali ] [ --footer fillet ] [ --tajuk
fillet ] [ --ignore_only_one ] [ --ignore_sole_first ] [ --inline ] [ --make_anchors ] [
--make_toc ] [ --notoc_match tali ] [ --ol | --nool ] [ --ol_num_levels ] [ --file keluar
fillet ] [ --overwrite] [ --quiet ] [ --textonly ] [ --title tali ] { --toc_after
tag = akhiran } { --toc_sebelumnya tag = awalan } { --toc_end tag = tag akhir } { --toc_entry tag=tingkat
} [ --toc_label tali ] [ --toc_only | --notoc_only ] [ --toc_tag tali ] [
--toc_tag_replace ] [ --use_id ] [ --useorg ] berkas ...

DESKRIPSI

hypertoc memungkinkan Anda untuk menentukan "elemen penting" yang akan di-hyperlink ke dalam a
"Daftar Isi" (ToC) untuk kumpulan dokumen HTML tertentu.

Pada dasarnya, ToC yang dihasilkan adalah daftar level multi-level yang berisi tautan ke
elemen penting. hypertoc menyisipkan tautan ke ToC ke elemen penting di a
tingkat yang ditentukan oleh pengguna.

Contoh:

Jika H1 ditetapkan sebagai level 1, maka HXNUMX akan muncul di daftar level pertama ToC. Jika
H2 ditentukan sebagai level 2, daripada yang muncul di daftar level kedua di ToC.

Ada dua aspek untuk generasi ToC: (1) menempatkan jangkar yang sesuai ke dalam HTML
dokumen (--make_anchors), dan (2) menghasilkan ToC dari dokumen HTML yang memiliki
jangkar di dalamnya agar ToC dapat ditautkan (--make_toc). Seseorang dapat memilih untuk melakukan salah satu atau keduanya
Ini.

hypertoc juga mendukung kemampuan untuk memasukkan ToC ke dalam dokumen HTML itu sendiri
melalui opsi --inline.

Agar hypertoc mendukung penautan ke elemen penting, hypertoc menyisipkan jangkar
ke dalam elemen penting. Seseorang dapat menggunakan hypertoc sebagai filter, mengeluarkan hasilnya ke
file lain, atau seseorang dapat menimpa file asli, dengan yang asli dicadangkan dengan a
akhiran (default: "org") ditambahkan ke nama file.

Seseorang juga dapat menentukan opsi dalam file konfigurasi serta pada baris perintah.

PILIHAN

Opsi dapat dimulai dengan "--" atau "-"; opsi boolean dapat dinegasikan dengan mendahuluinya dengan
"tidak"; opsi dengan nilai hash atau array dapat ditambahkan dengan memberikan opsi lagi untuk
setiap nilai.

Lihat Getopt::Long untuk informasi lebih lanjut.

--argfile nama file
Nama file untuk membaca lebih banyak opsi. Ini dapat digunakan lebih dari sekali. Untuk
contoh:

--argfile milikmu.args --argfile my.args

Lihat "File Opsi" untuk informasi lebih lanjut.

--bak
--bak tali

Jika file/file input sedang/sedang ditimpa (--overwrite aktif), salin file
file asli ke "nama file.tali". Jika nilainya kosong, tidak ada file cadangan
tertulis. (bawaan: org)

--debug
Aktifkan keluaran debugging verbose. Digunakan untuk men-debug modul ini; dengan kata lain,
jangan repot-repot. (default: nonaktif)

--entrisep
--entrisep tali

String pemisah untuk non- entri item (default: ", ")

--catatan kaki
--catatan kaki fillet

File yang berisi teks footer untuk daftar isi.

--tajuk
--tajuk fillet

File yang berisi teks header untuk daftar isi.

--membantu
Cetak pesan bantuan singkat dan keluar.

--abaikan_hanya_satu
Jika hanya ada satu item di ToC, jangan buat ToC.

--abaikan_satu-satunya_pertama
Jika item pertama di ToC adalah level tertinggi, DAN itu adalah satu-satunya
tingkat, abaikan saja. Ini berguna di halaman web di mana hanya ada satu header H1 tetapi
orang tidak tahu sebelumnya apakah hanya akan ada satu.

--Di barisan
Masukkan ToC ke dalam dokumen pada titik tertentu. Lihat "Menyejajarkan ToC" untuk informasi lebih lanjut.

--membuat_anchors | --gen_anchors
Buat jangkar untuk ditautkan ke daftar isi.

--membuat_toc | --gen_toc
Buat Daftar Isi yang menautkan ke elemen penting yang ditambatkan.

--man_help | --halaman manual | --manusia
Cetak semua dokumentasi dan keluar.

--notoc_match
--notoc_match tali

Jika ada tag individu tertentu yang tidak ingin Anda sertakan dalam tabel
isinya, meskipun mereka cocok dengan "elemen penting", maka jika pola ini
cocok dengan isi di dalam tag (bukan isi), maka tag itu tidak akan disertakan,
baik dalam menghasilkan jangkar maupun dalam menghasilkan ToC. (default: kelas = "notoc")

--ol | --nool
Gunakan daftar berurutan untuk entri Daftar Isi (sampai kedalaman tertentu). Jika --ol adalah
false (yaitu --nool disetel) lalu tidak gunakan daftar berurutan untuk entri ToC.

(default: salah)

(Lihat --ol_num_levels untuk menentukan seberapa dalam daftar daftar pesanan berjalan)

--ol_num_levels
Jumlah level dalam daftar OL akan pergi jika --ol benar. Jika diatur ke nol,
akan menggunakan daftar yang dipesan untuk semua level. (bawaan: 1)

--file keluar
--file keluar fillet

File untuk menulis output. Di sinilah output HTML yang dimodifikasi dan Table-of-
Isi pergi ke. Jika Anda memberikan '-' sebagai nama file, maka output akan masuk ke STDOUT.
(bawaan: STDOUT)

--timpa
Timpa file input dengan output. Jika ini berlaku, --outfile diabaikan.
Digunakan dalam menghasilkan_jangkar untuk membuat jangkar "di tempat" dan di hasil_toc if
opsi --inline sedang berlaku. (default: nonaktif)

--diam
Menekan pesan informatif. (default: mati)

--teks saja
Gunakan hanya konten teks dalam elemen penting.

--judul
--judul tali

Judul untuk halaman ToC (jika tidak menggunakan --header atau --inline atau --toc_only) (default: "Tabel
Isi")

--toc_after
--toc_after label=akhiran

--toc_after "H2= "

Untuk menentukan tata letak elemen penting dalam ToC. Itu label adalah tag HTML yang
menandai awal dari elemen. Itu akhiran adalah apa yang diperlukan untuk ditambahkan ke
Entri Daftar Isi dibuat untuk tag tersebut. Ini adalah argumen hash kumulatif.
(default: tidak ditentukan)

--toc_sebelumnya
--toc_sebelumnya label=awalan

--toc_before "H2= "

Untuk menentukan tata letak elemen penting dalam ToC. Itu label adalah tag HTML
yang menandai awal dari elemen. Itu awalan adalah apa yang diperlukan untuk didahului
ke entri Daftar Isi yang dihasilkan untuk tag itu. Ini adalah hash kumulatif
argumen. (default: tidak ditentukan)

--toc_end
--toc_end label=tanda akhir

--toc_end "H1=/H1"

Untuk menentukan elemen penting. Itu label adalah tag HTML yang menandai awal dari
elemen. Itu tanda akhir tag HTML yang menandai akhir elemen. Kapan
cocok dalam file input, huruf besar/kecil diabaikan (tetapi pastikan bahwa semua label Pilihan
mengacu pada tag yang sama persis sama!). Ini adalah argumen hash kumulatif.
(standar: H1=/H1 H2=/H2)

--toc_entry
--toc_entry label=tingkat

--toc_entry "TITLE=1" --toc_entry "H1=2"

Untuk menentukan elemen penting. Itu label adalah tag HTML yang menandai awal dari
elemen. Itu tingkat adalah level apa yang dianggap sebagai tag. Nilai dari tingkat
harus numerik, dan bukan nol. Jika nilainya negatif, entri berturut-turut
diwakili oleh elemen_signifikan akan dipisahkan oleh nilai yang ditetapkan oleh
--entrysep pilihan. Ini adalah argumen hash kumulatif. (default: H1=1 H2=2)

--toc_label | --toklabel
--toc_label tali

Teks HTML yang melabeli ToC. Selalu digunakan. (bawaan: " Daftar isi ")

--toc_hanya | --notoc_only
Keluarkan hanya Daftar Isi, yaitu Daftar Isi ditambah toc_label.
Jika ada --header atau --footer, ini juga akan menjadi output.

Jika --toc_only salah (yaitu --notoc_only disetel) maka jika tidak ada --header, dan
--inline tidak benar, maka header halaman HTML yang sesuai akan ditampilkan, dan jika ada
tidak --footer dan --inline tidak benar, maka footer halaman HTML akan ditampilkan.
(default:--notoc_only)

--toc_tag
--toc_tag tali

Jika ToC akan dimasukkan sebaris, ini adalah pola yang digunakan untuk mencocokkan tag
di mana ToC harus diletakkan. Ini bisa berupa tag awal, tag akhir, atau komentar, tetapi
< harus ditinggalkan; yaitu, jika Anda ingin ToC ditempatkan setelah BODY
tag, lalu beri "BODY". Jika Anda ingin tag komentar khusus dibuat di mana ToC seharusnya
go, lalu sertakan tanda komentar, misalnya: "!--toc--" (default:BODY)

--toc_tag_ganti
Dalam hubungannya dengan --toc_tag, ini adalah tanda untuk mengatakan apakah tag yang diberikan harus
diganti, atau jika ToC harus diletakkan setelah tag. Ini bisa berguna jika Anda
toc_tag adalah komentar dan Anda tidak memerlukannya setelah ToC terpasang.
(default: salah)

--use_id
Gunakan id="nama" untuk jangkar daripadanama"> jangkar. Namun jika jangkar
sudah ada untuk Elemen Penting, ini tidak akan membuat ID untuk itu
elemen.

--useorg
Gunakan file cadangan yang sudah ada sebelumnya sebagai sumber input; yaitu, file formulir
nama file.bak (lihat --bak).

FILE FORMAT

Opsi File
Opsi dapat diberikan dalam file maupun pada baris perintah dengan menggunakan --argfile
nama file pilihan di baris perintah. Juga, file ~/.hipertokrc dan ./.hypertocrc adalah
diperiksa untuk opsi.

Formatnya adalah sebagai berikut: Baris yang dimulai dengan # adalah komentar. Garis tertutup dalam PoD
penanda juga komentar. Garis kosong diabaikan. Pilihannya sendiri seharusnya
mengingat cara mereka berada di baris perintah, yaitu, nama opsi (termasuk itu
--) diikuti dengan nilainya (jika ada).

Sebagai contoh:

# atur ToC menjadi tiga level
--toc_entry H1=1
--toc_entry H2=2
--toc_entry H3=3

--toc_end H1=/H1
--toc_end H2=/H2
--toc_end H3=/H3

File opsi dapat disarangkan, dengan memberikan --argfile nama file argumen di dalam opsi
file, itu akan pergi dan mendapatkan file yang dirujuk itu juga.

Lihat Getopt::ArgvFile untuk informasi lebih lanjut.

RINCIAN

Penting Elemen
Berikut adalah beberapa contoh mendefinisikan elemen penting untuk Daftar Isi Anda.

Contoh of Default

Berikut ini mencerminkan pengaturan default jika tidak ada yang ditentukan secara eksplisit:

--toc_entry "H1=1" --toc_end "H1=/H1" --toc_entry "H2=2" --toc_end "H2=/H2"

Atau, jika itu didefinisikan di salah satu "File Opsi" yang mungkin:

# pengaturan default
--toc_entry H1=1
--toc_end H1=/H1
--toc_entry H2=2
--toc_end H2=/H2

Contoh of sebelum setelah

Opsi berikut menggunakan opsi sebelum/sesudah:

# File opsi yang menambahkan beberapa pemformatan
# buat entri ToC level 1
--toc_entry H1=1
--toc_end H1=/H1
--toc_before H1=
--toc_after H1=

# buat entri ToC level 2
--toc_entry H2=2
--toc_end H2=/H2
--toc_before H2=
--toc_setelah H2=

# Buat entri level 3 apa adanya
--toc_entry H3=3
--toc_end H3=/H3

Contoh of adat akhir

Opsi berikut mencoba mengindeks istilah definisi:

# File opsi yang dapat berfungsi untuk dokumen jenis Glosarium
--toc_entry H1=1
--toc_end H1=/H1
--toc_entry H2=2
--toc_end H2=/H2

# Asumsikan dokumen memiliki DD untuk setiap DT, jika tidak, ToC
# akan mendapatkan entri dengan banyak teks.
--toc_entry DT=3
--toc_end DT=DD
--toc_before DT=
--toc_after DT=

format itu ToC
Opsi --toc_entry dll. memberi Anda kontrol tentang tampilan entri ToC, tetapi ada
adalah opsi lain untuk memengaruhi tampilan akhir file ToC yang dibuat.

Dengan opsi --header, konten file yang diberikan akan ditambahkan sebelum
ToC yang dihasilkan Ini memungkinkan Anda untuk memiliki teks pengantar, atau teks lainnya, sebelum
Daftar Isi

Catatan:
Jika Anda menggunakan opsi --header, pastikan file yang ditentukan berisi HTML pembuka
tag, elemen HEAD (berisi elemen TITLE), dan tag BODY pembuka.
Namun, tag/elemen ini tidak boleh ada di file header jika opsi --inline
digunakan. Lihat "Menyejajarkan ToC" untuk informasi tentang isi file header
untuk inlining ToC.

Dengan opsi --toc_label , isi string yang diberikan akan didahului sebelum
ToC yang dihasilkan (tetapi setelah teks apa pun diambil dari file --header).

Dengan opsi --footer, isi file akan ditambahkan setelah dihasilkan
Daftar Isi

Catatan:
Jika Anda menggunakan -footer, pastikan itu menyertakan tag BODY dan HTML penutup (kecuali,
tentu saja, Anda menggunakan opsi --inline).

Jika opsi --header tidak ditentukan, markup HTML awal yang sesuai adalah
ditambahkan, kecuali opsi --toc_only ditentukan. Jika opsi --footer tidak
ditentukan, markup HTML penutup yang sesuai akan ditambahkan, kecuali opsi --toc_only
ditentukan.

Jika Anda tidak ingin/perlu berurusan dengan file header, dan footer, maka Anda diperbolehkan untuk
tentukan judul, opsi --title, dari file ToC; dan memungkinkan Anda untuk menentukan
heading, atau label, untuk diletakkan sebelum daftar entri ToC, opsi --toc_label. Kedua opsi
memiliki nilai default, lihat "OPSI" untuk informasi lebih lanjut tentang setiap opsi.

Jika Anda tidak ingin tag halaman HTML diberikan, dan hanya menginginkan ToC itu sendiri, maka
tentukan opsi --toc_only. Jika tidak ada --header atau --footer file, maka ini akan
cukup keluarkan konten --toc_label dan ToC itu sendiri.

sebaris itu ToC
Kemampuan untuk memasukkan ToC secara langsung ke dalam dokumen HTML didukung melalui
--opsi sebaris.

Inlining akan dilakukan pada file pertama dalam daftar file yang diproses, dan hanya akan
dilakukan jika file itu berisi tag pembuka yang cocok dengan nilai --toc_tag.

Jika --overwrite benar, maka file pertama dalam daftar akan ditimpa, dengan
ToC yang dihasilkan dimasukkan di tempat yang sesuai. Jika tidak, versi modifikasi dari yang pertama
file adalah output ke STDOUT atau ke file output yang ditentukan oleh opsi --outfile.

Opsi --toc_tag dan --toc_tag_replace digunakan untuk menentukan di mana dan bagaimana ToC itu
dimasukkan ke dalam keluaran.

Contoh 1

# ini adalah default
--toc_tag TUBUH --notoc_tag_replace

Ini akan menempatkan ToC yang dihasilkan setelah tag BODY dari file pertama. Jika --header
opsi ditentukan, maka konten file yang ditentukan dimasukkan setelah BODY
menandai. Jika opsi --toc_label tidak kosong, maka teks ditentukan oleh --toc_label
opsi dimasukkan. Kemudian ToC dimasukkan, dan terakhir, jika opsi --footer adalah
ditentukan, itu memasukkan footer. Kemudian sisa file input mengikuti apa adanya
sebelumnya.

Contoh 2

--toc_tag '!--toc--' --toc_tag_replace

Ini akan menempatkan ToC yang dihasilkan setelah komentar pertama dari formulir , dan itu
komentar akan digantikan oleh ToC (dalam urutan
--tajuk
--toc_label
ToC
--footer) diikuti oleh sisa file input.

Catatan:
File header tidak boleh berisi tag HTML awal dan elemen HEAD karena
File HTML yang sedang diproses harus sudah berisi tag/elemen ini.

CONTOH

membuat an inline ToC untuk satu fillet
hypertoc --inline --make_anchors --timpa --make_toc index.html

Ini akan membuat jangkar di "index.html", buat ToC dengan judul "Tabel
Contents" dan letakkan setelah tag BODY dari "index.html". File index.html.org akan
berisi file index.html asli, tanpa ToC atau jangkar.

membuat a ToC fillet dari beberapa arsip
Pertama, buat jangkar.

hypertoc --make_anchors --timpa index.html fred.html george.html

Kemudian buat ToC

hypertoc --make_toc --outfile table.html indeks.html fred.html george.html

membuat an inline ToC setelah itu pertama menuju of itu pertama fillet
hypertoc --make_anchors --inline --timpa --make_toc --toc_tag /H1 \
--notoc_tag_replace --toc_label "" index.html fred.html george.html

Ini akan membuat jangkar di file "index.html", "fred.html" dan "george.html", buat
ToC tanpa header dan letakkan setelah header H1 pertama di "index.html" dan buat cadangan
file asli ke "index.html.org", "fred.html.org" dan "george.html.org"

membuat an inline ToC dengan adat elemen
hypertoc --quiet --make_anchors --bak "" --overwrite \
--make_toc --inline --toc_label "" --toc_tag '!--toc--' \
--toc_tag_replace \
--toc_entry H2=1 --toc_entry H3=2 \
--toc_end H2=/H2 --toc_end H3=/H3 file saya.html

Ini akan membuat ToC sebaris menimpa file asli, dan mengganti a
komentar, dan yang mengambil header H2 sebagai level 1 dan header H3 sebagai level 2. Ini bisa menjadi
berguna di mana file .html dihasilkan oleh beberapa proses lain, dan Anda kemudian dapat membuat
ToC sebagai langkah terakhir.

membuat a ToC dengan adat elemen
hypertoc --quiet --make_anchors --bak "" --overwrite \
--toc_entry JUDUL=1 --toc_end JUDUL=/JUDUL
--toc_entry H2=2 --toc_entry H3=3 \
--toc_end H2=/H2 --toc_end H3=/H3 \
--make_toc --outfile indeks.html \
mary.html fred.html george.html

Ini membuat jangkar di elemen H2 dan H3, dan membuat file ToC bernama index.html,
pengindeksan pada TITLE, dan elemen H2 dan H3.

membuat a ToC dengan adat elemen dan Pilihan fillet
Diberikan file pilihan bernama 'custom.opt' sebagai berikut:

# Judul, H2 dan H3
--toc_entry JUDUL=1
--toc_end JUDUL=/JUDUL
--toc_entry H2=2
--toc_end H2=/H2
--toc_entry H3=3
--toc_end H3=/H3

maka contoh sebelumnya dapat memiliki baris perintah yang lebih pendek sebagai berikut:

hypertoc --quiet --make_anchors --bak "" --overwrite \
--argfile custom.opt --make_toc --outfile index.html mary.html fred.html george.html

CATATAN

· hypertoc cukup pintar untuk mendeteksi jangkar di dalam elemen penting. Jika jangkar
mendefinisikan atribut NAME, hypertoc menggunakan nilai. Jika tidak, ia menambahkan NAMAnya sendiri
atribut ke jangkar. Jika --use_id benar, maka ia juga akan memeriksa dan menggunakan
ID.

· Elemen TITLE diperlakukan secara khusus jika ditetapkan sebagai elemen penting. Dia
ilegal untuk memasukkan jangkar (A) ke dalam elemen TITLE. Oleh karena itu, hypertoc akan benar-benar
tautan ke nama file itu sendiri alih-alih elemen TITLE dokumen.

· hypertoc akan mengabaikan elemen signifikan jika tidak mengandung non-spasi
karakter. Pesan peringatan dibuat jika kondisi seperti itu ada.

· Jika Anda memiliki urutan elemen penting yang berubah sedikit tidak teratur
mode, seperti H1 -> H3 -> H2 atau bahkan H2 -> H1, meskipun hypertoc berurusan dengan ini untuk
buat daftar yang masih HTML bagus, jika Anda menggunakan daftar yang dipesan untuk itu
kedalaman, maka Anda akan mendapatkan penomoran yang aneh, karena elemen daftar tambahan akan menjadi
dimasukkan ke sarang elemen pada tingkat yang benar.

Misalnya (H2 -> H1 dengan --ol_num_levels=1):

1.
* Tajuk H2 Saya
2. Tajuk H1 Saya

Misalnya (H1 -> H3 -> H2 dengan --ol_num_levels=0 dan H3 juga signifikan):

1. Tajuk H1 Saya
1.
1. Tajuk H3 Saya
2. Tajuk H2 Saya
2. Tajuk H1 Kedua Saya

Dalam kasus seperti ini mungkin lebih baik untuk tidak menggunakan opsi --ol.

· Jika seseorang tidak menggunakan --overwrite saat membuat jangkar, maka perintahnya harus
dilakukan dalam dua lintasan, untuk memberikan nama file yang benar (yang dengan yang sebenarnya
jangkar di dalamnya) ke bagian pembuatan ToC. Jika tidak, ToC akan memiliki jangkar
menunjuk ke file yang tidak memilikinya.

· Saat menggunakan --inline, perlu diperhatikan jika menimpa -- jika seseorang menyetel ToC ke
dimasukkan setelah tag yang diberikan (seperti BODY default) maka jika seseorang menjalankan perintah
berulang kali seseorang bisa mendapatkan beberapa ToC dalam file yang sama, satu demi satu.

PERINGATAN

· Versi 3.10 (dan di atasnya) menghasilkan lebih banyak jangkar verbose (ramah SEO) daripada sebelumnya
versi. Jadi jangkar yang dihasilkan dengan versi sebelumnya tidak akan cocok dengan versi 3.10
jangkar.

· Versi 3.00 (dan lebih tinggi) dari hypertoc berperilaku agak berbeda dari Versi 2.x dari
hipertok. Itu sekarang dirancang untuk melakukan semuanya dalam satu lintasan, dan telah menjatuhkan tertentu
options: opsi --infile tidak lagi digunakan (semua nama file diletakkan di akhir
perintah); opsi --toc_file tidak ada lagi; gunakan opsi --outfile
sebagai gantinya; opsi --tocmap tidak lagi didukung.

Sekarang menghasilkan tag huruf kecil daripada yang huruf besar.

· hypertoc sangat tidak efisien (memori dan kecepatan), dan bisa lambat untuk skala besar
dokumen.

· Sekarang generasi jangkar dan ToC selesai dalam satu lintasan, bahkan lebih banyak memori
digunakan daripada yang terjadi sebelumnya. Ini lebih menonjol saat memproses banyak
file, karena semua file dibaca ke dalam memori sebelum diproses.

· Markup yang tidak valid akan dihasilkan jika elemen signifikan terkandung di dalam
jangkar. Sebagai contoh:

Perintah FOO

akan dikonversi menjadi (jika h1 adalah elemen penting),

The perintah FOO

yang ilegal karena jangkar tidak dapat bersarang.

Ini adalah gaya yang lebih baik untuk menempatkan pernyataan jangkar di dalam elemen yang akan ditambatkan. Untuk
contoh, berikut ini lebih disukai:

Perintah FOO

hypertoc akan mendeteksi NAMA "foo" dan menggunakannya.

Lebih baik lagi menggunakan ID:

Perintah FOO

· Atribut NAMA tanpa tanda kutip tidak dikenali.

Gunakan hypertocp online menggunakan layanan onworks.net