Authoring Guides (LMW)
Light My Way - Documentation
Page Content
- 1 Guides
- 1.1 Listing Guides
- 1.2 Deleting Guides
- 1.3 Modifying Guides
- 1.4 Ordering Guides
- 1.5 Viewing Guide Images
- 1.6 Creating Guides
- 1.6.1 Guide type
- 1.6.2 Title
- 1.6.3 Description
- 1.6.4 Chapter
- 1.6.5 Tags
- 1.6.6 Color
- 1.6.7 Guide Blocks
- 1.6.8 Default Active & Always Active
- 1.7 Auto sequenced guides
- 1.8 Creating Documentation links
- 1.8.1 Link
- 1.8.2 Title
- 1.8.3 Description
- 1.8.4 Chapter
- 1.8.5 Tags
- 1.8.6 Contexts
- 1.8.7 Manually selected Context elements
- 1.9 Creating Tours
- 1.9.1 Title
- 1.9.2 Description
- 1.9.3 Chapter
- 1.9.4 Tags
- 1.9.5 Color
- 1.9.6 Instruction Type
- 1.9.7 Default Active & Always Active
- 1.9.8 Contexts
- 1.9.9 Manually selected Context elements
- 1.10 Tour instructions
- 1.10.1 Click target on next
- 1.11 Cloning Guides
- 1.12 Adding Flags
Guides
Listing Guides
In ‘Chapters View’ all guides are listed. Switching to ‘Tags View’ guides can be navigated by tag and could be useful making it easy to find guides.
Deleting Guides
To delete a guide click on the three dots and then the trash bin icon.
Modifying Guides
Clicking on the three dots next to a guide and then the edit icon opens a form that allows modification.
Ordering Guides
To change the order of guides simply move the mouse over a guide until you see the movement cursor. You can now use drag and drop to move the guide up or down in the list.
This order will be presented to the Consumer as “Default sorted”.
Viewing Guide Images
To view all the images in a guide, click on the three dots and then the images icon. similarly, an individual instruction image can be viewed as well using the three dots icon.
Creating Guides
Click ‘Create Guide’ from the + menu (found at the top right) to open the create form, fill out the form and click save.
Guide type
Process - regular step-by-step guides with instructions shown based on the context of the platform. See below for more information on instructions.
Tour - step-by-step guides with instructions that have a next and previous button to navigate between instructions.
Block - just like process guides but these guide blocks can be reused by multiple guides. Guide blocks are not displayed to user.
Link - Presents a link to external resources (e.g. pdf-documentation, videos etc.) based on the context of the platform. See below for more information on Documentation links.
Title
The title is presented to the author and consumer in the list of guides and is used to identify the guide. It is also presented as a header inside the instruction callouts.
Description
The description is presented to the consumer in the list of guides by expanding an accordion.
A good description is rich, contains many key words to make the guide searchable. It should also make it easy for the consumer to understand what the guide is about and when it is made available.
Chapter
A guide can belong to a chapter. This will show up as folders for both authors and consumers to help structure all the guides.
Tags
A guide can be tagged with one or more tags allowing the consumer to filter out the guides that matters to him. Simply type the desired tags in the tags field to tie the guide with it.
Tags can be maintained in the preference menu later on.
Color
The guide color controls the color of the callouts and also puts a colored circle in guide lists for easy identification.
Blue is the default color.
You can also change the color of a specific instructions by expanding Options and changing the color of that instruction.
Group is the default value, meaning same color as the Guide.
Guide Blocks
Add previously made guide blocks to the guide.
Default Active & Always Active
If Default Active is toggled on the guide will be automatically turned on for all users on new installs / on extension update.
If Always Active is toggled on the guide will be automatically turned on and the user wont be able to toggle it off (useful for important messages, rules and validation etc.).
Auto sequenced guides
Light My Way will based on selected contexts, order of instructions and change in UI try to automatically show only one instruction at a time.
In cases no UI change can be used to evaluate which instruction will be shown a tour-like behavior will be used and the user will be able to click Prev/Next to move between instructions.
A reset button will be shown in the last instruction to reset to the first one. This can be toggled off with the Display reset sequence option in the guide settings.
The auto sequencing behavior can be toggled of by toggling off Auto sequence same state instructions.
Creating Documentation links
Link
A link to an external resources (e.g. pdf-documentation, videos etc.).
Title
The title is presented to the author and consumer in the list of documentation links and is clickable for the consumer and will open a new tab with the link.
Description
The description is presented to the consumer in the list of documentation links by expanding an accordion.
A good description is rich, contains many key words to make the guide searchable. It should also make it easy for the consumer to understand what the documentation is about and when it is made available.
Chapter
A link can belong to a chapter. This will show up as folders for both authors and consumers to help structure all the links.
Tags
A link can be tagged with one or more tags allowing the consumer to filter out the documentation that matters to him. Simply type the desired tags in the tags field to tie the link with it.
Tags can be maintained in the preference menu later on.
Contexts
To control when a link is shown (when Show Available Content Only is toggled on), it is tied with application state. This is achieved by selecting among a set of built-in contexts valid for the current view.
Manually selected Context elements
If the built-in standard contexts are not enough, one or more context elements could be used.
See below for more information about contexts and application state.
Creating Tours
Title
The title is presented to the author and consumer in the list of guides and is used to identify the guide. It is also presented as a header inside the instruction callouts.
Description
The description is presented to the consumer in the list of guides by expanding an accordion.
A good description is rich, contains many key words to make the guide searchable. It should also make it easy for the consumer to understand what the guide is about and when it is made available.
Chapter
A guide can belong to a chapter. This will show up as folders for both authors and consumers to help structure all the guides.
Tags
A guide can be tagged with one or more tags allowing the consumer to filter out the guides that matters to him. Simply type the desired tags in the tags field to tie the guide with it.
Tags can be maintained in the preference menu later on.
Color
The guide color controls the color of the callouts and also puts a colored circle in guide lists for easy identification.
Blue is the default color.
You can also change the color of a specific instructions by expanding Options and changing the color of that instruction.
Group is the default value, meaning same color as the Guide.
Instruction Type
Here the Author can select if the tour should be presented as regular Callouts or Global Info Banners.
Types:
Callout: Renders the default callout popover pointing to the selected element.
Global Info: Renders a global info overlay on top or bottom of the page (not pointing to a specific element).
Default Active & Always Active
If Default Active is toggled on the tour will be automatically turned on for all users on new installs / on extension update.
If Always Active is toggled on the tour will be automatically turned on and the user wont be able to toggle it off.
Contexts
To control when a tour is shown (when Show Available Content Only is toggled on), it is tied with application state. This is achieved by selecting among a set of built-in contexts valid for the current view.
Manually selected Context elements
If the built-in standard contexts are not enough, one or more context elements could be used.
See below for more information about contexts and application state.
Tour instructions
Tour instructions are similar to regular guide instructions but without context (since the context is only evaluated on the full tour and not individual instructions).
Click target on next
There is also an additional option here to automatically click on the selected target when the user clicks “Next” on the instruction.
This is useful for when the tour continues on another page of the application.
Cloning Guides
Guides as well as Instructions can be cloned using the “Clone“ or ”Clone as” actions. Where the “Clone“ action will create a copy and keeping the cone name, and “Clone as“ action will let you rename the guide/instruction before cloning.
Adding Flags
Guides as well as Instructions can have author notes added to them. This is useful to quickly flag a guide or instruction as not yet done or to notify other Authors about something with that guide/instruction.