hypertocp - онлайн в хмарі

ПРОГРАМА:

ІМ'Я

hypertoc - створити зміст для HTML-документів

Версія

версія 3.20

СИНТАКСИС

гіпертокс --допомога | --manpage | --man_help | -- чоловік

гіпертокс [--бак рядок ] [ --debug ] [ --entrysep рядок ] [ --нижній колонтитул файл ] [ --заголовок
файл ] [ --ignore_only_one ] [ --ignore_sole_first ] [ --inline ] [ --make_anchors] [
--make_toc ] [ --notoc_match рядок ] [ --ol | --nool ] [ --ol_num_levels ] [ --outfile
файл ] [ --overwrite ] [ --quiet ] [ --textonly] [ --title рядок ] { --toc_after
тег=суфікс } { --toc_before тег=префікс } { --toc_end тег=кінцевий тег } { --toc_entry тег=рівень
} [ --toc_label рядок ] [ --toc_only | --notoc_only ] [ --toc_tag рядок ] [
--toc_tag_replace ] [ --use_id ] [ --useorg ] файл ...

ОПИС

hypertoc дозволяє вам вказати «значущі елементи», на які будуть посилатися гіперпосилання в a
«Зміст» (ToC) для заданого набору документів HTML.

По суті, створений ToC є багаторівневим списком, що містить посилання на
значущі елементи. hypertoc вставляє посилання в ToC на важливі елементи в a
рівень, визначений користувачем.

приклад:

Якщо H1 вказано як рівень 1, то вони з’являються в списку першого рівня ТУ. Якщо
H2 вказуються як рівень 2, ніж вони з'являються в списку другого рівня в ToC.

Існує два аспекти генерації ToC: (1) встановлення відповідних якорів у HTML
документів (--make_anchors) і (2) генерування ToC з документів HTML, які мають
якоря в них для посилання на ToC (--make_toc). Можна вибрати один або обидва
Вони.

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

Для того, щоб hypertoc підтримував зв’язування зі значущими елементами, hypertoc вставляє якоря
на значущі елементи. Можна використовувати hypertoc як фільтр, виводячи результат до
інший файл, або можна перезаписати оригінальний файл, створивши резервну копію оригіналу за допомогою a
суфікс (за замовчуванням: "org"), доданий до імені файлу.

Можна також визначити параметри у файлі конфігурації, а також у командному рядку.

ВАРІАНТИ

Параметри можуть починатися з «--» або «-»; логічні параметри можна заперечувати, передуючи їм
"немає"; до параметрів із значеннями хеша або масиву можна додати, знову вказавши параметр for
кожне значення.

Дивіться Getopt::Long для отримання додаткової інформації.

--файл arg ім'я файлу
Ім'я файлу, з якого можна прочитати додаткові параметри. Це можна використовувати більше одного разу. Для
приклад:

--argfile your.args --argfile my.args

Додаткову інформацію див. у розділі «Файли параметрів».

--бак
--бак рядок

Якщо вхідний файл/файли перезаписуються (--перезапис увімкнено), скопіюйте
вихідний файл до "ім'я файлу.рядок". Якщо значення порожнє, файл резервної копії відсутній
написаний. (за замовчуванням:org)

--відлагоджувати
Увімкнути виведення детального налагодження. Використовується для налагодження цього модуля; іншими словами,
не турбуйся. (за замовчуванням: вимкнено)

-- входження
-- входження рядок

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

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

Файл, що містить текст нижнього колонтитула для змісту.

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

Файл, що містить текст заголовка змісту.

--допомога
Надрукуйте коротке повідомлення довідки та вийдіть.

--ігнорувати_лише_один
Якщо в ToC буде лише один пункт, не створюйте ToC.

--ignore_sole_first
Якщо перший пункт у ТУ має найвищий рівень, І він є єдиним
рівня, ігноруйте його. Це корисно на веб-сторінках, де є лише один заголовок H1, але
невідомо наперед, чи буде тільки один.

--в лінію
Помістіть ToC в документ у певний момент. Для отримання додаткової інформації див.

--make_anchors | --gen_anchors
Створіть прив’язки для змісту, на який можна посилатися.

--make_toc | --gen_toc
Створіть зміст, який посилається на закріплені важливі елементи.

--man_help | --manpage | -- чоловік
Роздрукуйте всю документацію та вийдіть.

--notoc_match
--notoc_match рядок

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

--ol | --ноол
Використовуйте впорядкований список для записів змісту (на задану глибину). Якщо --ol є
false (тобто встановлено --nool). НЕ використовувати впорядкований список для записів ToC.

(за замовчуванням: false)

(Див. --ol_num_levels, щоб визначити, наскільки глибокий список упорядкованого списку)

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

--outfile
--outfile файл

Файл для запису результату. Ось де змінений вихід HTML і таблиця-
Зміст переходить до. Якщо ви вкажете '-' як ім'я файлу, то вихід буде передано до STDOUT.
(за замовчуванням: STDOUT)

--перезаписати
Перезаписати вхідний файл вихідним. Якщо це діє, --outfile ігнорується.
Використовується в generate_anchors для створення якорів «на місці» і в generate_toc if
опція --inline діє. (за замовчуванням: вимкнено)

--спокійно
Придушити інформативні повідомлення. (за замовчуванням: вимкнено)

--лише текст
Використовуйте лише текстовий вміст у значущих елементах.

-- назва
-- назва рядок

Заголовок для сторінки ToC (якщо не використовується --header або --inline або --toc_only) (за замовчуванням: "Таблиця
змісту")

--toc_after
--toc_after тег=Суфікс

--toc_після "H2="

Для визначення розташування значущих елементів у ToC. The тег це тег HTML, який
позначає початок елемента. The Суфікс це те, що потрібно додати до
Запис змісту, створений для цього тегу. Це сукупний хеш-аргумент.
(за замовчуванням: не визначено)

--toc_before
--toc_before тег=префікс

--toc_before "H2= "

Для визначення розташування значущих елементів у ToC. The тег це тег HTML
який позначає початок елемента. The префікс це те, що потрібно поставити перед
до запису «Зміст», створеного для цього тегу. Це кумулятивний хеш
аргумент. (за замовчуванням: не визначено)

--toc_end
--toc_end тег=кінцевий тег

--toc_end "H1=/H1"

Для визначення значущих елементів. The тег це тег HTML, який позначає початок
елемент. The кінцевий тег тег HTML, який позначає кінець елемента. Коли
відповідність у вхідному файлі, регістр ігнорується (але переконайтеся, що всі ваші тег опції
посилання на той самий тег абсолютно однакові!). Це сукупний хеш-аргумент.
(за замовчуванням: H1=/H1 H2=/H2)

--toc_entry
--toc_entry тег=рівень

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

Для визначення значущих елементів. The тег це тег HTML, який позначає початок
елемент. The рівень це рівень, яким вважається тег. Значення рівень
має бути числовим і відмінним від нуля. Якщо значення негативне, послідовні записи
представлений значимим_елементом буде відокремлено значенням, встановленим за допомогою
--параметр entrysep. Це сукупний хеш-аргумент. (за замовчуванням: H1=1 H2=2)

--toc_label | --toclabel
--toc_label рядок

Текст HTML, який позначає ToC. Завжди використовувався. (за замовчуванням: " Зміст ")

--toc_only | --notoc_only
Виведіть лише Зміст, тобто Зміст плюс toc_label.
Якщо є --header або --footer, вони також будуть виведені.

Якщо --toc_only false (тобто --notoc_only встановлено), то якщо немає --заголовка, і
--inline не відповідає дійсності, тоді буде виведено відповідний заголовок HTML-сторінки, і якщо є
no --footer і --inline не відповідає дійсності, тоді буде виведено нижній колонтитул сторінки HTML.
(за замовчуванням:--notoc_only)

--toc_tag
--toc_tag рядок

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

--toc_tag_replace
У поєднанні з --toc_tag це прапор, який визначає, чи має бути даний тег
замінити, або якщо слід поставити ToC після тегу. Це може бути корисно, якщо ваш
toc_tag — це коментар, і він вам не потрібен після того, як у вас є загальні положення.
(за замовчуванням: false)

--use_id
Використовуйте id="ім'я" для якорів, а неім'я"> якоря. Однак якщо якір
вже існує для значного елемента, це не створить ідентифікатор для цього конкретного елемента
елемент.

--useorg
Використовуйте вже існуючі файли резервних копій як джерело введення; тобто файли форми
ім'я файлу.подивитися (див. --bak).

Фото ФОРМАТИ

Опції Файли
Параметри можна задавати як у файлах, так і в командному рядку за допомогою --argfile
ім'я файлу параметр у командному рядку. Також файли ~/.hypertocrc і ./.гіпертокр є
перевірив варіанти.

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

Наприклад:

# встановіть ТС на трирівневий
--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 для отримання додаткової інформації.

ПОДРОБИЦІ

значне Елементи
Ось кілька прикладів визначення значущих елементів для вашого змісту.

Приклад 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 до після

Наступні параметри використовують параметри до/після:

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

# зробити записи рівня 2 ToC
--toc_entry H2=2
--toc_end H2=/H2
--toc_before H2=
--toc_після 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_після DT=

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

За допомогою параметра --header вміст даного файлу буде перед
згенерований ToC. Це дозволяє мати вступний текст або будь-який інший текст перед
ToC

Примітка:
Якщо ви використовуєте параметр --header, переконайтеся, що вказаний файл містить початковий HTML
тег, елемент HEAD (містить елемент TITLE) і початковий тег BODY.
Однак ці теги/елементи не повинні бути в заголовковому файлі, якщо параметри --inline
використовується. Інформацію про те, що має містити заголовний файл, див
для вбудовування ToC.

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

За допомогою параметра --footer вміст файлу буде додано після згенерованого
ToC

Примітка:
Якщо ви використовуєте -нижній колонтитул, переконайтеся, що він містить закриваючі теги BODY і HTML (крім випадків,
звичайно, ви використовуєте параметр --inline).

Якщо параметр --header не вказано, буде відповідна початкова розмітка HTML
додано, якщо не вказано параметр --toc_only. Якщо параметр --footer не є
буде додано відповідну закриваючу HTML-розмітку, якщо не буде параметр --toc_only
вказано.

Якщо ви не хочете/необхідно мати справу з файлами заголовка та нижнього колонтитула, то вам надано це
вказати заголовок, параметр --title, файлу ToC; і це дозволяє вказати a
заголовок або мітка, щоб поставити перед списком записів ToC, параметр --toc_label. Обидва варіанти
мають значення за замовчуванням. Додаткову інформацію про кожну опцію див. у розділі "ОПЦІЇ".

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

Вбудовування ToC
Можливість включення ToC безпосередньо в HTML-документ підтримується за допомогою
--вбудована опція.

Вбудовування буде виконано для першого файлу в списку оброблених файлів, і буде тільки
виконується, якщо цей файл містить початковий тег, що відповідає значенню --toc_tag.

Якщо --overwrite має значення true, то перший файл у списку буде перезаписаний за допомогою
згенерований ToC, вставлений у відповідне місце. Інакше модифікована версія першого
файл виводиться в STDOUT або у вихідний файл, визначений параметром --outfile.

Параметри --toc_tag і --toc_tag_replace використовуються, щоб визначити, де і як знаходиться ToC
вставляється у вихід.

Приклад 1

# це значення за замовчуванням
--toc_tag ТІЛО --notoc_tag_replace

Це поставить згенерований ToC після тегу BODY першого файлу. Якщо --заголовок
вказано параметр, тоді вміст зазначеного файлу вставляється після ТІЛО
тег. Якщо параметр --toc_label не порожній, то текст, визначений параметром --toc_label
опція вставлена. Потім вставляється ToC, і, нарешті, якщо є параметр --footer
зазначено, він вставляє нижній колонтитул. Потім решта вхідного файлу буде як і раніше
раніше.

Приклад 2

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

Це помістить згенерований ТС після першого коментаря форми , і це
коментар буде замінено на Умови використання (у порядку
--заголовок
--toc_label
ToC
--footer), а потім решта вхідного файлу.

Примітка:
Файл заголовка не повинен містити початковий тег HTML і елемент HEAD, починаючи з
HTML-файл, який обробляється, вже має містити ці теги/елементи.

ПРИКЛАДИ

Створювати an вбудований ToC та цінності один файл
hypertoc --inline --make_anchors --overwrite --make_toc index.html

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

Створювати a ToC файл від множинний файли
Спочатку створіть якоря.

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

Потім створіть ToC

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

Створювати an вбудований ToC після перший заголовок 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 вбудований ToC з виготовлений на замовлення елементи
hypertoc --quiet --make_anchors --bak "" --перезаписати \
--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 мій файл.html

Це створить вбудований ToC, який перезапише вихідний файл і замінить a
коментар, який приймає заголовки H2 як рівень 1, а заголовки H3 як рівень 2. Це може бути
корисно, коли файл .html створюється якимось іншим процесом, а потім ви можете створити
ToC як останній крок.

Створювати a ToC з виготовлений на замовлення елементи
hypertoc --quiet --make_anchors --bak "" --перезаписати \
--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 \
mary.html fred.html george.html

Це створює прив’язки до елементів H2 і H3 і створює файл ToC під назвою index.html,
індексація на TITLE, а також елементи H2 і H3.

Створювати a ToC з виготовлений на замовлення елементи та опції файл
Дано файл параметрів під назвою "custom.opt" наступним чином:

# Назва, H2 і H3
--toc_entry НАЗВА=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 "" --перезаписати \
--argfile custom.opt --make_toc --outfile index.html mary.html fred.html george.html

ПРИМІТКИ

· hypertoc достатньо розумний, щоб виявляти якоря всередині значущих елементів. Якщо якір
визначає атрибут NAME, hypertoc використовує значення. В іншому випадку він додає власне NAME
атрибут якоря. Якщо --use_id має значення true, то він також перевіряє та використовує
ідентифікатори.

· Елемент TITLE обробляється спеціально, якщо вказано як значущий елемент. це є
заборонено вставляти якоря (A) в елементи TITLE. Тому гіпертокс буде насправді
посилання на саму назву файлу замість елемента TITLE документа.

· hypertoc буде ігнорувати значущий елемент, якщо він не містить пробілів
символів. Якщо така умова існує, генерується попередження.

· Якщо у вас є послідовність значущих елементів, які змінюються в злегка невпорядковані
моди, як-от H1 -> H3 -> H2 або навіть H2 -> H1, хоча гіперток має справу з цим, щоб
створіть список, який все ще є хорошим 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), а потім, якщо ви запускаєте команду
неодноразово можна було б отримати кілька умов угоди в одному файлі один за одним.

ПЕРЕКЛАДИ

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

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

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

· гіпертокс не дуже ефективний (пам'ять і швидкість) і може бути повільним для великих
документи.

· Тепер, коли генерація якорів і ToC виконується за один прохід, ще більше пам'яті
використовується, ніж це було раніше. Це більш помітно при обробці кількох
файли, оскільки всі файли зчитуються в пам'ять перед їх обробкою.

· Недійсна розмітка буде створена, якщо значущий елемент міститься всередині an
якір. Наприклад:

Команда FOO

буде перетворено в (якщо h1 є значущим елементом),

Команда FOO

що є незаконним, оскільки якоря не можуть бути вкладені.

Краще за стилем помістити оператори прив’язки в елемент, який буде прив’язано. Для
наприклад, бажано наступне:

Команда FOO

hypertoc виявить "foo" NAME і використає його.

Ще краще використовувати ідентифікатори:

Команда FOO

· Атрибути NAME без лапок не розпізнаються.

Використовуйте hypertocp онлайн за допомогою служб onworks.net