hypertocp - ออนไลน์ในคลาวด์

โครงการ:

ชื่อ

hypertoc - สร้างสารบัญสำหรับเอกสาร HTML

VERSION

3.20 รุ่น

เรื่องย่อ

hypertoc --help | --manpage | --man_help | --ชาย

ไฮเปอร์โทค [--bak เชือก ] [ --debug ] [ --รายการ เชือก ] [ -- ส่วนท้าย ไฟล์ ] [ --หัวข้อ
ไฟล์ ] [ --ignore_only_one ] [ --ignore_sole_first ] [ --inline ] [ --make_anchors ] [
--make_toc ] [ --notoc_match เชือก ] [ --ol | --nool ] [ --ol_num_levels ] [ --outfile
ไฟล์ ] [ --overwrite ] [ --quiet ] [ --เฉพาะข้อความ ] [ --title เชือก ] { --toc_after
tag=คำต่อท้าย } { --toc_before tag=คำนำหน้า } { --toc_end tag=ปิดแท็ก } { --toc_entry แท็ก=ระดับ
} [ --toc_label เชือก ] [ --toc_only | --notoc_only ] [ --toc_tag เชือก ] [
--toc_tag_replace ] [ --use_id ] [ --useorg ] ไฟล์ ...

DESCRIPTION

hypertoc ช่วยให้คุณสามารถระบุ "องค์ประกอบที่สำคัญ" ที่จะเชื่อมโยงหลายมิติใน
"สารบัญ" (ToC) สำหรับชุดเอกสาร HTML ที่กำหนด

โดยพื้นฐานแล้ว ToC ที่สร้างขึ้นนั้นเป็นรายการระดับหลายระดับที่มีลิงก์ไปยัง
องค์ประกอบที่สำคัญ hypertoc แทรกลิงก์ลงใน ToC ไปยังองค์ประกอบที่สำคัญที่a
ระดับที่ผู้ใช้กำหนด

ตัวอย่าง:

หากระบุ H1 เป็นระดับ 1 แสดงว่า HXNUMX อยู่ในรายการระดับแรกของ ToC ถ้า
H2 ถูกระบุเป็นระดับ 2 มากกว่าที่ปรากฏในรายการระดับที่สองใน ToC

การสร้าง ToC มีสองด้าน: (1) การวางจุดยึดที่เหมาะสมลงใน HTML
เอกสาร (--make_anchors) และ (2) การสร้าง ToC จากเอกสาร HTML ที่มี
ยึดในนั้นเพื่อให้ ToC เชื่อมโยงไปยัง (--make_toc) สามารถเลือกทำอย่างใดอย่างหนึ่งหรือทั้งสองอย่างได้
เหล่านี้

hypertoc ยังสนับสนุนความสามารถในการรวม ToC เข้ากับเอกสาร HTML อีกด้วย
ผ่านตัวเลือก --inline

เพื่อให้ hypertoc รองรับการเชื่อมโยงไปยังองค์ประกอบที่สำคัญ hypertoc แทรกจุดยึด
ลงในองค์ประกอบที่สำคัญ หนึ่งสามารถใช้ไฮเปอร์โทคเป็นตัวกรองโดยส่งผลลัพธ์ไปที่
ไฟล์อื่นหรือสามารถเขียนทับไฟล์ต้นฉบับโดยสำรองไฟล์ต้นฉบับด้วย a
คำต่อท้าย (ค่าเริ่มต้น: "org") ต่อท้ายชื่อไฟล์

นอกจากนี้ยังสามารถกำหนดตัวเลือกในไฟล์ปรับแต่งได้เช่นเดียวกับในบรรทัดคำสั่ง

OPTIONS

ตัวเลือกสามารถเริ่มต้นด้วย "--" หรือ "-"; ตัวเลือกบูลีนสามารถลบล้างได้โดยการนำหน้าด้วย
"ไม่"; คุณสามารถเพิ่มตัวเลือกที่มีค่าแฮชหรืออาร์เรย์ได้โดยให้ตัวเลือกอีกครั้งสำหรับ
แต่ละค่า

ดู Getopt::Long สำหรับข้อมูลเพิ่มเติม

--argfile ชื่อไฟล์
ชื่อของไฟล์ที่จะอ่านตัวเลือกเพิ่มเติมจาก สามารถใช้ได้มากกว่าหนึ่งครั้ง สำหรับ
ตัวอย่าง:

--argfile your.args --argfile my.args

ดู "ไฟล์ตัวเลือก" สำหรับข้อมูลเพิ่มเติม

--บัก
--บัก เชือก

หากไฟล์ / ไฟล์อินพุต / กำลังถูกเขียนทับ (--overwrite เปิดอยู่) ให้คัดลอก
ไฟล์ต้นฉบับเป็น "ชื่อไฟล์.เชือก"ถ้าค่าว่างก็ไม่มีไฟล์สำรอง
เขียนไว้. (ค่าเริ่มต้น:org)

--debug
เปิดใช้งานเอาต์พุตการดีบัก verbose ใช้สำหรับการดีบักโมดูลนี้ กล่าวอีกนัยหนึ่ง
ไม่รำคาญ (ค่าเริ่มต้น: ปิด)

--เข้าก.ย
--เข้าก.ย เชือก

สตริงตัวคั่นสำหรับ non- รายการรายการ (ค่าเริ่มต้น: ", ")

--ส่วนท้าย
--ส่วนท้าย ไฟล์

ไฟล์ที่มีข้อความส่วนท้ายสำหรับสารบัญ

--หัวข้อ
--หัวข้อ ไฟล์

ไฟล์ที่มีข้อความส่วนหัวสำหรับสารบัญ

--ช่วยด้วย
พิมพ์ข้อความช่วยเหลือสั้นๆ แล้วออก

--ignore_only_one
หากมีเพียงรายการเดียวใน ToC อย่าสร้าง ToC

--ignore_sole_first
หากรายการแรกใน ToC เป็นระดับสูงสุด และมีเพียงรายการเดียวในนั้น
ระดับละเว้นมัน สิ่งนี้มีประโยชน์ในหน้าเว็บที่มีส่วนหัว H1 เพียงอันเดียวแต่
ไม่รู้ล่วงหน้าว่าจะมีอันเดียวหรือเปล่า

--อินไลน์
ใส่ ToC ในเอกสาร ณ จุดที่กำหนด ดู "Inlining the ToC" สำหรับข้อมูลเพิ่มเติม

--make_anchors | --gen_anchors
สร้างจุดยึดสำหรับสารบัญที่จะเชื่อมโยง

--make_toc | --gen_toc
สร้างสารบัญซึ่งเชื่อมโยงไปยังองค์ประกอบสำคัญที่ยึดไว้

--man_help | --manpage | --ชาย
พิมพ์เอกสารทั้งหมดและออก

--notoc_match
--notoc_match เชือก

หากมีแท็กบางแท็กที่คุณไม่ต้องการรวมไว้ในตารางของ
เนื้อหาแม้ว่าจะตรงกับ "องค์ประกอบสำคัญ" แล้วถ้ารูปแบบนี้
จับคู่เนื้อหาภายในแท็ก (ไม่ใช่เนื้อหา) จากนั้นแท็กนั้นจะไม่ถูกรวม
ทั้งในการสร้างจุดยึดหรือในการสร้าง ToC (ค่าเริ่มต้น: class="notoc")

--ol | --นูล
ใช้รายการที่เรียงลำดับสำหรับรายการสารบัญ (ตามความลึกที่กำหนด) ถ้า --ol คือ
false (เช่น --nool ถูกตั้งค่า) แล้ว ทำไม่ได้ ใช้รายการสั่งซื้อสำหรับรายการ ToC

(ค่าเริ่มต้น: เท็จ)

(ดู --ol_num_levels เพื่อกำหนดความลึกของรายการสั่งซื้อ)

--ol_num_levels
จำนวนระดับที่ลึกกว่ารายการ OL จะไปถ้า --ol เป็นจริง หากตั้งค่าเป็นศูนย์
จะใช้รายการสั่งซื้อสำหรับทุกระดับ (ค่าเริ่มต้น: 1)

--outfile
--outfile ไฟล์

ไฟล์ที่จะเขียนเอาต์พุตไปยัง นี่คือที่ที่เอาต์พุต HTML ที่แก้ไขและ Table-of-
เนื้อหาไปที่ หากคุณให้ '-' เป็นชื่อไฟล์ เอาต์พุตจะไปที่ STDOUT
(ค่าเริ่มต้น: STDOUT)

--เขียนทับ
เขียนทับไฟล์อินพุตด้วยเอาต์พุต หากสิ่งนี้มีผล --outfile จะถูกละเว้น
ใช้แล้ว สร้าง_anchors สำหรับสร้างจุดยึด "เข้าที่" และใน สร้าง_toc if
ตัวเลือก --inline มีผลบังคับใช้ (ค่าเริ่มต้น: ปิด)

--เงียบ
ระงับข้อความที่ให้ข้อมูล (ค่าเริ่มต้น: ปิด)

--ข้อความเท่านั้น
ใช้เฉพาะเนื้อหาข้อความในองค์ประกอบที่สำคัญ

--ชื่อ
--ชื่อ เชือก

ชื่อเรื่องสำหรับหน้า ToC (หากไม่ได้ใช้ --header หรือ --inline หรือ --toc_only) (ค่าเริ่มต้น: "Table
ของเนื้อหา")

--toc_after
--toc_after แท็ก=วิภัตติ

--toc_after "H2="

สำหรับกำหนดเลย์เอาต์ขององค์ประกอบที่สำคัญใน ToC NS แท็ก เป็นแท็ก HTML ซึ่ง
ทำเครื่องหมายจุดเริ่มต้นขององค์ประกอบ NS วิภัตติ คือสิ่งที่ต้องต่อท้าย
รายการสารบัญที่สร้างขึ้นสำหรับแท็กนั้น นี่คืออาร์กิวเมนต์แฮชสะสม
(ค่าเริ่มต้น: ไม่ได้กำหนด)

--toc_before
--toc_before แท็ก=อุปสรรค

--toc_before "H2= "

สำหรับกำหนดเลย์เอาต์ขององค์ประกอบที่สำคัญใน ToC NS แท็ก เป็นแท็ก HTML
ซึ่งเป็นจุดเริ่มต้นขององค์ประกอบ NS อุปสรรค คือสิ่งที่ต้องมีไว้ข้างหน้า
ไปยังรายการสารบัญที่สร้างขึ้นสำหรับแท็กนั้น นี่คือแฮชสะสม
การโต้แย้ง. (ค่าเริ่มต้น: ไม่ได้กำหนด)

--toc_end
--toc_end แท็ก=ปิดแท็ก

--toc_end "H1=/H1"

เพื่อกำหนดองค์ประกอบที่สำคัญ NS แท็ก เป็นแท็ก HTML ซึ่งทำเครื่องหมายจุดเริ่มต้นของ
องค์ประกอบ NS ปิดแท็ก แท็ก HTML ซึ่งทำเครื่องหมายจุดสิ้นสุดขององค์ประกอบ เมื่อไหร่
ตรงกันในไฟล์อินพุต ตัวพิมพ์เล็กและตัวพิมพ์ใหญ่จะถูกละเว้น (แต่ให้แน่ใจว่าทั้งหมดของคุณ แท็ก ตัวเลือก
หมายถึงแท็กเดียวกันเหมือนกันทุกประการ!). นี่คืออาร์กิวเมนต์แฮชสะสม
(ค่าเริ่มต้น: H1=/H1 H2=/H2)

--toc_entry
--toc_entry แท็ก=ระดับ

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

เพื่อกำหนดองค์ประกอบที่สำคัญ NS แท็ก เป็นแท็ก HTML ซึ่งทำเครื่องหมายจุดเริ่มต้นของ
องค์ประกอบ NS ระดับ คือระดับของแท็กที่ถือว่าเป็น คุณค่าของ ระดับ
ต้องเป็นตัวเลขและไม่เป็นศูนย์ หากค่าเป็นค่าลบ รายการติดต่อกัน
ที่แทนโดยนัยสำคัญ_องค์ประกอบจะถูกคั่นด้วยค่าที่กำหนดโดย
--entrysep ตัวเลือก นี่คืออาร์กิวเมนต์แฮชสะสม (ค่าเริ่มต้น: H1=1 H2=2)

--toc_label | --toclabel
--toc_label เชือก

ข้อความ HTML ที่ติดป้ายกำกับ ToC ใช้เสมอ. (ค่าเริ่มต้น: " สารบัญ ")

--toc_only | --notoc_only
ส่งออกเฉพาะสารบัญ กล่าวคือ สารบัญ บวก toc_label
หากมี --header หรือ --footer สิ่งเหล่านี้ก็จะถูกส่งออกด้วย

หาก --toc_only เป็นเท็จ (เช่น --notoc_only ถูกตั้งค่า) หากไม่มี --header และ
--inline ไม่เป็นความจริง ส่วนหัวของหน้า HTML ที่เหมาะสมจะถูกส่งออก และหากมี
ไม่ --footer และ --inline ไม่เป็นความจริง จากนั้นส่วนท้ายของหน้า HTML จะถูกส่งออก
(ค่าเริ่มต้น:--notoc_only)

--toc_tag
--toc_tag เชือก

หากต้องการรวม ToC แบบอินไลน์ นี่คือรูปแบบที่ใช้เพื่อให้ตรงกับแท็ก
ที่ที่ควรวาง ToC นี่อาจเป็นแท็กเริ่มต้น แท็กปิด หรือความคิดเห็น แต่
< ควรเว้นไว้; นั่นคือ หากคุณต้องการให้ ToC อยู่หลัง BODY
แท็กแล้วให้ "BODY" หากคุณต้องการแท็กความคิดเห็นพิเศษเพื่อให้ ToC ควรอยู่ตรงไหน
go แล้วใส่เครื่องหมายความคิดเห็น เช่น "!--toc--" (ค่าเริ่มต้น:BODY)

--toc_tag_replace
ร่วมกับ --toc_tag นี่เป็นแฟล็กเพื่อบอกว่าแท็กที่กำหนดควรเป็น .หรือไม่
แทนที่หรือถ้า ToC ควรวางไว้หลังแท็ก สิ่งนี้มีประโยชน์หากคุณ
toc_tag เป็นความคิดเห็นและคุณไม่ต้องการมันหลังจากคุณมี ToC แล้ว
(ค่าเริ่มต้น: เท็จ)

--use_id
ใช้ id="ชื่อ"สำหรับสมอมากกว่าชื่อ"> สมอ. แต่ถ้าเป็นสมอ
มีอยู่แล้วสำหรับองค์ประกอบที่มีนัยสำคัญ ซึ่งจะไม่สร้างรหัสสำหรับองค์ประกอบนั้นโดยเฉพาะ
ธาตุ.

--useorg
ใช้ไฟล์สำรองที่มีอยู่แล้วเป็นแหล่งอินพุต นั่นคือไฟล์ของแบบฟอร์ม
ชื่อไฟล์.บัก (ดู --bak).

ไฟล์ รูปแบบ

Options ไฟล์
สามารถกำหนดตัวเลือกในไฟล์ได้เช่นเดียวกับในบรรทัดคำสั่งโดยใช้ --argfile
ชื่อไฟล์ ตัวเลือกในบรรทัดคำสั่ง นอกจากนี้ไฟล์ ~/.hypertocrc และ ./.hypertocrc คือ
ตรวจสอบตัวเลือก

รูปแบบมีดังนี้: บรรทัดที่ขึ้นต้นด้วย # คือความคิดเห็น เส้นที่อยู่ใน PoD
เครื่องหมายยังเป็นความคิดเห็น บรรทัดว่างจะถูกละเว้น ตัวเลือกตัวเองควรเป็น
กำหนดวิธีที่พวกเขาจะอยู่บนบรรทัดคำสั่ง นั่นคือ ชื่อตัวเลือก (รวมทั้ง
--) ตามด้วยค่าของมัน (ถ้ามี)

ตัวอย่างเช่น:

# ตั้งค่า ToC เป็นสามระดับ
--toc_entry H1=1
--toc_entry H2=2
--toc_entry H3=3

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

ไฟล์ตัวเลือกสามารถซ้อนกันได้โดยให้ --argfile ชื่อไฟล์ อาร์กิวเมนต์ภายในตัวเลือก
ไฟล์ก็จะไปรับไฟล์ที่อ้างอิงนั้นเช่นกัน

ดู Getopt::ArgvFile สำหรับข้อมูลเพิ่มเติม

รายละเอียด

สำคัญ องค์ประกอบ
ต่อไปนี้คือตัวอย่างบางส่วนของการกำหนดองค์ประกอบที่สำคัญสำหรับสารบัญของคุณ

ตัวอย่าง of ค่าเริ่มต้น

ต่อไปนี้แสดงถึงการตั้งค่าเริ่มต้นหากไม่มีการระบุอย่างชัดเจน:

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

หรือหากมีการกำหนดไว้ใน "ไฟล์ตัวเลือก" ที่เป็นไปได้:

# การตั้งค่าเริ่มต้น
--toc_entry H1=1
--toc_end H1=/H1
--toc_entry H2=2
--toc_end H2=/H2

ตัวอย่าง of ก่อนหลัง

ตัวเลือกต่อไปนี้ใช้ประโยชน์จากตัวเลือกก่อน/หลัง:

# ไฟล์ตัวเลือกที่เพิ่มการจัดรูปแบบบางส่วน
# สร้างรายการ ToC ระดับ 1
--toc_entry H1=1
--toc_end H1=/H1
--toc_before H1=
--toc_after H1=

# สร้างรายการ ToC ระดับ 2
--toc_entry H2=2
--toc_end H2=/H2
--toc_before H2=
--toc_after H2=

# สร้างรายการระดับ 3 ตามที่เป็นอยู่
--toc_entry H3=3
--toc_end H3=/H3

ตัวอย่าง of ประเพณี ปลาย

ตัวเลือกต่อไปนี้พยายามจัดทำดัชนีข้อกำหนด:

# ไฟล์ตัวเลือกที่ใช้ได้กับเอกสารประเภทอภิธานศัพท์
--toc_entry H1=1
--toc_end H1=/H1
--toc_entry H2=2
--toc_end H2=/H2

# สมมติว่าเอกสารมี DD สำหรับแต่ละ DT มิฉะนั้น ToC
# จะได้รับรายการที่มีข้อความจำนวนมาก
--toc_entry DT=3
--toc_end DT=DD
--toc_before DT=
--toc_after DT=

การจัดรูปแบบ TOC
ตัวเลือก --toc_entry ฯลฯ ช่วยให้คุณควบคุมลักษณะรายการ ToC ได้ แต่มี
เป็นตัวเลือกอื่นๆ ที่จะส่งผลต่อลักษณะที่ปรากฏขั้นสุดท้ายของไฟล์ ToC ที่สร้างขึ้น

ด้วยตัวเลือก --header เนื้อหาของไฟล์ที่กำหนดจะถูกนำหน้า
สร้าง ToC วิธีนี้ช่วยให้คุณมีข้อความเกริ่นนำหรือข้อความอื่นๆ ก่อน
ทีโอซี

หมายเหตุ
หากคุณใช้ตัวเลือก --header ตรวจสอบให้แน่ใจว่าไฟล์ที่ระบุมี HTML . ที่เปิดอยู่
แท็ก องค์ประกอบ HEAD (ที่มีองค์ประกอบ TITLE) และแท็กเปิด BODY
อย่างไรก็ตาม แท็ก/องค์ประกอบเหล่านี้ไม่ควรอยู่ในไฟล์ส่วนหัวหาก --inline options
ถูกนำมาใช้. ดู "Inlining the ToC" สำหรับข้อมูลเกี่ยวกับสิ่งที่ไฟล์ส่วนหัวควรมี
สำหรับการอินไลน์ ToC

ด้วยตัวเลือก --toc_label เนื้อหาของสตริงที่กำหนดจะถูกนำหน้า
สร้าง ToC (แต่หลังจากข้อความใด ๆ ที่นำมาจาก --header ไฟล์)

ด้วยตัวเลือก --footer เนื้อหาของไฟล์จะถูกต่อท้ายไฟล์ที่สร้างขึ้น
ทีโอซี

หมายเหตุ
หากคุณใช้ -footer ตรวจสอบให้แน่ใจว่าได้รวมแท็กปิด BODY และ HTML (เว้นแต่
แน่นอน คุณกำลังใช้ --inline ตัวเลือก)

หากไม่ได้ระบุตัวเลือก --header มาร์กอัป HTML เริ่มต้นที่เหมาะสมจะเป็น
เพิ่ม เว้นแต่จะระบุตัวเลือก --toc_only หาก --footer ตัวเลือกไม่ใช่
ระบุ มาร์กอัป HTML ปิดที่เหมาะสมจะถูกเพิ่ม ยกเว้นตัวเลือก --toc_only
ระบุไว้

หากคุณไม่ต้องการ / จำเป็นต้องจัดการกับส่วนหัวและส่วนท้ายของไฟล์แสดงว่าคุณได้รับการจัดสรรให้
ระบุชื่อ --title ตัวเลือกของไฟล์ ToC และช่วยให้คุณระบุ a
ส่วนหัวหรือป้ายกำกับ เพื่อวางไว้หน้ารายการ ToC ตัวเลือก --toc_label ทั้งสองตัวเลือก
มีค่าเริ่มต้น โปรดดู "ตัวเลือก" สำหรับข้อมูลเพิ่มเติมเกี่ยวกับแต่ละตัวเลือก

หากคุณไม่ต้องการให้แท็กหน้า HTML และเพียงแค่ต้องการ ToC เอง ดังนั้น
ระบุตัวเลือก --toc_only หากไม่มีไฟล์ --header หรือ --footer สิ่งนี้จะ
เพียงส่งออกเนื้อหาของ --toc_label และ ToC เอง

ซับใน TOC
ความสามารถในการรวม ToC ลงในเอกสาร HTML โดยตรงได้รับการสนับสนุนผ่านทาง
--ตัวเลือกอินไลน์

การทำอินไลน์จะเสร็จสิ้นในไฟล์แรกในรายการไฟล์ที่ประมวลผล และจะเป็นเพียง
เสร็จสิ้นหากไฟล์นั้นมีแท็กเปิดที่ตรงกับค่า --toc_tag

หาก --overwrite เป็นจริง ไฟล์แรกในรายการจะถูกเขียนทับด้วยเครื่องหมาย
สร้าง ToC แทรกที่จุดที่เหมาะสม มิฉะนั้นจะเป็นรุ่นแรก
ไฟล์ถูกส่งออกไปยัง STDOUT หรือไปยังไฟล์เอาต์พุตที่กำหนดโดยตัวเลือก --outfile

ตัวเลือก --toc_tag และ --toc_tag_replace ใช้เพื่อกำหนดว่า ToC อยู่ที่ไหนและอย่างไร
แทรกลงในเอาท์พุท

ตัวอย่าง 1

#นี่คือค่าเริ่มต้น
--toc_tag BODY --notoc_tag_replace

สิ่งนี้จะทำให้ ToC ที่สร้างขึ้นหลังแท็ก BODY ของไฟล์แรก ถ้า --header
ระบุตัวเลือกแล้วเนื้อหาของไฟล์ที่ระบุจะถูกแทรกหลังจาก BODY
แท็ก หากตัวเลือก --toc_label ไม่ว่างเปล่า แสดงว่าข้อความที่ระบุโดย --toc_label
แทรกตัวเลือกแล้ว จากนั้นใส่ ToC และสุดท้ายหากตัวเลือก --footer คือ
ระบุจะแทรกส่วนท้าย จากนั้นไฟล์อินพุตที่เหลือจะตามมาเหมือนเดิม
ก่อน

ตัวอย่าง 2

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

สิ่งนี้จะทำให้ ToC ที่สร้างขึ้นหลังจากความคิดเห็นแรกของแบบฟอร์ม และนั่น
ความคิดเห็นจะถูกแทนที่ด้วย ToC (ตามลำดับ
--หัวข้อ
--toc_label
TOC
--footer) ตามด้วยไฟล์อินพุตที่เหลือ

หมายเหตุ
ไฟล์ส่วนหัวไม่ควรมีแท็ก HTML เริ่มต้นและองค์ประกอบ HEAD เนื่องจาก
ไฟล์ HTML ที่กำลังประมวลผลควรมีแท็ก/องค์ประกอบเหล่านี้อยู่แล้ว

ตัวอย่าง

สร้างบัญชีตัวแทน an แบบอินไลน์ TOC for หนึ่ง ไฟล์
hypertoc --inline --make_anchors --เขียนทับ --make_toc index.html

สิ่งนี้จะสร้างจุดยึดใน "index.html" สร้าง ToC ด้วยส่วนหัวของ "Table of
เนื้อหา" และวางไว้หลังแท็ก BODY ของ "index.html" ไฟล์ index.html.org จะ
มีไฟล์ index.html ดั้งเดิม โดยไม่มี ToC หรือจุดยึด

สร้างบัญชีตัวแทน a TOC ไฟล์ ราคาเริ่มต้นที่ หลาย ไฟล์
ขั้นแรก สร้างจุดยึด

hypertoc --make_anchors --เขียนทับ index.html fred.html george.html

จากนั้นสร้างToC

ไฮเปอร์โตค --make_toc --outfile table.html index.html fred.html george.html

สร้างบัญชีตัวแทน an แบบอินไลน์ TOC หลังจาก เป็นครั้งแรก หัวเรื่อง of เป็นครั้งแรก ไฟล์
hypertoc --make_anchors --inline --overwrite --make_toc --toc_tag /H1 \
--notoc_tag_replace --toc_label "" index.html fred.html george.html

สิ่งนี้จะสร้างจุดยึดในไฟล์ "index.html", "fred.html" และ "george.html" สร้าง
ToC ที่ไม่มีส่วนหัวและวางไว้หลังส่วนหัว H1 แรกใน "index.html" และสำรองข้อมูล
ไฟล์ต้นฉบับเป็น "index.html.org", "fred.html.org" และ "george.html.org"

สร้างบัญชีตัวแทน an แบบอินไลน์ TOC กับ ประเพณี องค์ประกอบ
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 myfile.html

สิ่งนี้จะสร้าง Inline ToC เขียนทับไฟล์ต้นฉบับและแทนที่ a
แสดงความคิดเห็น และใช้ส่วนหัว H2 เป็นระดับ 1 และส่วนหัว H3 เป็นระดับ 2 ได้
มีประโยชน์ในกรณีที่ไฟล์ .html ถูกสร้างขึ้นโดยกระบวนการอื่น จากนั้นคุณสามารถสร้าง
ToC เป็นขั้นตอนสุดท้าย

สร้างบัญชีตัวแทน a TOC กับ ประเพณี องค์ประกอบ
hypertoc --quiet --make_anchors --bak "" --overwrite \
--toc_entry TITLE=1 --toc_end TITLE=/TITLE
--toc_entry H2=2 --toc_entry H3=3 \
--toc_end H2=/H2 --toc_end H3=/H3 \
--make_toc --outfile index.html \
mary.html fred.html จอร์จ.html

สิ่งนี้จะสร้างจุดยึดที่องค์ประกอบ H2 และ H3 และสร้างไฟล์ ToC ชื่อ index.html
การทำดัชนีบน TITLE และองค์ประกอบ H2 และ H3

สร้างบัญชีตัวแทน a TOC กับ ประเพณี องค์ประกอบ และ ตัวเลือก ไฟล์
รับไฟล์ตัวเลือกที่เรียกว่า 'custom.opt' ดังนี้:

# ชื่อเรื่อง H2 และ H3
--toc_entry TITLE=1
--toc_end TITLE=/TITLE
--toc_entry H2=2
--toc_end H2=/H2
--toc_entry H3=3
--toc_end H3=/H3

ตัวอย่างก่อนหน้านี้สามารถมีบรรทัดคำสั่งที่สั้นกว่าได้ดังนี้:

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

หมายเหตุ

· hypertoc ฉลาดพอที่จะตรวจจับจุดยึดภายในองค์ประกอบที่สำคัญ ถ้าสมอ
กำหนดแอตทริบิวต์ NAME hypertoc ใช้ค่า มิฉะนั้นจะเพิ่ม NAME . ของตัวเอง
คุณลักษณะของสมอ หาก --use_id เป็นจริง ก็จะตรวจสอบและใช้เช่นกัน
รหัส

· องค์ประกอบ TITLE จะได้รับการปฏิบัติเป็นพิเศษหากระบุไว้เป็นองค์ประกอบที่มีนัยสำคัญ มันคือ
การแทรกจุดยึด (A) ลงในองค์ประกอบ TITLE ผิดกฎหมาย ดังนั้น hypertoc จะ
ลิงก์ไปยังชื่อไฟล์แทนองค์ประกอบ TITLE ของเอกสาร

· hypertoc จะละเว้นองค์ประกอบที่สำคัญหากไม่มีช่องว่างใด ๆ
ตัวอักษร ข้อความเตือนจะถูกสร้างขึ้นหากมีเงื่อนไขดังกล่าว

· หากคุณมีลำดับขององค์ประกอบสำคัญที่เปลี่ยนแปลงไปในทางที่ไม่เป็นระเบียบเล็กน้อย
แฟชั่นเช่น H1 -> H3 -> H2 หรือแม้แต่ H2 -> H1 แม้ว่า hypertoc จะเกี่ยวข้องกับสิ่งนี้
สร้างรายการซึ่งยังคงเป็น HTML ที่ดี หากคุณใช้รายการที่เรียงลำดับไปนั้น
ลึกแล้วคุณจะได้หมายเลขแปลก ๆ เนื่องจากองค์ประกอบรายการพิเศษจะได้รับ
แทรกเพื่อซ้อนองค์ประกอบในระดับที่ถูกต้อง

ตัวอย่างเช่น (H2 -> H1 พร้อม --ol_num_levels=1):

1.
* ส่วนหัว H2 ของฉัน
2. ส่วนหัว H1 ของฉัน

ตัวอย่างเช่น (H1 -> H3 -> H2 โดย --ol_num_levels=0 และ H3 ก็มีความสำคัญเช่นกัน):

1. ส่วนหัว H1 ของฉัน
1.
1. ส่วนหัว H3 ของฉัน
2. ส่วนหัว H2 ของฉัน
2. ส่วนหัว H1 ที่สองของฉัน

ในกรณีเช่นนี้ อาจเป็นการดีกว่าที่จะไม่ใช้ตัวเลือก --ol

· หากไม่ได้ใช้ --overwrite เมื่อสร้างจุดยึด คำสั่งจะต้องเป็น
ทำในสองรอบเพื่อให้ชื่อไฟล์ที่ถูกต้อง (อันที่มีจริง
ยึดไว้ในนั้น) ไปยังส่วนการสร้าง ToC มิฉะนั้น ToC จะมีจุดยึด
ชี้ไปที่ไฟล์ที่ไม่มี

· เมื่อใช้ --inline ต้องใช้ความระมัดระวังหากเขียนทับ -- หากตั้งค่า ToC เป็น
ถูกรวมไว้หลังแท็กที่กำหนด (เช่น ค่าดีฟอลต์ BODY) ดังนั้นหากมีผู้เรียกใช้คำสั่ง
ไฟล์หนึ่งสามารถรับ ToC ได้หลายไฟล์ในไฟล์เดียวกันซ้ำๆ กัน

คำเตือน

· เวอร์ชัน 3.10 (ขึ้นไป) สร้างจุดยึดที่ละเอียดมากขึ้น (เป็นมิตรกับ SEO) มากกว่าเดิม
รุ่น ดังนั้นจุดยึดที่สร้างด้วยเวอร์ชันก่อนหน้าจะไม่ตรงกับเวอร์ชัน 3.10
สมอ

· เวอร์ชัน 3.00 (และสูงกว่า) ของ hypertoc ทำงานค่อนข้างแตกต่างจากเวอร์ชัน 2.x ของ
ไฮเปอร์โทค ตอนนี้ออกแบบมาเพื่อทำทุกอย่างในครั้งเดียวและลดลงบางส่วน
ตัวเลือก: ตัวเลือก --infile จะไม่ถูกใช้อีกต่อไป (ชื่อไฟล์ทั้งหมดจะต่อท้าย
คำสั่ง); ตัวเลือก --toc_file ไม่มีอยู่อีกต่อไป ใช้ --outfile ตัวเลือก
แทนที่; ไม่รองรับตัวเลือก --tocmap อีกต่อไป

ตอนนี้สร้างแท็กตัวพิมพ์เล็กแทนที่จะเป็นตัวพิมพ์ใหญ่

· hypertoc ไม่ค่อยมีประสิทธิภาพ (หน่วยความจำและความเร็ว) และอาจช้าสำหรับขนาดใหญ่
เอกสาร

· ตอนนี้การสร้างจุดยึดและ ToC นั้นเสร็จสิ้นในครั้งเดียว หน่วยความจำมากยิ่งขึ้น
ถูกใช้งานมากกว่าที่เคยเป็นมา สิ่งนี้มีความโดดเด่นมากขึ้นเมื่อประมวลผลหลายรายการ
ไฟล์ เนื่องจากไฟล์ทั้งหมดจะถูกอ่านในหน่วยความจำก่อนประมวลผล

· มาร์กอัปที่ไม่ถูกต้องจะถูกสร้างขึ้นหากมีองค์ประกอบที่สำคัญอยู่ภายใน an
สมอ ตัวอย่างเช่น:

คำสั่ง FOO

จะถูกแปลงเป็น (ถ้า h1 เป็นองค์ประกอบที่สำคัญ)

คำสั่ง FOO

ซึ่งผิดกฎหมายเนื่องจากไม่สามารถซ้อนสมอได้

เป็นการดีกว่าที่จะใส่ข้อความสั่งของจุดยึดภายในองค์ประกอบที่จะทอดสมอ สำหรับ
ตัวอย่างต่อไปนี้เป็นที่ต้องการ:

คำสั่ง FOO

hypertoc จะตรวจจับ NAME "foo" และใช้งาน

ยิ่งไปกว่านั้นคือการใช้ ID:

คำสั่ง FOO

· ไม่รู้จักแอตทริบิวต์ NAME ที่ไม่มีเครื่องหมายคำพูด

ใช้ hypertocp ออนไลน์โดยใช้บริการ onworks.net