hypertocp - En ligne dans le Cloud

PROGRAMME:

Nom

hypertoc - génère une table des matières pour les documents HTML

VERSION

Version 3.20

SYNOPSIS

hypertoc --help | --manpage | --man_help | --homme

hypertoque [--bak un magnifique ] [ --debug ] [ --entrysep un magnifique ] [ --bas de page filet ] [ --entête
filet ] [ --ignore_only_one ] [ --ignore_sole_first ] [ --inline ] [ --make_anchors ] [
--make_toc ] [ --notoc_match un magnifique ] [ --ol | --nool ] [ --ol_num_levels ] [ --outfile
filet ] [ --overwrite ] [ --quiet ] [ --textonly ] [ --title un magnifique ] { --toc_après
balise=suffixe } { --toc_avant balise=préfixe } { --toc_end balise=balise de fin } { --toc_entrée balise=niveau
} [ --toc_étiquette un magnifique ] [ --toc_only | --notoc_only ] [ --toc_tag un magnifique ] [
--toc_tag_replace ] [ --use_id ] [ --useorg ] fichier ...

DESCRIPTION

hypertoc vous permet de spécifier des "éléments significatifs" qui seront hyperliés dans un
"Table des matières" (ToC) pour un ensemble donné de documents HTML.

Fondamentalement, la ToC générée est une liste à plusieurs niveaux contenant des liens vers le
éléments significatifs. hypertoc insère les liens dans la ToC vers des éléments significatifs à un
niveau spécifié par l'utilisateur.

Mise en situation :

Si les H1 sont spécifiés au niveau 1, alors ils apparaissent dans la liste de premier niveau de la ToC. Si
Les H2 sont spécifiés comme un niveau 2, puis ils apparaissent dans une liste de deuxième niveau dans la ToC.

Il y a deux aspects à la génération de la ToC : (1) mettre des ancres appropriées dans le HTML
documents (--make_anchors), et (2) générer la ToC à partir de documents HTML qui ont
ancres en eux pour la table des matières à lier (--make_toc). On peut choisir de faire l'un ou les deux
celles-ci.

hypertoc prend également en charge la possibilité d'incorporer la table des matières dans le document HTML lui-même
via l'option --inline.

Pour que hypertoc prenne en charge les liens vers des éléments significatifs, hypertoc insère des ancres
dans les éléments significatifs. On peut utiliser hypertoc comme filtre, affichant le résultat dans
un autre fichier, ou on peut écraser le fichier d'origine, avec l'original sauvegardé avec un
suffixe (par défaut : "org") ajouté au nom de fichier.

On peut également définir des options dans un fichier de configuration ainsi que sur la ligne de commande.

OPTIONS

Les options peuvent commencer par "--" ou "-" ; les options booléennes peuvent être annulées en les faisant précéder de
"non"; les options avec des valeurs de hachage ou de tableau peuvent être ajoutées en redonnant l'option pour
chaque valeur.

Voir Getopt::Long pour plus d'informations.

--argfile nom de fichier
Le nom d'un fichier à partir duquel lire plus d'options. Cela peut être utilisé plus d'une fois. Pour
Exemple:

--argfile votre.args --argfile mon.args

Voir "Fichiers d'options" pour plus d'informations.

--bak
--bak un magnifique

Si le ou les fichiers d'entrée sont écrasés (--overwrite est activé), copiez le
fichier d'origine en "nom de fichier.un magnifique". Si la valeur est vide, il n'y a pas de fichier de sauvegarde
écrit. (par défaut : org)

--déboguer
Activez la sortie de débogage détaillée. Utilisé pour le débogage de ce module ; en d'autres termes,
ne vous embêtez pas. (par défaut : désactivé)

--entréesep
--entréesep un magnifique

Chaîne de séparation pour les non- entrées d'élément (par défaut : ", ")

--bas de page
--bas de page filet

Fichier contenant le texte du pied de page pour la table des matières.

--entête
--entête filet

Fichier contenant le texte d'en-tête pour la table des matières.

--Aidez-moi
Imprimez un court message d'aide et quittez.

--ignore_only_one
S'il n'y avait qu'un seul élément dans la ToC, ne faites pas de ToC.

--ignore_sole_first
Si le premier élément de la ToC est du niveau le plus élevé, ET c'est le seul de ce
niveau, ignorez-le. Ceci est utile dans les pages Web où il n'y a qu'un seul en-tête H1 mais
on ne sait pas d'avance s'il n'y en aura qu'un.

--en ligne
Mettez la ToC dans le document à un point donné. Voir « Inlining the ToC » pour plus d'informations.

--make_ancres | --gen_ancres
Créez des ancres pour la table des matières à lier.

--make_toc | --gen_toc
Créez une table des matières qui renvoie à des éléments significatifs ancrés.

--man_help | --manpage | --homme
Imprimez toute la documentation et quittez.

--notoc_match
--notoc_match un magnifique

S'il y a certaines balises individuelles que vous ne souhaitez pas inclure dans le tableau des
contenus, même s'ils correspondent aux « éléments significatifs », alors si ce modèle
correspond au contenu à l'intérieur de la balise (pas le corps), alors cette balise ne sera pas incluse,
ni dans la génération des ancres ni dans la génération de la ToC. (par défaut : class="notoc")

--ol | --nool
Utilisez une liste ordonnée pour les entrées de la table des matières (à une profondeur donnée). Si --ol est
false (c'est-à-dire que --nool est défini) alors ne le font pas utiliser une liste ordonnée pour les entrées de la table des matières.

(par défaut : faux)

(Voir --ol_num_levels pour déterminer la profondeur de la liste ordonnée)

--ol_num_levels
Le nombre de niveaux de profondeur de la liste OL ira si --ol est vrai. Si mis à zéro,
utilisera une liste ordonnée pour tous les niveaux. (par défaut : 1)

--fichier de sortie
--fichier de sortie filet

Fichier dans lequel écrire la sortie. C'est là que la sortie HTML modifiée et la table des
Le contenu va à. Si vous donnez « - » comme nom de fichier, la sortie ira à STDOUT.
(par défaut : STDOUT)

--écraser
Écrasez le fichier d'entrée avec la sortie. Si cela est en vigueur, --outfile est ignoré.
Utilisé dans générer_ancres pour créer les ancrages "en place" et dans générer_toc if
l'option --inline est active. (par défaut : désactivé)

--silencieux
Supprimer les messages informatifs. (par défaut : désactivé)

--texte seulement
Utilisez uniquement du contenu textuel dans les éléments significatifs.

--Titre
--Titre un magnifique

Titre de la page ToC (si vous n'utilisez pas --header ou --inline ou --toc_only) (par défaut : "Table
des contenus")

--toc_après
--toc_après Étiquette=suffixe

--toc_after "H2= "

Pour définir la disposition des éléments significatifs dans la ToC. Les Étiquette est la balise HTML qui
marque le début de l'élément. Les suffixe est ce qui doit être annexé à la
Entrée de table des matières générée pour cette balise. Il s'agit d'un argument de hachage cumulatif.
(par défaut : non défini)

--toc_avant
--toc_avant Étiquette=préfixe

--toc_before "H2= "

Pour définir la disposition des éléments significatifs dans la ToC. Les Étiquette est la balise HTML
qui marque le début de l'élément. Les préfixe est ce qui doit être préfixé
à l'entrée de la table des matières générée pour cette balise. Ceci est un hachage cumulatif
argument. (par défaut : non défini)

--toc_end
--toc_end Étiquette=balise de fin

--toc_end "H1=/H1"

Pour définir les éléments significatifs. Les Étiquette est la balise HTML qui marque le début de
l'élément. Les balise de fin la balise HTML qui marque la fin de l'élément. Lorsque
correspondant dans le fichier d'entrée, la casse est ignorée (mais assurez-vous que tous vos Étiquette Options
faisant référence à la même étiquette sont exactement les mêmes !). Il s'agit d'un argument de hachage cumulatif.
(par défaut : H1=/H1 H2=/H2)

--toc_entrée
--toc_entrée Étiquette=niveau

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

Pour définir les éléments significatifs. Les Étiquette est la balise HTML qui marque le début de
l'élément. Les niveau est le niveau auquel la balise est considérée. La valeur de niveau
doit être numérique et non nul. Si la valeur est négative, écritures consécutives
représenté par l'élément significatif sera séparé par la valeur définie par
--option d'entrée. Il s'agit d'un argument de hachage cumulatif. (par défaut : H1=1 H2=2)

--toc_label | --tocétiquette
--toc_étiquette un magnifique

Texte HTML qui étiquette la table des matières. Toujours utilisé. (défaut: " Table des matières ")

--toc_only | --notoc_only
Sortez uniquement la table des matières, c'est-à-dire la table des matières plus le toc_label.
S'il y a un --header ou un --footer, ceux-ci seront également affichés.

Si --toc_only est faux (c'est-à-dire --notoc_only est défini) alors s'il n'y a pas de --header, et
--inline n'est pas vrai, alors un en-tête de page HTML approprié sera affiché, et s'il y a
non --footer et --inline n'est pas vrai, un pied de page HTML sera généré.
(par défaut :--notoc_only)

--toc_tag
--toc_tag un magnifique

Si une ToC doit être incluse en ligne, c'est le modèle qui est utilisé pour faire correspondre la balise
où la table des matières doit être placée. Cela peut être une balise de début, une balise de fin ou un commentaire, mais
le < doit être omis ; c'est-à-dire, si vous voulez que la table des matières soit placée après le BODY
tag, puis donnez "BODY". Si vous voulez qu'une balise de commentaire spéciale soit placée là où la table des matières doit
go, puis incluez les marques de commentaire, par exemple : " !--toc--" (par défaut : BODY)

--toc_tag_replace
En conjonction avec --toc_tag, c'est un indicateur pour dire si la balise donnée doit être
remplacé, ou si la table des matières doit être placée après la balise. Cela peut être utile si votre
toc_tag est un commentaire et vous n'en avez pas besoin une fois que vous avez mis en place la table des matières.
(par défaut : faux)

--use_id
Utilisez id="prénom" pour les ancres plutôt queprénom"> ancres. Cependant si une ancre
existe déjà pour un élément significatif, cela ne fera pas d'ID pour cet élément particulier
.

--useorg
Utilisez des fichiers de sauvegarde préexistants comme source d'entrée ; c'est-à-dire des fichiers de la forme
nom de fichier.bak (voir --bak).

DOSSIER FORMATS

Options Fichiers
Les options peuvent être données dans les fichiers ainsi que sur la ligne de commande en utilisant le --argfile
nom de fichier option dans la ligne de commande. Aussi, les fichiers ~/.hypertocrc et ./.hypertocrc sont
coché pour les options.

Le format est le suivant : Les lignes commençant par # sont des commentaires. Lignes enfermées dans le PoD
les marqueurs sont aussi des commentaires. Les lignes vides sont ignorées. Les options elles-mêmes devraient être
étant donné la façon dont ils seraient sur la ligne de commande, c'est-à-dire le nom de l'option (comme le
--) suivi de sa valeur (le cas échéant).

Par exemple :

# définir la table des matières à trois niveaux
--toc_entry H1=1
--toc_entry H2=2
--toc_entry H3=3

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

Les fichiers d'options peuvent être imbriqués, en donnant un --argfile nom de fichier argument à l'intérieur de l'option
fichier, il ira également chercher ce fichier référé.

Voir Getopt::ArgvFile pour plus d'informations.

DÉTAILS

Important Éléments
Voici quelques exemples de définition des éléments importants pour votre table des matières.

Exemple of Réglage par défaut

Ce qui suit reflète le paramètre par défaut si rien n'est explicitement spécifié :

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

Ou, s'il a été défini dans l'un des "Fichiers d'options" possibles :

# paramètres par défaut
--toc_entry H1=1
--toc_end H1=/H1
--toc_entry H2=2
--toc_end H2=/H2

Exemple of avant après

Les options suivantes utilisent les options avant/après :

# Un fichier d'options qui ajoute du formatage
# créer des entrées ToC de niveau 1
--toc_entry H1=1
--toc_end H1=/H1
--toc_avant H1=
--toc_after H1=

# créer des entrées ToC de niveau 2
--toc_entry H2=2
--toc_end H2=/H2
--toc_avant H2=
--toc_after H2=

# Faites des entrées de niveau 3 telles quelles
--toc_entry H3=3
--toc_end H3=/H3

Exemple of Customiser fin

Les options suivantes tentent d'indexer les termes de définition :

# Un fichier d'options pouvant fonctionner pour les documents de type Glossaire
--toc_entry H1=1
--toc_end H1=/H1
--toc_entry H2=2
--toc_end H2=/H2

# Suppose que le document a un DD pour chaque DT, sinon ToC
# obtiendra des entrées avec beaucoup de texte.
--toc_entry DT=3
--toc_end DT=JJ
--toc_before DT=
--toc_after DT=

formatage le Table des matières
Les options --toc_entry etc. vous permettent de contrôler l'apparence des entrées de la table des matières, mais il
sont d'autres options pour affecter l'apparence finale du fichier ToC créé.

Avec l'option --header, le contenu du fichier donné sera ajouté avant le
ToC généré. Cela vous permet d'avoir un texte d'introduction, ou tout autre texte, avant le
Table des matières.

Remarque:
Si vous utilisez l'option --header, assurez-vous que le fichier spécifié contient le code HTML d'ouverture
balise, l'élément HEAD (contenant l'élément TITLE) et la balise d'ouverture BODY.
Cependant, ces balises/éléments ne doivent pas figurer dans le fichier d'en-tête si les options --inline
est utilisé. Voir "Inlining the ToC" pour plus d'informations sur ce que le fichier d'en-tête doit contenir
pour incorporer la ToC.

Avec l'option --toc_label, le contenu de la chaîne donnée sera ajouté avant le
ToC généré (mais après tout texte extrait d'un fichier --header).

Avec l'option --footer, le contenu du fichier sera ajouté après le
Table des matières.

Remarque:
Si vous utilisez le -footer, assurez-vous qu'il inclut les balises de fermeture BODY et HTML (à moins que,
bien sûr, vous utilisez l'option --inline).

Si l'option --header n'est pas spécifiée, le balisage HTML de départ approprié sera
ajouté, sauf si l'option --toc_only est spécifiée. Si l'option --footer n'est pas
spécifié, le balisage HTML de fermeture approprié sera ajouté, à moins que l'option --toc_only
est spécifié.

Si vous ne voulez pas / n'avez pas besoin de traiter les fichiers d'en-tête et de pied de page, vous êtes autorisé à
spécifiez le titre, option --title, du fichier ToC ; et il vous permet de spécifier un
titre, ou étiquette, à mettre avant la liste des entrées de la table des matières, l'option --toc_label. Les deux options
ont des valeurs par défaut, voir "OPTIONS" pour plus d'informations sur chaque option.

Si vous ne voulez pas que les balises de page HTML soient fournies, et que vous voulez juste la table des matières elle-même, alors
spécifiez l'option --toc_only. S'il n'y a pas de fichiers --header ou --footer, cela
affichez simplement le contenu de --toc_label et la table des matières elle-même.

Inliner le Table des matières
La possibilité d'incorporer la ToC directement dans un document HTML est prise en charge via le
--option en ligne.

L'inlining se fera sur le premier fichier de la liste des fichiers traités, et ne sera
terminé si ce fichier contient une balise d'ouverture correspondant à la valeur --toc_tag.

Si --overwrite est vrai, alors le premier fichier de la liste sera écrasé, avec le
ToC généré inséré à l'endroit approprié. Sinon une version modifiée du premier
Le fichier est sorti soit sur STDOUT, soit sur le fichier de sortie défini par l'option --outfile.

Les options --toc_tag et --toc_tag_replace sont utilisées pour déterminer où et comment la ToC est
inséré dans la sortie.

Exemple 1

# c'est la valeur par défaut
--toc_tag CORPS --notoc_tag_replace

Cela mettra la table des matières générée après la balise BODY du premier fichier. Si le --header
est spécifiée, alors le contenu du fichier spécifié est inséré après le BODY
étiqueter. Si l'option --toc_label n'est pas vide, alors le texte spécifié par --toc_label
l'option est insérée. Ensuite, la table des matières est insérée, et enfin, si l'option --footer est
spécifié, il insère le pied de page. Ensuite, le reste du fichier d'entrée suit comme il était
avant.

Exemple 2

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

Cela mettra la ToC générée après le premier commentaire du formulaire , et cela
commentaire sera remplacé par la ToC (dans l'ordre
--entête
--toc_étiquette
Table des matières
--footer) suivi du reste du fichier d'entrée.

Remarque:
Le fichier d'en-tête ne doit pas contenir la balise HTML de début et l'élément HEAD car le
Le fichier HTML en cours de traitement doit déjà contenir ces balises/éléments.

EXEMPLES

Création an en ligne Table des matières en UN filet
hypertoc --inline --make_anchors --overwrite --make_toc index.html

Cela créera des ancres dans "index.html", créera une ToC avec un titre de "Table of
Contents" et placez-le après la balise BODY de "index.html". Le fichier index.html.org sera
contenir le fichier index.html d'origine, sans ToC ni ancres.

Création a Table des matières filet de plusieurs fichiers
Tout d'abord, créez les ancres.

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

Créez ensuite la table des matières

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

Création an en ligne Table des matières après le premier titre of le premier filet
hypertoc --make_anchors --inline --overwrite --make_toc --toc_tag /H1 \
--notoc_tag_replace --toc_label "" index.html fred.html george.html

Cela va créer des ancres dans les fichiers "index.html", "fred.html" et "george.html", créer
une table des matières sans en-tête et placez-la après le premier en-tête H1 dans "index.html" et sauvegardez
les fichiers originaux dans "index.html.org", "fred.html.org" et "george.html.org"

Création an en ligne Table des matières avec Customiser éléments
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 monfichier.html

Cela créera une table des matières en ligne écrasant le fichier d'origine et remplaçant un
commentaire, et qui prend les en-têtes H2 comme niveau 1 et les en-têtes H3 comme niveau 2. Cela peut être
utile lorsque le fichier .html est généré par un autre processus, et vous pouvez ensuite créer
la ToC comme dernière étape.

Création a Table des matières avec Customiser éléments
hypertoc --quiet --make_anchors --bak "" --overwrite \
--toc_entry TITRE=1 --toc_end TITRE=/TITRE
--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

Cela crée des ancres aux éléments H2 et H3, et crée un fichier ToC appelé index.html,
indexation sur le TITRE, et les éléments H2 et H3.

Création a Table des matières avec Customiser éléments ainsi que Options filet
Étant donné un fichier d'options appelé 'custom.opt' comme suit :

# Titre, H2 et H3
--toc_entry TITRE=1
--toc_end TITRE=/TITRE
--toc_entry H2=2
--toc_end H2=/H2
--toc_entry H3=3
--toc_end H3=/H3

alors l'exemple précédent peut avoir des lignes de commande plus courtes comme suit :

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

NOTES

· hypertoc est suffisamment intelligent pour détecter les ancres à l'intérieur d'éléments significatifs. Si l'ancre
définit l'attribut NAME, hypertoc utilise la valeur. Sinon, il ajoute son propre NOM
attribuer à l'ancre. Si --use_id est vrai, il vérifie et utilise également
identifiants.

· L'élément TITLE est traité spécialement s'il est spécifié comme élément significatif. Il est
il est interdit d'insérer des ancres (A) dans les éléments TITLE. Par conséquent, l'hypertoc sera en fait
lien vers le nom de fichier lui-même au lieu de l'élément TITLE du document.

· hypertoc ignorera un élément significatif s'il ne contient pas d'espace non blanc
personnages. Un message d'avertissement est généré si une telle condition existe.

· Si vous avez une séquence d'éléments significatifs qui changent de manière légèrement désordonnée
mode, comme H1 -> H3 -> H2 ou même H2 -> H1, bien que l'hypertoc traite de cela pour
créer une liste qui est toujours du bon HTML, si vous utilisez une liste ordonnée à cela
profondeur, alors vous obtiendrez une numérotation étrange, car un élément de liste supplémentaire aura été
inséré pour imbriquer les éléments au niveau correct.

Par exemple (H2 -> H1 avec --ol_num_levels=1) :

1.
* Mon en-tête H2
2. Mon en-tête H1

Par exemple (H1 -> H3 -> H2 avec --ol_num_levels=0 et H3 étant également significatifs) :

1. Mon en-tête H1
1.
1. Mon en-tête H3
2. Mon en-tête H2
2. Mon deuxième en-tête H1

Dans de tels cas, il peut être préférable de ne pas utiliser l'option --ol.

· Si l'on n'utilise pas --overwrite lors de la génération des ancres, alors la commande doit être
fait en deux passes, afin de donner les noms de fichiers corrects (ceux avec le
ancres en eux) à la partie génération ToC. Sinon la ToC aura des ancres
pointant vers des fichiers qui n'en ont pas.

· Lors de l'utilisation de --inline, il faut faire attention en cas d'écrasement -- si l'on définit le ToC sur
être inclus après une balise donnée (comme le BODY par défaut) puis si l'on exécute la commande
à plusieurs reprises, on pouvait obtenir plusieurs ToC dans le même fichier, l'un après l'autre.

MISES EN GARDE

· La version 3.10 (et supérieure) génère des ancres plus détaillées (conviviales pour le référencement) qu'avant
versions. Ainsi, les ancres générées avec les versions antérieures ne correspondront pas à la version 3.10
ancres.

· La version 3.00 (et supérieure) d'hypertoc se comporte quelque peu différemment de la version 2.x de
hypertoc. Il est maintenant conçu pour tout faire en un seul passage et a abandonné certaines
options : l'option --infile n'est plus utilisée (tous les noms de fichiers sont mis à la fin de
la commande); l'option --toc_file n'existe plus ; utilisez l'option --outfile
au lieu; l'option --tocmap n'est plus prise en charge.

Il génère désormais des balises en minuscules plutôt qu'en majuscules.

· hypertoc n'est pas très efficace (mémoire et vitesse), et peut être lent pour les gros
documents.

· Maintenant que la génération des ancres et de la ToC se fait en un seul passage, encore plus de mémoire
est utilisé qu'auparavant. Ceci est plus notable lors du traitement de plusieurs
fichiers, car tous les fichiers sont lus en mémoire avant de les traiter.

· Un balisage invalide sera généré si un élément significatif est contenu à l'intérieur d'un
ancre. Par exemple:

La commande FOO

sera converti en (si h1 est un élément significatif),

La commande FOO

ce qui est illégal car les ancres ne peuvent pas être imbriquées.

Il est préférable de placer des déclarations d'ancrage dans l'élément à ancrer. Pour
exemple, ce qui suit est préféré :

La commande FOO

hypertoc détectera le NOM "foo" et l'utilisera.

Encore mieux, c'est d'utiliser des identifiants :

La commande FOO

· Les attributs NAME sans guillemets ne sont pas reconnus.

Utiliser hypertocp en ligne en utilisant les services onworks.net