Skip to main content
OCLC Support

Enable end user help

Learn how to link Folio to end user help using OLIB Web.

About Folio end user help

Folio can link to end user help. This can be the help page supplied by OCLC, or pages created by your own institution.

View the help page provided

The "Library Search" help page provided by OCLC contains simple text and images to help your users get the most out of Folio. The output is responsive so that it can be viewed on a mobile or tablet device.

View Library Search and decide whether you would like your Folio to connect to it.

Configure help menu option

Once configured the user clicks from Folio's help menu to the start of the help page. Folio does not connect to the end user help page by default; there are "Help/About" links but by default they all connect to the OCLC.org website:

  • This page
  • Index
  • About

To configure a link from the Index, to the start of the Library Search help page:

  1. Go to OPAC> Configuration Settings.
  2. Search using Configuration Settings by Setting for hmenu_options.
  3. Open the "Index" record to modify the details:
Config Block g_helpmenu
Setting hmenu_options
Description The Help Menu options array.
Value "https://help.oclc.org/Library_Management/OLIB/Folio/010Library_search"
Value 2 "Index"
Value 3  
Allowable Values A valid Help Menu option entry.
Sequence 1 1
Sequence 2 2
Include? Yes
  1. In Value enter the following URL, encased in double quotes:
https://help.oclc.org/Library_Management/OLIB/Folio/010Library_search
  1. Optionally, in Value 2, replace the default "Index" text with your own text, e.g. "Library Catalogue Help", including double quotes.
  2. Set Include?=Yes.
  3. Save the details.

When you next load Folio, the Help> Index link takes you to the top of the end user Library Search help page.

Context sensitive help links

icon-help-1.gif  As well as using the Help> Index link above, the user can click the Help icon from within the Folio search page:

Folio help icon on keyword search page

  • A new window loads the help page, displaying the contextual heading for the help you requested; e.g. the help text for the Keyword search displays when you click the Help button in the Keyword search page
  • The reader can also browse to the rest of the help page headings

 Context link for each search option

This is how the help link displays in a search option:

Folio help icon with title/author search input.

Create a new Folio setting:

  •  help_page

one for each of the Folio searches below. In each new setting, select the correct Config Block, enter the URL in Value (encased in "" double quotes):

Search Config Block Setting Value
Keyword search g_kws2 help_page

"https://help.oclc.org/Library_Management/OLIB/Folio/010Library_search#Keyword"

Title/Author search g_tiau help_page "https://help.oclc.org/Library_Management/OLIB/Folio/010Library_search#Title_and_author"
Advanced search g_adv help_page "https://help.oclc.org/Library_Management/OLIB/Folio/010Library_search#Advanced"
Subject search g_subject help_page "https://help.oclc.org/Library_Management/OLIB/Folio/010Library_search#Subject"
  1. Go to OPAC> Configuration Settings.
  2. Click New Record to create the setting help_page.
  3. In the new record, select the relevant Config Block e.g. g_kws2.
  4. In Value, insert the correct URL, encased in double quotes, e.g. "https://help.oclc.org/Library_Management/OLIB/Folio/010Library_search#Keyword"
  5. Enter Sequence numbers, e.g. (16, 0).
  6. Repeat for each of the above search settings.

The Help icon will now appear near the search box, for each of the above search pages.

Context link for title details tabs

This is how the help link displays in the tabs below title details:

Folio help icon in ratings and reviews tab.

On clicking the Help icon:

  • A new window loads the help, displaying the contextual heading for the help you requested; e.g. the help text for Ratings and Reviews displays when you click the Help icon in the Ratings and Reviews tab
  • The reader can also browse to the rest of the help headings
  1. Go to OPAC> Configuration Settings.
  2. Search for tidetails_tabs_labels to list them all.
  3. Open the relevant setting (e.g. for Ratings and Reviews) in modify, and in Value 2, enter one of the URLs below, encased in "" double quotes.
Details Tab Config Block Setting Value 2
Availability g_title_details tidetails_tabs_labels

"https://help.oclc.org/Library_Management/OLIB/Folio/010Library_search#Availability"

Related Items g_title_details tidetails_tabs_labels

"https://help.oclc.org/Library_Management/OLIB/Folio/010Library_search#Related_Items"

Contents g_title_details tidetails_tabs_labels

"https://help.oclc.org/Library_Management/OLIB/Folio/010Library_search#Contents"

Abstract g_title_details tidetails_tabs_labels

"https://help.oclc.org/Library_Management/OLIB/Folio/010Library_search#Abstract"

Other Information g_title_details tidetails_tabs_labels

"https://help.oclc.org/Library_Management/OLIB/Folio/010Library_search#Other_Information"

Also Borrowed g_title_details tidetails_tabs_labels

"https://help.oclc.org/Library_Management/OLIB/Folio/010Library_search#Also_Borrowed"

Ratings and Reviews g_title_details tidetails_tabs_labels "https://help.oclc.org/Library_Management/OLIB/Folio/010Library_search#Ratings_and_Reviews"
Tags g_title_details tidetails_tabs_labels

"https://help.oclc.org/Library_Management/OLIB/Folio/010Library_search#Tags"

Configure your own HTML help pages

If preferred you can author your own content for the help. Copying and adapting from the existing OCLC help page is permitted if this would be useful.

  1. Create the HTML help pages you require.
  2. Link them to Folio using the following configuration.

To link your own HTML help pages to Folio, you use the same configuration as above, using the settings for the Help menu option and context sensitive links described above.

The difference is that you then replace any of the above URLs, with ones that link to your own HTML help pages.

For example, here is the help_page setting for the keyword search:

Config Block g_kws2
Setting help_page
Description The URL for the Keyword search page in the Folio online help.
Value " http://www.mylibrary.ac.uk/support/helppages//Keyword%20Search.htm"
Include? Yes

Replace the Value field with your own URL encased in double quotes. This URL would link to your own help page for the keyword search.