hxindex - Интернет в облаке

ПРОГРАММА:

ИМЯ

hxindex - вставить индекс в HTML-документ

СИНТАКСИС

hxindex [ -t ] [ -x ] [ -n ] [ -f ] [ -r ] [ -c классов ] [ -b Использование темпера с изогнутым основанием ] [ -i индексная база данных ] [ -s
шаблон ] [ -u фраза ] [-] [ файл или URL ]

ОПИСАНИЕ

The hxindex ищет термины для индексации в документе, собирает их, превращает в
целевые якоря и создает отсортированный индекс в виде списка HTML, который вставляется на место
заполнителя в документе. Полученный документ выводится на стандартный вывод.

Индекс вставляется на место комментария формы



или между двумя комментариями формы


...


В последнем случае сначала удаляется весь существующий контент между двумя комментариями.

Термины индекса являются элементами типа или элементы с атрибутом класса
"показатель". (Для обратной совместимости также атрибуты класса "index-inst" и "index-def"
признаны.) элементы (и класс "index-def") считаются более важными, чем
элементы с классом "индекс" и будет выделен жирным шрифтом в созданном индексе.

Опция -c добавляет дополнительные классы, которые являются псевдонимами для "индекс".

По умолчанию в качестве элемента индекса используется содержимое элемента. Вот два
примеры употребления индексного термина "обувь":

Обувь - это предмет одежды, который ...
дополнена кожаной обувью ...

Если индексируемый термин не равен содержимому элемента, название атрибут
можно использовать для обозначения правильного термина:

... Обувь - это предмет одежды, который ...
... с двумя кожаными туфлями ...

The название атрибут также должен использоваться, когда индексный термин является подтермом другого.
Подтермы отображаются в указателе с отступом под их заголовком. Чтобы определить подтермин, используйте
название атрибут с двумя восклицательными знаками ("!!") между термином и подтермом, например
это:

...
...
...

Как показывает последний пример выше, может быть несколько уровней субподтермов.

The название атрибут также позволяет связывать несколько терминов индекса с одним
вхождение. Несколько терминов разделены вертикальной чертой ("|"). Сравните
следующие примеры с приведенными выше:

...
...

Эти два элемента вставляют два термина в указатель. Обратите внимание, что второй пример
выше объединены подтермины и несколько терминов.

Можно запустить индекс для файла, у которого уже есть индекс. Старые целевые якоря
и старый индекс будет удален перед повторным созданием.

ДОПОЛНИТЕЛЬНЫЕ ОПЦИИ

Поддерживаются следующие варианты:

-t По умолчанию hxindex добавляет атрибут ID к элементу, который содержит
появление термина и причислены вставляет элемент внутри него с имя
атрибут, равный идентификатору. Это позволяет старым браузерам, игнорирующим ID
атрибуты, такие как Netscape 4, чтобы также найти цель. В -t вариант
подавляет элемент.

-x Эта опция включает соглашения о синтаксисе XML: пустые элементы заканчиваются на />
вместо > как в HTML. -x подразумевает -т.

-i индексная база данных
hxindex может читать начальный индекс из файла и записывать объединенную коллекцию
индексировать термины обратно в этот файл. Это позволяет индексировать несколько документов.
The -i Параметр используется для указания имени файла, содержащего индекс.

-b Использование темпера с изогнутым основанием Эта опция полезна в сочетании с -i чтобы дать ссылку на базовый URL-адрес
документ. По умолчанию, hxindex будет хранить ссылки на вхождения в индексная база данных
файл в форме #якорь, но когда -b дано, ссылки будут иметь вид
база # якорь .

При использовании в сочетании с -n, атрибуты заголовка ссылок будут содержать
название документа, содержащего термин. Заголовок вставлен перед
шаблон (см. вариант -s) и отделены от него запятой и пробелом.
Например, если hxindex называется с

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

и termdb уже содержит запись для "foo" в разделе "3.1"
документ под названием "file2.html" с заголовком "The foos", затем сгенерированный индекс
будет содержать такую ​​запись:

фу,
title = "The foos, section 3.1"> 3.1

-c класс [, класс [, ...]]
Нормальные индексные термины признаются, потому что они имеют класс "показатель". The -c
опция добавляет дополнительные, разделенные запятыми имена классов, которые будут учитываться
псевдонимы для "индекс". Например, -c пример позаботится о том, чтобы <Span
class = "instance"> срок признается термином для индекса.

-n По умолчанию индекс состоит из ссылок с символом # в качестве якорного текста. Вариант -n
заставляет текст ссылки состоять из номеров разделов разделов, в которых
условия встречаются, возвращаясь к "без номера" (см. вариант -u ниже) если нет
номер раздела можно найти. Номера разделов можно найти, выполнив поиск
ближайший предшествующий начальный тег с классом "secno" или "no-num". На случай, если
"secno", содержимое этого элемента принимается за номер раздела. в
в случае "no-num" предполагается, что раздел не имеет номера и hxindex напечатает
вместо этого "без номера". Эти классы также используются хкснум(1), так что это
полезно для бега hxindex после хкснумнапример,

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

-s шаблон
Когда вариант -n используется, ссылка будет иметь атрибут заголовка и шаблон
определяет, что в нем содержится. По умолчанию это "раздел% s", где% s - это
заполнитель для номера раздела. Другими словами, индекс будет содержать
такие записи:

срок, 7.8

Некоторые примеры:

hxindex -n -s 'глава% s'
hxindex -n -s 'часть% s'
hxindex -n -s 'hoofdstuk% s' -u 'номер зоны'

Эта опция полезна только в сочетании с -n

-u фраза Когда вариант -n используется для отображения номеров разделов, ссылки на которые нет
номер секции можно найти, показано как фраза вместо. По умолчанию это «??».

Эта опция полезна только в сочетании с -n

-f Удалить название атрибуты, которые использовались для индекса, а также комментарии
которые ограничивают вставленный индекс. Это позволяет избежать отображения в браузерах этих
атрибуты. Обратите внимание, что hxindex не может быть запущен снова на собственном выходе, если это
опция используется. (Мнемоника: "freeze "или"final ".)

-r Не игнорируйте конечную пунктуацию при сортировке терминов индекса. Например, если два члена
написаны как

фу, ... фу

hxindex обычно игнорирует запятую и рассматривает их как один и тот же термин, но с
-р, они рассматриваются как разные. Это влияет на конечные запятые (,), точки с запятой
(;), двоеточия (:), восклицательный знак (!), вопросительные знаки (?) и точки (.).
Конечная точка никогда не игнорируется, если в терминах их два или более, чтобы
защищать аббревиатуры («BC») и многоточие («подробнее ...»). Это делает влиять на
как печатается индексный термин (он всегда печатается в том виде, в каком он появляется в тексте),
только как это сравнивается с аналогичными условиями. (Мнемоника: "raw ".)

ОПЕРАНДЫ

Поддерживается следующий операнд:

файл или URL
Имя файла HTML или XML или URL-адрес одного из них. Если отсутствует, или если файл
«-», вместо него читается стандартный ввод.

ВЫХОД статус

Возвращаются следующие значения выхода:

0 Успешное завершение.

>0 Произошла ошибка при синтаксическом анализе HTML-файла.

ОКРУЖАЮЩАЯ СРЕДА

Предполагается, что ввод будет в UTF-8, но текущая локаль используется для определения
порядок сортировки терминов индекса. Т.е., hxindex смотрит на LANG, LC_ALL и / или
Переменные среды LC_COLLATE. Видеть местный(1).

Чтобы использовать прокси для получения удаленных файлов, установите переменные среды http_proxy or
ftp_proxy. Например, http_proxy = "http://localhost: 8080 / "

Используйте hxindex онлайн с помощью сервисов onworks.net