IRP Shopper
Common Tasks (1)
Open
Interventions (1)
Open
Languages (1)
Open
Questions & Answers (1)
Open
Reviews (1)
Open
Site Scripts (1)
Open
Web Services (1)
Open
Training Videos
Peer Support

Help Topics

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

You create Help Topics a level below Help Categories. Help Topics contain the detailed help information.

You can enter information using a rich text editor or by writing in HTML. This means that you can fully customise the Topics.

You can assign each Help Topic to one Help Category; the Help Topic will then be displayed below this Help Category in the left navigation menu:

IRP Admin image

If Site Help is enabled in Application Settings, customers can go directly to the Help page by entering your_IRP/Help.aspx in their browser (where your_IRP is your IRP domain name). Of course, you can provide a link to this area in an appropriate part of your navigation.

HelpTopics.aspx page

The main HelpTopics.aspx page appears as follows:

IRP Admin image

The details are as follows:

  • ID: This is the unique ID of the Help Topic in IRP Admin.
  • Help Topic Title: This is the name of the Help Topic.
  • Help Topic Content: This indicates the content of the Help Topic.
  • Date Created: This indicates the date and time when the Help Topic was created.
  • Visible In Menu: This indicates whether the Help Topic is visible in the help menu.
  • Views: This indicates the number of times that users have viewed the Help Topic on the front end of your website.
  • Preview: Click this button to see how the Help Topic will look on the front end of your website.
  • Edit: Click this button to edit the Help Topic. For more details see the How To Add A Help Topic article in this section.

At the top of the page you can use the following buttons:

  • Help: Click to enable Help. If set to true, Site Help will be available on the front-end of the website. If set to false, the user’s browser will redirect to your home page if they attempt to access the front-end Help page. Note that website Help can still be added even if Help is not enabled.
  • Add New Help Topic: Click this button to add a new Help Topic. See How To Add A Help Topic in this section.
  • Show All Help Topics: Click this button to show all the Help Topics in the main grid.
  • Settings 'cogwheel': Click this icon to go to Site Help Application Settings – see below for more information.

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)

Close
Close
How To Add A Help Topic

To add a new Help Topic, follow these steps.

  1. Go to Site Help > Help Topics in the IRP Admin left navigation menu.
  2. Click the Add New Help Topic button.
  3. Fill in the details in the form below:
    SettingDescription
    Help Topic Details
    Help Topic ID This is created automatically by the IRP and is the unique IRP identifier for this Help Topic.
    Help Topic Title Enter a title for the help topic that will be displayed on the front end of your web site. Click the Translate button to translate the title into the other languages in your system.
    Show In Menu Check this box to display the Help Topic in the left navigation menu.
    Is Searchable Check this box to allow the topic to be returned in search results on the Help.aspx search bar.
    Help Topic Content
    Content Enter the Help Topic details using either the rich text editor or the HTML editor. This is the content that will be displayed for the Help Topic on the front end of your website. You can also click the Upload Files button to upload content that you have saved elsewhere. This can be part of your Help Topic. Remember to translate the information into each of the languages that you have in your system.
    Auto Generate Short Help Topic Content Check this box to automatically generate the short Help Topic content based on the full Help Topic content. (Note that if you check this box, the following section described below called 'Help Topic Short Content' will not be shown on the HelpTopicEdit.aspx page as it will no longer be needed.)
    Help Topic Short Content
    Content Short: (You will only see this whole section if you have not checked the box for 'Auto Generate Short Help Topic Content'.) Enter the Short Help Topic Content that will appear if this Help Topic is returned when a search is performed within the Help section. Remember to translate the information into each of the languages that you have in your system.
    SEO
    SEO Page Title The SEO Page Title is output in the title HTML meta tag on your web page. You only need to set this if it is different to your Page Title. Note that if you have a translated value for Page Title, and not for SEO Page Title, it will use your translated value for Page Title, and not the default English value. You can translate this into any enabled language. 250 characters max.
    SEO Page Description The SEO Page Description is output in your web page’s description HTML meta tag. Note that SEO Page Description will output the default English value if no translated value exists. You can translate this into any enabled language. 250 characters max.
    SEO Page Keywords SEO Page Keywords is output in your web page's keywords HTML meta tag. Note that SEO Page Keywords will output the default English value if no translated value exists. You can translate this into any enabled language. 250 characters max.
  4. When you have entered all of the required information, click the Insert Help Topic button. You can then add a brand and/or category to the help topic. When you enable this, a 'View help for' link to the help topic will be displayed on the brand or category page (Small Tranlsation 1492). To enable this feature, follow the remaining steps described below.
  5. Back on the main Help Topics page, click the Edit button beside the topic that you want to work with.
  6. Click the Relate Help Topics to Models tab.
  7. Select the brand or category from the lists and click the Add Relation button to relate them to the help topic.
  8. To assign a help topic to one or more categories, click the Parent Help Categories tab.
  9. Use the Add and Remove buttons to move help categories between the Non-Added Help Categories box and the Added Help Categories box.
  10. Click the Update Help Topic button to save the details.

Remember to use the Preview button to test what the help information will look like on the front end of your website.

FAQs (1)

Close
Can I disable help topics on my website?

Yes, you can do this by checking the ‘Help’ box at the top of the ‘Help Topics’ screen in IRP Admin. This disables the main Help Application Setting. When set to false (the box is unchecked), the user's browser will redirect to your home page if they attempt to access the front-end Help page. When set to true (the box is checked), Site Help will be available on the front-end of the website.  Note that you can still add website Help even if the Help box is not checked is not checked.

Copyright © 2020 IRP Commerce. Use of this website constitutes acceptance of the IRP World Terms of Use, IRP Privacy Policy and IRP Cookie Policy

IRP Commerce Limited, Concourse 3, Catalyst, BT3 9DT, UK. Company Number: NI 041856. VAT Number: GB 888249658
A Deloitte Fast 50 Company seven times: 2010, 2011, 2012, 2013, 2014, 2018 & 2019