User guide

This section outlines the key parts to this application - designed for rendering help documentation.

Breadcrumbs

The breadcrumbs bar is found at the top of the app - it shows where you currently are in the hierarchy of the documentation. Clicking items on this bar provides quick access to parent pages.

Search

Located at the top-left of the app, the search box can be used to enter in a plain-text search term, press Enter or the search button to initiate a search.

Two pop-up boxes show the pages found with hits, and the app will navigate to the first page hit. The first box (top left) shows the number of hits, and the up/down buttons can be used to move between pages with hits. The second box (bottom left) provides a scrollable list of links to all page hits, referenced by section name. All matching words will be highlighted in the rendered document until the pop-up is closed (by pressing the close button).

To perform a Java and C# API search for a class or class-member, prefix the name of the search item with a '#' character, for example: #qualifiednamevalue. The name search is not case sensitive but the search term must match the whole name.

Collapse all

Pressing the "collapse all" button (adjacent to the search button) collapes the tree-view menu.

Tree-view

The tree-view menu provides a collapsible hierarchical view of the Table of Contents. Nodes are expanded or collapsed by either selecting the node itself (which may change the page selection) or the adjacent arrow icon.

Page up/page down

Buttons for page up/down are placed at the right edge of the application footer. Note that the keyboard PgUp and PgDn keys serve the same purpose.

Touch control

This app should work with any touch-enabled device. The layout is optimised for desktop or tablet devices in landscape orientation.