Helplinks — Contextual Help in the Application
Helplinks connect application interface elements with articles in the knowledge base. Thanks to them, users can see a hint or link to an article right where they are working.
How It Works
- In the application code, you place a helplink with a key (e.g.,
tasks.create) - In the helplinks panel, you assign the key to a knowledge base entry
- The helplinks widget automatically displays the content or a link to the article
Helplink Properties
-
Key — unique identifier within the knowledge base (e.g.,
settings.email,tasks.create) - Entry — associated knowledge base article
- Section — optional anchor to a specific section of the entry
- Content — optional short HTML text displayed in the widget
- Active — whether the helplink is visible (inactive ones are created automatically)
Automatic Creation
When the widget requests a helplink that doesn’t exist in the database — the system automatically creates it as inactive. This way you can see which keys are used in the application and later assign them to articles.
Statistics
Each helplink tracks:
- Open count — how many times the widget fetched it
- Click count — how many times a user clicked the link
Multilingual Support
The widget automatically searches for the helplink in the appropriate language version of the knowledge base. If not found — it falls back to the default version.
Testing
From the knowledge base desk, you can display a list of helplinks for testing — check which keys have assigned entries.