Toggle on/off

The consumer can toggle guides to be displayed on/off. The toggle state is persisted over time (browser local storage) and allows the user to keep his favorite guides on so that the right instruction automatically appears as the application state is right.

Available guides

To make it easy for users to find help relevant to the current view the guides, with at least one instruction valid for the current view (contexts) is displayed on top.

By default Show Available Content Only is toggled on and only guides and documentation with at least one valid context will show up.
If the user toggles this off all guides and documentation will be listed.

The user also get aware there is help to get in case the panel tab is minimized. If there is a guide available but it is disabled a shining indication appears on the panel tab.

Finding guides

Users can find instruction guides by a filtering functionality. The filter field opens by clicking the search icon. Entered text will filter down the guide matching the text in labels, description and instruction content. The filter function is cancelled by pressing the arrow and any entered text is cleared by pressing the x.

Description

A detailed description for each guide can be added by the author and is made available to the consumer by expanding an accordion. A good description makes the guide searchable and makes it easy for the consumer to understand what it is about and when it is made available.

Color

To easily differentiate between guides the author can assign different colors. Guide colors are also displayed next to the guide name in the panel.

Sort Guides

Users can sort guides by color, alphanumerically or “Default sorted” (the order the Author has sorted them by) by clicking the sort icon.
By default the sorting is set to “Default sorted”.

Tags View

By clicking on “Enable TagsView” the guides will be grouped by tags.
For more information about tags see “Tags” below.

Documentation

Users can find relevant external resources (e.g. pdf-documentation, videos etc.) by navigating to the Documentation tab.

Clicking these links will open a new tab with that link.

Screenshot view

If a guide contains screenshots the guide can be viewed in screenshot view by clicking the image icon.

The steps that are active in the current context will be highlighted.

If the user clicks on an image it will be opened in a modal together with the description.

Export guides

If export guides are enabled by the administrator then the user can export the guides by clicking on the menu icon and selecting an export format.

Just-in-time delivery

To ensure that the right instruction appear at the right time, all callouts reacts and validates as the application state change.

Instructions valid for the current view and application state automatically appears on screen. With the context that its guide is toggled active.

In case of multiple instructions appearing on top of each other. The hovered instruction would go on top.

Dismissing instructions

In case an instruction callout is in the way it can be dismissed by clicking the x. Instruction dismissal is temporary and will appear next session as long as application state and group toggle state still say it should.

If you want a dismissal to be persistent you can click the dismiss-icon. The instruction wont be shown again unless the guide is toggled off and then on again.

Links

Some instructions can contain links. When a link is clicked the content will open in a new browser tab.

Images

Instructions can contain images. When an image is clicked the image will open in a new browser tab.

Preferences

To increase usability the consumer can control some of the behavior through preferences found at the top right corner of the panel.

UI Preferences

Under the preferences option the user can control callout layout and styling.

Use thick tabs

Make tabs bigger when toggled on.

Minimized callouts

When the cursor is close to the target the callout will be minimized to not distract from the target and the action the user is about to do.

This can be toggled of in the preferences.

Language

Changing language changes the language of the different actions and buttons in Light My Way.

Currently English and French is available.

Flip LMW Panel

This is used to switch side of the panel from the right to the left and vice versa.

You can also flip the panel from the browser context menu by right-clicking the page and navigating to “Light My Way“ → “Flip Panel“.

Refresh

Reloads Light My Way with the latest data.

Start Tour

Start a tour on how to use Light My Way.

This tour is automatically started on every new installation.

Tags

Filter listed guides by tags. Toggling tags on/off can be done from the tag icon found at the top right corner. By enabling at least one tag all guides will be filtered down to only include those matching the selected tags. Tag filtering is a good way to hide the guides not of value to you and allow you to focus on the ones that are.

By navigating to the AI Help tab the user can get directions and information directly based on the context of the application.

The AI will try to give as relevant information as possible but the user can reply with follow up questions to get further help.