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

ПРОГРАММА:

ИМЯ

hypertoc - создать оглавление для HTML-документов

Версия

версия 3.20

СИНТАКСИС

Hypertoc --help | --manpage | --man_help | --человек

гиперток [--bak string ] [--debug] [--entrysep string ] [--footer файл ] [--header
файл ] [--ignore_only_one] [--ignore_sole_first] [--inline] [--make_anchors] [
--make_toc] [--notoc_match string ] [--ol | --nool] [--ol_num_levels] [--outfile
файл ] [--overwrite] [--quiet] [--textonly] [--title string ] {--toc_after
tag = суффикс } {--toc_before tag = префикс } {--toc_end tag = endtag } {--toc_entry tag = level
} [--toc_label string ] [--toc_only | --notoc_only] [--toc_tag string ] [
--toc_tag_replace] [--use_id] [--useorg] файл ...

ОПИСАНИЕ

hypertoc позволяет указать «важные элементы», на которые будут ссылаться гиперссылки в
«Оглавление» (ToC) для данного набора документов HTML.

По сути, созданный ToC представляет собой многоуровневый список, содержащий ссылки на
значимые элементы. Hypertoc вставляет ссылки в ToC на важные элементы в
уровень, указанный пользователем.

Пример:

Если H1 указаны как уровень 1, они появляются в списке первого уровня ToC. Если
H2 указаны как уровень 2, чем они отображаются в списке второго уровня в ToC.

Есть два аспекта генерации ToC: (1) размещение подходящих якорей в HTML.
документы (--make_anchors) и (2) создание ToC из HTML-документов, которые имеют
якоря в них для ссылки на ToC (--make_toc). Можно выбрать одно или оба
эти.

Hypertoc также поддерживает возможность включения ToC в сам HTML-документ.
через параметр --inline.

Чтобы Hypertoc поддерживал привязку к значимым элементам, Hypertoc вставляет якоря.
в значимые элементы. Можно использовать hypertoc в качестве фильтра, выводя результат в
другой файл, или можно перезаписать исходный файл с резервной копией оригинала
суффикс (по умолчанию: "org"), добавленный к имени файла.

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

ДОПОЛНИТЕЛЬНЫЕ УСЛУГИ, НЕ ВКЛЮЧЕННЫЕ В ПАКЕТ

Опции могут начинаться с «-» или «-»; логические параметры можно отменить, поставив перед ними
"нет"; параметры со значениями хеша или массива могут быть добавлены, если снова указать параметр для
каждое значение.

См. Getopt :: Long для получения дополнительной информации.

--argfile имя файла
Имя файла, из которого нужно прочитать дополнительные параметры. Это можно использовать более одного раза. Для
пример:

--argfile ваш.args --argfile my.args

См. «Файлы параметров» для получения дополнительной информации.

--бак
--бак string

Если входной файл / файлы перезаписываются (--overwrite включен), скопируйте
исходный файл в "имя файла.string". Если значение пусто, файл резервной копии отсутствует.
написано. (по умолчанию: org)

--отлаживать
Включить подробный вывод отладки. Используется для отладки этого модуля; другими словами,
не беспокойтесь. (по умолчанию: выключено)

--entrysep
--entrysep string

Строка-разделитель для не- записи элементов (по умолчанию: ",")

- нижний колонтитул
- нижний колонтитул файл

Файл, содержащий текст нижнего колонтитула для оглавления.

- заголовок
- заголовок файл

Файл, содержащий текст заголовка для оглавления.

--Помогите
Распечатайте короткое справочное сообщение и выйдите.

--ignore_only_one
Если в ToC будет только один элемент, не создавайте ToC.

--ignore_sole_first
Если первый элемент в ToC имеет самый высокий уровень, И он единственный из этого
уровень, игнорируйте это. Это полезно на веб-страницах, где есть только один заголовок H1, но
заранее не известно, будет ли он только один.

--в линию
Поместите ToC в документ в заданную точку. См. «Встраивание ToC» для получения дополнительной информации.

--make_anchors | --gen_anchors
Создайте якоря для оглавления, на которое будет ссылаться.

--make_toc | --gen_toc
Создайте оглавление, которое будет ссылаться на закрепленные важные элементы.

--man_help | --manpage | --человек
Распечатайте всю документацию и выйдите.

--notoc_match
--notoc_match string

Если есть определенные отдельные теги, которые вы не хотите включать в таблицу
содержимое, даже если они соответствуют «значимым элементам», то, если этот шаблон
совпадает с содержимым внутри тега (а не с телом), тогда этот тег не будет включен,
либо в создании якорей, либо в генерации ToC. (по умолчанию: class = "notoc")

--ol | --ноул
Используйте упорядоченный список для записей оглавления (до заданной глубины). Если --ol равно
false (т.е. установлено --nool), тогда не используйте упорядоченный список для записей ToC.

(по умолчанию: false)

(См. --Ol_num_levels, чтобы определить, насколько далеко заходит список упорядоченного списка)

--ol_num_levels
Количество уровней, на которые будет идти листинг OL, если --ol истинно. Если установлено в ноль,
будет использовать упорядоченный список для всех уровней. (по умолчанию: 1)

--outfile
--outfile файл

Файл для записи вывода. Здесь измененный вывод HTML и Таблица-
Содержание отправляется в. Если вы укажете «-» в качестве имени файла, то вывод пойдет в STDOUT.
(по умолчанию: STDOUT)

- перезаписать
Замените входной файл выходным. Если это действует, --outfile игнорируется.
Используется в генерировать_анкоры для создания якорей «на месте» и в генерировать_toc if
действует опция --inline. (по умолчанию: выключено)

--тихий
Подавить информационные сообщения. (по умолчанию: выключено)

--только текст
Используйте только текстовое содержимое в значимых элементах.

--заглавие
--заглавие string

Заголовок для страницы ToC (если не используются --header, --inline или --toc_only) (по умолчанию: «Таблица
содержания »)

--toc_after
--toc_after день=суффикс

--toc_after "H2 ="

Для определения расположения значимых элементов в ToC. В день это HTML-тег, который
отмечает начало элемента. В суффикс это то, что необходимо добавить к
Запись содержания, созданная для этого тега. Это совокупный аргумент хеширования.
(по умолчанию: не определено)

--toc_before
--toc_before день=префикс

--toc_before "H2 = "

Для определения расположения значимых элементов в ToC. В день это тег HTML
который отмечает начало элемента. В префикс это то, что необходимо добавить в начало
к записи Оглавления, созданной для этого тега. Это совокупный хеш
аргумент. (по умолчанию: не определено)

--toc_end
--toc_end день=конец

--toc_end "H1 = / H1"

Для определения значимых элементов. В день это HTML-тег, который отмечает начало
элемент. В конец HTML-тег, который отмечает конец элемента. Когда
совпадение во входном файле, регистр игнорируется (но убедитесь, что все ваши день кредита
ссылаясь на один и тот же тег, абсолютно одинаковы!). Это совокупный аргумент хеширования.
(по умолчанию: H1 = / H1 H2 = / H2)

--toc_entry
--toc_entry день=уровень

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

Для определения значимых элементов. В день это HTML-тег, который отмечает начало
элемент. В уровень какой уровень считается тегом. Значение уровень
должно быть числовым и отличным от нуля. Если значение отрицательное, последовательные записи
представленный значимым_элементом, будет разделен значением, установленным
Параметр --entrysep. Это совокупный аргумент хеширования. (по умолчанию: H1 = 1 H2 = 2)

--toc_метка | --toclabel
--toc_label string

HTML-текст, обозначающий ToC. Всегда использовал. (дефолт: " Оглавление ")

--toc_only | --notoc_only
Выведите только Table of Contents, то есть Table of Contents плюс toc_label.
Если есть --header или --footer, они также будут выведены.

Если --toc_only ложно (т.е. установлено --notoc_only), то если нет --header, и
--inline неверно, тогда будет выводиться подходящий заголовок HTML-страницы, и если есть
no --footer и --inline неверны, тогда будет выводиться нижний колонтитул HTML-страницы.
(по умолчанию: - notoc_only)

--toc_tag
--toc_tag string

Если ToC должен быть включен в строку, это шаблон, который используется для сопоставления тега
где должен быть помещен ToC. Это может быть начальный тег, конечный тег или комментарий, но
знак <следует опустить; то есть, если вы хотите разместить ToC после BODY
тег, затем укажите "ТЕЛО". Если вы хотите, чтобы специальный тег комментария был там, где должен быть
go, затем добавьте знаки комментария, например: "! - toc--" (по умолчанию: BODY)

--toc_tag_replace
В сочетании с --toc_tag это флаг, указывающий, должен ли данный тег быть
заменены, или если ToC должен быть помещен после тега. Это может быть полезно, если ваш
toc_tag - это комментарий, и он вам не нужен после того, как у вас есть ToC.
(по умолчанию: false)

--use_id
Используйте id = "имя"для якорей, а неимя"> якоря. Однако если якорь
уже существует для значимого элемента, это не приведет к созданию идентификатора для этого конкретного элемента.
элемент.

--useorg
Используйте в качестве источника ввода уже существующие файлы резервных копий; то есть файлы формы
имя файла.Бак (см. --bak).

ФАЙЛОВ ФОРМАТЫ

Опции Файлы
Параметры могут быть заданы как в файлах, так и в командной строке с помощью параметра --argfile.
имя файла параметр в командной строке. Также файлы ~ / .hypertocrc и ./.hypertocrc являются
проверил варианты.

Формат следующий: Строки, начинающиеся с символа #, являются комментариями. Строки, заключенные в PoD
маркеры также являются комментариями. Пустые строки игнорируются. Сами варианты должны быть
учитывая то, как они были бы в командной строке, то есть имя параметра (включая домен
-), за которым следует его значение (если есть).

Например:

# устанавливаем трехуровневый ToC
--toc_entry H1 = 1
--toc_entry H2 = 2
--toc_entry H3 = 3

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

Файлы опций могут быть вложенными, указав --argfile имя файла аргумент внутри опции
файл, он также получит этот упомянутый файл.

См. Getopt :: ArgvFile для получения дополнительной информации.

ПОДРОБНЕЕ

Значительный Elements
Вот несколько примеров определения важных элементов для вашего Оглавления.

Пример of По умолчанию

Следующее отражает настройку по умолчанию, если ничего не указано явно:

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

Или, если он был определен в одном из возможных «Файлов параметров»:

# настройки по умолчанию
--toc_entry H1 = 1
--toc_end H1 = / H1
--toc_entry H2 = 2
--toc_end H2 = / H2

Пример of до после

Следующие параметры используют параметры до / после:

# Файл опций, который добавляет некоторое форматирование
# сделать записи ToC уровня 1
--toc_entry H1 = 1
--toc_end H1 = / H1
--toc_before H1 =
--toc_after H1 =

# сделать записи ToC уровня 2
--toc_entry H2 = 2
--toc_end H2 = / H2
--toc_before H2 =
--toc_after H2 =

# Сделайте записи уровня 3 как есть
--toc_entry H3 = 3
--toc_end H3 = / H3

Пример of изготовленный на заказ конец

Следующие варианты пытаются проиндексировать термины определения:

# Файл опций, который может работать для документов типа Глоссарий
--toc_entry H1 = 1
--toc_end H1 = / H1
--toc_entry H2 = 2
--toc_end H2 = / H2

# Предполагается, что в документе есть DD для каждого DT, в противном случае ToC
# будут получать записи с большим количеством текста.
--toc_entry DT = 3
--toc_end DT = DD
--toc_before DT =
--toc_after DT =

форматирование домен оглавление
Параметры --toc_entry и т. Д. Дают вам контроль над тем, как могут выглядеть записи ToC, но там
другие параметры, влияющие на окончательный вид созданного файла ToC.

С параметром --header содержимое данного файла будет добавлено перед
сгенерированный ToC. Это позволяет вам иметь вводный текст или любой другой текст перед
КП.

Примечание:
Если вы используете параметр --header, убедитесь, что указанный файл содержит открывающий HTML-код.
тег, элемент HEAD (содержащий элемент TITLE) и открывающий тег BODY.
Однако эти теги / элементы не должны быть в файле заголовка, если параметры --inline
используется. См. «Встраивание ToC» для получения информации о том, что должен содержать файл заголовка.
для встраивания ToC.

С параметром --toc_label содержимое данной строки будет добавлено перед
сгенерированный ToC (но после любого текста, взятого из файла --header).

С параметром --footer содержимое файла будет добавлено после сгенерированного
КП.

Примечание:
Если вы используете -footer, убедитесь, что он включает закрывающие теги BODY и HTML (если,
конечно, вы используете параметр --inline).

Если параметр --header не указан, соответствующая начальная разметка HTML будет
добавлен, если не указана опция --toc_only. Если параметр --footer не установлен
указано, соответствующая закрывающая разметка HTML будет добавлена, если только опция --toc_only
указан.

Если вы не хотите / не нуждаетесь в файлах верхнего и нижнего колонтитулов, то вам разрешено
укажите заголовок, параметр --title, ToC-файла; и позволяет указать
заголовок или метку, чтобы поставить перед списком записей ToC параметр --toc_label. Оба варианта
имеют значения по умолчанию, см. «ОПЦИИ» для получения дополнительной информации по каждому параметру.

Если вы не хотите, чтобы теги HTML-страницы предоставлялись, а просто хотите, чтобы сам ToC, тогда
укажите параметр --toc_only. Если файлов --header или --footer нет, то это будет
просто выведите содержимое --toc_label и сам ToC.

Встраивание домен оглавление
Возможность включения ToC непосредственно в HTML-документ поддерживается через
- встроенный вариант.

Встраивание будет выполнено для первого файла в списке обработанных файлов и будет только
выполнено, если этот файл содержит открывающий тег, соответствующий значению --toc_tag.

Если --overwrite истинно, то первый файл в списке будет перезаписан с
сгенерированный ToC вставлен в соответствующее место. В противном случае модифицированная версия первого
файл выводится либо в STDOUT, либо в выходной файл, определенный параметром --outfile.

Параметры --toc_tag и --toc_tag_replace используются для определения того, где и как находится ToC.
вставлен в выход.

Пример 1

# это по умолчанию
--toc_tag ТЕЛО --notoc_tag_replace

Это поместит сгенерированный ToC после тега BODY первого файла. Если --header
задана опция, то содержимое указанного файла вставляется после BODY
ярлык. Если параметр --toc_label не пуст, то текст, указанный в параметре --toc_label
опция вставлена. Затем вставляется ToC, и, наконец, если опция --footer установлена
указано, он вставляет нижний колонтитул. Затем следует остальная часть входного файла, как это было
раньше.

Пример 2

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

Это поместит сгенерированный ToC после первого комментария формы. , и это
комментарий будет заменен ToC (в порядке
- заголовок
--toc_label
оглавление
--footer), за которым следует остальная часть входного файла.

Примечание:
Заголовочный файл не должен содержать начальный тег HTML и элемент HEAD, поскольку
Обрабатываемый HTML-файл уже должен содержать эти теги / элементы.

ПРИМЕРЫ

Создавай an встроенный оглавление для one файл
Hypertoc --inline --make_anchors --overwrite --make_toc index.html

Это создаст якоря в "index.html", создаст ToC с заголовком "Таблица
Contents "и поместите его после тега BODY в index.html. Файл index.html.org будет
содержать исходный файл index.html без ToC или привязок.

Создавай a оглавление файл от с разными файлов
Сначала создайте якоря.

hypertoc --make_anchors --перезаписать index.html fred.html george.html

Затем создайте ToC

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

Создавай an встроенный оглавление после домен первый Заголовок of домен первый файл
hypertoc --make_anchors --inline --overwrite --make_toc --toc_tag / H1 \
--notoc_tag_replace --toc_label "" index.html fred.html george.html

Это создаст якоря в файлах "index.html", "fred.html" и "george.html", создаст
ToC без заголовка и поместите его после первого заголовка H1 в "index.html" и сделайте резервную копию
исходные файлы в "index.html.org", "fred.html.org" и "george.html.org"

Создавай an встроенный оглавление изготовленный на заказ элементы
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 myfile.html

Это создаст встроенный ToC, перезаписывающий исходный файл и заменяющий
комментарий, который принимает заголовки H2 как уровень 1 и заголовки H3 как уровень 2. Это может быть
полезно, когда файл .html создается каким-либо другим процессом, и затем вы можете создать
ToC в качестве последнего шага.

Создавай a оглавление изготовленный на заказ элементы
hypertoc --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 \
Мэри.html Фред.html Джордж.html

Это создает якоря в элементах H2 и H3 и создает файл ToC с именем index.html,
индексация элементов TITLE и H2 и H3.

Создавай a оглавление изготовленный на заказ элементы и кредита файл
Для файла параметров custom.opt, как показано ниже:

# Заголовок, H2 и 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

то предыдущий пример может иметь более короткие командные строки, как показано ниже:

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

ПРИМЕЧАНИЯ

· Hypertoc достаточно умен, чтобы обнаруживать якоря внутри значимых элементов. Если якорь
определяет атрибут NAME, Hypertoc использует значение. В противном случае он добавляет собственное ИМЯ
атрибут якоря. Если --use_id истинно, то он также проверяет и использует
ID.

· Элемент TITLE обрабатывается особым образом, если он указан как значимый элемент. это
незаконно вставлять якоря (A) в элементы TITLE. Следовательно, гиперток действительно будет
ссылка на само имя файла вместо элемента TITLE документа.

· Hypertoc игнорирует значимый элемент, если он не содержит пробелов
символы. Если такое условие существует, генерируется предупреждающее сообщение.

· Если у вас есть последовательность значимых элементов, которые изменяются в несколько неупорядоченном виде
мода, такая как H1 -> H3 -> H2 или даже H2 -> H1, хотя Hypertoc имеет дело с этим, чтобы
создать список, который по-прежнему является хорошим HTML, если вы используете упорядоченный список для этого
глубина, то вы получите странную нумерацию, так как лишний элемент списка будет
вставлен для размещения элементов на правильном уровне.

Например (H2 -> H1 с --ol_num_levels = 1):

1.
* Мой заголовок H2
2. Мой заголовок H1

Например (H1 -> H3 -> H2 с --ol_num_levels = 0 и H3 также имеет значение):

1. Мой заголовок H1
1.
1. Мой заголовок H3
2. Мой заголовок H2
2. Мой второй заголовок H1

В таких случаях, возможно, лучше не использовать параметр --ol.

· Если при генерации привязок не используется --overwrite, тогда команда должна быть
выполняется за два прохода, чтобы дать правильные имена файлов (с фактическими
якоря в них) к части генерации ToC. В противном случае у ToC будут якоря.
указывая на файлы, в которых их нет.

· При использовании --inline следует соблюдать осторожность при перезаписи - если для ToC установлено значение
быть включенным после данного тега (например, BODY по умолчанию), тогда, если кто-то запускает команду
многократно можно было получить несколько ToC в одном файле, один за другим.

Пещеры

· Версия 3.10 (и выше) генерирует более подробные (оптимизированные для SEO) привязки, чем предыдущие
версии. Таким образом, якоря, созданные в более ранних версиях, не будут соответствовать версии 3.10.
якоря.

· Версия 3.00 (и выше) Hypertoc ведет себя несколько иначе, чем Версия 2.x of
гиперток. Теперь он предназначен для выполнения всего за один проход, и некоторые
опции: опция --infile больше не используется (все имена файлов помещаются в конец
команда); опция --toc_file больше не существует; используйте параметр --outfile
вместо; опция --tocmap больше не поддерживается.

Теперь он генерирует теги в нижнем регистре, а не в верхнем регистре.

· Hypertoc не очень эффективен (память и скорость) и может быть медленным для больших
документов.

· Теперь, когда создание якорей и ToC выполняется за один проход, еще больше памяти
используется, чем было раньше. Это более заметно при обработке нескольких
файлы, так как все файлы считываются в память перед их обработкой.

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

Команда FOO

будет преобразован в (если h1 - значимый элемент),

Команда FOO

что недопустимо, поскольку якоря не могут быть вложенными.

Лучше всего поместить операторы привязки в элемент, который нужно привязать. Для
Например, предпочтительнее следующее:

Команда FOO

Hypertoc обнаружит ИМЯ "foo" и будет использовать его.

Еще лучше использовать идентификаторы:

Команда FOO

· Атрибуты NAME без кавычек не распознаются.

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