[ANN] YstokHelp 0.1.001 - Система подготовки книги помощи
Dmitriy Ivanov
Система YstokHelp служит для подготовки книги помощи - документации в
формате HTML по программному продукту.
Система включает в себя:
(1) набор соглашений и вспомогательных файлов,
(2) программно-инструментальные средства - компилятор оглавления и
предметного указателя.
Готовая книга обеспечивает:
- возможность просмотра с помощью любого Интернет-браузера,
- переход на нужные страницу и фрагмент (якорь) при вызове
контекстно-зависимой помощи из приложения на языке Лисп (возможны и другие),
- перекрестные ссылки внутри книги.
Исходные файлы препарируются также в формате HTML. Автору не нужно изучать
дополнительных языков разметки, а достаточно пользоваться
- либо простым текстовым редактором,
- либо одним из распространных WYSIWYG-редактором HTML.
Инструментальная часть написана на Коммон Лисп с учётом переносимости под
разные реализации. Определение книги выглядит, как определение ASDF-системы.
Исходный код и книга помощи по самой системе YstokHelp находятся здесь:
http://lisp.ystok.ru/ru/yhelp/index.html
Сообщения об ошибках и дополнения приветствуются.
Чего хотелось бы в следующих версиях:
(1) фрагменты кода Javascript для различных браузеров, позволяющие управлять
окном, например, прятать панель инструментов "Адрес" или строку состояния.
(2) транслятор в формат PDF.
--
Sincerely,
Dmitriy Ivanov
lisp.ystok.ru