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

Собственно программный продукт, который описывается в книге помощи. В качестве него может выступать

Коммон Лисп (Common Lisp)

Лисп — универсальный язык программирования, изобретенный Джоном Маккарти в 1958 г. Диалект Коммон Лисп является самым популярным благодаря промышленному стандарту ANSI Common Lisp, опубликованному в 1994 году.

Булево свойство

Свойство, указанное в атрибуте help, называется булевым, если его значение трактуется как логическое:

Заголовочный элемент (heading)

HTML-элемент с одним из тегов: H1,... H6 или CAPTION. Разбросанные по исходным файлам статей заголовочные элементы с наименьшими номерами уровня могут служить в качестве источника оглавления книги.

Элемент H6 рекомендуется для подписей к рисункам и нумерации формул, а элемент CAPTION  — для подписей к таблицам.

Исходная папка

Папка, в которой автор препарирует исходные файлы книги или раздела.

Исходная папка задаётся ключевым аргументом pathname в определении книги помощи. Исходная папка раздела может располагаться вне исходной папки книги.

Ключ, ключевой аргумент

Символическое имя, начинающееся с двоеточия. В терминологии Коммон Лисп — это символ в пакете keyword.

Ключевые (именованные) аргументы — последовательность пар вида
  ключ1 значение1 ключ2 значение2...

Примеры

Целевая папка

Папка, куда компилятор YstokHelp помещает готовую книгу помощи или отдельный раздел.

Целевая папка задаётся ключевым аргументом output-pathname в определении книги помощи. Как правило, целевая папка раздела должна располагаться внутри целевой папки книги.

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

Псевдолитера

Аналогична HTML-литере: её можно вставлять с помощью escape-последовательности вида &имя;.

В отличие от стандартных HTML-литер, вместо псевдолитеры подставляется HTML-элемент или любой другой HTML-код, указанный в двойных кавычках в соответствующей паре в аргументе :entities макроса define-book.

Примеры
ПараСсылка на литеруПреобразуется в HTML
(sqrt . "√‾") &sqrt; √‾ т.е. √‾
(nequiv . "<img class='glyph' src='help:/glf/nequiv.png'>") &nequiv; <img class="glyph" src="../glf/nequiv.png">

Служебное слово (stopword)

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

ASDlite (вариант ASDF)

Компактный вариант библиотеки ASDF, весьма распространённой в мире программирования на языке Лисп.

Содержимое HTML-элемента

Под содержимым элемента в HTML понимают текст или другое наполнение, заключённое между открывающим и закрывающим тегами этого элемента. Например:

<P>Это содержимое элемента</P>

Контекстное меню

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

Меню "всплывает" при выполнении ЩЕЛЧКА-ПРАВОЙ-КНОПКОЙ. С клавиатуры вызывается нажатием SHIFT+F10.

Окно, всплывающее поверх основного окна, требующее обязательной реакции пользователя. Вызывающее окно блокируется и операция приостанавливается до тех пор, пока пользователь не выйдет из "режима" (моды). Т.е. пользователь должен что-то ввести с клавиатуры или выбрать из списка вариантов, а затем нажать кнопку ОК (равносильно, клавишу клавиатуры ENTER), Да или другую.

Модальный диалог часто содержит кнопку Отменить. ЩЕЛЧОК на ней или нажатие клавиши ESC приводит к исчезновению модального окна без сохранения изменений и означает отмену операции.

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