hxindex: en línea en la nube

PROGRAMA:

NOMBRE

hxindex: inserta un índice en un documento HTML

SINOPSIS

índicehx [ -t ] [ -x ] [ -n ] [ -f ] [ -r ] [ -c privadas ] [ -b bases ] [ -i indexdb ] [ -s
plantilla ] [ -u redactar ] [-] [ archivo-o-URL ]

DESCRIPCIÓN

El índicehx busca términos para ser indexados en un documento, los recopila, los convierte en
los anclajes de destino y crea un índice ordenado como una lista HTML, que se inserta en el lugar
de un marcador de posición en el documento. El documento resultante se escribe en la salida estándar.

El índice se inserta en el lugar de un comentario del formulario.



o entre dos comentarios del formulario


...


En el último caso, primero se elimina todo el contenido existente entre los dos comentarios.

Los términos del índice son elementos de tipo o elementos con un atributo de clase de
"índice". (Para compatibilidad con versiones anteriores, también atributos de clase "index-inst" y "index-def"
son reconocidos.) elementos (y clase "index-def") se consideran más importantes que
elementos con clase "índice" y aparecerá en negrita en el índice generado.

La opción -c agrega clases adicionales, que son alias para "índice".

De forma predeterminada, el contenido del elemento se toma como término de índice. Aquí hay dos
ejemplos de apariciones del término índice "zapato":

Un zapato es una prenda que ...
completado por un zapato de cuero ...

Si el término a indexar no es igual al contenido del elemento, el título atributo
se puede utilizar para dar el término correcto:

... Los zapatos son prendas que ...
... con dos zapatos de cuero ...

El título El atributo también debe usarse cuando el término índice es un subtermo de otro.
Los subtérminos aparecen sangrados en el índice, debajo de su término principal. Para definir un subtermo, use un
título atributo con dos signos de exclamación ("!!") entre el término y el subtermo, como
modo:

...
...
...

Como muestra el último ejemplo anterior, puede haber múltiples niveles de sub-subterráneos.

El título El atributo también permite asociar varios términos de índice con un solo
ocurrencia. Los términos múltiples se separan con una barra vertical ("|"). Compara el
siguientes ejemplos con los anteriores:

...
...

Ambos elementos insertan dos términos en el índice. Tenga en cuenta que el segundo ejemplo
arriba combina subtermos y términos múltiples.

Es posible ejecutar el índice en un archivo que ya tiene un índice. Las viejas anclas de destino
y el índice antiguo se eliminará antes de volver a generarse.

OPCIONES

Se admiten las siguientes opciones:

-t De forma predeterminada, índicehx agrega un atributo de ID al elemento que contiene el
aparición de un término y also inserta un elemento dentro de él con un nombre
atributo igual al ID. Esto es para permitir navegadores antiguos que ignoran la identificación.
atributos, como Netscape 4, para encontrar también el objetivo. los -t opción
suprime el .

-x Esta opción activa las convenciones de sintaxis XML: los elementos vacíos terminarán en />
en lugar de > como en HTML. -x implica t.

-i indexdb
índicehx puede leer un índice inicial de un archivo y escribir la colección combinada de
indexar términos de nuevo a ese archivo. Esto permite que un índice abarque varios documentos.
El -i La opción se usa para dar el nombre del archivo que contiene el índice.

-b bases Esta opción es útil en combinación con -i para dar la referencia de URL base de
el documento. Por defecto, índicehx almacenará enlaces a incidencias en el indexdb
archivo en el formulario #ancla, pero cuando -b se proporciona, los enlaces se verán como
base # ancla preferiblemente.

Cuando se usa en combinación con -n, los atributos de título de los enlaces contendrán
el título del documento que contiene el término. El título se inserta antes
de la forma más plantilla (ver opcion -s) y se separa de ella con una coma y un espacio.
Por ejemplo, si índicehx se llama con

hxindex -i termdb -n -base miarchivo.html miarchivo.html

y termdb ya contiene una entrada para "foo" en la sección "3.1" de un
documento llamado "file2.html" con el título "The foos", luego el índice generado
contendrá una entrada como esta:

foo
title = "Los foos, sección 3.1"> 3.1

-c clase [, clase [, ...]]
Los términos de índice normales se reconocen porque tienen una clase de "índice". El -c
La opción agrega nombres de clases adicionales separados por comas que se considerarán
alias para "índice". P.ej, -c ejemplo se asegurará de que <Span
class = "instancia"> término se reconoce como un término para el índice.

-n De forma predeterminada, el índice consta de enlaces con "#" como texto de anclaje. Opción -n
hace que el texto del enlace consista en los números de sección de las secciones en las que
los términos ocurren, volviendo a "sin número" (ver opción -u abajo) si no
Se pudo encontrar el número de sección. Los números de sección se encuentran buscando el
etiqueta de inicio anterior más cercana con una clase de "secno" o "no-num". En el caso de
"secno", el contenido de ese elemento se toma como el número de sección. En el
En caso de "no-num", se supone que la sección no tiene número y índicehx imprimirá
"sin número" en su lugar. Estas clases también son utilizadas por hxnum(1), entonces es
útil para correr índicehx después de hxnum, p.ej,

hxnum myfile.html | hxindex -n> mynewfile.html

-s plantilla
Cuando la opción -n se utiliza, el enlace tendrá un atributo de título y el plantilla
determina lo que contiene. El valor predeterminado es "sección% s", donde% s es un
marcador de posición para el número de sección. En otras palabras, el índice contendrá
entradas como esta:

plazo, 7.8

Algunos ejemplos:

hxindex -n -s 'capítulo% s'
hxindex -n -s 'parte% s'
hxindex -n -s 'hoofdstuk% s' -u 'número de zona'

Esta opción solo es útil en combinación con -n

-u redactar Cuando la opción -n se utiliza para mostrar números de sección, referencias para las cuales no
El número de sección que se puede encontrar se muestra como redactar en lugar de. El valor predeterminado es "??".

Esta opción solo es útil en combinación con -n

-f Eliminar título atributos que se utilizaron para el índice, así como los comentarios
que delimitan el índice insertado. Esto evita que los navegadores muestren estos
atributos. Tenga en cuenta que índicehx no se puede ejecutar de nuevo en su propia salida si este
se utiliza la opción. (Mnemotécnico: "freeze "o"final ".)

-r No ignore la puntuación final al ordenar los términos del índice. Por ejemplo, si dos términos
están escritos como

foo, ... foo

índicehx normalmente ignorará la coma y los tratará como el mismo término, pero con
-r, son tratados como diferentes. Esto afecta a las comas finales (,), punto y coma
(;), dos puntos (:), signo de exclamación (!), signo de interrogación (?) y puntos (.).
Un punto final nunca se ignora si hay dos o más en el término, para
proteger abreviaturas ("BC") y puntos suspensivos ("más ..."). Esto hace no afectar
cómo se imprime el término del índice (siempre se imprime como aparece en el texto),
sólo cómo se compara con términos similares. (Mnemónico: "raw ".)

OPERANDOS

Se admite el siguiente operando:

archivo-o-URL
El nombre de un archivo HTML o XML o la URL de uno. Si está ausente o si el archivo está
"-", en su lugar se lee la entrada estándar.

SALIR ESTADO

Se devuelven los siguientes valores de salida:

0 Completar con exito.

>0 Se produjo un error al analizar el archivo HTML.

MEDIO AMBIENTE

Se supone que la entrada está en UTF-8, pero la configuración regional actual se utiliza para determinar la
orden de clasificación de los términos del índice. Es decir, índicehx mira el LANG, LC_ALL y / o
Variables de entorno LC_COLLATE. Ver local(1).

Para usar un proxy para recuperar archivos remotos, configure las variables de entorno http_proxy or
ftp_proxy. P.ej, http_proxy = "http://localhost: 8080 / "

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