Skip to content

Help system

  • Use help wizard to create required files for a new help system.

help-wizard

  • Target folder with HelpBuildConfig added by wizard.

target-folder

  • Required ressources added by wizard.

help-ressources

  • Link to generated files.

help-system

  • Fill Settings with required informations, baseUrl is used for all topic locations.

help-settings

  • Fill ContextFolder instance with some content:

  • Use resource association to link content with a model resource.

  • Use location for page link to confluence page together with defined baseUrl.

help-context

  • Generate help-gen target folder.

  • Use F1 to navigate from linked Resource (PfcHandover, ...) to confluence page directly.

  • Use Help / Help Contents for overview page:

help-browser-overview

Consider that the Eclipse internal web browser does not care about "X-Frame-Options Policy" set by confluence server. It supports direct navigation from table of content to page. However, the Eclipse internal web browser does not support all actual ECMAScript features, so use an external browser if some missing features are required to show web content and use new tab link while navigating.