Authoring - Overview

Snippets are pre-set chunks of formatted content that can be reused in topics of a project. This prevents redundancies and errors. Snippets can be suggested while you type. You can also search the content for phrazes and than manually replace a phraze by a snippet or you can simply select a snippet object from the project gallery to insert it in the content.

Snippets are topics that are created and maintained in the project gallery usually by the project manager. Besides text a snippet topic can include any object that can be inserted in a regular topic such as text, images, hyperlinks, variables, etc. However, you cannot insert a snippet in a snippet topic.

Security settings can determine which author is allowed to use or change a snippet.

Below is an example of a project that contains a bunch of snippets organized in the gallery's subfolders.

Snippets in the project gallery

The text in the first paragraph is used to suggest snippets while you type. Empty snippets are not included in the suggestion mechanism.


 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
 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
 Customizing the look and feel
 User accounts
 Working with templates
 Working with metadata
 Workflow management
 Using event exits
 Appendix A: The URL parameters
 Appendix B: The object indicators
 Appendix C: Play Javascript