О книге помощи

Введение в систему YstokHelp

Структура книги помощи

Вспомогательные файлы

Навигационные страницы

Статейные страницы

Всплывающие окна

Всплывающие заметки

Всплывающие меню

Компилятор

Пример определения книги помощи

Якоря и гибкие ссылки: схема `help`

Атрибут `help`

Сегменты: разбиение исходных файлов на страницы

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Определение книги помощи: `define-book` [макрос]

Компоненты книги помощи

Книга: `book-system` [класс]

Раздел: `chapter` [класс]

Исходный файл: `parsed-file` [класс]

Исходный HTML-файл: `parsed-html-file` [класс]

topic-mixin [класс]

Cтатья: `topic` [класс]

Текстовая статья: `text-topic` [класс]

Навигация: `navigation-mixin` [класс]

Навигационная страница: `navigation` [класс]

Набор фрамуг: `frameset` [класс]

Вспомогательный файл: `aux-file` [класс]

Вспомогательная папка: `aux-folder` [класс]

Контекстная подсказка: `context-popup` [класс]

Поддержка всплывающих окон

Всплывающая заметка: `popup` [класс]

Автоматическая вставка всплывающей заметки

Автоматическая вставка всплывающего меню

Шаблоны и функции генерации HTML-кода

anchor-href, ahref [функция]

anchor-content, acontent [функция]

anchor-text, atext [функция]

anchor-a, aa [функция]

Генерация списков ссылок

Шаблонные переменные для генерации списков

Динамическое оглавление: `toc-children` [функция]

Динамический список ссылок: `anchor-topics`

item-a [обобщённая функция]

Компилятор оглавления книги

toc [класс]

create-toc [обобщённая функция]

Режим toc-source `:title`

Режим toc-source `heading-list`

Компилятор предметного указателя

Ключевые фразы

Служебные слова

index [класс]

create-index [функция]

Перестановочный указатель

Компиляция книги помощи

compile-book [функция]

Формат файла якорей

dump-anchors [обобщённая функция]

Язык книги и локализация

lang-alpha-char-p-function [обобщённая функция]

lang-word-char-p-function [обобщённая функция]

lang-default-index-letters [обобщённая функция]

lang-char-representative [обобщённая функция]

Библиотека времени исполнения

YstokHelp API

ystok.help [пакет]

book [класс]

default-book [переменная]

default-book-pathname [переменная]

register-book [функция]

load-book [функция]

ensure-book [обобщённая функция]

view-topic [функция]

view-page [функция]

Контекстная помощь

Идентификатор помощи

Формат файла контекстных подсказок

popup-context [функция]

Приложение YstokHelp

Меню и панель инструментов Книга

Настройки программы

Вкладка Общие

Вкладка Якоря

Вкладка Компоненты

Вкладка Логические хосты

Вкладка HTML

Вкладка Помощь

Командная строка запуска

Исходный код и лицензия для YstokHelp

Предметный указатель