Skip to content

Latest commit

 

History

History

Folders and files

NameName
Last commit message
Last commit date

parent directory

..
 
 
 
 

README.md

📖Help Viewer quick guide

The application is divided into two main areas:

Left panel

The left panel lets you navigate through the help file.

At the bottom of this panel, you’ll find several buttons:

Help navigation

  • 📖 Hierarchical TOC (Table of Contents) tree
    (visible if defined by the help author)
  • 🔖 Subchapter list
    (shown if the current chapter has subchapters)
  • 📇 Keywords list / Glossary
    (visible if defined by the help author)
  • 🔎 Fulltext keywords list
    (visible if defined by the help author or the indexing functionality is active)

These items are displayed as an expandable tree with clickable nodes. Clicking on an item expands its subcontent or opens the selected chapter.
📇 and 🔎 have an input field at the top where you can search for an exact phrase.
Just start typing and press Enter to search.
Press Esc to clear the field.

  • 🏡 Go to the help file’s homepage (README.md)

Viewer customization

  • 🌐 UI Language selection
  • 🕘 Search for other version (of help file) (Internet connection required)
  • 🎨 Switch color mode
    (color, greyscale, white to black, black to white, sepia)
  • 📚 Show all chapters as book
    (after selecting page breaks and the method of printing Unicode icons in the text, simply click the button a second time and the result will be displayed)
    (only chapters displayed in the topic tree, the help home page, and chapters referenced in the text are included in the output)
  • ✏️ Notes
    Allows you to add, manage, and toggle the display (👁️) or hiding (🙈) of user notes. Notes can be deleted by simply erasing their content. Those displayed on the screen are automatically included in the printout. They are only displayed when browsing individual chapters. Notes are stored only in your environment and no one else has access to them. However, if you switch to a different language or newer version of the same help file, your notes will also be displayed in it.
  • ↔ Move (toggle) sidebar to left/right
  • 🔲 Toggle UI to/from fullscreen
  • 📽 Presentation mode
    (full screen mode (🔲), keys ⬅, ⬆, ➡, ⬇ are used to switch between chapters/slides)
  • 🌈 Select style
    (you can select a different application style from the drop-down list)
  • ❌︎ Close left sidebar

Right panel

The right panel displays the main content area:

  • Current chapter/topic content

  • Chapter title in the upper bar

  • Action buttons:

    • ☰ Show left panel back
      (if hidden)
    • 🖨️ Print current chapter
    • ⬅ Go to the previous chapter
    • ⬆ Go one level up
    • ➡ Go to the next chapter
    • 📝 Edit in repository
    • 📥 Export the current chapter or all chapters

Why something might be missing?

There are several reasons why certain elements may not appear:

Missing icon or feature Why?
📖 / 📇 These were not defined by the help file author
🔎 These were not defined by the help file author, the indexing function is disabled, or the indexing process has not been completed yet
🔖 The current chapter has no subchapters
The left panel is already visible
Left panel You closed the app with the panel hidden. Just click ☰ in the top bar to bring it back
🕘 Help is not linked to the public online repository or it is not accessible (e.g. no internet connection)
📥 Export The system administrator has removed the entire function or individual export formats from the application

The 📥 Custom package feature allows you to customise most of the functionality. If it was used when downloading the application, some features may be unavailable.

Configuration data

The application remembers your preferences using local storage:

Key Description
colorTheme Selected color mode (🎨)
sidebarVisible Visibility of the left panel (❌︎ / ☰)
language Selected UI language (🌐)
keywordListingCount Count of searched keywords in 📇, 🔎 lists.
sidebarSide Left panel side (↔ ; 0 = left, 1 = right)
printIcons Unicode icons (characters) printing mode; 0 = remove, 1 = keep, 2 = author's configuration
notesVisible User notes display mode; 0 = hidden (🙈), 1 = shown (👁️)
skin Style/skin of application UI (🌈; empty = default)
exportDictionaries For static export (if supported by the application): 1 = dictionaries will be exported (📇, 🔎), 0 = dictionaries will not be included in the export

The ✏️ Notes module stores its data in the web browser's IndexedDB storage (database: HelpViewer).

Getting started

Opening help file

Append ?d={path} to the viewer's URL to open a custom help file. If omitted, the default file hlp/Help-{selected language}.zip will be loaded automatically. If the language is specified with __ (two underscores), the selected UI language from the user configuration will be used.

The following are valid path formats that end with:

  • .zip - zip help file
  • / - directory on your disk or network URI address

❔ Contextual help

If your administrator has installed the HelpViewer plugin in Chrome/Edge (Chromium) and the application is configured correctly, you can get quick contextual help by right-clicking on an element and selecting ❔ ("What's this?").

If this option is not available, the plugin or configuration on the application side is missing.
If no chapter or text is displayed, the description of the element is missing from the help.

Browser tips

Modern web browsers include built-in features such as:

🧭 Content Navigation

Shortcut Action
Tab Go to next button / link on the page
SHIFT + Tab Go to previous button / link on the page
↑ ↓ ← → Scroll or move focus inside content (if possible)
PageUp / PageDown Jump one page up/down in content

🌐 Browser Navigation & Page Actions

Shortcut Action
ALT + ← / → Navigate back/forward in history
CTRL + L Focus address bar
CTRL + D Bookmark current page

🔍 Display & magnification

Shortcut Action
CTRL + mouse wheel Zoom in / Zoom out
CTRL + 0 Reset zoom
F11 Toggle / Exit fullscreen mode (page or iframe)
ESC Exit fullscreen mode
F3 / CTRL + F Find text on page

🔁 Content reload

Shortcut Action
CTRL + R / F5 Reload page
CTRL + SHIFT + R Hard reload (bypass cache)

💾 Application & Install

Shortcut Action
Address bar icon (📥) on right side Install web app
🌐 Latest version download link @LTOPVERSIONV@