Authoring - Creating the FAQ

To demonstrate the FAQ capabilities let's add a FAQ to the 'Animal information' example project. This is very simple since the default settings of the project folder already provide the ability to add a FAQ.

Adding an FAQ

Just popup the menu of the 'Project: Animal information' folder and select 'New -> FAQ'

Entering the FAQ description

Enter the description of the FAQ folder and click 'OK'.

The FAQ folder added to the project folder

When the FAQ folder is added to the project folder you won't see its description in the tree node. Instead, only the 'FAQ' prefix is shown. This is a default behaviour since the project folder is setup to hold only one FAQ folder. This behaviour can be changed and it is explained in changing the class behaviour. Anyway, we strongly advise you to specify a decent description for all your new objects even when it is not immediately shown in the Workbench tree node.

If required you can further subdivide your FAQ into categories. Assume for example you want to categorize the ‘Mammals’ and ‘Amphibians’ FAQ topics.

Subdividing a FAQ into categories

Popup the menu on the FAQ folder and select ‘New > FAQ category’.

Entering the FAQ category description

Enter ‘Amphibians’ as description and click ‘OK’. Use the same working principles to add the ‘Mammals’ category.

Finally you can add the actual FAQ topics. For example, add a FAQ topic to provide a straight answer to the question ‘Is a shark a mammal’.

Adding a FAQ topic

Select the ‘Mammal’ category, popup the menu and select ‘New > FAQ topic’.

Entering the FAQ topic description

Enter the description of the topic and try to reflect the question in the description. Here in this example that would be ‘Are sharks mammals’. Click ‘OK’ to add the topic to the category.

Next, select the topic in the tree and note the button that appears in front of the title on top of the editor pane as indicated by the red arrow in the next image.

Opening the FAQ topic's chunks popup

A FAQ topic consists of two predefined chunks: a question and an answer. If you click on that button a popup reveals those two chunk items on the left of the editor pane.

A FAQ topic's chunk list

The 'Question' chunk is pre selected. If you put the cursor back in the editor pane on the right the 'Chunks' popup will close and you can further explain the question.

Entering the FAQ topic's question chunk

Next, re-open the 'Chunk' popup by clicking on the button and select the ‘Answer’ item in the 'Chunks' popup to enter the answer in the editor pane. Also note the description of the selected chunk in the editor title as indicated by a red rectangle in the next image.

Entering a FAQ topic's answer chunk

When the FAQ topics are ready you can preview the entire 'Project: Animal information' to check out the result. You will notice the 'FAQ' item in the navigation bar.

Navigating to the FAQ page

Click on it to navigate to the FAQ page.

A FAQ topic with a question and an answer chunk

Expand the category and select the underlying topic. On the right you see two chunks: the question part and the answer part. The two titles 'Question' and 'Answer' can be customized and translated.

Should you have left the 'Question' chunk empty because you think the description 'Are sharks mammals' is clear enough than the FAQ topic will only show the 'Answer' chunk as shown in the next image.

A FAQ topic with only an answer chunk

Here in this case the title (see red rectangle) on top of the topic actually represents the question part.


 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
 Spelling checking
 Using the view mode
 Creating an index
 Creating a FAQ
 Creating the 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