Authoring - Appendix A: The URL parameters

The principle to access HelpServer content over the Internet is by means of a URL. The URL contains the location of HelpServer's web application and indicators to access the required content object. The best way is to capture the URL by coping the URL in the Workbench. The copy 'URL' function constructs the fixed part of the URL and puts it on the clipboard. Next, you can paste it where ever you need it. In the next image it is pasted in the web browser's address bar. We use this as an example to describe the different parts in the URL.

A HelpServer URL

 1.

The location of the HelpServer web application.

 
 2.

The string 'go' indicates that you are going to access content by means of an alias and optionally a pointer(path).

 
 3.

The actual alias consisting of the project name and object name separated by a dot (not case sensitive).

 
 4.

The pointer or multiple pointers separated by a dot to constitute a pointerpath (not case sensitive).

 

Additionally you can extend the URL with a number of named parameters as demonstrated in the next image

The named parameters in the URL

Consider the following guidelines.

 1.

The question mark (?) is required to indicate the start of the named parameter string.

 
 2.

Each parameter consists of a name and a value separated by an equal sign (=). The name is always in uppercase, some values are case sensitive.

 
 3.

Some parameters consists of a name and a value pair, the values in the pair are separated by a comma (,).

 
 4.

If you add multiple parameters, then separate these with an ampersand (&).

 

And

 

The position of the named parameters in the URL does not matter.

 
 

Blanks in the values have to be replaced by a plus sign (+).

 

Currently the following named parameters are supported.

 

VAR=variablename,valuename

 

This is to initialize a variable with its value. You use this to actuate the conditions of dynamic content. The variablename and valuename are not case sensistive. You can find the names in the properties of the variable and value objects.

 

BARD=NTAB

 

This parameter indicates the various bars and panes typically shown when browsing HelpServer content. By default, the visibility of these bars is indicated in the scheme. You use this parameter to override the settings in the scheme. The value of this parameter is a set of characters that represents a scheme's bar or pane. If you omit a character then the corresponding bar or pane is not available.

 

N indicates the Navigation bar.

 
 

T indicates the Title bar.

 
 

A indicate the Action bar.

 
 

B indicates the Body content.

 

For example if you only want to see the content, without a navigation, title, or action bar then you specify BARD=B. If you also would like to see the title then you specify BARD=BT. The bars and backgrounds or laid out in the

 

IFRAME=1

 

This indicates that the HelpServer content will be shown in an iframe.

 

RES=resoure id

 

This parameter has the same functionality as the pointer or pointer path. It is meant to be used by C/C++ applications.

 

LANG=value.

 

This is the two character ISO-639 code that indicates the language in which the help data should be shown. The value is case sensitive. A full list of the ISO-639 codes can be found on the web. By default the language of the profile of the user is used. Using this parameter will override the language in the user's profile.

 

SCHEME=value

 

The system uses a default scheme to lay-out the HelpServer pages. If you want to override this default you can use this parameter. The value is the identifier of another scheme then the default one. It is not case sensitive.

 

UNDEFMSG=string

 

This is the message that will be displayed when users request help that is not yet available. When no message identifier is specified, HelpServer displays a predefined string. The value is not case sensitive.

 

OMITFBK=1

 

This definition prevents display of the feedback pane.

 

OMITTREE=1

 

This definition prevents display of the folder tree pane.

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
 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