Глобальные переменные

В данном разделе перечислены специальные переменные (special variables) языка Лисп, которые управляют компилятором и которые можно изменить, если Вы работаете с исходными текстами программы.

Если Вы используете приложение YstokHelp, соответствующие настройки доступны на вкладках Общие и Компоненты.

[глобальный параметр] *anchor-span-css-classes*

Аннотация

Список имён CSS-классов элементов SPAN, оставляемых в содержимом якоря.

Пакет

ystok.help

Начальное значение

("code" "small-caps" "menu-command" "widget")

Описание

Когда извлекается содержимое HTML-элемента для якоря, из того, что указано в исходном файле, остаются только следующие теги:

Вдобавок, когда для самого определяющего элемента указан атрибут class и среди его значений есть имя class, совпадающее с одним из списка *anchor-span-css-classes*, то оно запоминается, и на страницах предметного указателя и оглавления для ссылки будет также присутствовать атрибут

 class="class".

[глобальный параметр] *anchor-span-css-class-properties*

Аннотация

Список ключей — имён CSS-классов элементов SPAN, которые перемещаются в конец ключевых фраз.

Пакет

ystok.help

Начальное значение

(:category)

Описание

Когда извлекается содержимое HTML-элемента для якоря, из того, что указано в исходном файле, удаляются вложенные элементы вида

<SPAN class="class">content</SPAN>

где class — имя, совпадающее с одним из перечисленных в списке-значении глобального параметра *anchor-span-css-class-properties*. Когда формируются страницы оглавления и предметного указателя, эти вложенные элементы печатаются вслед за ключевой фразой.

Сопоставление имён классов происходит в режиме, не зависящем от регистра букв (case-insensitive).

Вместо элемента SPAN данный суффикс можно задать в атрибуте help свойством category, например:

<H2 help="category:[глобальный параметр]">содержимое</H2>

[глобальный параметр] *anchor-definition-tags*

Аннотация

Список ключей — тегов HTML, ссылки на которые помечаются как определяющие.

Пакет

ystok.help

Начальное значение

(:dfn :dt)

Описание

Когда якорь вводится одним из указанных тегов и в атрибуте help не указано булево свойство defintion, значенме этого свойства считается истинным по умолчанию.

[глобальный параметр] *anchor-definition-css-classes*

Аннотация

Список имён CSS-классов элементов, ссылки на которые помечаются как определяющие.

Пакет

ystok.help

Начальное значение

("signagure")

Описание

Пусть якорь вводится элементом, который имеет следующие атрибуты:

Тогда если class — имя, совпадающее с одним из перечисленных в списке-значении глобального параметра *anchor-definition-css-classes*, то булево свойство defintion для якоря считается истинным по умолчанию. Явно указанное значение этого свойства с помощью атрибута help перекрывает данное умолчание.

[глобальный параметр] *bbcode-in-keywords*

Аннотация

Значение по умолчанию для свойства bbcode.

Пакет

ystok.help

Начальное значение

t

Описание

Задаёт значение по умолчанию для свойства bbcode по отношению к свойству keywords.

[глобальный параметр] *bbcode-in-text*

Аннотация

Значение по умолчанию для свойства bbcode.

Пакет

ystok.help

Начальное значение

t

Описание

Задаёт значение по умолчанию для свойства bbcode по отношению к свойству text.

[глобальный параметр] *exclude-subdirectories*

Аннотация

Список подпапок, исключаемых при компиляции компонента aux-folder.

Пакет

ystok.help

Начальное значение

("_private" "_vti_cnf" "_vti_pvt")

Описание

Некоторые редакторы исходных HTML-файлов создают вспомогательные директории, которые не нужны в готовой книге помощи.

Обычно компилятор копирует целиком содержимое вспомогательной папки, представленной компонентом типа aux-folder. Когда имя некоторой подпапки совпадает с одной из строк, перечисленных в списке *exclude-subdirectories*, компилятор исключит эту подпапку и все вложенные в неё файлы из операции копирования.

[глобальный параметр] *index-heading-anchors*

Аннотация

Определяет, играют ли заголовки роль якорей.

Пакет

ystok.help

Начальное значение

t

Описание

Когда значение параметра есть истина, заголовочные элементы вида
  <Hi id="heading-id">
регистрируются в качестве якорей, а также наполняют предметный указатель.

nil
Не регистрировать заголовки в качестве якорей.
:keywords
Если в заголовочном элементе явно задано свойство keywords, то поместить указанные в нём ключевые фразы в предметный указатель; иначе не регистрировать якорь.
:text
Если в заголовочном элементе присутствует свойство keywords, то ориентироваться по нему, как описано выше.
Если keywords отсутствует, но явно задано свойство text, то извлечь из него ключевую фразу, которая будет помещена в предметный указатель.
t (истина)
Собирать в таблицу якорей все заголовки. В предметный указатель попадут либо фразы, указанные явно в вышеупомянутых свойствах, либо фраза, извлечённая из содержимого заголовочного элемента.

[глобальный параметр] *index-table-css-class*

Аннотация

Имя CSS-класса для элемента TABLE каждой страницы предметного указателя.

Пакет

ystok.help

Начальное значение

"idx"

[глобальный параметр] *default-index-max-left-chars*

Аннотация

Ширина левого столбца перестановочного предметного указателя по умолчанию.

Пакет

ystok.help

Начальное значение

15

Описание

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

Значение данного параметра служит умолчанием для аргумента max-left-chars, когда он не задан для компонента index.

[глобальный параметр] *toc-body-css-class*

Аннотация

Имя CSS-класса для элемента BODY страницы оглавления.

Пакет

ystok.help

Начальное значение

"toc"

[глобальный параметр] *default-toc-max-level*

Аннотация

Наибольшее число уровней заголовков, по умолчанию собираемых в оглавление.

Пакет

ystok.help

Начальное значение

3

Описание

Значение данного параметра служит умолчанием для аргумента max-level, когда он не задан для компонента toc.

[глобальный параметр] *default-toc-source*

Аннотация

Заголовочные элементы, из которых по умолчанию собирается оглавление.

Пакет

ystok.help

Начальное значение

(:H1 :H2)

Описание

Список ключей - тегов HTML, по которым собираются результаты функции toc-children и главное оглавление.

Значение данного параметра служит умолчанием для аргумента source, когда он не задан для компонента toc.