hypertocp - Online en la nube

PROGRAMA:

NOMBRE

hypertoc: genera una tabla de contenido para documentos HTML

VERSIÓN

Versión 3.20

SINOPSIS

hypertoc --help | --manpage | --man_help | --hombre

hipertoc [--bak cadena ] [--debug] [--entrysep cadena ] [--footer presentar ] [--header
presentar ] [--ignore_only_one] [--ignore_sole_first] [--inline] [--make_anchors] [
--make_toc] [--notoc_match cadena ] [--ol | --nool] [--ol_num_levels] [--outfile
presentar ] [--overwrite] [--quiet] [--textonly] [--title cadena ] {--toc_after
etiqueta = sufijo } {--toc_before etiqueta = prefijo } {--toc_end tag = endtag } {--toc_entry etiqueta = nivel
} [--toc_label cadena ] [--toc_only | --notoc_only] [--toc_tag cadena ] [
--toc_tag_replace] [--use_id] [--useorg] archivo ...

DESCRIPCIÓN

hypertoc le permite especificar "elementos significativos" a los que se enlazará en un hipervínculo
"Tabla de contenido" (ToC) para un conjunto determinado de documentos HTML.

Básicamente, la ToC generada es una lista de niveles múltiples que contiene enlaces a la
elementos significativos. hypertoc inserta los enlaces en la TdC a elementos significativos en un
nivel especificado por el usuario.

Ejemplo:

Si los H1 se especifican como nivel 1, aparecerán en la lista de primer nivel de la TdC. Si
Los H2 se especifican como nivel 2, de lo que aparecen en una lista de segundo nivel en la ToC.

Hay dos aspectos en la generación de ToC: (1) poner anclajes adecuados en el HTML
documentos (--make_anchors), y (2) generar la ToC a partir de documentos HTML que tienen
ancla en ellos para que la ToC se vincule a (--make_toc). Uno puede optar por hacer una o ambas
estas.

hypertoc también admite la capacidad de incorporar la ToC en el propio documento HTML
a través de la opción --inline.

Para que hypertoc admita la vinculación a elementos importantes, hypertoc inserta anclas
en los elementos significativos. Se puede usar hypertoc como filtro, dando salida al resultado a
otro archivo, o uno puede sobrescribir el archivo original, con el original respaldado con un
sufijo (predeterminado: "org") agregado al nombre del archivo.

También se pueden definir opciones en un archivo de configuración, así como en la línea de comandos.

CAMPUS

Las opciones pueden comenzar con "-" o "-"; Las opciones booleanas se pueden negar precediéndolas con
"no"; Se pueden agregar opciones con valores hash o de matriz dando la opción nuevamente para
cada valor.

Consulte Getopt :: Long para obtener más información.

--archivoarg nombre de archivo
El nombre de un archivo para leer más opciones. Esto se puede utilizar más de una vez. Para
ejemplo:

--argfile sus.argumentos --argfile mis.argumentos

Consulte "Archivos de opciones" para obtener más información.

--bak
--bak cadena

Si el archivo / archivos de entrada se sobrescriben (--overwrite está activado), copie el
archivo original a "nombre de archivo.cadena". Si el valor está vacío, no hay archivo de respaldo
escrito. (predeterminado: org)

--depurar
Habilite la salida de depuración detallada. Se utiliza para depurar este módulo; en otras palabras,
no te molestes. (predeterminado: desactivado)

--entrysep
--entrysep cadena

Cadena separadora para no entradas de elementos (predeterminado: ",")

--pie de página
--pie de página presentar

Archivo que contiene texto de pie de página para la tabla de contenido.

--encabezamiento
--encabezamiento presentar

Archivo que contiene el texto del encabezado de la tabla de contenido.

--ayuda
Imprima un breve mensaje de ayuda y salga.

--ignorar_solo_uno
Si solo hubiera un elemento en la TdC, no hagas una TdC.

--ignore_sole_first
Si el primer elemento de la TdC es del nivel más alto, Y es el único de ese
nivel, ignórelo. Esto es útil en páginas web donde solo hay un encabezado H1 pero
no se sabe de antemano si solo habrá uno.

--en línea
Ponga ToC en el documento en un punto dado. Consulte "Incluir la ToC" para obtener más información.

--make_anchors | --gen_anchors
Cree anclas para que la tabla de contenido se vincule.

--make_toc | --gen_toc
Haga una tabla de contenido que vincule a elementos importantes anclados.

--man_help | --manpage | --hombre
Imprima toda la documentación y salga.

--notoc_match
--notoc_match cadena

Si hay determinadas etiquetas individuales que no desea incluir en la tabla de
contenidos, aunque coincidan con los "elementos significativos", si este patrón
coincide con el contenido dentro de la etiqueta (no el cuerpo), entonces esa etiqueta no se incluirá,
ya sea en la generación de anclas ni en la generación de la ToC. (predeterminado: class = "notoc")

--ol | --nool
Utilice una lista ordenada para las entradas de la Tabla de contenido (a una profundidad determinada). Si --ol es
falso (es decir, nool está configurado) entonces Rechazar utilice una lista ordenada para las entradas de ToC.

(predeterminado: falso)

(Consulte --ol_num_levels para determinar qué tan profundo va el listado de lista ordenada)

--ol_num_niveles
El número de niveles de profundidad de la lista OL irá si --ol es verdadero. Si se establece en cero,
utilizará una lista ordenada para todos los niveles. (predeterminado: 1)

--archivo de salida
--archivo de salida presentar

Archivo para escribir la salida. Aquí es donde la salida HTML modificada y la Tabla de
El contenido va a. Si da '-' como nombre de archivo, la salida irá a STDOUT.
(predeterminado: STDOUT)

--Sobrescribir
Sobrescriba el archivo de entrada con la salida. Si esto está en efecto, --outfile se ignora.
Utilizada en generar_anclajes para crear los anclajes "en su lugar" y en generar_toc if
la opción --inline está en vigor. (predeterminado: desactivado)

--tranquilo
Suprime los mensajes informativos. (predeterminado: desactivado)

--solo texto
Utilice solo contenido de texto en elementos significativos.

--título
--título cadena

Título de la página de ToC (si no usa --header o --inline o --toc_only) (predeterminado: "Table
de Contenidos ")

--toc_después
--toc_después etiqueta=sufijo

--toc_after "H2 ="

Para definir el diseño de elementos importantes en la TdC. los etiqueta es la etiqueta HTML que
marca el inicio del elemento. los sufijo es lo que se requiere agregar al
Entrada de tabla de contenido generada para esa etiqueta. Este es un argumento hash acumulativo.
(predeterminado: indefinido)

--toc_antes
--toc_antes etiqueta=prefijo

--toc_before "H2 = "

Para definir el diseño de elementos significativos en la TdC. los etiqueta es la etiqueta HTML
que marca el inicio del elemento. los prefijo es lo que se requiere anteponer
a la entrada de la Tabla de contenido generada para esa etiqueta. Este es un hash acumulativo
argumento. (predeterminado: indefinido)

--toc_end
--toc_end etiqueta=etiqueta final

--toc_end "H1 = / H1"

Para definir elementos significativos. los etiqueta es la etiqueta HTML que marca el inicio de
el elemento. los etiqueta final la etiqueta HTML que marca el final del elemento. Cuando
coincidencia en el archivo de entrada, se ignoran las mayúsculas y minúsculas (pero asegúrese de que todos sus etiqueta opciones
que se refieren a la misma etiqueta son exactamente iguales!). Este es un argumento hash acumulativo.
(predeterminado: H1 = / H1 H2 = / H2)

--toc_entrada
--toc_entrada etiqueta=nivel

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

Para definir elementos significativos. los etiqueta es la etiqueta HTML que marca el inicio de
el elemento. los nivel es el nivel que se considera que tiene la etiqueta. El valor de nivel
debe ser numérico y distinto de cero. Si el valor es negativo, entradas consecutivas
representado por el elemento significativo estará separado por el valor establecido por
--entrysep opción. Este es un argumento hash acumulativo. (predeterminado: H1 = 1 H2 = 2)

--toc_etiqueta | --toclabel
--toc_etiqueta cadena

Texto HTML que etiqueta la ToC. Usado siempre. (defecto: " Tabla de contenido ")

--toc_solo | --notoc_solo
Imprima solo la Tabla de contenido, es decir, la Tabla de contenido más el toc_label.
Si hay un --header o --footer, estos también se mostrarán.

Si --toc_only es falso (es decir, se establece --notoc_only), entonces si no hay --header, y
--inline no es verdadero, entonces se generará un encabezado de página HTML adecuado, y si hay
no --footer y --inline no es verdadero, entonces se generará un pie de página HTML.
(predeterminado: - notoc_only)

--toc_etiqueta
--toc_etiqueta cadena

Si se va a incluir una ToC en línea, este es el patrón que se utiliza para hacer coincidir la etiqueta
donde debe colocarse la TdC. Puede ser una etiqueta de inicio, una etiqueta de fin o un comentario, pero
el <debe dejarse fuera; es decir, si desea que la TdC se coloque después de BODY
etiqueta, luego da "BODY". Si desea que una etiqueta de comentario especial haga donde debería
ir, luego incluir las marcas de comentario, por ejemplo: "! - toc--" (predeterminado: BODY)

--toc_tag_replace
Junto con --toc_tag, esta es una bandera para decir si la etiqueta dada debe ser
reemplazado, o si la ToC debe colocarse después de la etiqueta. Esto puede ser útil si su
toc_tag es un comentario y no lo necesita después de tener la ToC en su lugar.
(predeterminado: falso)

--use_id
Utilice id = "nombre "para anclas en lugar denombre "> anclas. Sin embargo, si un ancla
ya existe para un elemento significativo, esto no hará una identificación para ese elemento en particular
.

--useorg
Utilice archivos de respaldo preexistentes como fuente de entrada; es decir, archivos de la forma
nombre de archivo.bak (ver --bak).

ARCHIVO FORMATOS

Opciones archivos
Las opciones se pueden dar tanto en archivos como en la línea de comandos usando --argfile
nombre de archivo opción en la línea de comandos. Además, los archivos ~ / .hypertocrc y ./.hypertocrc son
comprobado las opciones.

El formato es el siguiente: Las líneas que comienzan con # son comentarios. Líneas encerradas en PoD
los marcadores también son comentarios. Las líneas en blanco se ignoran. Las opciones mismas deben ser
dada la forma en que estarían en la línea de comando, es decir, el nombre de la opción (de alta calidad que incluyen las
-) seguido de su valor (si lo hay).

Por ejemplo:

# establecer la ToC en tres niveles
--toc_entry H1 = 1
--toc_entry H2 = 2
--toc_entry H3 = 3

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

Los archivos de opciones se pueden anidar, dando un --argfile nombre de archivo argumento dentro de la opción
archivo, irá y obtendrá ese archivo referido también.

Consulte Getopt :: ArgvFile para obtener más información.

DETALLES

Significativo Elements
A continuación, se muestran algunos ejemplos de cómo definir los elementos importantes de su índice.

Ejemplo of Predeterminado

Lo siguiente refleja la configuración predeterminada si no se especifica nada explícitamente:

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

O, si se definió en uno de los posibles "Archivos de opciones":

# configuración por defecto
--toc_entry H1 = 1
--toc_end H1 = / H1
--toc_entry H2 = 2
--toc_end H2 = / H2

Ejemplo of antes después

Las siguientes opciones utilizan las opciones de antes / después:

# Un archivo de opciones que agrega algo de formato
# hacer entradas de TdC de nivel 1
--toc_entry H1 = 1
--toc_end H1 = / H1
--toc_before H1 =
--toc_after H1 =

# hacer entradas de ToC de nivel 2
--toc_entry H2 = 2
--toc_end H2 = / H2
--toc_before H2 =
--toc_after H2 =

# Realice entradas de nivel 3 como están
--toc_entry H3 = 3
--toc_end H3 = / H3

Ejemplo of personalizado final

Las siguientes opciones intentan indexar términos de definición:

# Un archivo de opciones que puede funcionar para documentos de tipo glosario
--toc_entry H1 = 1
--toc_end H1 = / H1
--toc_entry H2 = 2
--toc_end H2 = / H2

# Asume que el documento tiene un DD para cada DT; de lo contrario, ToC
# obtendrá entradas con mucho texto.
--toc_entry DT = 3
--toc_end DT = DD
--toc_before DT =
--toc_after DT =

Maquetación las TdC
Las opciones --toc_entry, etc. le dan control sobre cómo pueden verse las entradas de ToC, pero no
Hay otras opciones para afectar la apariencia final del archivo ToC creado.

Con la opción --header, el contenido del archivo dado se antepondrá antes de la
ToC generado. Esto le permite tener un texto introductorio, o cualquier otro texto, antes de la
ToC.

Nota:
Si usa la opción --header, asegúrese de que el archivo especificado contenga el HTML de apertura
etiqueta, el elemento HEAD (que contiene el elemento TITLE) y la etiqueta BODY de apertura.
Sin embargo, estas etiquetas / elementos no deben estar en el archivo de encabezado si las opciones --inline
se utiliza. Consulte "Incluir la ToC" para obtener información sobre lo que debe contener el archivo de encabezado.
para incluir la ToC.

Con la opción --toc_label, el contenido de la cadena dada se antepondrá antes de la
ToC generado (pero después de cualquier texto tomado de un archivo --header).

Con la opción --footer, el contenido del archivo se agregará después de la generada
ToC.

Nota:
Si usa el -footer, asegúrese de que incluya las etiquetas BODY y HTML de cierre (a menos que,
por supuesto, está utilizando la opción --inline).

Si no se especifica la opción --header, el marcado HTML inicial apropiado será
agregado, a menos que se especifique la opción --toc_only. Si la opción --footer no es
especificado, se agregará el marcado HTML de cierre apropiado, a menos que la opción --toc_only
está especificado.

Si no quiere / necesita lidiar con archivos de encabezado y pie de página, entonces está autorizado a
especifique el título, opción --title, del archivo ToC; y te permite especificar un
encabezado, o etiqueta, para poner antes de la lista de entradas de ToC, la opción --toc_label. Ambas opciones
tienen valores predeterminados, consulte "OPCIONES" para obtener más información sobre cada opción.

Si no desea que se proporcionen etiquetas de página HTML y solo desea la ToC en sí, entonces
especifique la opción --toc_only. Si no hay archivos --header o --footer, esto
simplemente muestre el contenido de --toc_label y la propia ToC.

En línea las TdC
La capacidad de incorporar la ToC directamente en un documento HTML es compatible a través de la
- opción en línea.

La inserción se realizará en el primer archivo de la lista de archivos procesados ​​y solo se
hecho si ese archivo contiene una etiqueta de apertura que coincide con el valor --toc_tag.

Si --overwrite es verdadero, entonces se sobrescribirá el primer archivo de la lista, con el
ToC generado insertado en el lugar apropiado. De lo contrario, una versión modificada de la primera
El archivo se envía a STDOUT o al archivo de salida definido por la opción --outfile.

Las opciones --toc_tag y --toc_tag_replace se utilizan para determinar dónde y cómo se encuentra la ToC
insertado en la salida.

Ejemplo 1

# este es el predeterminado
--toc_tag CUERPO --notoc_tag_replace

Esto colocará la ToC generada después de la etiqueta BODY del primer archivo. Si el encabezado
se especifica la opción, luego el contenido del archivo especificado se inserta después de BODY
etiqueta. Si la opción --toc_label no está vacía, entonces el texto especificado por --toc_label
se inserta la opción. Luego se inserta la ToC, y finalmente, si la opción --footer es
especificado, inserta el pie de página. Luego, el resto del archivo de entrada sigue como estaba
antes.

Ejemplo 2

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

Esto colocará la ToC generada después del primer comentario del formulario. , y eso
el comentario será reemplazado por el ToC (en el orden
--encabezamiento
--toc_etiqueta
TdC
--footer) seguido del resto del archivo de entrada.

Nota:
El archivo de encabezado no debe contener la etiqueta HTML inicial y el elemento HEAD, ya que
El archivo HTML que se está procesando ya debería contener estas etiquetas / elementos.

EJEMPLOS

Crear an en línea TdC para una presentar
hipertoc --inline --make_anchors --overwrite --make_toc index.html

Esto creará anclas en "index.html", creará una ToC con un encabezado de "Tabla de
Contenido "y colóquelo después de la etiqueta BODY de" index.html ". El archivo index.html.org
contienen el archivo index.html original, sin ToC ni anclajes.

Crear a TdC presentar en múltiples archivos
Primero, crea los anclajes.

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

Luego crea la ToC

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

Crear an en línea TdC después de las la primera Bóveda of las la primera presentar
hypertoc --make_anchors --inline --overwrite --make_toc --toc_tag / H1 \
--notoc_tag_replace --toc_label "" index.html fred.html george.html

Esto creará anclas en los archivos "index.html", "fred.html" y "george.html", cree
un ToC sin encabezado y colóquelo después del primer encabezado H1 en "index.html" y haga una copia de seguridad
los archivos originales en "index.html.org", "fred.html.org" y "george.html.org"

Crear an en línea TdC personalizado elementos
hipertoc --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

Esto creará una ToC en línea que sobrescribirá el archivo original y reemplazará una
comentario, y que toma los encabezados H2 como nivel 1 y los encabezados H3 como nivel 2. Esto puede ser
útil donde el archivo .html es generado por algún otro proceso, y luego puede crear
la TdC como último paso.

Crear a TdC personalizado elementos
hipertoc --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 \
maría.html fred.html jorge.html

Esto crea anclajes en los elementos H2 y H3, y crea un archivo ToC llamado index.html,
indexación en el TÍTULO, y los elementos H2 y H3.

Crear a TdC personalizado elementos y opciones presentar
Dado un archivo de opciones llamado 'custom.opt' de la siguiente manera:

# Título, H2 y 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

entonces el ejemplo anterior puede tener líneas de comando más cortas de la siguiente manera:

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

NOTAS

· Hypertoc es lo suficientemente inteligente como para detectar anclajes dentro de elementos significativos. Si el ancla
define el atributo NAME, hypertoc usa el valor. De lo contrario, agrega su propio NOMBRE
atributo al ancla. Si --use_id es verdadero, entonces también busca y usa
Identificaciones.

· El elemento TITLE se trata especialmente si se especifica como un elemento significativo. Está
ilegal insertar anclajes (A) en elementos TITLE. Por lo tanto, hypertoc realmente
enlace al nombre del archivo en sí en lugar del elemento TITLE del documento.

· Hypertoc ignorará un elemento significativo si no contiene ningún espacio que no sea en blanco
caracteres. Se genera un mensaje de advertencia si existe tal condición.

· Si tiene una secuencia de elementos significativos que cambian de forma ligeramente desordenada
moda, como H1 -> H3 -> H2 o incluso H2 -> H1, aunque hypertoc se ocupa de esto para
cree una lista que siga siendo un buen HTML, si está utilizando una lista ordenada para eso
profundidad, entonces obtendrá una numeración extraña, ya que un elemento de lista adicional habrá sido
insertado para anidar los elementos en el nivel correcto.

Por ejemplo (H2 -> H1 con --ol_num_levels = 1):

1.
* Mi encabezado H2
2. Mi encabezado H1

Por ejemplo (H1 -> H3 -> H2 con --ol_num_levels = 0 y H3 también es significativo):

1. Mi encabezado H1
1.
1. Mi encabezado H3
2. Mi encabezado H2
2. Mi segundo encabezado H1

En casos como este, puede ser mejor no usar la opción --ol.

· Si uno no está usando --overwrite al generar anclas, entonces el comando debe ser
hecho en dos pasadas, con el fin de dar los nombres de archivo correctos (los que tienen el
ancla en ellos) a la parte de generación de ToC. De lo contrario, la ToC tendrá anclas.
apuntando a archivos que no los tienen.

· Al usar --en línea, se debe tener cuidado al sobrescribir - si se establece la ToC en
incluirse después de una etiqueta determinada (como el BODY predeterminado), si se ejecuta el comando
repetidamente, se pueden obtener varios TdC en el mismo archivo, uno tras otro.

AVISOS

· La versión 3.10 (y superior) genera anclajes más detallados (compatibles con SEO) que antes
versiones. Por lo tanto, los anclajes generados con versiones anteriores no coincidirán con la versión 3.10
anclas.

· La versión 3.00 (y superior) de hypertoc se comporta de forma algo diferente a la versión 2.x de
hipertoc. Ahora está diseñado para hacer todo en una sola pasada y ha perdido ciertos
opciones: la opción --infile ya no se usa (todos los nombres de archivo se colocan al final de
El comando); la opción --toc_file ya no existe; usa la opción --outfile
en lugar de; la opción --tocmap ya no es compatible.

Ahora genera etiquetas en minúsculas en lugar de mayúsculas.

· Hypertoc no es muy eficiente (memoria y velocidad) y puede ser lento para grandes
documentos.

· Ahora que la generación de anclas y de la ToC se hace en una sola pasada, aún más memoria
se utiliza que en el caso anterior. Esto es más notable cuando se procesan múltiples
archivos, ya que todos los archivos se leen en la memoria antes de procesarlos.

· Se generará un marcado no válido si un elemento significativo está contenido dentro de un
ancla. Por ejemplo:

El comando FOO

se convertirá a (si h1 es un elemento significativo),

El comando FOO

lo cual es ilegal ya que los anclajes no se pueden anidar.

Es mejor colocar declaraciones de anclaje dentro del elemento que se va a anclar. Para
ejemplo, se prefiere lo siguiente:

El comando FOO

hypertoc detectará el NOMBRE "foo" y lo usará.

Aún mejor es usar ID:

El comando FOO

· Los atributos NAME sin comillas no se reconocen.

Utilice hypertocp en línea utilizando los servicios de onworks.net