Systém JavaHelp

Systém JavaHelp
Základní data

Správce Proces komunity Java
vývojář Sun Microsystems
Aktuální  verze 2.0_05
(3. října 2007)
operační systém nezávislý na platformě
programovací jazyk Jáva
kategorie Systém nápovědy
Licence GNU General Public License with Classpath Exception
javahelp.java.net

JavaHelp System je platformově nezávislý systém nápovědy Java od Sun Microsystems , který umožňuje snadno integrovat online nápovědu a dokumentaci do aplikací Java. Texty nápovědy jsou založeny na HTML , zatímco rozhraní je založeno na XML .

Systémem JavaHelp se rozumí jak specifikace programovacího rozhraní (podle Java Specification Request 97), tak referenční implementace této specifikace. Referenční implementace je otevřený zdroj pod GNU General Public License 2.0. Programovací rozhraní je aktuálně (2010) ve verzi 2.0, referenční implementace ve verzi 2.0_05.

Systém JavaHelp sám o sobě není redakčním nástrojem , ale existuje řada redakčních nástrojů, které mohou generovat nápovědu ve formátu JavaHelp.

Složky a vlastnosti

Systém JavaHelp se skládá z následujících částí:

Prohlížeč nápovědy
Prohlížeč nápovědy je okno pro zobrazení nápovědy včetně navigačních prvků, jako je panel nástrojů, navigační okno a fulltextové vyhledávání. Samotné texty nápovědy jsou založeny na HTML 3.2 a lze je pro další funkce rozšířit o jednoduché komponenty Java. Obsah a rejstřík podle standardů W3C se generují automaticky.
Prohlížeč nápovědy lze zobrazit v samostatném okně nebo kdekoli jinde v aplikaci. Totéž platí pro jednotlivé komponenty Prohlížeče nápovědy (například navigační okno).
Kontextová nápověda
Kontextové informace nápovědy lze také zobrazit mimo Prohlížeč nápovědy pomocí komponent Swing. Odpovídající nápověda je propojena na základě ID aktuálních ovládacích prvků Swing.
JavaHelp API
Rozhraní JavaHelp API odpovídá za shrnutí a správné zobrazení textů nápovědy. Umožňuje také konsolidovat nápovědu z různých zdrojů, jako je obsah, index a vyhledávací databáze.
Rozhraní JavaHelp API je navrženo tak, aby bylo konfigurovatelné a rozšiřitelné. Lze jej například rozšířit o speciální navigační pomůcky, vyhledávací algoritmy nebo prohlížeče HTML.
Informace o nápovědě
Informace nápovědy jsou od zbytku aplikace odděleny systémem JavaHelp. To umožňuje například pomoc v různých jazycích. To také umožňuje nezávisle a nezávisle na aplikaci aktualizovat online nápovědu nebo pouze její části.

webové odkazy

Individuální důkazy

  1. ↑ Stránka projektu JavaHelp na java.net ( Memento od 11. června 2007 v internetovém archivu )
  2. ↑ Funkce JavaHelp