YstokHelp
YstokHelp — система для подготовки книги помощи (из категории help authoring tool).
Книга помощи представляет собой документацию
в формате HTML по конкретному программному продукту, изделию, курсу и т.п.
Готовая книга помощи обеспечивает:
- независимость от браузера, установленного на компьютере пользователя,
- удобство при последовательном чтении,
- переход на нужные страницу и фрагмент (якорь) при вызове
контекстно-зависимой помощи из программы,
- перекрестные ссылки внутри книги.
YstokHelp включает в себя:
- соглашения о структуре папок,
- набор вспомогательных файлов,
- программно-инструментальные средства: препроцессор, компилятор предметного
указателя, компилятор оглавления.
Полученную книгу помощи можно использовать совместно с программой,
написанной на любом языке программирования.
Для программ на языке Коммон Лисп в комплект входит библиотека функций
времени исполнения, вызываемых при запросе пользователем интерактивной помощи.
Последовательность подготовки книги
- Автор пишет исходные файлы в формате HTML с дополнительной разметкой.
Для этого можно воспользоваться как простейшим текстовым
редактором, так и сложным WYSIWYG-интстументарием.
- Автор готовит определение книги, аналогичное определение системы на основе
ASDlite или
ASDF (Another System Definition Facility).
Компоненты книги помощи: сама книга, статьи, разделы и т.п. — являются экземплярами
подклассов встроенных в ASDF классов.
- Автор запускает препроцессор, который препарирует статьи и создает файлы
навигационных страниц. Окончательный формат книги — также HTML.
История разработки: change.log.
Установка приложения YstokHelp
Windows-приложение YstokHelp — это полностью готовая
исполняемая программа для свободного использования (freeware).
Инструкция по установке
- Загрузить на свой компьютер файл yhelp-m-n-bbb-ru.exe
— самораспаковывающийся установочный файл, или Мастер установки.
- Сразу открыть этот файл или, сохранив на диске, запустить его позже,
например, из Проводника Windows или другим способом.
- Следовать инструкциям Мастера установки на экране:
- прочитать Лицензионное соглашение и принять его,
- задать Папку установки, где будут размещены файлы
(по умолчанию в C:\Program Files\ystok\Help.m),
- выбрать необязательные компоненты, например, файлы примеров,
- наконец, нажать Установить.
По умолчанию Мастер установки создаст ярлыки в меню
Пуск → Программы → YstokHelp m.n
(Start → Programs → YstokHelp m.n).
Документация
Документация для YstokHelp в виде книги изготовлена
с помощью самого YstokHelp, в соответствии с вышеописанной процедурой.
Определение, с помощью которого была препарирована эта книга, находится в
файле проекта yhelp-book-ru.asd
(также прилагается в дистрибутиве).
Платформы
Исходный код YstokHelp и необходимых библиотек, теоретически, переносимый.
Но по факту, протестирован только под Lispworks 4.4 и 5.0 для Windows.
Если Вам удалось запустить на другой платформе
или реализации языка Лисп, пожалуйста, дайте нам знать.
