About
Use the Helppage module to set up a Help page or FAQ page with sections for questions, answers, and optional titles or Contact us links.
Once enabled, the page is available at /help. Make sure this URL isn’t already used by another module (for example, the Custompages module).
You can use language tokens and exceptions to support multiple languages. You can also add a CTA button that links to a URL or opens an email using mailto:email@company.com.
The Help page is publicly accessible to any user via {contenthubs_url}/help.
This is a Content Hubs module that requires the Theming module to be enabled.
Configure
1. Go to your Configuration Management console and click on the Helppage module. You can also navigate to it directly using a link: https://{your_KMS_URL}/admin/config/tab/helppage.
The 'Helppage' page opens.
2. Configure the following:
enable - Set to 'Yes' to enable the module.
Permission - Select the minimum role allowed that can access this page. Set as 'anonymousRole' to allow guests to view the page. If your site does not support anonymous users, choose 'Guest override' to make this page public to all.
The following options are available:
- Guest override
- anonymousRole
- viewerRole
- privteOnlyRole
- adminRole
- unmoderatedAdminRole
- unconfirmedViewerRole
pageTitle - Use the pageTitle field to set the top page title.
Contact Us button
contactUs - Adds a box on the top right of the help page with a clickable call to action button. Set to 'Yes' to expand this section and configure the contact us fields.
titleText - Enter the title text to present at the top of the box.
buttonText - Enter the text for the Call to Action button.
buttonLink - Enter the URL for the Call to Action button ('mailto' tag is accepted).
bottomText - Enter the text to present below box (HTML markup supported).
Enter the title, the button and its link (you can use an "https://help.company.com" link or a "mailto:email@ocmpany.com"), and additional text below the button.
FAQ section
The help page UI can be separated into sections for FAQ according to topics, or you may use just one section. You can place multiple questions and answers in each section.
Click "+ Add faqSections" to create a section.
title - Enter the section title in the title field.
Order - Mandatory field. Lower number will show higher on the page.
Click +Addquestions to add questions and answers.
question - Enter the question text (plain text).
answer - Enter the answer text (HTML markup supported).
You can add links and make text bold using html tags (e.g. <a> or <b>) in the questions or answers
3. Click Save.
