Authoring - Suggesting snippets while you type

The editor can monitor your typing for phrazes that can be replaced by snippets. The ability to suggest snippets as you type can be switched on and off in your Workbench profile.

This ability is not supported for browser based authoring.

The system uses a 'fuzzy search' method on the text in the first paragraph of the snippet topic. The search is based on a minimum score to detect candidate snippets. A high score results in less but more accurate suggestions. A lower score results in more and possibly fuzzier suggestions. The maximum number of suggestions can also be determined in the profile. A lower score and more suggestions could decrease the editor's performance.

Enabling the suggest snippets as you type

As soon as one or more candidate snippets are encountered while typing, a small tabbed pane will popup as shown in the image below.

Suggesting snippets

If multiple tabs appear then each tab represents one snippet. The match percentage is indicated in the tab. If you click on 'Change'  the phraze immediate before the cursor will be replaced by the selected snippet object.

A phraze replaced by a snippet

The text you see in the snippet pane could be a sub string of the actual snippet text. To read the entire snippet you can click on the 'Open' button of the snippet pane or you can double click on the snippet object in the topic.

An opened snippet topic

Security settings will determine whether you are allowed to change the snippet topic or not.

If you continue typing the snippet pane will automatically close. Also a mouse click anywhere in the editor pane will close the snippet pane. You can manually try to reopen it by pressing the CTRL+Space keys. The editor will then examine the phraze immediate before the cursor and if it matches one or more snippets, the pane will reappear. If no match is found, nothing will happen.

Authoring

 About HelpServer
 Starting up and logging on
 The basic working principles
 Using the content in help and documentation systems
 Formatting the content
 Searching and replacing text
 Reusing content with shares
 Navigating with hyperlinks
 Navigating with pointerpaths
 Using bookmarks and jumps
 Duplicating content with clones
 Using tables
 Including media files
 Navigating to web pages
 Using embedded chunks
 Including html code
 Navigating with menus
 Using snippets
 Overview
 Suggesting snippets while you type
 Launching the snippet checking on a folder
 Inserting snippets
 Spelling checking
 Using the view mode
 Creating an index
 Creating a FAQ
 Creating a glossary
 Team authoring
 Working with projects
 Setting up structured authoring
 Generating file based output
 Creating printed output
 Importing files and folders
 Loading files in the project gallery
 Converting legacy content
 Including legacy content in real time
 Transferring objects between installations
 Smartcontent
 Notification
 Feedback
 Translating
 Customizing the look and feel
 User accounts
 Security
 Working with templates
 Working with metadata
 Versioning
 Auditing
 Workflow management
 Annotations
 Using event exits
 Appendix A: The URL parameters
 Appendix B: The object indicators
 Appendix C: Play Javascript