Введение в систему YstokHelp
Система YstokHelp
служит для подготовки книги помощи.
Книга помощи представляет собой документацию
в формате HTML по конкретному программному продукту.
YstokHelp включает в себя
Правильно подготовленная книга обеспечивает:
- независимость от браузера,
установленного на компьютере пользователя,
- переход на нужные страницу и фрагмент (якорь) при вызове
контекстно-зависимой помощи из программы,
- перекрестные ссылки внутри книги,
- удобство при последовательном чтении.
Соглашения и файлы
Автор книги препарирует исходные файлы в формате HTML с применением таблиц
стилей CSS2. Чтобы подготовить несложную книгу помощи, требуются:
Программно-инструментальные средства
- Компилятор книги помощи
- В исходных страницах преобразует гибкие ссылки с нестандартной схемой
help в окончательные, а также автоматически компилирует оглавление и предметный указатель.
Доступен в виде готового приложения Windows с графическим пользовательским
интерфейсом.
- Библиотека времени исполнения
- Прикладной программный интерфейс (API) включает набор функций,
вызываемых из работающего приложения.
Библиотека написана на языке Коммон Лисп и доступна в виде
исходных текстов.