Add a Required Reading article list to your homepage

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!

Reader accounts required
The Required Reading feature and list only work with individual reader accounts. Knowledge bases with Security and access > Security settings > Content authentication set to public, IP address, or shared password can't use this feature.

How does it work?

To set it up, you'll add the merge code for the list where you'd like the information to be displayed. KnowledgeOwl displays 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 of articles they need to acknowledge.

Sample Required Articles list

Mixed access knowledge bases
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.

Change number of articles displayed

By default, the 5 most recently required articles will be displayed. You can change this to display between 1-10:

  1. Go to Customize > Website.
  2. Scroll to the Article list settings section.
  3. Use the Required reading dropdown to select the number of articles you'd like the list to display (1-10). If you don't see this dropdown, you haven't Set up Required Reading.
  4. Be sure to Save your changes.

Setup

Some assembly required
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 somewhere in your knowledge base: into either the Customize > Homepage custom content editor or into the Customize > Style > Custom HTML of the relevant layouts:

  • [translation("required-reading:required-reading-list-heading")]: This merge code grabs the Required Reading list heading in Customize > Default 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.

To add the list to your homepage:

Refer to the more detailed instructions below for each setup.

Add the Required Articles List to Customize > Style homepage

Newer knowledge bases have their entire homepage set in Customize > Style (HTML & CSS). If your knowledge base uses this layout, follow these instructions to add the Required Articles List there. (If your knowledge base doesn't show any article lists in Customize > Style (HTML & CSS) > Custom HTML > Homepage, skip these and follow the next set of instructions!)

  1. Go to Customize > Style (HTML & CSS).
  2. In the Customize HTML, CSS, and JS section, select Custom HTML.
  3. Select Homepage from the Select HTML section to edit dropdown.
  4. Near the bottom of the code editor, find the div class="homepage-widgets row", usually on or around row 9:
            <div class="homepage-widgets row">
                <div class="col-md-4 col-sm-6"><h3>[translation("article-lists:popular-articles")]</h3>[template("pop-articles")]</div>
                <div class="col-md-4 col-sm-6"><h3>[translation("article-lists:new-articles")]</h3>[template("new-articles")]</div>
                <div class="col-md-4 col-sm-6"><h3>[translation("article-lists:updated-articles")]</h3>[template("up-articles")]</div>
            </div>
  5. Create a new line where you'd like the Required reading list to go. Copy the code below and paste it onto that new line:
    <div class="col-md-4 col-sm-6"><h3>[translation("required-reading:required-reading-list-heading")]</h3>[template("required-articles")]</div>
  6. For example, your code would look like this if you added Required reading as the final list:
            <div class="homepage-widgets row">
                <div class="col-md-4 col-sm-6"><h3>[translation("article-lists:popular-articles")]</h3>[template("pop-articles")]</div>
                <div class="col-md-4 col-sm-6"><h3>[translation("article-lists:new-articles")]</h3>[template("new-articles")]</div>
                <div class="col-md-4 col-sm-6"><h3>[translation("article-lists:updated-articles")]</h3>[template("up-articles")]</div>
                <div class="col-md-4 col-sm-6"><h3>[translation("required-reading:required-reading-list-heading")]</h3>[template("required-articles")]</div>
            </div>
  7. This will add the Required Reading list on a separate row from the other three lists. If you'd like them all on one row, adjust all four divs to have col-md-3 instead of col-md-4.
  8. Be sure to Save your changes once you're done!

Add the Required Articles List to Customize > Homepage

If your article lists aren't in Customize > Style > Homepage:

  1. Go to Customize > Homepage.
  2. Copy one of the other homepage lists and paste it in again.
  3. Replace the title merge code with: 
    [translation("required-reading:required-reading-list-heading")]
  4. Replace the list merge code with:
    [template("required-articles")]
  5. Save.

Your homepage might now look like this:

The Homepage custom content editor. It displays the base-cats template followed by four sections: Popular Articles, New Articles, Updated Articles, and a section with the translation merge code title referenced above and the required articles template below it.Sample Homepage editor layout with Required Articles list adde