Javahelp зрители (или альтернативы)

Question

Я пытаюсь интегрировать поисковую помощь в мое приложение Java (Swing). Я использую docbook прямо сейчас, чтобы генерировать PDF-помощь, и я знаю, что она может генерировать JavaHelp. Я думаю, что просмотрщик по умолчанию для JavaHelp довольно невозможен (особенно в окнах, даже при использовании окон L & F). Я не мог найти хороших зрителей, но любопытно, знаете ли вы, что там есть, или если есть лучшие альтернативы для помощи в приложении.

Answer 1

Зритель контента по умолчанию (HTML рендерер) в JavaHelp является HTMLEditorKit. Этот компонент не очень впечатляет; он поддерживает только HTML 3.2 и имеет ограниченные возможности CSS. Можно подключить alternative content viewers in JavaHelp.

Возможно, вы захотите попробовать Oracle Help. Он очень похож на JavaHelp, но более активно поддерживается. Средство просмотра содержимого по умолчанию, которое поставляется с помощью справки Oracle, также более эффективно. Таблицы стилей DocBook-XSL JavaHelp могут потребовать некоторой настройки для создания вывода, который работает с помощью справки Oracle (см. this page).

Трудно найти окончательную информацию о статусе и планах на будущее для этих технологий. Последняя версия JavaHelp была выпущена в октябре 2007 года, а Oracle Help 11.1.2.1.0 была выпущена в сентябре 2011 года. Есть форумы (here и here), но активность низкая.

Возможно, вам будет интересна веб-справочная система. В этом случае взгляните на WebHelp, один из новых форматов вывода для контента DocBook.

Answer 2

Я использую Sphinx для всех моих потребностей в документации и имеет отличные HTML-шаблоны. Сам сайт sphinx основан на одном из шаблонов. Существует также eclipse plugin, который помогает вам настроить базовый проект сфинкса и действует как редактор. Преимущества

1. Вы пишете документацию, используя синтаксис ReST, который похож на wiki.
2. Хорошо выглядят HTML шаблоны/
3. Возможность порождать другие форматы, такие как EPUB, PDF и т.д.
4. Versionable