Notifications
You currently have no notifications!
SITE HELP
IRP
Common Tasks (1)
Interventions (1)
Languages (1)
Questions & Answers (1)
Reviews (1)
Site Scripts (1)
Web Services (1)
Training Videos
Peer Support

Help Categories

How Tos (1)

You can find this section under Site Help > Help Categories in the IRP Admin left navigation menu.

You use the site help feature to create a structured help section on your front-end website.

You can also customise the site help and use it as a blog or a customer knowledge base section. There is a good example on the Vivomed site (shown in the image below).

You create site help using Help Categories and Help Topics. Help Categories act as a heading or section. You can assign multiple topics to each Help Category but each Help Topic should be assigned to one Help Category only. Help Categories and Help Topics are shown in the image below:

If Site Help is enabled in Application Settings, customers can go directly to the Help page by entering <YourIRP>Help.aspx in their browser. Of course, you can provide a link to this area in an appropriate part of your navigation.

Help Category Page

The main HelpCategories.aspx appears as follows:

Help Categories page

This shows various details including:

  • ID: This is the unique IRP identifier for this Help Category.
  • Display Order: This defines where this Help Category should appear in relation to other Help Categories in the left navigation menu. Lower values will display before higher values, e.g. a Help Category with a display order value of 1, will appear before a Help Category with a value of 2. You can edit this value – if you do so, be sure to click the Update Help Categories button to save your changes.
  • Help Category Name: This is the name of the Help Category which will be displayed in the left navigation menu
  • Help Topic Title: This is the default Help Topic for this Help Category. This Help Topic will be displayed when someone clicks the Help Category link in the left navigation menu.
  • Visible In Menu: This indicates whether or not the Help Category is displayed in the left navigation menu.
  • Date Created: This shows the date and time when the Help Category was created in IRP Admin.
  • Edit: Click this button to make changes to a Help Category. For more details, see How To Add A Help Category.

Site Help Application Settings

You configure several key Application Settings for Site Help under Application Settings > Site Help Settings, including the essential Enable Site Help setting. See the Site Help Settings topic for more information.



How To Guides (1)

To add a Help Category, follow these steps:

  1. Go to Site Help > Help Categories in the left navigation menu.
  2. Click the Add New Help Category button.
    The Help Category Information screen appears:
  3. Add Help Category screen

  4. Fill in the details as follows:
    SettingDescription
    Help Category ID This is created automatically by the IRP and is the unique IRP identifier for this Help Category.
    Show In Help Menu Check this box to display the category in the left navigation menu.
    Help Category Name Enter the name of the category. This will be displayed in the left navigation menu if you have checked 'Show In Help Menu'. Click the Translate button to translate the name into the other languages in your system.
    Display Order This defines where this help category should appear in relation to other help categories in the left navigation menu. Lower values will display before higher values, e.g. a help category with a display order value of 1, will appear before a help category with a value of 2.
    Default Help Topic Select the default help topic for this help category. This help topic will be displayed when someone clicks the help category link in the left navigation menu.
  5. When you have entered all the details, click the Insert Help Category button to add the category.
    If you have already created help topics, you can assign them to the Help Category you have just created by following the remainder of these steps.
  6. If you are not already on the HelpCategoryEdit.aspx page, from the main Help Categories page (HelpCategories.aspx), click the Edit button beside the category that you want to work with and the HelpCategoryEdit.aspx page will appear.
  7. Click the Related Help Topics tab.
    The Related Help Topics screen appears:
  8. Add Help Topic to Category screen

  9. Use the Add Help Topic drop-down list to select a topic.
  10. Click the Update Help Category button to add the topic to the category.

If you ever want to delete a Help Category, simply go to the HelpCategoryEdit.aspx page for the Help Category you want to remove and then click the Delete Help Category button:

Delete Help Category button

Copyright © 2019 IRP Commerce. Use of this website constitutes acceptance of the IRP World Terms of Use, IRP Privacy Policy and IRP Cookie Policy
IRP Commerce is a Trading Name of Export Technologies Limited, Concourse 2, Catalyst, Belfast, BT3 9DT, UK. Registered in Northern Ireland, Number: NI 041856. VAT Number: GB 888249658
A Deloitte Fast 50 Company six times: 2010, 2011, 2012, 2013, 2014 & 2018