KnowledgeOwl Support
Table of Contents
Table of Contents
Toggle navigation
Release notes
Contact support
Home
Glossary
Write the docs
Categories
Add a category or sub-category
Choose a category type
Use default categories
Use topic display categories
Use blog style categories
Use shared content categories
Use custom content categories
Use URL redirect categories
Edit a category
Internal note
Internal category title
Hide a category from navigation
Customize category behavior in the table of contents
Restrict a category to certain readers
Delete a category and its content
Reorder categories or articles
Move categories or articles between levels
Why is a category not coming up in search?
Why is a category not displaying to readers?
Exclude a category and all its content from search results
Articles
Create from template
Share articles between categories and knowledge bases
Full and Short Titles
Internal note
Internal title
Publishing Status
Updated
Topic Articles
New, Updated, and Video Callouts
Restrictions
Versions
Related Articles section
Pages to Recommend On (Contextual Help)
Redirect old articles to a new permalink
Modern WYSIWYG Editor
Search phrases
Autosave
SCAYT Spell Check
Adding images and files to articles
Editing and updating files in articles
Working with links to other websites
Link to Article
Display Code
Reorder articles
Move articles between levels
Working with Anchors
Structure Template (Sample)
Sharing "draft" articles
What kind of article change history does KnowledgeOwl keep?
URL redirect article
Editor keyboard shortcuts
Files and images
Who can access the files and images in my knowledge base?
Find the URL to your File Library file
Adding images and files to articles
Adding files and images inside of articles
Adding files and images in bulk
Adding videos to your articles
Editing and updating files
File upload errors
Display PDF file in articles
Display Microsoft Office OneDrive files in articles
Display Microsoft Office file in articles
Custom image captions
Adjust image width for all images
Display images side-by-side
Managing images and files
Editing and updating files in the File Library
Find a file's URL
Using labels as filters
File Labels
What are file labels?
Create a file label
Edit a file label
Delete a file label
Add an existing label to a file
Remove a label from a file
Merge labels
What does merging labels do?
Using file labels as File Library filters
Tags
What are tags?
Create a tag
Edit a tag
Delete a tag
Add an existing tag to an article
Remove a tag from an article
Tags in searches
Hide tags from Search Results
Merge tags
What does merging tags do?
Snippets
What is a snippet?
Creating a snippet
Using snippets
Snippet Library
Snippet use cases
Snippet references
Shared & synced content
Shared content articles
Why aren't some of my shared content articles showing up in search?
How can I tell multiple shared child articles apart?
New
Import content
Import best practices
Import from Zendesk
Import from Freshdesk
Import using the API
Testing imports
Generate content
Using SurveyGizmo Surveys to Generate Content in KnowledgeOwl
Look and feel
Homepage look and feel
Homepage Overview
Change the background image on my homepage
Remove the homepage title
Change the color of the homepage title
Article Widgets
New Articles Widget
Updated Articles Widget
Popular Articles Widget
Recent Articles Widget
Create a custom home page articles widget
Add a custom banner using built-in div styles
Add a custom icon and header link on your homepage
Overall look and feel
Logos
Custom Colors
Themes
Layouts
Add a link to the upper right (top navigation)
Custom Fonts
Undo changes to Settings > Style
Configuring reCAPTCHA
Theme Builder
Favicons
Breadcrumbs
Click to zoom / enlarge images
Customize style or layout using HTML/CSS
Display a back to top icon when scrolling
Only Play GIFs While Hovering
Localizing your knowledge base to your timezone
Different Logos for Different Reader Groups
Access to the Header via Custom Head
Set your footer copyright to automatically update
Fix Anchor Links Hidden by Top Navigation
Using your own domain
Create a CNAME record on your DNS
Add a private domain
Set up your SSL cert
Add reCAPTCHA
SSL cert troubleshooting: CNAME record has not fully synced
SSL cert troubleshooting: CAA policy does not allow
Article look and feel
Article Table of Contents
Split up article content into tabs
Create expanding/collapsing sections in an article
Using H5 and H6 as Standard Formatting
Adjust Line Spacing
Format numbered list spacing and borders
Customize nested numbered list styles
Make the PDF icon prettier
Setup a JavaScript redirect
Fix Email Article for Articles with Apostrophes
Conditional content based on tags
Table of contents & organization
Display categories open by default
Add Home button to table of contents
Add search bar to table of contents
Add glossary link to table of contents
Add a link to the full PDF download to table of contents
Add contact us link to table of contents
Change the width when the table of contents collapses
Change the slideout Table of Contents' width (Minimalist Theme)
Hide the table of contents
Search look and feel
Change your search bar placeholder
Customize the search "No Results" message
Hide tags from Search Results
Style the glossary snippet search results
New
PDF look and feel
Add page numbers to PDFs
Display content only in PDFs
Snippet to force page breaks in PDFs
Prevent Page Breaks in PDF Table Rows
Display clickable links in PDFs
Default HTML
Default Home Page Article HTML
Default Home Page HTML
Default Body HTML
Default Top Navigation HTML
Default Article HTML
Default Login HTML
Default 404 Page HTML
Default Restricted Access Page HTML
Default Right Column HTML
Merge codes
Article
Homepage
Reader
Body
Other
Features
Related Articles
How it works
Where do Related Articles show up?
Adding Related Articles
Reordering or removing Related Articles
Enabling and disabling automatic suggestions for Related Articles
Backward suggest Related Articles
Hide Related Articles section from a specific article
Hide Related Articles when there are none
Hide Related Articles when there is only one or less
Contact Form
Contact form overview
Customize Contact Form Link
What data is collected in the Contact Form?
Create Tickets from Customers in your Help Desk or CRM
Create Zendesk Tickets
Create Freshdesk Tickets
Bypass contact form self-serve
Open the contact form with certain details filled in
Add template text to the start or end of the contact form's subject
Install Zendesk App
Manage articles
Manage Articles overview
Using standard Manage filters
Creating a custom Manage filter
Editing a custom Manage filter
Deleting a custom Manage filter
Export the Manage Articles list to CSV
Bulk editing articles in Manage
Bulk activating "ready for review" versions
Archiving articles in bulk in Manage
New
Deleting articles in bulk in Manage
How do bulk edits, archives, and deletes work?
Ratings
Ratings overview
Enable ratings
Add ratings to all articles
Add ratings to individual articles
Ratings reporting
Reset article ratings
Comments
Add Comments section to articles
Comment restrictions and permissions
Comment security
View comments pending approval
Commenter icons / images / avatars
Limit the max characters allowed in comments
Glossary
Overview
Glossary formatting
Populate the glossary
Add glossary terms to your search results
New
Style the glossary snippet search results
When should I use alternate titles?
View the glossary
Style the letters at the top of the glossary
Automatically highlight definitions in articles
Add glossary definitions in articles manually
When one glossary term contains another glossary term
Customize how glossary terms look
Keep glossary header visible when scrolling
Add search to the glossary page
Glossary FAQs
Subscriptions
Using subscriptions
How subscriptions work
Subscribing to a category
Unsubscribing from a category
Configuring subscriptions
Requirements for enabling subscriptions
Configure SMTP for subscriptions
Configure subscription notification schedule and email subject
Configure public subscriptions
Enable subscriptions
Add Subscribe button to topic and custom content categories
Style the Subscribe button differently
Force readers to subscribe using their reader account email address
Contextual Help Widget (2.0)
Widget 2.0 overview
Widget 2.0 display settings
Widget 2.0 installation
Customize widget tabs, headers, and text
Customize widget contact form
Widget authentication--when and how to use it
Widget 2.0 JWT authentication
Widget 2.0 Oauth2 authentication
Customize the widget look and feel
Using Widget 2.0 on Single Page Applications
Open widget to specific tab
Open widget to a specific article or category
Transition checklist: from Modern Widget to Widget 2.0
Advanced option: add the widget in your own div wrapper
New
Hide one of the Widget 2.0 tabs
Contextual Help Widget (Modern & Legacy)
How the widget works
Installation
Using the Widget for Contextual Help: Pages to Recommend On
Widget Authentication with Oauth2
Using the Widget on Single Page Applications
Modern Widget + Zendesk Contact Form
PDFs
PDF overview
Individual article PDFs
Standard PDF export (Full PDF Download)
Custom PDF exports
PDF Watermarks and Passwords
HTML Zip export
Overview
Creating an HTML Zip export
HTML export of categories with question marks in the title
SEO guide
Get started
Best practices
KnowledgeOwl SEO features
Promote your knowledge base
Make your knowledge base public
Generate your sitemap
Optimize your homepage
Custom title tags and meta descriptions
Public Sitemaps and SEO
Duplicate content
Hide from search engines
Measure SEO performance
Google Search Console
Search
Using search
Searching the knowledge base
Autosuggest search
Full text search
Exact match searches
Tag Searches
Configuring search
Pagination
Sorting
Glossary snippets
New
Article blurbs
Filter search by categories
Autosuggest
Exclude category
Linked articles
Index large PDFs
Search weights
Search testing
Primary search language
Synonyms
Tags versus search phrases
How search works
Search basics
Indexing
Stemming
Search relevance scoring
Search FAQs
Why is my category not showing up in search?
How do I add keywords to my article?
Search doesn't work for unhyphenated versions of hyphenated words.
Use Google Custom Search Engine in KnowledgeOwl
Can I exclude an entire category--and all its articles--from search?
Why is my article that's linked to another article not showing up in search?
Reporting
Reporting Dashboard
Your Knowledge Base at a Glance
Article Ratings Report
Popular Articles Report
Published Articles with 0 Views
Searches with no Results
Reset article views in the Popular Articles report
Contact form reporting
Contact form reporting
Widget reporting
Pages Searched using the Widget
Recommended Article Weights
Comments reporting
Overview
How do I know when there are comments pending approval?
Approving or deleting comments
Who can view, approve, and delete comments?
What happens when I delete a comment?
Google Analytics
Set Up Google Analytics
Set Up Google Analytics Site Search and Page-Specific Traffic
Security and permissions
General security options
Use secure links (SSL/HTTPS )
Create a public knowledge base
Create a public knowledge base with some private content
Create a private knowledge base
Create a private knowledge base with different content for different readers
Security Setting
Restrict Content to Logged In Readers
Requiring login to view files/images
User management
What is a user?
User permissions
Add a user
User login type
Updated
What is the difference between an editor and a writer?
Custom roles
Available custom role permissions
Updated
What are user teams?
Create user teams
Restrict content to user teams
Change the order of user teams
Edit users and permissions
Reset a user password
Can users share logins?
Deleting a user
What happens when I delete a user?
Reader management
What's the difference between a user and a reader?
Create a reader
Create readers in bulk
Can I show different content to different readers?
Reader Groups
How do reader groups work?
Create a reader group
Display conditional content based on reader logins
Test reader group access
Auto-assign groups by email rules
Checking if an article or category is restricted to reader groups
Reader signups
Using reader signups
Add custom fields to the reader signup form
Approve new reader signups
Auto-assign new readers to groups upon signup
Reader emails
Customize your reader welcome emails
Customize your reader password reset emails
Configure SMTP for reader emails
How custom SMTP from/reply impacts the email template from/reply to fields
Reader password security
What's the difference between admin managed and self-administered reader passwords?
Set up self-administered reader options
Allow Google log in for readers
Allow readers to log in using SSO
Single sign-on (SSO)
Single Sign-on (SSO) Overview
SSO FAQs
SSO instructions
Configure SAML SSO (generic instructions)
Configure SSO using Active Directory Federation Services (ADFS)
Configure SSO using Azure Active Directory (Azure AD)
Configure SSO using G Suite (formerly Google Apps)
Remote authentication
Salesforce SSO
SSO options for different knowledge base setups
Opening links to SSO knowledge bases from Microsoft Office
Account and billing
Adding and editing knowledge bases
Creating an additional knowledge base
Copy a knowledge base
Delete a knowledge base
Billing
Payment options
Discounts
Update credit card
View past receipts and invoices
Change billing email
Pause or suspend subscription
Cancel my account
Company and Product Info
Contact support
How do I stay up-to-date on KnowledgeOwl?
System requirements and supported browsers
Terms and conditions
Troubleshooting software issues
KnowledgeOwl status page
KnowledgeOwl W-9
Company website
How can I send product feedback?
Security, privacy, and compliance
Security and reliability
Cookie declaration
Data processing addendum (DPA)
HIPAA compliance
GDPR
Privacy policy
Uptime SLAs
List of Sub-processors
Plans, pricing, and trials
30-day free trial
Extend my trial
Pricing
Plans
Priority Support
Professional Services
Enterprise
API and webhooks
API
How to generate a new API key
API Overview
Articles Endpoint
List Articles
Get Article
Create an Article
Suggest articles (API)
Article Version Endpoint
Article Comment Endpoint
List Comments
Readers Endpoint
Reader Endpoint
List Readers
Reader Group Endpoint
List Reader Groups
Objects
Article
Article Version Object
Category
Comment
File
Reader
Reader Group
Tag
API calls in snippets
Update an existing API key
Examples
Create a Category
Get a List of Articles Based on a Word in the URL
Pull and update article HTML
Upload File to the Library
Update File in the Library
Delete an API key
Webhooks
Webhooks overview and creation
Available webhook events
Webhook API calls
Using Webhooks with Slack
Zapier
What is Zapier?
Zapier and KnowledgeOwl webhooks
Prerequisites
Quickstart
Tutorial
More use cases
Zapier and the KnowledgeOwl API
Prerequisites
Quickstart
Tutorial
More use cases
Getting started
Before you start
Set up your account
Create your knowledge base
Create categories
Create articles
Customize your branding
Set up who can access your site and how
Next steps
Integrate KnowledgeOwl into your Web Site or Application
CAPRA
An overview of the CAPRA self-assessment in KnowledgeOwl
CAPRA KnowledgeOwl orientation
The basics: app vs. knowledge base
The basics: editing standards
The basics: adding documents, files, and more
The basics: adding links to other websites or online resources
Managing multiple users making changes
Tracking your self-assessment progress
Tracking complete/incomplete standards
Alternative workflow: Draft rather than Needs Review
Using tags to track more detailed progress
Final review checklist
Moving your self-assessment report into the NRPA Portal
Customizing your self-assessment knowledge base
How do I give access to my CAPRA self-assessment?
Granting access to your self-assessment
Default setting - shared password
No login required (publicly available)
Individual reviewer accounts
Updating standards that have changed
How to create a new standard
Updating an existing standard
Release notes
Home
Subscribe
Security and permissions
Who can access your knowledge base? How do they access it? What can they see and do while they're there? Includes info on creating reader and user accounts, restricting access to specific content, and integrating with other authentication methods.
General security options
Learn what your options are for requiring login to view some or all content, segmenting content by group, and protecting files.
User management
Users are people who can log in to create and manage content in your knowledge base. Learn how to set up and manage users in KnowledgeOwl.
Reader management
Create and manage your readers, groups, and signup options.
Single sign-on (SSO)
Allow readers to easily and securely log in using an existing set of credentials.
Subscribe for Updates
Email Address: