hypertocp - Online nel cloud

PROGRAMMA:

NOME

hypertoc - genera un sommario per documenti HTML

VERSIONE

Versione 3.20

SINOSSI

hypertoc --help | --manpage | --man_help | --uomo

ipertoc [--bak stringa ] [ --debug ] [ --entrysep stringa ] [ --piè di pagina filetto ] [ --intestazione
filetto ] [ --ignore_only_one ] [ --ignore_sole_first ] [ --inline ] [ --make_anchors ] [
--make_toc ] [ --notoc_match stringa ] [ --ol | --nool ] [ --ol_num_livelli ] [ --outfile
filetto ] [ --overwrite ] [ --quiet ] [ --textonly ] [ --title stringa ] { --toc_dopo
tag=suffisso } { --toc_prima tag=prefisso } { --toc_end tag=tag finale } { --toc_entry tag=livello
} [ --toc_etichetta stringa ] [ --toc_only | --notoc_only ] [ --toc_tag stringa ] [
--toc_tag_replace ] [ --use_id ] [ --useorg ] file...

DESCRIZIONE

hypertoc ti consente di specificare "elementi significativi" a cui verrà collegato un collegamento ipertestuale in a
"Table of Contents" (ToC) per un determinato insieme di documenti HTML.

Fondamentalmente, il ToC generato è un elenco a più livelli contenente collegamenti al
elementi significativi. hypertoc inserisce i collegamenti nel ToC a elementi significativi in ​​a
livello specificato dall'utente.

Esempio:

Se gli H1 sono specificati come livello 1, allora appaiono nell'elenco di primo livello del ToC. Se
Gli H2 sono specificati come livello 2, quindi appaiono in un elenco di secondo livello nel ToC.

Ci sono due aspetti della generazione di ToC: (1) inserire ancore adeguate nell'HTML
documenti (--make_anchors) e (2) generare il ToC da documenti HTML che hanno
ancore al loro interno affinché il ToC si colleghi a (--make_toc). Si può scegliere di fare uno o entrambi
Questi.

hypertoc supporta anche la capacità di incorporare il ToC nel documento HTML stesso
tramite l'opzione --inline.

Affinché hypertoc supporti il ​​collegamento a elementi significativi, hypertoc inserisce ancore
negli elementi significativi. Si può usare hypertoc come filtro, emettendo il risultato su
un altro file, o si può sovrascrivere il file originale, con il backup dell'originale con a
suffisso (predefinito: "org") aggiunto al nome del file.

Si possono anche definire le opzioni in un file di configurazione così come sulla riga di comando.

VERSIONI

Le opzioni possono iniziare con "--" o "-"; le opzioni booleane possono essere negate facendole precedere da
"no"; le opzioni con valori hash o array possono essere aggiunte dando di nuovo l'opzione per
ogni valore.

Vedi Getopt::Long per maggiori informazioni.

--argfile Nome del file
Il nome di un file da cui leggere più opzioni. Questo può essere utilizzato più di una volta. Per
esempio:

--argfile tuo.args --argfile mio.args

Vedere "File delle opzioni" per ulteriori informazioni.

--bak
--bak stringa

Se il file/i file di input è/sono in fase di sovrascrittura (--overwrite è attivo), copiare il file
file originale in "Nome del file.stringa". Se il valore è vuoto, non esiste un file di backup
scritto. (predefinito:org)

- debug
Abilita output di debug dettagliato. Utilizzato per il debug di questo modulo; in altre parole,
non preoccuparti. (predefinito: disattivato)

--entratasep
--entratasep stringa

Stringa di separazione per non voci dell'elemento (predefinito: ", ")

--piè di pagina
--piè di pagina filetto

File contenente il testo del piè di pagina per il sommario.

--intestazione
--intestazione filetto

File contenente il testo dell'intestazione per il sommario.

--Aiuto
Stampa un breve messaggio di aiuto ed esci.

--ignora_solo_uno
Se ci fosse un solo elemento nel ToC, non creare un ToC.

--ignore_sole_first
Se il primo elemento nel ToC è del livello più alto, E è l'unico di quello
livello, ignoralo. Ciò è utile nelle pagine Web in cui è presente solo un'intestazione H1 ma
non si sa in anticipo se ce ne sarà uno solo.

--in linea
Metti ToC nel documento in un dato punto. Vedere "Inserimento del ToC" per ulteriori informazioni.

--make_anchors | --gen_anchors
Crea ancore per il sommario a cui collegarsi.

--make_toc | --gen_toc
Crea un sommario che si colleghi a elementi significativi ancorati.

--man_help | --manpage | --uomo
Stampa tutta la documentazione ed esci.

--notoc_match
--notoc_match stringa

Se ci sono alcuni tag individuali che non desideri includere nella tabella di
contenuti, anche se corrispondono agli "elementi significativi", allora se questo modello
corrisponde al contenuto all'interno del tag (non al corpo), allora quel tag non verrà incluso,
né nel generare ancore né nel generare il ToC. (predefinito: class="notoc")

--olo | --nool
Utilizzare un elenco ordinato per le voci del sommario (a una determinata profondità). Se --ol è
false (cioè --nool è impostato) allora non utilizzare un elenco ordinato per le voci del sommario.

(predefinito: falso)

(Vedi --ol_num_levels per determinare quanto è profondo l'elenco dell'elenco ordinato)

--ol_num_livelli
Il numero di livelli profondi dell'elenco OL andrà se --ol è vero. Se impostato a zero,
utilizzerà un elenco ordinato per tutti i livelli. (predefinito:1)

--file di uscita
--file di uscita filetto

File in cui scrivere l'output. Qui è dove l'output HTML modificato e il Table-of-
Il contenuto va a. Se inserisci '-' come nome del file, l'output andrà a STDOUT.
(predefinito: STDOUT)

--sovrascrivi
Sovrascrivi il file di input con l'output. Se questo è in vigore, --outfile viene ignorato.
Usato in generare_ancore per creare le ancore "in place" e in generare_toc if
l'opzione --inline è attiva. (predefinito: disattivato)

--silenzioso
Sopprimere i messaggi informativi. (predefinito: disattivato)

--solo testo
Usa solo contenuto di testo in elementi significativi.

--titolo
--titolo stringa

Titolo per la pagina ToC (se non si utilizza --header o --inline o --toc_only) (predefinito: "Table
dei Contenuti")

--toc_dopo
--toc_dopo etichetta=suffisso

--toc_after "H2= "

Per definire il layout degli elementi significativi nel ToC. Il etichetta è il tag HTML che
segna l'inizio dell'elemento. Il suffisso è ciò che deve essere aggiunto al
Voce del sommario generata per quel tag. Questo è un argomento hash cumulativo.
(predefinito: non definito)

--toc_prima
--toc_prima etichetta=prefisso

--toc_before "H2= "

Per definire la disposizione degli elementi significativi nel ToC. Il etichetta è il tag HTML
che segna l'inizio dell'elemento. Il prefisso è ciò che è necessario anteporre
alla voce Sommario generata per quel tag. Questo è un hash cumulativo
discussione. (predefinito: non definito)

--toc_end
--toc_end etichetta=tag di chiusura

--toc_end "H1=/H1"

Per la definizione di elementi significativi. Il etichetta è il tag HTML che segna l'inizio di
l'elemento. Il tag di chiusura il tag HTML che segna la fine dell'elemento. quando
corrispondenza nel file di input, il caso viene ignorato (ma assicurati che tutti i tuoi etichetta Opzioni
riferendosi allo stesso tag sono esattamente gli stessi!). Questo è un argomento hash cumulativo.
(predefinito: H1=/H1 H2=/H2)

--toc_entrata
--toc_entrata etichetta=livello

--toc_entry "TITOLO=1" --toc_entry "H1=2"

Per la definizione di elementi significativi. Il etichetta è il tag HTML che segna l'inizio di
l'elemento. Il livello è il livello considerato il tag. Il valore di livello
deve essere numerico e diverso da zero. Se il valore è negativo, voci consecutive
rappresentato dall'elemento_significativo sarà separato dal valore impostato da
--opzione entrysep. Questo è un argomento hash cumulativo. (predefinito: H1=1 H2=2)

--toc_etichetta | --toclabel
--toc_etichetta stringa

Testo HTML che etichetta il ToC. Usato sempre. (predefinito: " Sommario ")

--toc_only | --notoc_only
Emetti solo il sommario, ovvero il sommario più toc_label.
Se è presente un --header o un --footer, verranno emessi anche questi.

Se --toc_only è false (cioè --notoc_only è impostato) allora se non c'è --header, e
--inline non è vero, verrà emessa un'intestazione di pagina HTML adatta e, se c'è
no --footer e --inline non è vero, verrà emesso un piè di pagina HTML.
(predefinito:--notoc_only)

--toc_tag
--toc_tag stringa

Se un ToC deve essere incluso in linea, questo è il modello che viene utilizzato per abbinare il tag
dove dovrebbe essere messo il ToC. Può essere un tag iniziale, un tag finale o un commento, ma
il < dovrebbe essere omesso; cioè, se vuoi che il ToC sia posizionato dopo il BODY
tag, quindi dai "BODY". Se vuoi un tag commento speciale da inserire dove dovrebbe essere il ToC
vai, quindi includi i segni di commento, ad esempio: "!--toc--" (predefinito:BODY)

--toc_tag_replace
Insieme a --toc_tag, questo è un flag per dire se il tag dato dovrebbe essere
sostituito, o se il ToC deve essere messo dopo il tag. Questo può essere utile se il tuo
toc_tag è un commento e non ne hai bisogno dopo aver attivato il ToC.
(predefinito: falso)

--use_id
Usa id="Nome" per ancore piuttosto cheNome"> ancore. Tuttavia se un'ancora
esiste già per un elemento significativo, questo non creerà un ID per quel particolare
elemento.

--useorg
Utilizzare file di backup preesistenti come origine di input; cioè, file della forma
Nome del file.bak (vedi --bak).

RISORSE FORMATI

Opzioni File
Le opzioni possono essere fornite nei file così come sulla riga di comando usando --argfile
Nome del file opzione nella riga di comando. Inoltre, i file ~/.hypertocrc e ./.hypertocrc sono
controllato per le opzioni.

Il formato è il seguente: Le righe che iniziano con # sono commenti. Linee racchiuse in PoD
i marcatori sono anche commenti. Le righe vuote vengono ignorate. Le opzioni stesse dovrebbero essere
dato il modo in cui sarebbero sulla riga di comando, ovvero il nome dell'opzione (Compreso , il
--) seguito dal suo valore (se presente).

Per esempio:

# imposta il ToC su tre livelli
--toc_voce H1=1
--toc_voce H2=2
--toc_voce H3=3

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

I file di opzioni possono essere nidificati, dando un --argfile Nome del file argomento all'interno dell'opzione
file, andrà a prendere anche quel file di riferimento.

Vedere Getopt::ArgvFile per ulteriori informazioni.

DETTAGLI

Significativo Elementi
Ecco alcuni esempi di definizione degli elementi significativi per il tuo sommario.

Esempio of Predefinito

Quanto segue riflette l'impostazione predefinita se non viene specificato nulla in modo esplicito:

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

Oppure, se è stato definito in uno dei possibili "File Opzioni":

# impostazioni predefinite
--toc_voce H1=1
--toc_end H1=/H1
--toc_voce H2=2
--toc_end H2=/H2

Esempio of prima dopo

Le seguenti opzioni utilizzano le opzioni prima/dopo:

# Un file di opzioni che aggiunge un po' di formattazione
# crea voci ToC di livello 1
--toc_voce H1=1
--toc_end H1=/H1
--toc_before H1=
--toc_after H1=

# crea voci ToC di livello 2
--toc_voce H2=2
--toc_end H2=/H2
--toc_before H2=
--toc_after H2=

# Crea le voci di livello 3 così come sono
--toc_voce H3=3
--toc_end H3=/H3

Esempio of costume fine

Le seguenti opzioni cercano di indicizzare i termini di definizione:

# Un file di opzioni che può funzionare per documenti di tipo Glossario
--toc_voce H1=1
--toc_end H1=/H1
--toc_voce H2=2
--toc_end H2=/H2

# Presuppone che il documento abbia un DD per ogni DT, altrimenti ToC
# otterrà voci con molto testo.
--toc_entry DT=3
--toc_end DT=GG
--toc_before DT=
--toc_after DT=

formattazione , il ToC
Le opzioni --toc_entry ecc. ti danno il controllo su come possono apparire le voci ToC, ma c'è
sono altre opzioni per influenzare l'aspetto finale del file ToC creato.

Con l'opzione --header, il contenuto del file dato verrà anteposto prima del
ToC generato. Questo ti permette di avere un testo introduttivo, o qualsiasi altro testo, prima del
ToC.

Nota:
Se usi l'opzione --header, assicurati che il file specificato contenga l'HTML di apertura
tag, l'elemento HEAD (contenente l'elemento TITLE) e il tag BODY di apertura.
Tuttavia, questi tag/elementi non dovrebbero essere nel file di intestazione se le opzioni --inline
viene utilizzato. Vedere "Inlineare il ToC" per informazioni su cosa dovrebbe contenere il file di intestazione
per incorporare il ToC.

Con l'opzione --toc_label, il contenuto della stringa data verrà anteposto prima del
ToC generato (ma dopo qualsiasi testo preso da un file --header).

Con l'opzione --footer, il contenuto del file verrà aggiunto dopo il generato
ToC.

Nota:
Se usi il -footer, assicurati che includa i tag di chiusura BODY e HTML (a meno che,
ovviamente stai usando l'opzione --inline).

Se l'opzione --header non è specificata, il markup HTML iniziale appropriato sarà
aggiunto, a meno che non sia specificata l'opzione --toc_only. Se l'opzione --footer non lo è
specificato, verrà aggiunto il markup HTML di chiusura appropriato, a meno che l'opzione --toc_only
è specificato.

Se non vuoi/hai bisogno di gestire i file di intestazione e piè di pagina, allora sei assegnato a
specificare il titolo, opzione --title, del file ToC; e ti permette di specificare a
intestazione, o etichetta, da mettere prima dell'elenco delle voci ToC, l'opzione --toc_label. Entrambe le opzioni
hanno valori predefiniti, vedere "OPZIONI" per maggiori informazioni su ciascuna opzione.

Se non vuoi che vengano forniti i tag della pagina HTML e vuoi solo il ToC stesso, allora
specificare l'opzione --toc_only. Se non ci sono file --header o --footer, questo lo farà
emette semplicemente il contenuto di --toc_label e il ToC stesso.

inlining , il ToC
La capacità di incorporare il ToC direttamente in un documento HTML è supportata tramite il
--opzione in linea.

L'inlining verrà eseguito sul primo file nell'elenco dei file elaborati e sarà solo
fatto se quel file contiene un tag di apertura che corrisponde al valore --toc_tag.

Se --overwrite è vero, il primo file nell'elenco verrà sovrascritto, con il
ToC generato inserito nel punto appropriato. Altrimenti una versione modificata della prima
file viene emesso su STDOUT o sul file di output definito dall'opzione --outfile.

Le opzioni --toc_tag e --toc_tag_replace sono usate per determinare dove e come si trova il ToC
inserito nell'output.

Esempio 1

# questa è l'impostazione predefinita
--toc_tag CORPO --notoc_tag_replace

Questo metterà il ToC generato dopo il tag BODY del primo file. Se --header
viene specificata l'opzione, quindi i contenuti del file specificato vengono inseriti dopo il BODY
etichetta. Se l'opzione --toc_label non è vuota, allora il testo specificato da --toc_label
l'opzione è inserita. Quindi viene inserito il ToC e, infine, se l'opzione --footer è
specificato, inserisce il piè di pagina. Quindi il resto del file di input segue come era
prima.

Esempio 2

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

Questo metterà il ToC generato dopo il primo commento del modulo , e quello
commento sarà sostituito dal ToC (nell'ordine
--intestazione
--toc_etichetta
ToC
--footer) seguito dal resto del file di input.

Nota:
Il file di intestazione non deve contenere il tag HTML iniziale e l'elemento HEAD poiché il
Il file HTML in elaborazione dovrebbe già contenere questi tag/elementi.

ESEMPI

Creare an inline ToC per prima filetto
hypertoc --inline --make_anchors --overwrite --make_toc indice.html

Questo creerà ancore in "index.html", creerà un ToC con un'intestazione di "Table of
Contents" e posizionarlo dopo il tag BODY di "index.html". Il file index.html.org lo farà
contengono il file index.html originale, senza ToC o anchor.

Creare a ToC filetto da multiplo file
Per prima cosa, crea le ancore.

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

Quindi creare il ToC

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

Creare an inline ToC dopo , il prima di tutto intestazione of , il prima di tutto filetto
hypertoc --make_anchors --inline --overwrite --make_toc --toc_tag /H1 \
--notoc_tag_replace --toc_label "" index.html fred.html george.html

Questo creerà ancore nei file "index.html", "fred.html" e "george.html", creare
un ToC senza intestazione e posizionarlo dopo la prima intestazione H1 in "index.html" ed eseguire il backup
i file originali in "index.html.org", "fred.html.org" e "george.html.org"

Creare an inline ToC con costume elementi
hypertoc --quiet --make_anchors --bak "" --overwrite \
--make_toc --inline --toc_label "" --toc_tag '!--toc--' \
--toc_tag_replace \
--toc_voce H2=1 --toc_voce H3=2 \
--toc_end H2=/H2 --toc_end H3=/H3 miofile.html

Questo creerà un ToC in linea sovrascrivendo il file originale e sostituendo a
commento e che accetta le intestazioni H2 come livello 1 e le intestazioni H3 come livello 2. Questo può essere
utile dove il file .html viene generato da qualche altro processo e puoi quindi creare
il ToC come ultimo passaggio.

Creare a ToC con costume elementi
hypertoc --quiet --make_anchors --bak "" --overwrite \
--toc_entry TITOLO=1 --toc_end TITOLO=/TITOLO
--toc_voce H2=2 --toc_voce H3=3 \
--toc_end H2=/H2 --toc_end H3=/H3 \
--make_toc --outfile indice.html \
maria.html fred.html giorgio.html

Questo crea ancoraggi agli elementi H2 e H3 e crea un file ToC chiamato index.html,
indicizzazione sul TITOLO e sugli elementi H2 e H3.

Creare a ToC con costume elementi ed Opzioni filetto
Dato un file di opzioni chiamato 'custom.opt' come segue:

# Titolo, H2 e H3
--toc_entry TITOLO=1
--toc_end TITOLO=/TITOLO
--toc_voce H2=2
--toc_end H2=/H2
--toc_voce H3=3
--toc_end H3=/H3

quindi l'esempio precedente può avere righe di comando più brevi come segue:

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

NOTE

· hypertoc è abbastanza intelligente da rilevare ancore all'interno di elementi significativi. Se l'ancora
definisce l'attributo NAME, hypertoc utilizza il valore. Altrimenti, aggiunge il proprio NOME
attribuire all'ancora. Se --use_id è vero, controlla e usa allo stesso modo
ID.

· L'elemento TITLE viene trattato in modo speciale se specificato come elemento significativo. è
illegale inserire ancore (A) negli elementi TITLE. Pertanto, hypertoc sarà effettivamente
link al nome del file stesso invece dell'elemento TITLE del documento.

· hypertoc ignorerà un elemento significativo se non contiene alcuno spazio non bianco
caratteri. Se esiste una tale condizione, viene generato un messaggio di avviso.

· Se si dispone di una sequenza di elementi significativi che cambiano in modo leggermente disordinato
moda, come H1 -> H3 -> H2 o anche H2 -> H1, anche se hypertoc si occupa di questo per
crea un elenco che sia ancora un buon HTML, se stai usando un elenco ordinato per quello
profondità, quindi otterrai una numerazione strana, poiché sarà stato un elemento di elenco in più
inserito per annidare gli elementi al livello corretto.

Ad esempio (H2 -> H1 con --ol_num_levels=1):

1.
* La mia intestazione H2
2. La mia intestazione H1

Ad esempio (H1 -> H3 -> H2 con --ol_num_levels=0 e anche H3 è significativo):

1. La mia intestazione H1
1.
1. La mia intestazione H3
2. La mia intestazione H2
2. La mia seconda intestazione H1

In casi come questo potrebbe essere meglio non usare l'opzione --ol.

· Se non si usa --overwrite durante la generazione di ancore, allora il comando deve essere
fatto in due passaggi, in modo da dare i nomi di file corretti (quelli con l'effettivo
ancore in esse) alla parte generazione ToC. Altrimenti il ​​ToC avrà delle ancore
puntando a file che ne sono sprovvisti.

· Quando si utilizza --inline, è necessario prestare attenzione se si sovrascrive -- se si imposta il ToC su
essere incluso dopo un dato tag (come il BODY predefinito) quindi se si esegue il comando
ripetutamente si potrebbero ottenere più ToC nello stesso file, uno dopo l'altro.

AVVERTENZE

· La versione 3.10 (e successive) genera ancoraggi più dettagliati (SEO-friendly) rispetto a prima
versioni. Pertanto le ancore generate con le versioni precedenti non corrisponderanno alla versione 3.10
ancore.

· La versione 3.00 (e successive) di hypertoc si comporta in modo leggermente diverso rispetto alla versione 2.x di
ipertoc. Ora è progettato per fare tutto in un passaggio e ha perso alcuni punti
opzioni: l'opzione --infile non viene più utilizzata (tutti i nomi dei file vengono messi alla fine di
il comando); l'opzione --toc_file non esiste più; usa l'opzione --outfile
Invece; l'opzione --tocmap non è più supportata.

Ora genera tag minuscoli anziché maiuscoli.

· hypertoc non è molto efficiente (memoria e velocità), e può essere lento per grandi
documenti.

· Ora che la generazione delle ancore e del ToC avviene in un solo passaggio, ancora più memoria
viene utilizzato rispetto a prima. Questo è più notevole quando si elaborano più
file, poiché tutti i file vengono letti in memoria prima di elaborarli.

· Verrà generato un markup non valido se un elemento significativo è contenuto all'interno di an
ancora. Per esempio:

Il comando FOO

sarà convertito in (se h1 è un elemento significativo),

Il comando FOO

che è illegale poiché le ancore non possono essere nidificate.

È uno stile migliore inserire istruzioni di ancoraggio all'interno dell'elemento da ancorare. Per
esempio, si preferisce quanto segue:

Il comando FOO

hypertoc rileverà il NOME "pippo" e lo utilizzerà.

Ancora meglio è usare gli ID:

Il comando FOO

· Gli attributi NAME senza virgolette non vengono riconosciuti.

Usa hypertocp online utilizzando i servizi onworks.net