hypertocp - Online în cloud

PROGRAM:

NUME

hypertoc - generează un cuprins pentru documentele HTML

VERSIUNE

Versiunea 3.20

REZUMAT

hypertoc --ajutor | --manpage | --man_help | --om

hipertoc [--bak şir ] [ --debug ] [ --entrysep şir ] [ --subsol fişier ] [ --antet
fişier ] [ --ignore_only_one ] [ --ignore_sole_first ] [ --inline ] [ --make_anchors ] [
--make_toc ] [ --notoc_match şir ] [ --ol | --nool ] [ --ol_num_levels ] [ --outfile
fişier ] [ --overwrite ] [ --quiet ] [ --textonly ] [ --title şir ] { --toc_after
tag=sufix } { --toc_before tag=prefix } { --toc_end etichetă=etichetă finală } { --toc_entry tag=nivel
} [ --toc_label şir ] [ --toc_only | --notoc_only ] [ --toc_tag şir ] [
--toc_tag_replace ] [ --use_id ] [ --useorg ] fișier...

DESCRIERE

hypertoc vă permite să specificați „elementele semnificative” la care vor fi hyperlinkate într-un
„Cuprins” (ToC) pentru un anumit set de documente HTML.

Practic, ToC generat este o listă cu mai multe niveluri care conține link-uri către
elemente semnificative. hypertoc inserează legăturile în ToC către elemente semnificative la a
nivelul specificat de utilizator.

Exemplu:

Dacă H1-urile sunt specificate ca nivel 1, atunci acestea apar în lista de prim nivel a ToC. Dacă
H2-urile sunt specificate ca un nivel 2, decât apar într-o listă de al doilea nivel în ToC.

Există două aspecte ale generației ToC: (1) introducerea ancorelor adecvate în HTML
documente (--make_anchors) și (2) generarea ToC din documente HTML care au
ancore în ele pentru ca ToC să se conecteze la (--make_toc). Se poate alege să facă una sau ambele
aceste.

hypertoc acceptă, de asemenea, capacitatea de a încorpora ToC în documentul HTML în sine
prin opțiunea --inline.

Pentru ca hypertoc să suporte legătura cu elemente semnificative, hypertoc inserează ancore
în elementele semnificative. Se poate folosi hypertoc ca filtru, rezultând rezultatul la
alt fișier sau se poate suprascrie fișierul original, cu copia de rezervă a originalului cu a
sufix (implicit: „org”) adăugat la numele fișierului.

Se pot defini, de asemenea, opțiuni într-un fișier de configurare, precum și pe linia de comandă.

OPŢIUNI

Opțiunile pot începe cu „--” sau „-”; opțiunile booleene pot fi anulate precedându-le cu
"Nu"; opțiunile cu valori hash sau matrice pot fi adăugate dând din nou opțiunea pentru
fiecare valoare.

Consultați Getopt::Long pentru mai multe informații.

--argfile nume de fișier
Numele unui fișier din care să citiți mai multe opțiuni. Acesta poate fi folosit de mai multe ori. Pentru
exemplu:

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

Consultați „Fișiere cu opțiuni” pentru mai multe informații.

--bak
--bak şir

Dacă fișierul/fișierele de intrare sunt/sunt suprascrise (--overwrite este activat), copiați fișierul
fișierul original la "nume de fișier.şir". Dacă valoarea este goală, nu există niciun fișier de rezervă
scris. (implicit:org)

--depanare
Activați ieșirea de depanare verbosă. Folosit pentru depanarea acestui modul; cu alte cuvinte,
nu te deranja. (implicit: oprit)

--intrare sep
--intrare sep şir

Șir separator pentru non- intrări de articole (implicit: ", ")

--subsol
--subsol fişier

Fișier care conține text de subsol pentru cuprins.

--antet
--antet fişier

Fișier care conține textul antetului pentru cuprins.

--Ajutor
Imprimați un scurt mesaj de ajutor și ieșiți.

--ignora_doar_unul
Dacă ar fi un singur articol în ToC, nu faceți o ToC.

--ignore_sole_first
Dacă primul articol din ToC este de cel mai înalt nivel, ȘI este singurul din acesta
nivel, ignora-l. Acest lucru este util în paginile web în care există doar un antet H1, dar
nu se știe dinainte dacă va fi doar unul.

--în linie
Puneți ToC în document la un moment dat. Consultați „Inlinearea ToC” pentru mai multe informații.

--make_anchors | --gen_anchors
Creați ancore pentru tabelul de conținut la care să vă conectați.

--make_toc | --gen_toc
Creați un Cuprins care să trimită la elemente semnificative ancorate.

--man_help | --manpage | --om
Tipăriți toată documentația și ieșiți.

--notoc_match
--notoc_match şir

Dacă există anumite etichete individuale pe care nu doriți să le includeți în tabelul
conținuturi, chiar dacă se potrivesc cu „elementele semnificative”, atunci dacă acest tipar
se potrivește cu conținutul din interiorul etichetei (nu al corpului), atunci acea etichetă nu va fi inclusă,
fie în generarea ancorelor, nici în generarea ToC. (implicit: class="notoc")

--ol | --nool
Utilizați o listă ordonată pentru intrările din Cuprins (la o anumită adâncime). Dacă --ol este
false (adică --nool este setat) atunci nu face utilizați o listă ordonată pentru intrările ToC.

(implicit: false)

(Consultați --ol_num_levels pentru a determina cât de adânc este lista ordonată)

--ol_num_levels
Numărul de niveluri adânci în lista OL va merge dacă --ol este adevărat. Dacă se setează la zero,
va folosi o listă ordonată pentru toate nivelurile. (implicit: 1)

--outfile
--outfile fişier

Fișier în care să scrieți rezultatul. Aici apare ieșirea HTML modificată și Tabelul cu
Conținutul merge la. Dacă dați „-” ca nume de fișier, atunci ieșirea va merge la STDOUT.
(implicit: STDOUT)

--sobrescrie
Suprascrieți fișierul de intrare cu rezultatul. Dacă acest lucru este în vigoare, --outfile este ignorat.
Folosit in genera_ancore pentru crearea ancorelor „la loc” și în generate_toc if
opțiunea --inline este în vigoare. (implicit: oprit)

--Liniște
Suprimați mesajele informative. (implicit: dezactivat)

--doar text
Folosiți numai conținut text în elemente semnificative.

--titlu
--titlu şir

Titlu pentru pagina ToC (dacă nu se utilizează --header sau --inline sau --toc_only) (implicit: „Tabel
de conținut")

--toc_după
--toc_după etichetă=sufix

--toc_after "H2= "

Pentru definirea aspectului elementelor semnificative din ToC. The etichetă este eticheta HTML care
marchează începutul elementului. The sufix este ceea ce trebuie atașat la
Intrarea de Cuprins a fost generată pentru acea etichetă. Acesta este un argument hash cumulativ.
(implicit: nedefinit)

--toc_before
--toc_before etichetă=prefix

--toc_before "H2= "

Pentru definirea aspectului elementelor semnificative din ToC. The etichetă este eticheta HTML
care marchează începutul elementului. The prefix este ceea ce se cere să fie antepus
la intrarea de cuprins generată pentru acea etichetă. Acesta este un hash cumulativ
argument. (implicit: nedefinit)

--toc_end
--toc_end etichetă=etichetă finală

--toc_end „H1=/H1”

Pentru definirea elementelor semnificative. The etichetă este eticheta HTML care marchează începutul
elementul. The etichetă finală eticheta HTML care marchează sfârșitul elementului. Când
potrivire în fișierul de intrare, majusculele sunt ignorate (dar asigurați-vă că toate dvs etichetă Opțiuni
referitor la aceeași etichetă sunt exact aceleași!). Acesta este un argument hash cumulativ.
(implicit: H1=/H1 H2=/H2)

--toc_entry
--toc_entry etichetă=nivel

--toc_entry „TITLE=1” --toc_entry „H1=2”

Pentru definirea elementelor semnificative. The etichetă este eticheta HTML care marchează începutul
elementul. The nivel este nivelul care este considerat a fi eticheta. Valoarea a nivel
trebuie să fie numeric și diferit de zero. Dacă valoarea este negativă, intrări consecutive
reprezentat de elementul_semnificativ va fi separat de valoarea stabilită de
--opțiune entrysep. Acesta este un argument hash cumulativ. (implicit: H1=1 H2=2)

--toc_label | --toclabel
--toc_label şir

Text HTML care etichetează ToC. Întotdeauna folosit. (Mod implicit: " Cuprins ")

--toc_doar | --notoc_only
Produceți numai Cuprins, adică Cuprins plus toc_label.
Dacă există un --header sau un --footer, acestea vor fi de asemenea afișate.

Dacă --toc_only este fals (adică --notoc_only este setat), atunci dacă nu există --header și
--inline nu este adevărat, atunci va fi afișat un antet de pagină HTML adecvat și, dacă există
nu --footer și --inline nu sunt adevărate, atunci va fi afișat un subsol de pagină HTML.
(implicit:--notoc_only)

--toc_tag
--toc_tag şir

Dacă o ToC trebuie să fie inclusă în linie, acesta este modelul care este utilizat pentru a se potrivi etichetei
unde ar trebui pus ToC. Aceasta poate fi o etichetă de început, o etichetă de final sau un comentariu, dar
< ar trebui lăsat afară; adică dacă vrei ca ToC să fie plasat după BODY
etichetați, apoi dați „BODY”. Dacă doriți o etichetă specială de comentariu pentru a face unde ar trebui ToC
mergeți, apoi includeți semnele de comentariu, de exemplu: "!--toc--" (implicit: BODY)

--toc_tag_replace
În combinație cu --toc_tag, acesta este un semnalizator pentru a spune dacă eticheta dată ar trebui să fie
înlocuit sau dacă ToC ar trebui pus după etichetă. Acest lucru poate fi util dacă dvs
toc_tag este un comentariu și nu aveți nevoie de el după ce aveți ToC la locul lor.
(implicit: false)

--use_id
Utilizați id="nume" pentru ancore mai degrabă decâtnume"> ancore. Totuşi dacă o ancoră
există deja pentru un element semnificativ, acest lucru nu va face un ID pentru acel anume
element.

--useorg
Utilizați fișierele de rezervă preexistente ca sursă de intrare; adică fișiere de formular
nume de fișier.Bak (vezi --bak).

FILE FORMATE

Opţiuni Fişiere
Opțiunile pot fi date în fișiere, precum și pe linia de comandă folosind --argfile
nume de fișier opțiunea din linia de comandă. De asemenea, fișierele ~/.hipertocrc iar ./.hipertocrc sunt
verificat pentru opțiuni.

Formatul este următorul: liniile care încep cu # sunt comentarii. Liniile incluse în PoD
markerii sunt, de asemenea, comentarii. Liniile goale sunt ignorate. Opțiunile în sine ar trebui să fie
dat fiind modul în care ar fi pe linia de comandă, adică numele opțiunii (inclusiv il
--) urmat de valoarea acestuia (dacă există).

De exemplu:

# setați ToC la trei niveluri
--toc_entry H1=1
--toc_entry H2=2
--toc_entry H3=3

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

Fișierele cu opțiuni pot fi imbricate, dând un --argfile nume de fișier argument în interiorul opțiunii
fișier, va merge și va primi și acel fișier referit.

Consultați Getopt::ArgvFile pentru mai multe informații.

DETALII

Semnificativ Elemente de
Iată câteva exemple de definire a elementelor semnificative pentru cuprinsul dvs.

Exemplu of Mod implicit

Următoarele reflectă setarea implicită dacă nimic nu este specificat în mod explicit:

--toc_entry „H1=1” --toc_end „H1=/H1” --toc_entry „H2=2” --toc_end „H2=/H2”

Sau, dacă a fost definit într-unul dintre posibilele „Fișiere de opțiuni”:

# setări implicite
--toc_entry H1=1
--toc_end H1=/H1
--toc_entry H2=2
--toc_end H2=/H2

Exemplu of înainte după

Următoarele opțiuni folosesc opțiunile înainte/după:

# Un fișier de opțiuni care adaugă o anumită formatare
# faceți intrări în ToC de nivelul 1
--toc_entry H1=1
--toc_end H1=/H1
--toc_before H1=
--toc_după H1=

# faceți intrări în ToC de nivelul 2
--toc_entry H2=2
--toc_end H2=/H2
--toc_before H2=
--toc_după H2=

# Faceți intrările de nivelul 3 așa cum sunt
--toc_entry H3=3
--toc_end H3=/H3

Exemplu of personalizat capăt

Următoarele opțiuni încearcă să indexeze termenii definiți:

# Un fișier de opțiuni care poate funcționa pentru documente de tip Glosar
--toc_entry H1=1
--toc_end H1=/H1
--toc_entry H2=2
--toc_end H2=/H2

# Presupune că documentul are un DD pentru fiecare DT, altfel ToC
# va primi intrări cu mult text.
--toc_entry DT=3
--toc_end DT=DD
--toc_before DT=
--toc_după DT=

Formatarea il ToC
Opțiunile --toc_entry etc. vă oferă control asupra modului în care pot arăta intrările ToC, dar acolo
sunt alte opțiuni pentru a afecta aspectul final al fișierului ToC creat.

Cu opțiunea --header, conținutul fișierului dat va fi adăugat înainte de
ToC generat. Acest lucru vă permite să aveți text introductiv sau orice alt text înainte de
ToC.

Notă:
Dacă utilizați opțiunea --header, asigurați-vă că fișierul specificat conține codul HTML de deschidere
eticheta, elementul HEAD (conținând elementul TITLE) și eticheta BODY de deschidere.
Cu toate acestea, aceste etichete/elemente nu ar trebui să fie în fișierul antet dacă opțiunile --inline
este folosit. Consultați „Inlinearea ToC” pentru informații despre ce ar trebui să conțină fișierul antet
pentru integrarea ToC.

Cu opțiunea --toc_label, conținutul șirului dat va fi adăugat înainte de
ToC generat (dar după orice text preluat dintr-un fișier --header).

Cu opțiunea --footer, conținutul fișierului va fi atașat după generare
ToC.

Notă:
Dacă utilizați -footer, asigurați-vă că include etichetele BODY și HTML de închidere (cu excepția cazului în care,
desigur, utilizați opțiunea --inline).

Dacă opțiunea --header nu este specificată, va fi marcarea HTML de pornire adecvată
adăugată, cu excepția cazului în care este specificată opțiunea --toc_only. Dacă opțiunea --footer nu este
specificat, se va adăuga marcajul HTML de închidere corespunzător, cu excepția cazului în care opțiunea --toc_only
este specificat.

Dacă nu doriți/trebuie să vă ocupați de fișierele antet și subsol, atunci vi se acordă
specificați titlul, opțiunea --title, a fișierului ToC; și vă permite să specificați a
antet, sau etichetă, pentru a pune înaintea listei de intrări ToC, opțiunea --toc_label. Ambele variante
au valori implicite, consultați „OPȚIUNI” pentru mai multe informații despre fiecare opțiune.

Dacă nu doriți ca etichetele de pagină HTML să fie furnizate și doriți doar ToC în sine, atunci
specificați opțiunea --toc_only. Dacă nu există fișiere --header sau --footer, atunci aceasta va fi
pur și simplu scoateți conținutul --toc_label și ToC în sine.

Inliniere il ToC
Capacitatea de a încorpora ToC direct într-un document HTML este acceptată prin intermediul
--opțiune în linie.

Inlinearea se va face pe primul fișier din lista de fișiere procesate și va fi doar
făcut dacă acel fișier conține o etichetă de deschidere care se potrivește cu valoarea --toc_tag.

Dacă --overwrite este adevărat, atunci primul fișier din listă va fi suprascris, cu
ToC generat inserat la locul corespunzător. În caz contrar, o versiune modificată a primei
fișierul este scos fie în STDOUT, fie în fișierul de ieșire definit de opțiunea --outfile.

Opțiunile --toc_tag și --toc_tag_replace sunt utilizate pentru a determina unde și cum este ToC
introdus în ieșire.

Exemplu 1

# acesta este implicit
--toc_tag BODY --notoc_tag_replace

Acest lucru va pune ToC generat după eticheta BODY a primului fișier. Dacă antetul --
este specificată opțiunea, apoi conținutul fișierului specificat este inserat după BODY
etichetă. Dacă opțiunea --toc_label nu este goală, atunci textul specificat de --toc_label
este inserată opțiunea. Apoi este inserat ToC și, în sfârșit, dacă opțiunea --footer este
specificat, inserează subsolul. Apoi, restul fișierului de intrare urmează așa cum a fost
înainte.

Exemplu 2

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

Acest lucru va pune ToC generat după primul comentariu al formularului , și asta
comentariul va fi înlocuit cu ToC (în ordinea
--antet
--toc_label
ToC
--footer) urmat de restul fișierului de intrare.

Notă:
Fișierul antet nu trebuie să conțină eticheta HTML de început și elementul HEAD de la
Fișierul HTML în curs de procesare ar trebui să conțină deja aceste etichete/elemente.

EXEMPLE

Crea an inline ToC pentru unu fişier
hypertoc --inline --make_anchors --overwrite --make_toc index.html

Acest lucru va crea ancore în „index.html”, va crea un ToC cu un titlu „Tabel of
Contents” și plasați-l după eticheta BODY de „index.html”. Fișierul index.html.org va
conține fișierul index.html original, fără ToC sau ancore.

Crea a ToC fişier din multiplu fișiere
Mai întâi, creați ancorele.

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

Apoi creați ToC

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

Crea an inline ToC după il primul îndreptare of il primul fişier
hypertoc --make_anchors --inline --overwrite --make_toc --toc_tag /H1 \
--notoc_tag_replace --toc_label "" index.html fred.html george.html

Aceasta va crea ancore în fișierele „index.html”, „fred.html” și „george.html”, creați
un ToC fără antet și plasați-l după primul antet H1 în „index.html” și faceți o copie de rezervă
fișierele originale la „index.html.org”, „fred.html.org” și „george.html.org”

Crea an inline ToC cu personalizat element
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

Aceasta va crea o ToC inline care va suprascrie fișierul original și va înlocui un
comentariu și care ia anteturile H2 ca nivel 1 și antetele H3 ca nivel 2. Acest lucru poate fi
util acolo unde fișierul .html este generat de un alt proces și apoi îl puteți crea
ToC ca ultim pas.

Crea a ToC cu personalizat element
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 george.html

Acest lucru creează ancore la elementele H2 și H3 și creează un fișier ToC numit index.html,
indexarea pe TITLE și elementele H2 și H3.

Crea a ToC cu personalizat element și Opțiuni fişier
Având în vedere un fișier de opțiuni numit „custom.opt”, după cum urmează:

# Titlu, H2 și 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

atunci exemplul anterior poate avea linii de comandă mai scurte, după cum urmează:

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

NOTE

· hypertoc este suficient de inteligent pentru a detecta ancore în interiorul elementelor semnificative. Dacă ancora
definește atributul NAME, hypertoc folosește valoarea. În rest, își adaugă propriul NUME
atribui ancorei. Dacă --use_id este adevărat, atunci verifică și folosește
ID-uri.

· Elementul TITLE este tratat în mod special dacă este specificat ca element semnificativ. Este
ilegală introducerea ancorelor (A) în elementele TITLE. Prin urmare, hypertoc va de fapt
link către numele fișierului însuși în loc de elementul TITLE al documentului.

· hypertoc va ignora un element semnificativ dacă nu conține niciun spațiu care nu este alb
personaje. Un mesaj de avertizare este generat dacă există o astfel de condiție.

· Dacă aveți o succesiune de elemente semnificative care se modifică într-un mod ușor dezordonat
moda, cum ar fi H1 -> H3 -> H2 sau chiar H2 -> H1, deși hypertoc se ocupă de asta pentru
creați o listă care este încă HTML bună, dacă utilizați o listă ordonată pentru aceasta
adâncime, atunci veți obține o numerotare ciudată, așa cum ar fi fost un element suplimentar de listă
introdus pentru a cuibari elementele la nivelul corect.

De exemplu (H2 -> H1 cu --ol_num_levels=1):

1.
* Antetul meu H2
2. Antetul meu H1

De exemplu (H1 -> H3 -> H2 cu --ol_num_levels=0 și H3 fiind de asemenea semnificative):

1. Antetul meu H1
1.
1. Antetul meu H3
2. Antetul meu H2
2. Al doilea antet H1 al meu

În astfel de cazuri, poate fi mai bine să nu utilizați opțiunea --ol.

· Dacă nu se utilizează --overwrite atunci când se generează ancore, atunci comanda trebuie să fie
făcut în două treceri, pentru a da numele corecte de fișiere (cele cu actual
ancore în ele) la partea de generare a ToC. În caz contrar, ToC va avea ancore
arătând spre fișiere care nu le au.

· Când utilizați --inline, trebuie să aveți grijă dacă se suprascrie -- dacă se setează ToC la
să fie incluse după o etichetă dată (cum ar fi BODY implicită), apoi dacă cineva rulează comanda
în mod repetat, se putea obține mai multe ToC în același fișier, unul după altul.

Avertismente

· Versiunea 3.10 (și mai sus) generează ancore mai detaliate (prietenoase pentru SEO) decât înainte
versiuni. Astfel, ancorele generate cu versiuni anterioare nu se vor potrivi cu versiunea 3.10
ancore.

· Versiunea 3.00 (și mai sus) a hypertoc se comportă oarecum diferit față de versiunea 2.x a
hipertoc. Acum este proiectat să facă totul într-o singură trecere și a scăzut sigur
opțiuni: opțiunea --infile nu mai este utilizată (toate numele fișierelor sunt puse la sfârșitul lui
comanda); opțiunea --toc_file nu mai există; utilizați opțiunea --outfile
in schimb; opțiunea --tocmap nu mai este acceptată.

Acum generează etichete cu litere mici, mai degrabă decât cele cu majuscule.

· hypertoc nu este foarte eficient (memorie și viteză), și poate fi lent pentru mare
documente.

· Acum acea generație de ancore și de ToC se fac într-o singură trecere, chiar mai multă memorie
este folosit decât a fost cazul înainte. Acest lucru este mai notabil atunci când procesați mai multe
fișiere, deoarece toate fișierele sunt citite în memorie înainte de a le procesa.

· Markup nevalid va fi generat dacă un element semnificativ este conținut în interiorul unui
ancoră. De exemplu:

Comanda FOO

va fi convertit în (dacă h1 este un element semnificativ),

Comanda FOO

ceea ce este ilegal deoarece ancorele nu pot fi imbricate.

Este mai bine să puneți declarații de ancorare în elementul care trebuie ancorat. Pentru
exemplu, se preferă următoarele:

Comanda FOO

hypertoc va detecta NUMELE „foo” și îl va folosi.

Și mai bine este să folosiți ID-uri:

Comanda FOO

· Atributele NAME fără ghilimele nu sunt recunoscute.

Utilizați hypertocp online folosind serviciile onworks.net