Open topic with navigation

Help

Any netFORUM page> Help icon

Using Online Help

Find what you need with context-sensitive help in netFORUM. You no longer have to search the wiki to find field-level help for a netFORUM page. When you click the Help icon, the following three links display:

• Help: click Help to go to exactly the help topic you need. Or launch the help and use the comprehensive Index or Table of Contents to find the help you need.

  Note: If a page is not linked to a specific topic, the Help icon opens the default help page. You can then use the table of contents, index, or search features to find the information you need.

• Toolkit Documentation (Wiki): click Toolkit Documentation (Wiki) to go to the landing page of the Abila Wiki. Find Toolkit documentation by clicking the Toolkit link in the Developers section.
• About netFORUM: click About netFORUM the see a pop-up window with information, such as version, web server, or database server, about your version of netFORUM.

Using Help Icons

The Help system contains icons that allow you to perform certain actions. Below is a list of the available icons and what happens when you click them:

Use this Icon	To Perform this Action
	home icon to go to the home Help topic
	back icon to go to the previously viewed Help topic.
	forward icon to go to the next Help topic.
	stop icon to stop the Help topic from loading.
	refresh icon to reload the current Help topic.
	expand all icon to expand all hidden text.
	collapse all icon to collapse all hidden text.
	print icon to open the print page for the current Help topic. Click the Print button to send the Help topic to the printer.
	highlight off icon to stop the Help system from highlighting each occurrence of the search term.
	add to favorites icon to add this help topic to the list of favorites in the navigation panel.
	favorites icon to open the list of favorites in the navigation panel.
	hide navigation icon to hide the navigation panel.
	search icon to open the Search section of the navigation panel.

Using Help Features

Help topics work like web pages with some extra features to help you find the information you need. If the context-sensitive Help from the application doesn't take you to a page that contains the information you need, you have several options for finding that information within the Help. Try these options to find the information you need:

• Use the More Information links
• Look for your topic in the Table of Contents
• Search the Index
• Use the Search feature

More Information Links

Most help pages come with a More Information box right at the top. The More Information box contains links to Help topics relevant to the current topic. If the text in the help topic refers to another help topic or information that can be found in another topic, then look for the link to that topic in the More Information box.

Table of Contents

Every help page is part of a larger help system with a Table of Contents, Index, Search, and Favorites navigation panel on the left. By default the Table of Contents displays, but you can choose what appears in the navigation panel by clicking one of the four buttons at the bottom of the panel. To find the information you need from the Table of Contents, remember this organization:

• Each top-level book refers to a netFORUM module. The books are presented in alphabetical order.
  • Each second-level book refers to the group items available in the module. The group items are presented in alphabetical order.
    • Each third-level book contains help topics about the profile for the group item, if there is one.
      • Each fourth-level book contains the help topics about the child forms for the profile, if there are more than three child forms.

Index

The Index contains a list of keywords that appear in the help topics. To use the Index, follow these steps:

1. Find your keyword. Type the keyword in the text box at the top of the Index navigation panel. The Index automatically finds the keyword closest to the word you typed.
2. Click your keyword. The help topic that contains the keyword opens.

Search

The Search feature searches all the words in the Help Topics for the word you enter in the search text box. To use the Search feature, follow these steps:

1. Type your search word or phrase in the search text box.
2. Click the Search button. A list of help topics appears in the navigation panel.
3. Click the title of the topic that seems most relevant. The help topic opens.

Help Screen Captures

Context-sensitive help, because it sits right on top of the netFORUMpage in question, does not need many screen captures. In the case that a screen capture appears in a Help Topic, the screen capture is of the baseline netFORUM. Baseline means that it is the version of netFORUM as it was developed, with no user preferences changed or customizations added.

Adding Additional Help Links

By default, only the three links described in Using Online Help display in the Help menu. You have the option of using netFORUM Toolkit to add additional links for each group item. You must manually add each new link to every group item in which you want the link to be available.

Configuring Online Help

The help system links that display when a user clicks the Help icon are controlled by the helpurl system option. By default, this system option points to the Abila Help system. However, clients have the option of pointing to their own Help system by modifying the URL specified in the current setting field of the helpurl system option.

Modifying this URL changes the destination for all of the links displayed in the Help menu, including the links specific to where users are in the application. For example, you change the current setting field in the helpurl system option to http://www.newhelp.com and a user clicks on the List - Organizations page in the CRM module. The Help link would change to a sub-domain of the www.newhelp.com domain (that is, http://www.newhelp.com/Organizations).

Important! Changing the URL in the current setting field in the helpurl system option changes the destination for all the links in the Help menu. If you change the destination URL, the your organization is responsible for maintaining all of the related help documentation.