Want to display some of the required articles directly on your homepage? You can do that, too.
We've created an article list merge code specifically for this purpose!
The Required Reading feature and list only work with individual reader accounts. Knowledge bases with default access set to public, shared passwords, or shared IP addresses cannot use this feature.
How does it work?
To set up, you'll add the merge code for the list where you'd like the information to be displayed. KnowledgeOwl will display up to 10 of the most recently required articles in the list, and the See more link at the bottom will navigate readers directly to the Required Reading page to view a full list and see which articles they need to acknowledge.
If your knowledge base allows a mixture of public and private content, the Required Reading Article List will show as empty/blank for anyone who hasn't logged in.
By default, the 5 most recently required articles will be displayed. You can change this to display between 1-10:
- Go to Settings > Basic.
- Scroll to the Article List Settings section.
- Click on the dropdown next to Required Reading Articles and select the number of articles you'd like the list to display (1-10).
- Be sure to Save your changes.
We do not add this list to any section of your knowledge base by default.
If you'd like to add it, you'll add two merge codes into either Knowledge Base > Home Page or into the Settings > Style, Custom HTML of the relevant layouts:
[translation("required-reading:required-reading-list-heading")]: this merge code grabs the Required Reading list heading in Tools > Customize Text > Customize Text, making it so no one has to edit the code in the future to update the title
[template("required-articles")]: this merge code generates the required articles list
Different setups are discussed further below.
Add the Required Articles List to your home page (Settings > Style)
Newer knowledge bases have their entire home page set in Settings > Style. If your knowledge base uses this layout, you can follow these instructions to add the Required Articles List there. (If your knowledge base doesn't show any article lists in Settings > Style > Custom HTML > Home Page, skip these and follow the next set of instructions!)
- Go to Settings > Style.
- Below the Preview pane, be sure Custom HTML is selected.
- Select Home Page from the Custom HTML dropdown.
- Near the bottom of the code editor, find the div with class="homepage-widgets row".
- Copy one of the other article lists and paste that code in again.
- Replace the title merge code with:
- Replace the list merge code with:
- Your code should now look something like this:
- You can Preview your changes to be sure they look right.
- Be sure to Save your changes once you're done!
Add the Required Articles List to your home page (Knowledge Base > Home Page)
If you're using our older home page:
- Go to Knowledge Base > Home Page.
- Copy one of the other home page lists and paste it in again.
- Replace the title with this merge code:
- Replace the merge code with:
Your home page might now look like this: