Documentation - HeroThemes https://herothemes.com Happier Customers, Fewer Support Tickets. Sun, 19 Jul 2026 20:17:43 +0000 en-US hourly 1 Heroic KB Blocks – User Guide https://herothemes.com/kb/heroic-kb-blocks-user-guide/ https://herothemes.com/kb/heroic-kb-blocks-user-guide/#respond Wed, 11 Mar 2026 15:01:39 +0000 https://herothemes.com/?post_type=ht_kb&p=1745527 Heroic Knowledge Base includes custom blocks that let you build your help site directly in the WordPress editor: a search bar with live results, breadcrumb navigation, category grids...

The post Heroic KB Blocks – User Guide first appeared on HeroThemes.

]]>
Heroic Knowledge Base includes custom blocks that let you build your help site directly in the WordPress editor: a search bar with live results, breadcrumb navigation, category grids and lists, article lists (latest, popular, related), file attachments, helpfulness voting, and a sticky container for sidebars. You can mix and match these blocks on your KB homepage, category and article templates, and any page or post.

Where to find the blocks: In the block editor, click the + (Add block) button and search for the block name (e.g. “KB Search”, “KB Breadcrumbs”) or browse the Heroic KB category. Each block’s sidebar offers options for content, layout, and styling.

This guide describes each block, how to add it, its main settings, and where it works best. Use the table of contents (if your theme or plugin provides one) to jump to a specific block.

KB Search Block

Add a search box that searches the knowledge base as visitors type, with optional category filter and live suggestions. Place it prominently on the KB homepage and other KB pages.

Where to find the block

  1. In the block editor, click + (Add block).
  2. Search for KB Search Block or find it under Heroic KB.
  3. Insert the block (e.g. at the top of the KB homepage).

Quick start

  1. Add the KB Search block where visitors will see it first (e.g. top of KB homepage).
  2. Set Search Placeholder (e.g. “How can we help?”, “Search our guides…”).
  3. Optionally turn on Show Icon and set Show Category Filter for larger sites.
  4. Use block styling to match your theme (colors, border, typography).

Block settings

OptionDescription
Show IconMagnifying glass in the search bar
Icon Color / Icon BackgroundSearch icon appearance
Show Icon on ResultsDocument icon next to each result in the dropdown
Show Description on ResultsShow excerpt in the results dropdown
Show Category FilterDropdown to limit search to a category
Category PlaceholderText when no category selected (e.g. “All Categories”)
Search PlaceholderPlaceholder in the search input
Search Trigger LengthMin characters before search runs (default: 3)

Styling: block/sidebar options for background, text color, typography, border, padding.

Notes

  • Results update as the user types (no full-page reload).
  • Enable the category filter for large knowledge bases so users can narrow results.

KB Breadcrumbs

Show where the visitor is in the knowledge base with a clickable path: Home → Knowledge Base → Category → Current page. Helps with navigation and understanding hierarchy.

From the Site Editor

Breadcrumbs usually live in block templates or template parts, not on individual pages. That way they appear on every KB article and category archive with one place to edit.

  • Go to Appearance → Editor (Site Editor), then open Templates. To edit where breadcrumbs appear, look for these Heroic Knowledge Base templates (author: Heroic Knowledge Base):
    • KB Category Archive — Category archive page for displaying category articles.
    • KB Search Results — Search results page for KB articles.
    • KB Single Article — Single article template.
  • These templates can use a shared header that includes the KB Breadcrumbs block in a top bar, often alongside the search block. Edit the template or the header section to change where the breadcrumb appears, its layout, or to add it to another KB template.
  • To add or move the block: select the template you want (e.g. KB Category Archive or KB Single Article), then in the canvas click into the header area (or the group that contains the breadcrumb), click + (Add block), search for KB Breadcrumbs or Heroic KB, and insert the block. Place it at the top of the content area so it shows on all KB pages that use that template.

Where to find the block (editor)

  1. In the block editor (page/post or Site Editor template), click + (Add block).
  2. Search for KB Breadcrumbs or find it under Heroic KB.
  3. Insert the block at the top of the content area so it appears on every KB page that uses that template (or template part).

Quick start

  1. In the Site Editor, open the KB template or template part where you want breadcrumbs (e.g. category archive or its header).
  2. Add KB Breadcrumbs at the top of the main content or header.
  3. Set KB Archive Text to the label for your KB home (e.g. “Knowledge Base”, “Help Center”).
  4. Use Show Home Link to include or omit the site home in the trail.
  5. Use block styling to match colors, typography, and spacing.

What the trail shows

Home > Knowledge Base > Parent Category > Subcategory > Current Article
Each segment except the current page is a link. The current page is shown as text only.

Block settings

OptionDescriptionDefault
KB Archive TextLabel for the knowledge base archive (home) link“Knowledge Base”
Show Home LinkInclude the site home as the first linkOn

Styling: colors (links, hover), typography, background, border, spacing.

Notes

  • The current page is not linked. Breadcrumbs update automatically based on the current post or archive.
  • Works on articles, category archives, and the main KB archive. In block themes, editing the template or shared header in the Site Editor updates breadcrumbs for all KB pages that use it.

KB Category Card

Display knowledge base categories as a grid of cards with icons, descriptions, and article counts. Suited to the KB homepage or any page where you want a visual overview of topics.

Where to find the block

  1. In the block editor, click + (Add block).
  2. Search for KB Category Card or find it under Heroic KB.
  3. Insert the block; use the sidebar to set columns, what to show, and optional article lists.

Quick start

  1. Add the KB Category Card block (e.g. on the KB homepage).
  2. Set Columns (1–4); 2–3 works well for most layouts.
  3. Choose Card Type: icon on Top, Left, or Right.
  4. Turn on Show Category NameShow DescriptionShow IconShow Article Count as needed.
  5. Optionally enable Show Article List and set how many articles per card and “View all” link.

Block settings

Layout: Columns, Alignment, Card Type (Top/Left/Right).
What to display: Show Category Name, Show Description, Show Icon, Show Article Count, Count Position.
Article list (optional): Show Article List, Number of Articles, Show View All Link, Sort By, Sort Order.
Manage Categories: Reorder, hide categories, preview.

Notes

  • Article counts include articles in subcategories. Category icons are set in WordPress. Layout responds to smaller screens.

KB Category Simple

Show knowledge base categories as a plain list of links. Best for sidebars and tight spaces where you need compact navigation without icons or descriptions.

Where to find the block

  1. In the block editor, click + (Add block).
  2. Search for KB Category Simple or find it under Heroic KB.
  3. Insert the block. Use Manage Categories in the sidebar to reorder and show/hide categories.

Quick start

  1. Add KB Category Simple (e.g. in a sidebar).
  2. Click Manage Categories to drag-and-drop order and toggle visibility.
  3. Use block styling for text/link colors, font size, and spacing.
  4. Optionally wrap in a KB Sticky Container so the list stays visible while scrolling.

Block settings

Manage Categories: Reorder, show/hide categories, view full list.
Styling: Colors (text, links), typography, spacing, shadow.

Simple vs Category Card

SimpleCategory Card
LayoutText listCard grid
Icons / Descriptions / Article countNoYes
Best forSidebars, footersHomepage, landing

Notes

  • Default order is alphabetical until you set order in Manage Categories. Hidden categories stay in WordPress but do not appear on the front.

KB Articles List

Show a list of knowledge base articles by LatestPopularMost Liked, or Related (same category as the current article). The list updates automatically as content or analytics change.

Where to find the block

  1. In the block editor, click + (Add block).
  2. Search for KB Articles List or find it under Heroic KB.
  3. Insert the block and choose the article type and number of articles in the sidebar.

Quick start

  1. Add the KB Articles List block where you want the list (e.g. homepage, sidebar).
  2. In the sidebar set Article Type to Latest, Popular, Most Liked, or Related.
  3. Set Number of Articles (1–20); 5–10 is usually enough.
  4. Leave Show Icon on unless you want text-only titles.

Block settings

OptionDescriptionDefault
Show IconDocument icon next to each titleOn
Article TypeWhich articles to showLatest
Number of ArticlesHow many to show (1–20)5

Article types: Latest (most recent), Popular (most views; requires view tracking), Most Liked (highest helpfulness; requires feedback), Related (same category; only on single article pages).
Styling: text color, link color, typography in block/sidebar.

Where to use

  • Homepage – Latest or Popular. Article sidebar – Related. Footer / sidebar – Most Liked.

Common questions

Why is “Most Liked” empty? It only shows articles that have received helpfulness votes. Enable feedback and encourage voting.
Why does “Related” show nothing? Related only works on a single article page and uses the article’s category. Ensure the article has a category and that others exist in that category.
How does “Popular” work? It uses view counts. Enable view tracking in Heroic KB settings.

Notes

  • Lists update automatically. Related excludes the current article. Popular and Most Liked depend on analytics/feedback being enabled.

KB Attachment Block

Show downloadable files attached to the current knowledge base article. Use it for PDFs, documents, templates, and other resources linked from the article.

Where to find the block

  1. Edit a KB article or the article template.
  2. Click + (Add block) and search for KB Attachment or open Heroic KB.
  3. Insert the block where you want the attachments to appear (typically after the main content, before the feedback block).

Quick start

  1. Add the KB Attachment block to your article (or template).
  2. Set Heading in the sidebar (e.g. “Article attachments”, “Downloads”, “Resources”).
  3. Attach files to the article via the WordPress Media Library (upload and attach to the post).
  4. The block will list those files automatically; if none are attached, it shows nothing.

Block settings

OptionDescriptionDefault
HeadingTitle above the file list“Article attachments”

Styling: usual block/sidebar options.

How attachments are added

Edit the KB article → upload or select files in the Media Library and attach them to the article. The Attachment block displays all files attached to that article. No extra configuration needed.
Supported file types: Any type WordPress supports (e.g. PDF, Word, Excel, images, ZIP, MP3, MP4)

Notes

  • If no files are attached, the block does not output anything. Files are served from your WordPress media library. Consider storage and bandwidth for many large files.

KB Feedback Block

Let visitors rate an article as helpful (yes) or not helpful (no). Use the results to see which articles work well and which to improve. One block per article, usually at the end of the content.

Where to find the block

  1. Edit a KB article or the article template.
  2. Click + (Add block) and search for KB Feedback or open Heroic KB.
  3. Insert the block after the main content (and before or after attachments if you use them).

Quick start

  1. Add the KB Feedback block at the end of the article (or template).
  2. Leave Title as “Was this article helpful?” or change it (e.g. “Did this answer your question?”).
  3. Set Upvote Text and Downvote Text (e.g. “Yes” / “No”).
  4. Choose Icon Style: Thumbs or Check/Cross. Adjust default and hover colors if needed.

Block settings

OptionDescriptionDefault
TitleQuestion shown to the reader“Was this article helpful?”
Upvote Text / Downvote TextButton labels“Yes” / “No”
Icon StyleButton iconsThumbs (or Check/Cross)
Icon colorsDefault background, Upvote hover, Downvote hover

Styling: background, text, border, spacing.

Notes

  • Place the block after the main content so visitors can vote after reading. One feedback block per article is enough.
  • Visitors typically vote once per article. Feedback features must be enabled in the plugin for voting to work and for Popular/Most Liked lists to use this data.

KB Sticky Container

Keep a block (or group of blocks) visible at the top of the viewport while the rest of the page scrolls. Use it for sidebars: related articles, category list, table of contents, or quick links.

Where to find the block

  1. In the block editor, click + (Add block).
  2. Search for KB Sticky Container or find it under Heroic KB.
  3. Insert the block (usually in a sidebar column), then add the blocks you want to stick inside it (e.g. KB Articles List, KB Category Simple).

Quick start

  1. Create or edit a layout with a main content column and a sidebar (e.g. 70% / 30%).
  2. In the sidebar column, add KB Sticky Container.
  3. Inside the container, add blocks such as KB Articles List (Related) or KB Category Simple.
  4. Ensure Sticky is on in the block sidebar. When the page is long enough to scroll, the sidebar content will stick to the top.

Block settings

OptionDescriptionDefault
StickyEnable or disable sticky behaviorOn

How it works

When the visitor scrolls down, the content inside the Sticky Container stays at the top of the viewport (within the layout). Sticky only applies when there is enough page height to scroll. Works with any blocks inside the container.

Best uses

  • Related articles – Keep “Related articles” visible while reading a long article.
  • Category navigation – Category list stays in view.
  • Quick links / contact – Keep important links or contact info visible.

Notes

  • Use one sticky section per page. Keep the sticky content shorter than the viewport height when possible. Test on mobile.
  • Sticky only activates when there is enough content to scroll. Supported in modern browsers.

The post Heroic KB Blocks – User Guide first appeared on HeroThemes.

]]>
https://herothemes.com/kb/heroic-kb-blocks-user-guide/feed/ 0
KnowAll Quickstart Guide https://herothemes.com/kb/knowall-quickstart-guide/ https://herothemes.com/kb/knowall-quickstart-guide/#respond Mon, 03 Nov 2025 10:23:18 +0000 https://herothemes.com/?post_type=ht_kb&p=1742785 This is a guide on getting started with HeroThemes KnowAll 2.0 Knowledge Base theme for WordPress. Getting Started To use the KnowAll theme you must have WordPress already...

The post KnowAll Quickstart Guide first appeared on HeroThemes.

]]>
This is a guide on getting started with HeroThemes KnowAll 2.0 Knowledge Base theme for WordPress.

Getting Started

To use the KnowAll theme you must have WordPress already installed on your server. KnowAll is constantly updated for compatibility with the latest version of WordPress, so it’s recommended to use a current version to take advantage of newer features and functionality.

KnowAll 2.0 introduces Full Site Editing (FSE), giving you the choice between two template modes:

  • Full Site Editing (FSE) Mode – Edit everything visually in the Site Editor using blocks
  • Legacy Mode – Use the traditional Customizer and PHP templates

This guide will walk you through installation, setup, and customization of your knowledge base.

1. Theme Installation

Once you have completed your purchase, you can download the theme package installation zip file at the end of the checkout. You can re-download it at any time from your HeroThemes account or with the details sent in your purchase email.

When you have downloaded knowall-v2.x.zip, you can install the theme in two ways:

  • WordPress Upload (recommended): In the WordPress admin panel navigate to Appearance > Add New Themes > Upload. Go to browse and select the zipped theme folder. Press install now and the theme will be uploaded and installed.
  • FTP Upload: Using your FTP program upload the un-zipped theme folder into the /wp-content/themes/ folder of your WordPress installation.

Once the theme is uploaded, you need to activate it. Go to Appearance > Themes and activate your new theme.

2. Using KnowAll Welcome Setup

The KnowAll welcome screen appears on first activation and helps configure the theme, so you can get started quickly and easily.

If the welcome screen does not appear, you can access it anytime from Themes > KnowAll Welcome Setup.

At the end of the setup process, your site will look similar to the KnowAll demo, without the need to import any files.

2.1 Enter your KnowAll License Key

Enter your theme license key found in your purchase email, or from the License section in your HeroThemes account.

This activates automatic updates and support for your theme.

The Heroic Knowledge Base and Heroic Blocks plugins are packaged with the KnowAll theme and are required for the theme to work. Additionally, Heroic Knowledge Base Integrations will be available if you have a Pro license key and entered this in step 2.1.

2.2 Install Required Plugins

Plus and Pro licenses no longer require a separate plugin – this will be detected automatically and enabled during setup.

Required and optional plugins selected will be installed automatically when you click Continue on this screen.

2.3 Install Sample Content

On this screen you can choose what content from the KnowAll demo you want to recreate on your site. It is recommended you leave all options ticked. The content will then be created automatically and can be managed from the WordPress dashboard.

Sample content includes:

  • Sample articles
  • Article categories with images
  • Navigation menus
  • Homepage layout
  • Sample pages

Click Continue to install the sample content.

2.4 Complete Setup

That’s it! From the final screen you can then view your site and there are quick links to start adding/editing your own articles or customizing the site with your own logo and colors.

3. Choosing Your Template Mode

After completing the Welcome Setup, you need to decide which template mode to use for your knowledge base.

Use FSE Mode if:

  • You are starting a new knowledge base
  • You want complete visual control over your site
  • You prefer modern WordPress block editing

Use Legacy Mode if:

  • You are upgrading from KnowAll v1.x
  • You have existing custom code or child theme
  • You prefer the traditional Customizer interface

How to Switch Modes

  1. Go to Knowledge Base > Settings
  2. Click the Appearance tab
  3. Locate Template Engine
  4. Select your desired mode:
    • Full Site Editing (Block) – for FSE mode
    • Force Legacy Templates – for Legacy mode
  5. Click Save Changes
  6. Clear all caches (browser, WordPress, server)

Important: When switching between modes, your articles remain unchanged, but you’ll need to reconfigure your design settings (colors, fonts, layouts).

By default, new installations start in FSE mode. Existing sites upgrading from KnowAll v1.x will automatically use Legacy mode to maintain compatibility.

4. Using the Knowledge Base

Once you have installed and activated the required plugins, you can manage your knowledge base content.

Refer to the Heroic Knowledge Base documentation for in-depth guidance on the features and configuration of the knowledge base.

5. Enable Automatic Updates

Enable automatic updates for your theme:

  1. Go to Appearance > KnowAll Theme License
  2. Enter your license key from your purchase email
  3. Click Save
  4. Click Activate License

When a new version is available, it will show as “Update Available” from Appearance > Themes.


Getting Started with FSE Mode

Enable FSE Mode

If not already enabled, navigate to Knowledge Base > Settings > Appearance and locate the Template Engine section.

Select Full Site Editing (Block) and click Save Changes.

Clear your site cache if you are using a caching plugin.

Access the Site Editor

Once FSE mode is enabled, access the Site Editor:

  • Go to Appearance > Editor in the WordPress admin
  • Or click Edit Site in the top admin bar

The Site Editor will open with your homepage displayed.

Basic Setup

Logo: Click logo → Replace → Upload → Save

Colors: Styles → Colors → Click Primary color → Enter hex code → Save

Fonts: Styles → Typography → Choose fonts → Save

Menu: Navigation → Edit → Add/remove/reorder links → Save

Edit Templates

Homepage Template:

  1. Templates → Home
  2. Click heading to edit text
  3. Click search box to style
  4. Click category cards to adjust
  5. Save

Article Template:

  1. Templates → Single Knowledge Base Article
  2. Click any element to edit (title, content, sidebar, TOC, feedback)
  3. Use right sidebar to adjust colors, fonts, spacing
  4. Delete unwanted sections (select → Delete)
  5. Save

Header: Templates → Header → Edit logo, nav, colors → Save or Patterns

Footer: Templates → Footer → Edit copyright, links → Save or Patterns

Other Templates: Category, Page, 404 – edit the same way → Templates

Working with Blocks

Add: Click + button or type /

Move: Drag ⋮⋮ handle

Delete: Select → Delete

Heroic Blocks: Search “Heroic” for Category Cards, Article Showcase, Breadcrumbs, Feedback, TOC


Getting Started with Legacy Mode

Enable Legacy Mode

Go to Knowledge Base > Settings > Appearance > Template Engine.

Select Force Legacy Templates and click Save Changes.

Access Customizer

Go to Appearance > Customize.

The Customizer opens with settings on the left and live preview on the right.

Legacy Customizer Setting

You can customize various visual aspects of the theme using the WordPress Live Customizer. Go to Appearance > Customize. Take some time to look through the options and customize them for your site.

The main options for the theme can be found in the Theme panel, which is then divided into various sections:

  • Header
    • Site Logo
    • Background – Solid Color, Image, Gradient
  • Footer
    • Copyright/Footer message
  • Styling
    • Link Color
    • Link Hover Color
    • Site Width
    • Theme Layout – Boxed or Full-Width
    • Background
  • Typography
    • Headings font
    • Body font
  • Homepage
    • Search Title
    • Homepage Sidebar Position
    • Homepage Title
    • Archive Style (Choice of six)
    • Border Divider
    • Archive Columns
  • Category Settings
    • Category Sidebar Position
  • Article Settings
    • Article Sidebar Position
    • Sticky Sidebar
    • Show Related Articles
    • Show Last Modified
  • Custom CSS

Basic Setup

Logo: Site Identity → Select Logo → Upload → Publish

Header Background: Theme → Header → Choose color/image/gradient → Publish

Colors: Theme → Styling → Link Color and Link Hover Color → Publish

Fonts: Theme → Typography → Select Headings Font and Body Font → Publish

Menu: Appearance > Menus → Create menu → Add items → Assign to Site Header → Save

Configure Layout

Homepage:

  • Theme → Homepage
  • Set Search Title, Homepage Title, Archive Style, Archive Columns
  • Publish

Articles:

  • Theme → Article Settings
  • Set Sidebar Position, Sticky Sidebar, Related Articles, Last Modified
  • Publish

Categories:

  • Theme → Category Settings
  • Set Sidebar Position
  • Publish

Footer:

  • Theme → Footer
  • Edit Copyright/Footer Message
  • Publish

Configure Widgets

Go to Appearance > Widgets.

Drag widgets into:

  • Sidebar — Article (shows on article pages)
  • Sidebar — Category (shows on category pages)
  • Sidebar — Home (shows on homepage)

Configure each widget → Save

Add Custom CSS (Optional)

Customizer → Theme → Custom CSS → Add code → Publish


Switching Between Modes

You can switch between Full Site Editing (FSE) and Legacy template modes at any time.

Before You Switch

Take these precautions:

  1. Backup your site – Create a full backup of files and database
  2. Document settings – Screenshot your colors, fonts, and layout settings
  3. Note customizations – Take a record of any custom CSS you’ve added
  4. Test on staging – Try switching on a test site first (if available)

After You Switch

Complete these steps in the new mode:

  1. Reconfigure colors – Set your brand colors again
  2. Upload logo – Add your logo in the new editor
  3. Set typography – Choose your fonts again
  4. Configure header/footer – Update navigation and footer text
  5. Test templates – Check homepage, articles, categories
  6. Verify mobile – Test on different screen sizes
  7. Clear caches – Clear browser and site cache
  8. Test functionality – Verify search, navigation, links work

Remember: Your articles, pages, categories, and content remain unchanged. Only design settings need reconfiguration.

The post KnowAll Quickstart Guide first appeared on HeroThemes.

]]>
https://herothemes.com/kb/knowall-quickstart-guide/feed/ 0
Heroic AI Help Assistant https://herothemes.com/kb/installing-heroic-ai-assistant/ https://herothemes.com/kb/installing-heroic-ai-assistant/#respond Mon, 11 Dec 2023 13:29:20 +0000 https://herothemes.com/?post_type=ht_kb&p=1135167 Note: This documentation is awaiting an update. New versions of Heroic KB and KnowAll no longer require a separate OpenAI or Pinecone API key. Heroic KB now includes...

The post Heroic AI Help Assistant first appeared on HeroThemes.

]]>
Note: This documentation is awaiting an update. New versions of Heroic KB and KnowAll no longer require a separate OpenAI or Pinecone API key.

Heroic KB now includes the ability to add an AI-enhanced help assistant to your Heroic Knowledge Base, leveraging your documentation and ChatGPT models. Users can receive knowledgeable answers from the AI trained on your own knowledge base articles.

To activate it, you need OpenAI and Pinecone API keys for language processing and custom model storage, respectively.

Heroic AI help assistant

How to setup Heroic AI Help Assistant

  1. Ensure the latest Heroic KB is installed and active on your site with the Help Assistant enabled.
  2. Add a OpenAI API Key
  3. Add a Pinecone API Key
  4. Train AI Assistant on your Knowledge Base

Enabling the Help Assistant

You can find instructions on setting up the Heroic KB and standard Help Assistant here.

Enable the Help Assistant from Heroic KB > Settings > Help Assistant > Enabled Help Assistant, Show Help Assistant on this Site and AI Help Assistant.

Heroic Help Assistant settings

Install and Configure the Heroic AI Help Assistant

You can download an install the required plugin from Your HeroThemes Account.

Install from Plugins > Add New Plugin > Upload Plugin

Once installed and activated, new settings will be available from Settings > AI Help Assistant (note that this is in the WordPress setting menu NOT the Heroic KB settings)

Help Assistant AI settings

How to get your OpenAI API Key

You’ll need a paid OpenAI account to generate a OpenAI API key.

Login to the OpenAI API Platform and follow the steps below:

OpenAI API Key
OpenAI creating new API Key
OpenAI creating new API Key 2
OpenAI creating new API Key 3
Copy created API key

How to get your Pinecone API Key

You’ll need a free or paid Pinecone account with API access (be aware free accounts have limitations such as a single index and region)

Login to the Pinecone console and follow the steps below:

To generate a Pinecone API Key:

Create Pinecone API Key
Pinecone API Key 1
Pinecone API Key 2

Copy the key value to the Heroic AI Help Assistant settings.

Heroic AI Help Assistant currently only supports pods. Support for Pinecone’s serverless and new API will be added in an upcoming release.

For free Pinecone accounts, use as gcp-starter as the Pinecone Environment / Region. The gcp-starter supports a single index.

For paid Pinecone accounts you can use any GCP Region supported by Pinecone – for example eu-west4-gcp, us-central1-gcp, us-east4-gcp and so on.

Enter these settings in the Heroic AI Assistant settings panel and click the Create Pinecone Index button to automatically create the new Pinecone index. (Remember – only one index can be created at a time for free accounts). You can use the Delete Pinecone Index button to delete any existing Heroic KB AI Help Assistant index associated with the current site. The index name is displayed in the settings for information only, it cannot be changed in settings.

Created Pinecone Index

Train your AI Help Assistant

Once the OpenAI and Pinecone API keys have been saved and the Pinecone index created, your AI assistant is ready to be trained on your knowledge base.

For the best results, ensure your Knowledge Base is well populated with high quality content, relevant to the audience you wish to target.

Train your AI Help Assistant

The AI will now be trained, this can take several minutes depending on the size of your knowledge base and training data. In the meantime, do not exit the page. Progress will be displayed in the Training panel.

Your AI Help Assistant is Ready

Once done, the help assistant will use the AI models automatically, you can test this in the Test your AI Assistant panel.

Visitors will see a prompt to ask a question and will be given a relevant response based on your trained AI Help Assistant.

They will automatically be displayed a prompt directing them to a support contact link, set from Heroic KB > Settings > Transfers.

The post Heroic AI Help Assistant first appeared on HeroThemes.

]]>
https://herothemes.com/kb/installing-heroic-ai-assistant/feed/ 0
HeroThemes Formatting Blocks Documentation https://herothemes.com/kb/heroic-blocks-documentation/ https://herothemes.com/kb/heroic-blocks-documentation/#respond Mon, 15 Apr 2019 13:18:41 +0000 https://herothemes.com/?post_type=ht_kb&p=42017 The Heroic Blocks plugin allows you to add interactive content to your articles from the new WordPress editor. These blocks represent an improvement over the old shortcodes, that...

The post HeroThemes Formatting Blocks Documentation first appeared on HeroThemes.

]]>
The Heroic Blocks plugin allows you to add interactive content to your articles from the new WordPress editor.

The Heroic Blocks are exclusive to the Heroic Knowledge Base plugin / KnowAll WordPress Knowledge Base theme. It is not included with, or used by, any other plugin or theme.

These blocks represent an improvement over the old shortcodes, that required special code be inserted into content. It’s now possible to see in real time how content will look to the reader as it is being edited.

It is recommended to use the Heroic Blocks for small amounts of content you wish to differentiate from the rest of an article.

There are four blocks currently available in Heroic Blocks – Tabs, Messages, Toggle & Accordion.

Getting Started

Heroic Blocks requires the plugin is active before they will be available in the editor. It also requires WordPress version 5 or greater.

The Heroic Blocks plugin will usually be installed and activated automatically during the theme setup of a compatible HeroThemes product. If you need to activate the plugin manually, this can be done from the WordPress dashboard in Plugins > Installed Plugins.

Once activated, the included blocks will be available in the Heroic Blocks group in the post editor screen.

These blocks can be added to new or existing content.

Currently the Heroic Blocks can display light formatting and links, they can not include other blocks or rich content such as images. Please bear this in mind as you plan your articles.

Heroic WordPress blocks

Messages Block

Useful for displaying messages and callouts, the messages block includes four inbuilt styles – Success (default), Alert, Danger and Information. The message colour and icon changes based on the style selected.

In the inspector panel, it’s possible to select the style in the Style section, the Options section is where you can toggle the icon display.

Messages Block

Messages Block styles

Toggle Block

The toggle block expands and contracts when the heading is clicked. It is useful for hiding/showing additional information.

Toggle Block

Tabs Block

The tabs block splits content into separate sections, useful for displaying information variations of peers in the same category – for example different instructions based on operating system.

Only one tab content is displayed at a time, based on the active tab selected.

Tabs Block

Accordion Block

The accordion block is similar to the toggle block in that it can be used to group related content and only one accordion content section is displayed at a time. It’s linear and stacked, so is more useful in displaying step-by-step and sequential information.

Accordion Block

Accordion Block style

The post HeroThemes Formatting Blocks Documentation first appeared on HeroThemes.

]]>
https://herothemes.com/kb/heroic-blocks-documentation/feed/ 0
KnowAll Theme Documentation (Legacy) https://herothemes.com/kb/knowall-theme-documentation/ https://herothemes.com/kb/knowall-theme-documentation/#respond Mon, 05 Feb 2018 11:01:05 +0000 http://herothemes.com/?post_type=ht_kb&p=3357 Installation Video Getting Started To install the KnowAll theme you must have WordPress already installed on your server. Please consult the WordPress installation guide or your web host...

The post KnowAll Theme Documentation (Legacy) first appeared on HeroThemes.

]]>
This is legacy documentation see the updated KnowAll Quickstart Documentation for KnowAll 2.0 installation guidance.

Installation Video

Getting Started

To install the KnowAll theme you must have WordPress already installed on your server. Please consult the WordPress installation guide or your web host provider for help with this.

KnowAll is constantly updated for compatibly with the latest version of WordPress, so it’s recommended to use a current version to take advantage of newer features and functionality.

Need help choosing a website host for your new site? See our Recommended WordPress Web Hosting providers

1. Theme Installation

Once you have completed your purchase, you can download the theme package installation zip file at the end of the checkout. You can re-download it at any time from your HeroThemes account or with the details sent in your purchase email.

Download KnowAll theme package from your HeroThemes account
Download KnowAll theme package from your HeroThemes account

When you have downloaded KnowAll.zip, you can install the theme in two ways:

  • WordPress Upload (recommended): In the WordPress admin panel navigate to Appearance > Add New Themes > Upload. Go to browse and select the zipped theme folder. Press install now and the theme will be uploaded and installed.
  • FTP Upload: Using your FTP program upload the un-zipped theme folder into the /wp-content/themes/ folder of your WordPress installation.

Once the theme is uploaded, you need to activate it. Go to Appearance > Themes and activate your new theme.

knowall theme file upload
Activate KnowAll theme

2. Using KnowAll Welcome Setup

The KnowAll welcome screen appears on first activation and helps configure the theme, so you can get started quickly and easily.

At the end of the setup process, your site will look similar to the KnowAll demo, without the need to import any files.

2.1 Enter your KnowAll License Key

Enter your theme license key found in your purchase email, or from the License section in your HeroThemes account.

Activate KnowAll with your theme license key
Activate KnowAll with your theme license key

2.2 Install Required Plugins

Heroic KB – Plus and Pro customers – ensure you download and install the Heroic KB – Plus / Pro Addons plugin from the Downloads tab of Your HeroThemes Account to ensure you are prompted to install required plugins.

The Heroic Knowledge Base and Heroic Blocks plugins are packaged with the KnowAll theme and are required for the theme to work. Additionally, Heroic Knowledge Base Integrations will be available if you have a Pro license key and entered this in step 2.1 of this guide. These will be installed automatically when you click Continue on this screen.

Required plugin installation

2.3 Install Sample Content

On this screen you can choose what content from the KnowAll demo you want to recreate on your site. It is recommended you leave all options ticked, the content will then be created automatically and can be managed from the WordPress dashboard.

Sample content installation
Install KnowAll sample content

2.4 Complete Setup

That’s it, from the final screen you can then view your site and there are quick links to start adding/editing your own articles or customizing the site with your own logo and colors.

KnowAll setup complete
KnowAll setup complete

3. Using the Knowledge Base

Once your have installed and activated the plugins you will them be able to setup your knowledge base.

You can add content now, either by using the demo installer from the Welcome screen or start creating your own content.

Refer to the Heroic Knowledge Base documentation for more in depth guidance on the features and configuration of the knowledge base.

Note that KnowAll overrides some of the settings from the knowledge base, these will be hidden where appropriate, or available as an option in the Customizer (see below).

If the welcome screen does not appear you can access it anytime from the welcome screen at Themes > KnowAll Welcome Setup.

Knowledge base created with KnowAll

3.1 Add Category Images

With the sample content installed, your homepage will be populated. Add articles to populate your knowledge base, for best results categorise the articles with Article Categories.

KnowAll supports category images. To add an image to an article category select Knowledge Base > Article Categories and Edit the category you wish to add image. From the Edit Article Category screen, you can add or edit category images.

edit knowledge base category

4. Using the Heroic Blocks Plugin

Blocks can be added from the edit screen. Simply add the block you want to use with the + button. KnowAll includes four block for styling articles Messages, Toggle, Tabs and Accordion. You can filter to show only the Heroic Blocks by searching in the blocks menu.

Heroic Knowledge base blocks

5. Homepage Settings

If you install the demo content and recommended settings, KnowAll will act as a dedicated knowledge base theme. This means the posts menu will be disabled and the front page of your site will show the knowledge base archive.

You can enable blog and static front pages from Appearance > Customize > Homepage Settings > KnowAll Blog Support from where you can then also set the front page and blog pages if required.

KnowAll home page configuration.
KnowAll home page configuration.

6. Configure the Navigation Menu

To setup your custom navigation menus, goto Appearance > Menus or from the live Customizer Menus panel. Give your menu a name and build it up using the available items on the left. You can add a variety of menu items including pages, categories and custom links. To see all available menu items, you may need to click the screen options tab at the very top of the screen and configure your options.

Once you have built and saved your menu, simply select the theme location(s), in KnowAll there are two available – site header and site footer.

KnowAll custom menu configuration
KnowAll custom menu configuration

7. Configure the Widgets

This theme features three Widgetized areas, which allow you to drag ‘n’ drop WordPress widgets which can be accessed from Appearance > Widgets.

The widgetized areas include: Sidebar — Article, Sidebar — Category and Sidebar — Home. To use a widget in one of these areas, drag it from the Available Widgets panel on the left into one of the boxed areas on the right.

Individual widget options can then be set, as shown in the screenshot below, including the title of the widget and what content appears.

KnowAll widget setup

8. Using your New KnowAll Theme

With the initial setup done, you can add/edit content. Change colors and layout (see the customizer options in the section below), and craft your help center.

knowall ready

Customizer Setting

You can customize various visual aspects of the theme using the WordPress Live Customizer. Go to Appearance > Customize. Take some time to look through the options and customize them for your site.

The main options for the theme can be found in the Theme panel, which is then divided into various sections:

  • Header
    • Site Logo
    • Background – Solid Color, Image, Gradient
  • Footer
    • Copyright/Footer message
  • Styling
    • Link Color
    • Link Hover Color
    • Site Width
    • Theme Layout – Boxed or Full-Width
    • Background
  • Typography
    • Headings font
    • Body font
  • Homepage
    • Search Title
    • Homepage Sidebar Position
    • Homepage Title
    • Archive Style (Choice of six)
    • Border Divider
    • Archive Columns
  • Category Settings
    • Category Sidebar Position
  • Article Settings
    • Article Sidebar Position
    • Sticky Sidebar
    • Show Related Articles
    • Show Last Modified
  • Custom CSS

Enabling Automatic Updates and Support

Enable automatic updates for your theme from Appearance > KnowAll Theme License and enter the code from your download receipt (also available in Your HeroThemes Account page). Click Save and then Activate License to activate automatic updates and support.

When a new version is available it will show as Update Available from the Appearance > Themes view.

Enable automatic updates and support by entering your theme license code
Enable automatic updates and support by activating your theme

F.A.Q and Support

Nothing found on search pages?

If there are no results in the live search, try adding documents that match the key words. Key words match to the title and text of article using the WordPress search engine. The latest version of KnowAll also allows searching of article categories and tags.

If there are results in the live search, but none on the results pages, reactivate the theme by switching to a default theme (twentysixteen or twentyfifteen) and then back to KnowAll.

I get a “Heroic Knowledge Base and Heroic Blocks need to be installed and activated” on my site?

You simply need install the required plugins as described in the Install Required Plugins heading above, or from Themes > Install Plugins.

I still need help?

No problem, the HeroThemes support center is the place to find help.

The post KnowAll Theme Documentation (Legacy) first appeared on HeroThemes.

]]>
https://herothemes.com/kb/knowall-theme-documentation/feed/ 0
Heroic FAQs Plugin Documentation https://herothemes.com/kb/heroic-faqs-plugin-documentation/ https://herothemes.com/kb/heroic-faqs-plugin-documentation/#respond Fri, 25 Aug 2017 10:04:06 +0000 https://herothemes.com/?post_type=ht_kb&p=17681 The Heroic Frequently Asked Questions (FAQs) plugin adds an easy-to-manage FAQ style section to your content. Installation To install Heroic FAQs you will require a self-hosted WordPress version...

The post Heroic FAQs Plugin Documentation first appeared on HeroThemes.

]]>
The Heroic Frequently Asked Questions (FAQs) plugin adds an easy-to-manage FAQ style section to your content.

Installation

To install Heroic FAQs you will require a self-hosted WordPress version 4.4 or higher installation. You can install the plugin in a number of ways:

  • From Zip File: In the WordPress admin panel navigate to Plugins > Add New, select the ‘Upload’ and browse to the zipped plugin file, and hit install now.
  • FTP Upload: Using your FTP program upload the un-zipped plugin folder into the /wp-content/plugins/ folder of your WordPress installation.

Once the plugin has been installed, you need to activate it. Go to Plugins > Installed Plugins and activate the Heroic FAQs.

Installing Heroic FAQ plugin

Activating Heroic FAQs

When you first activate the plugin, you will be taken automatically to the FAQ Builder. If required, you will be prompted to enter your license key to enable automatic updates and support for the current site. It is possible to skip this step, but you will be reminded that no license key has been entered.

Activating Heroic FAQs

Creating FAQs

The FAQs are organized into groups. FAQ Groups can contain one or more FAQ items. The whole group is then placed in your website content.

FAQs groups and items are created and managed in the FAQ Builder, which can be reached from the FAQs menu in the admin or using New > FAQ in the Toolbar.

Creating FAQs 1
Creating FAQs 2

1. Create an FAQ Group

To get started, click on Add FAQ Group. Enter a name for the group and click save. This name is used primarily to help organize related FAQs and can also be displayed on your site.

Create an FAQ Group

2. Add FAQ items to a Group

Once you have created an FAQ Group, you can add individual FAQ items to the group.

Click on the Add New FAQ button within the FAQ Group you wish to add an FAQ item.

Add FAQ items to a Group

A new FAQ will be added to the group and you can edit the Question text. Next, enter the answer. The answer area is a WYSIWIG editor, so it’s possible to add rich text and a multi-line response.

Add FAQ items to a Group settings

3. Adding FAQs Blocks to Content

After the FAQs have been populated, they can be displayed in any post or page content using an FAQ Block in the WordPress 5 editor (it’s also possible to add FAQs using shortcodes, see the section below).

To insert an FAQ, while editing content, select the + icon at the top of the editor window, select the Heroic FAQ Block (under Common Blocks) to add it to your content.

Adding FAQs Blocks to Content

With the Heroic FAQ Block selected you can choose your FAQ Group from the Block detail screen on the right.

You can also select various pre-defined styles and further customize the FAQ display with behavior, icon select, style and color options. These are:-

  • FAQ Select
    • FAQ Group. The FAQ Group to be displayed.
    • FAQ Style. The primary style to be applied, which can be overriden with the Customize FAQ options.
  • Customize FAQ
    • FAQ Behavior. Either toggle or accordion
    • Display Group Name. Display the group name above FAQ items list. Either None, H3 or Bold.
    • Icon Position. Off, Left or Right interaction icon.
    • Extras. Only for toggle behavior. Either none or all expanded.
    • Icon Size. A slider to control the icon size.
    • Icon Select. Choose between one of fifteen icons.
    • Default Expanded Item. Only for accordion behavior. Select the default expanded item, or collapsed.
    • Expanded Question Color.
    • Collapse Icon Color.
    • Expand Icon Color.
  • Advanced
    • Additional CSS Class. Custom CSS class(es) for styling with CSS.

When you change an option, the preview is updated, so you can experiment with display options before publishing or updating your content.

Because FAQ Groups can be used in multiple locations on your site, the editing of the actual FAQ Groups and items needs to be done in the FAQ builder.

FAQs Blocks options

Managing FAQs

For FAQ groups it’s possible to rename and delete the group after confirmation from the dropdown on the right of the group. Note that deleting the group will also delete all the FAQs contained in that group as FAQ items cannot exist outside an FAQ Group.

By default and when the FAQ builder loads, FAQ items will be collapsed. You can expand an FAQ by clicking on the question text. Clicking the pencil icon will load the WYSIWIG editor. Clicking the X icon will delete the item after confirmation.

FAQ items can be used to display rich content such as text, images and videos. They cannot be used for nested content, such as other shortcodes, tables etc.

Managing FAQs

The toggle switch on the FAQ Group and FAQ items can be used to stop individual FAQs or whole FAQ groups from appearing on your site. This is useful if you want to hide FAQ responses without deleting them.

Managing FAQs 2
Note: The WordPress API, 3rd party plugins and the FAQ Blocks still show hidden FAQ content, so it is not advised to rely on disabling FAQ items for security.

FAQ items within the group can be reordered by clicking on the three dots to the left of the question and dragging it to a new position in the list.

Drag and drop FAQs

Default Expanded Item

For accordion FAQ behavior, in addition to being able to specify a default expanded item in the block inspector controls, it’s possible to use a hash anchor in a url. eg https://example.com/faq-page/#group-name-item-title. This would open the item of group name and scroll to it. This only works on the first load of a page.

To get the the ID of an item in a group, right click and inspect the item, the ID is contained in the id attribute of the hfaq__question.

getting id ID of an item in a group

Classic Editor and Shortcodes

FAQs can also be added to content using the Add FAQ button above the WordPress classic editor. The shortcodes can also be used in classic blocks in the WP5 editor.

Adding FAQ with shortcode
Adding FAQ with Classic Editor

The FAQ select dialog will appear, allowing you to select an FAQ Group and how it will be presented in the FAQ Select tab.

FAQ customization options

In the dialog’s Customize tab, it is possible to set:

  • FAQ Behavior – Accordion or Toggle
  • Icon Position – Off, Left or Right
  • Icon Size – Between 16px and 24px
  • Icon – A choice of various icons
  • FAQ Question Color – Set the color of the question
  • FAQ Icon Color – Closed and expanded

Note that the name and number of FAQ items in the group may change but the shortcode will be unaffected.

Click preview or save the content to see how the new FAQ looks.

FAQ font view

Heroic FAQs Shortcode Reference

It is possible to manually alter the Heroic FAQs after use by altering the parameters.

Shortcode tag

ht_faq_group

Parameters

id The ID of the FAQ group to render (default ‘0’)
hfaq_style The primary style to render (default ‘1’)
hfaq_nametag The tag to wrap the name (default ‘none’, do not output the group name)
hfaq_type The interaction type (default ‘accordion’)
hfaq_icon_pos Icon position relative to the question text (default ‘left’)
hfaq_icon The Icon (default ‘1’)
hfaq_icon_size Icon size in pixels (default ’24’)
hfaq_question_opencolor The color of the question (default ‘#333’)
hfaq_icon_opencolor The icon color when the FAQ is open (default ‘#000’)
hfaq_icon_closecolor The icon color when the FAQ is closed (default ‘#ccc’)
hfaq_default_expanded_item The default expanded icon (default ‘1’, only applies to accordion behavior), set to -1 to collapse group

Troubleshooting

FAQ Builder Page does not load

If the FAQ builder / wizard page does not load, there may be an issue with your browser or site configuration that is preventing the Heroic FAQ builder from loading correctly. Simply follow the troubleshooting steps here will resolve most common issues.

Only X number of FAQ items are displayed

Some themes override the default ‘number of posts’ displayed in the FAQs, this can usually be adjusted with a setting. Refer to your theme’s documentation for additional guidance. In some themes this defaults to the number of posts from Settings > Reading > Blog pages show at most.

Compatibility with Page Builders

The new WordPress 5 editor is fully supported, with the Heroic FAQs block, discussed above. FAQs can also be used in the the legacy/classic editor with the shortcodes. Third party page builders are not supported, or may need to use either the shortcode or block, please see our notes on page builder compatibility and refer to the plugin author for further assistance.

The post Heroic FAQs Plugin Documentation first appeared on HeroThemes.

]]>
https://herothemes.com/kb/heroic-faqs-plugin-documentation/feed/ 0
Heroic Knowledge Base Analytics Documentation https://herothemes.com/kb/heroic-knowledge-base-analytics-documentation/ https://herothemes.com/kb/heroic-knowledge-base-analytics-documentation/#respond Fri, 11 Dec 2015 17:42:07 +0000 http://herothemes.com/?post_type=ht_kb&p=2165 The Analytics Dashboard gives you a clear view of how your knowledge base is performing. It includes five main tabs: Dashboard, Feedback, Search, Transfers, and Conversations. Each tab...

The post Heroic Knowledge Base Analytics Documentation first appeared on HeroThemes.

]]>
The Analytics Dashboard gives you a clear view of how your knowledge base is performing. It includes five main tabs: Dashboard, Feedback, Search, Transfers, and Conversations. Each tab provides different insights with charts, tables, and filters.

The dashboard has been updated with a modern, desktop-optimized design. Metrics are shown in bold, color-coded cards for quick scanning. Charts are interactive, with hover details and daily/monthly toggle options. Tables now support advanced filtering, sorting, and server-side pagination for smoother handling of large datasets. Tooltips explain every metric, and the design uses a clear, consistent style across all tabs, making navigation simple for administrators working in WordPress.


Time Filters

You can view data for all time, last 90 days, last 30 days, last 7 days, or choose a custom range with the calendar picker.

Applying time filters to the analytics

Dashboard

The Dashboard shows the big picture with four main metrics: feedback, searches, transfers, and conversations. Each metric is displayed in a colorful card with icons, tooltips for explanations, and a clean layout that makes it easy to scan quickly.

The analytics dashboard

Feedback

The Feedback tab focuses on how users rate your content. It shows the total number of responses, the split between positive and negative feedback, and a progress bar for quick comparison. A detailed table lists feedback entries with filters for thumbs up, thumbs down, or written comments.

The analytics feedback tab

Search

The Search tab reveals how people look for answers. It tracks total searches, failed searches with no results, overall search effectiveness, and popular search terms. An interactive chart shows search activity over time, while tables highlight failed and popular searches.

The analytics search tab view 1-2
The analytics search tab view 2-2

Transfers

The Transfers tab measures when users move from the knowledge base to your help desk. It shows total transfers, transfer rate, and breakdowns by category or individual articles. Tables make it easy to see which areas are causing escalations.

The analytics transfers tab

Conversations

The Conversations tab monitors AI chat interactions. It records total chats, resolved conversations, unresolved sessions, and abandoned ones. You can also open transcripts to review what users asked.

The analytics conversations tab
The analytics conversation details card

Tips

  • Review failed searches to spot missing content.
  • Monitor transfer rates to identify weak areas.
  • Track feedback ratios to measure article quality.
  • Check abandoned conversations to improve AI responses.

The post Heroic Knowledge Base Analytics Documentation first appeared on HeroThemes.

]]>
https://herothemes.com/kb/heroic-knowledge-base-analytics-documentation/feed/ 0
Heroic Knowledge Base Plugin Documentation https://herothemes.com/kb/heroic-knowledge-base-plugin-documentation/ https://herothemes.com/kb/heroic-knowledge-base-plugin-documentation/#respond Thu, 28 May 2015 14:46:35 +0000 http://herothemes.com/?post_type=ht_kb&p=648 This guide walks you through how to set up and configure the Knowledge Base plugin. Installation To install Heroic Knowledge Base you will require a self-hosted WordPress version 5.8...

The post Heroic Knowledge Base Plugin Documentation first appeared on HeroThemes.

]]>
This guide walks you through how to set up and configure the Knowledge Base plugin.

Installation

To install Heroic Knowledge Base you will require a self-hosted WordPress version 5.8 or higher installation. You can install the plugin in a number of ways:

  • From Zip File: In the WordPress admin panel navigate to Plugins > Add New, select the ‘Upload’ and browse to the zipped plugin file, and hit install now.
  • FTP Upload: Using your FTP program upload the un-zipped plugin folder into the /wp-content/plugins/ folder of your WordPress installation.

Once the plugin has been installed, you need to activate it. Click Activate or goto Plugins > Installed Plugins and activate the Heroic Knowledge Base.

Activating Heroic Knowledge Base Plugin

Setup Assistant

Upon plugin activation, you will automatically be sent to the Heroic Knowledge Base setup assistant screen, which guides you through the activation and setup process.

Activate Support & Updates

Enter your license key (found in the Licenses tab of Your HeroThemes Account or purchase email) to activate support, updates and smart features including email reports and help assistant.

Heroic Knowledge Base setup assistant step 1

In the next step, you will see a message confirming the site has been successfully activated. If you are unable to activate the site, you can continue with setup but support, automatic updates and smart features may not work correctly until this is done. You can enter/update your license at anytime from the Knowledge Base > Settings screen, in the Licenses & Updates tab. You can manage active sites from Your HeroThemes Account at any time.

Heroic Knowledge Base setup assistant step 2

Installing Sample Content and Required Plugins

The setup section allows you to install demo content, including a numbers of articles, categories and tags, which can be used to test the knowledge base layout and gives a great example of how the knowledge base can be structured and tagged. Note there is no demo uninstall button, but you can delete and edit all the articles, categories and tags after the sample has been installed. To install the sample content, select Install Sample Content, it only takes a few moments and creates and configures a sample knowledge base automatically.

From the setup screen, required and optional plugins can be installed. The available options may vary depending on the tier purchased. Select plugins your wish to install and click Install Selected to continue.

Heroic Knowledge Base - Install content and optional plugins.

Setup Complete

Once setup, an Installation Complete message will be displayed with a list of the basics to help you get started with Heroic Knowledge Base on your site.

Heroic Knowledge Base setup assistant step 4

Activating Automated Updates and Support

In order to receive automatic updates and premium support, be sure to enter your license key during setup or on the License and Updates tab from the setting page. This will help keep your Knowledge  Base running smoothly and access support quickly should it be needed. The support section also has a quick link to this documentation.

This is not required if the knowledge base is packaged with your theme.

The Setup Assistant can be visited again at any time from the Plugins > Install Plugins page and selecting Setup Assistant

Accessing Heroic Knowledge Base setup assistant

Creating and Using Knowledge Base Articles

There will now be a new Knowledge Base menu in the WordPress admin panel.

From here you can manage existing articles, create new articles and control the Knowledge Base categories and tags. Articles are the components of your knowledge base. These work a lot like any other posts, but have there own archive, categories and tags.

Heroic KB nav options

Select Add New Article to create a new Heroic Knowledge Base Article.

From this page, you can control everything about your article:

  • Title – The title of the article
  • Content – The body content of the article
  • Options – Add attachments and allow voting
  • Format – The format of article (may be used by theme)
  • Categories – Custom knowledge base categories the article will be classified under.
  • Tags – Custom knowledge base tags to associate with the article.
The knowledge base article editor screen

The Knowledge Base adds several more metaboxes, to add features to your articles.

Article Options

Attachments can be added to an article here. Select Add or Upload File to select attachments to add to the article.

Note: The article View Count is calculated from page visits and can only be altered in the database.

knowledge base article options

Voting Options

Disable voting on the individual article.

Usefulness is determined by the votes, manually setting the usefulness in this box can cause inconsistencies to develop in the usefulness calculation.

knowledge base voting options

Votes and Feedback

This section displays the votes and feedback for this article. You can search through comments a sort by ratings, users etc.

Delete individual votes by selecting the relevant option next to the vote

Delete all votes by selecting the button at the bottom of the section.

The usefulness for the article can be recalculated from the votes using the Recalculate Usefulness (rating) button at the bottom of the section. This is handy when the usefulness rating falls out of sync with the votes.

knowledge base voting and feedback reports

Live Search Articles

The knowledge base features live search functionality, users can search the knowledge base articles. The options for the live search can be controlled from Heroic KB > Settings > Search. You can read more about search functionality in WordPress, limitations and enhancements in our guide to WordPress search.

Heroic KB live search bar

Settings

The settings menu from Heroic KB > Settings allows you to control various options for the whole Knowledge Base.  These are divided into various sections – including General Settings, Archive Options, Article Options, Search Options, which can be seen on the left of the settings panel.

These settings may not visible or configurable, depending on the features your active theme supports. Alternatively, they may be set as theme options or overridden by the theme. If a setting does not appear, it means the current theme does not support any user configurable settings for this item

Home & General Settings

The general settings control a numbers of options related to how the Knowledge Base is displayed, search as sort order and the number of articles to display in categories and tags.

The Home & General settings are only applicable if in Legacy templating mode

Home & General Settings

Categories & Tags Options

This options page controls the settings for the knowledge base categories and tags.

The Categories & Tags settings are only applicable if in Legacy templating mode

categories and tags options

Article Options

The article options page controls the settings for the individual knowledge base articles, such as meta and comments options.  Note comment options can also be controlled on an individual basis from the edit article screen and on a site basis from WordPress’s discussion options.

The Article settings are only applicable if in Legacy templating mode

knowledge base article options

Search Options

The search options page controls settings for options related to the Knowledge Base search functionality. You can read more about the WordPress search functionality that powers the knowledge base search, including how to extend it in our article covering Search in WordPress here.

The Search settings are only applicable if in Legacy templating mode

Search display options for the knowledge base

Slugs Settings

From this screen you can set the slugs for the Knowledge Base

The knowledge base allows you to define custom slugs for Heroic Knowledge Base articles, categories and tags. These can be controlled from Knowledge Base > Settings > Slugs. On updating the slugs, you may need to ‘flush’ your permalinks by visiting Settings > Permalinks, this forces WordPress to update the relevant slugs.

The slug for the knowledge base homepage can be controlled by editing that page, see the Home & General tab for quick link to the knowledge base homepage edit screen.

Slug settings

Sidebars

Use the sidebar settings to control how sidebars appear in the knowledge base section. You can add widgets to the sidebars from Appearance > Widgets.

The sidebars are only applicable if in Legacy templating mode

Managing the sidebar display in Heroic Knowledge Base

Appearance

The appearance tab controls the overall appearance of the knowledge base. Depending on your theme, most of the styling control will usually be controlled by WordPress’ template editor.

Heroic Knowledge Base  appearance settings

Managing the Knowledge Base templates

Manage the templates can be done in newer themes from the Appearance > Editor > Templates link, or by clicking Edit Site on any page you want to edit the template for.

Heroic Knowledge Base templates

Custom Styles

This page controls the overall styles for the knowledge base. If you wish to further control styles beyond these available options, you will need to modify your theme.

The custom styles are only applicable if in Legacy templating mode

Heroic Knowledge Base custom style settings

Article Feedback

This section allows you to control feedback, which you can use to gain insight from readers to make adjustments and improve articles. All the feedback for an article can be seen on the Edit Article screen.

Knowledge Base Article Feedback Settings

Transfers

Provide a way for customers to quickly access your support system with the transfers functionality. More details below.

Transfers settings

License and Updates

To enable automatic updates and access premium support, enter you license key on this page.

Note that certain themes manage the licensing and updates of the Knowledge Base plugin and will not require entry on this page.

License key entry

Help Assistant

The Help Assistant (previously called Embed) is functionality lets you add your knowledge base anywhere on the current WordPress site or on any another site (the external site doesn’t need to be WordPress), the knowledge base will be displayed in a small dock in the bottom right hand corner of the site.

Heroic KB Help Assistant

The embed settings can be controlled from Knowledge Base > Settings > Help Assistant. The Help Assistant requires that you have activated your site.

The help assistant settings

Note the embed functionality requires articles to be public, any hidden or restricted content will not be displayed correctly.

Email Reports

Email Reports are weekly digests from your knowledge base sent directly to email addresses you specify. The reports include number of weekly review and average article feedback / rating. The overall top viewed and top rated articles is also listed. To received email reports, your site needs to be active.

Knowledge base email reports

The settings for email reports are contained in Knowledge Base > Settings > Email Reports.

Separate multiple recipients for the report with a comma. Enable HTML reports for the best readability.

As email reports is reliant on the ability of your site to send and deliver-ability of email, you need to ensure your site is active.

Knowledge base email reports settings

Knowledge Base Widgets

Heroic Knowledge Base comes with six widgets for displaying information from the Knowledge Base:

  • Articles – Knowledge Base Articles
  • Authors – Knowledge Base Authors
  • Categories – Knowledge Base Categories
  • Search – Search the Knowledge Base from any page
  • Table of Contents – Display a table of contents. Only works on knowledge base articles.
  • Exit Point – Capture visitors that leave your knowledge base to an internal/external system (see section below)

Widgets can be activated from Appearance > Widgets and dragging to an active widget area, this allows you to display key information from the Knowledge Base across your site.

Heroic KB WordPress widgets

Knowledge Base Widget Areas

There are widget areas, independent of the theme, controlled by the knowledge base:

  • Knowledge Base Sidebar (Home) – for the knowledge base homepage
  • Knowledge Base Sidebar (Categories and Tags) – displayed in knowledge base categories and tags
  • Knowledge Base Sidebar (Article) – displayed in knowledge base articles

How these are displayed can be controlled in the knowledge base sidebar options, detailed in the section above.

Heroic KB sidebar options

Transfers

The most common use case for the knowledge base is a portal to deflect or assist support tickets or sales queries. When a visitor accesses the knowledge base but then goes on to raise a support ticket or complete a contact form (or access any other dedicated page) this can be tracked as a transfer. It works for both internal and external links. You just have to ensure the transfer widget is enabled.

Add transfer widget

From Appearance > Widgets, select the Knowledge Base Exit Point widget and drag it to an appropriate widget area.

A dummy page and widget will automatically be created when you first install the plugin.

You can set other options such as the title, text and button text.

Set the transfer page URL

The transfer page can be set from the widget’s link URL or from Settings>Transfer Options > Default Transfer URL. This should be the page you want to direct visitors to if they are unable to find an answer to their query in the knowledge base.

When a user clicks on the link in this widget, the source knowledge base location is recorded and can be analysed with the analytics module (see below).

Analytics

The Heroic Knowledge Base Analytics documentation can be found here.

Additional Tips

Linking to the Knowledge Base

You can link to any of the knowledge base articles as with any other post. To add the knowledge base to a menu, go to Appearance > Menus and add the page set as your knowledge base homepage.

Using the Knowledge Base as the homepage

To use the Knowledge Base as the homepage, set Front page to your knowledge base homepage in Settings > Reading.

Voting and Feedback

Visitors to the knowledge base can vote on articles. When a user votes up or down, they can add feedback to an article, which can be viewed from the ‘edit article’ screen. Top articles and contributors are assigned badges, depending on theme support.

Using Articles in Posts or Pages

The knowledge base articles, categories and tags are self-contained, and you can link them from any other page or post. The articles archive page links to all the other articles and categories  eg www.example.com/articles.

Styling the Knowledge Base

You can use your theme’s style.css (or preferable child theme) to control most aspects of the styling of the Knowledge Base.

Heroic Knowledge Base Categories

With the Heroic Knowledge Base, you can create, edit and control custom categories for your knowledge base articles.

Knowledge base categories can be created in two ways:

1. From Knowledge Base > Article Categories.

2. From an article add/edit page, under the Knowledge Base Category

In supporting themes, category images and colours can be controlled from the Edit Knowledge Base Category page. These options will appear if available.

knowledge base article category

Controlling the Article Order

Article order in the Knowledge Base Categories can be set by heading over to your WordPress Dashboard > Heroic KB > Settings > General page. Scroll down to the Categories & Tags section, where the Article order can be managed using the Sort By and Sort Order options.

Article order can also be manually set when the Sort By in General Settings is set to Custom. The article order can then be set from the Knowledge Base > Article Ordering menu.

Simply select the category you want to re-order articles. You can then drag and drop the articles in that category to re-order. Click Save Order at the bottom of the page to save the article order.

article ordering

Controlling the Category Order

The knowledge base category order can be controlled from the Knowledge Base > Article Category Ordering page. Drag and drop categories to re-order and change the order they are displayed on your site. Click Save Order at the bottom of the page to save the category order.

The parent category and nesting options can be controlled from the Edit Category page in Knowledge Base > Article Categories.

knowledge base category order

F.A.Q. and Support

For customers with an active site, you can reach the support team at HeroThemes Support.

How do I reset article votes?

Votes for an individual article can be reset by editing an article, and checking the “Delete All Votes” box, found in the “Votes and Feedback” section. Then simply update the article and all votes will then be removed.

How do I password protect articles?

Individual articles can be password protected in the same way as other WordPress posts and pages. See Using Password Protection on the WordPress Codex for more details.

How do I integrate the knowledge base plugin with my theme?

Please see our separate Integrating Heroic Knowledge Base with your theme guide for detailed instructions on integrating the Heroic Knowledge Base with themes (standalone Heroic Knowledge Base purchase only)

I get a 404 error when accessing Knowledge Base pages?

The most common cause of this is the permalinks have not been flushed. To force this, simply visit the Permalinks settings page from Settings > Permalinks and hit save in your WordPress dashboard and then try again. It is recommended for most themes, the Permalinks are not set to default. For more details see this article for guidance on using Pretty Permalinks.

The post Heroic Knowledge Base Plugin Documentation first appeared on HeroThemes.

]]>
https://herothemes.com/kb/heroic-knowledge-base-plugin-documentation/feed/ 0
KnowHow Documentation https://herothemes.com/kb/knowhow-documentation/ https://herothemes.com/kb/knowhow-documentation/#respond Wed, 20 May 2015 14:05:39 +0000 http://herothemes.com/?post_type=ht_kb&p=586 Getting Started The KnowHow theme runs on the WordPress platform. Prior to installing the theme, we therefore recommend installing WordPress on your server. Please consult the WordPress installation guide or...

The post KnowHow Documentation first appeared on HeroThemes.

]]>
Getting Started

The KnowHow theme runs on the WordPress platform. Prior to installing the theme, we therefore recommend installing WordPress on your server. Please consult the WordPress installation guide or your web host provider for help with this. It’s highly recommended to use a current WordPress version to take advantage of newer features and functionality.

Need help choosing a website host for your new site? See our Recommended WordPress Web Hosting providers

General Requirements of the theme

Before Using KnowHow, you need to first ensure that your server and WordPress meet specific requirements. Below are some of these requirements:

  1. PHP version 7.2 or greater
  2. MySQL version 5.6 or greater OR MariaDB version 10.1 or greater
  3. WordPress memory limit of 256 MB or greater
  4. HTTPS (SSL) support

You can use the debug info plugin to check current PHP limits or you can contact your webhost and ask them for the information.

Theme Installation

Once you purchase the theme, you can download it from the ThemeForest downloads section.

You will then need to click on the download button right next to the theme and here you will need to select the download option “All files and documentation”.

Once you are done with the download, you will then need to extract the zip contents of the download. This is a crucial step at this stage.

The “All files and documentation” option will include:

  1. Installable Theme File (knowhow.zip) – You can upload this file to your WordPress to install the theme.
  2. Installable Child theme (knowhow-childtheme.zip) – You can upload this to your WordPress install, to serve as your child theme.
  3. Documentation – Contains theme documentation file.
  4. Licensing Folder – Contains all licensing info files.
  5. Demo XML Folder – This will contain an XML file that will be used in the demo import
  6. Read me file – Contains instructions on where to access the online documentation and support

You can install the theme in either of two ways:

Method 1 – Via the WordPress admin dashboard

Navigate to the Appearance > Themes > Add New.

Adding new theme to WordPress

Click on the Upload Theme button and upload the select the knohow.zip file we previously extracted.

Upload KnowHow theme

Press the install now button and the theme will be uploaded and installed.

Note: You can as well install the child theme (knowhow-childtheme.zip) following the same instructions here.

Method 2 – FTP Upload

  1. Connect to your server via FTP software, using your FTP server URL, FTP username, FTP password and a port number.
  2. Once logged in, navigate to your wp-content > themes folder.
  3. Upload the unzipped theme folder into the wp-content > themes folder.
Uploading WordPress theme using FTP

Once the theme is uploaded, you will then need to activate it. To do so, navigate to the Appearance > Themes section and activate your theme.

Activate uploaded theme

Common Theme Installation Error:

“Broken theme and/or stylesheet missing” error: This error means that you are not uploading the correct theme zip files. You need to ensure that you are uploading the zip file with a style.css file in it.

Install and Activate Required Plugins

Once you are done with the theme installation and activation, you may then proceed to the next step which is plugins installation. The theme requires specific plugins to enhance its functionality.

In order to install these plugins, you will need to carry out the following:

Navigate to the Appearance > Install Plugins section within the WordPress dashboard

Installing required plugins

Bulk Install all the plugins within the list and have them activated as well

Installing required plugins 2
Installed plugins

Install Sample Content

Once you are done with the plugins installation, you can then choose to start with the demo import.

Within the ThemeForest download you will find a Demo XML folder. This folder contains the knowhow.demo.xml of which we will use to import the demo.

Demo XML folder

To install it you will need to carry out the following steps:

  1. Navigate to the Tools > Import section within your WordPress dashboard
  2. Install the WordPress importer if not yet installed
  3. Run the Importer and upload the knowhow.demo.xml file
  4. Enable file attachments import and trigger the file import
Importing Demo XML folder

Setting Up Content

With the demo import complete, your site will be populated with the demo content of which will have a similar view to our demo here.

From this point on, you can then begin adding your own content. The KnowHow theme mainly uses posts and post categories to render content.

Post Categories

Knowledge base categories

Post/Article categories are used in grouping of the topics within your site and allows users to navigate your site faster.

The categories to be used in the grouping of posts can be added from the Posts > Categories section within the WordPress dashboard.

Knowledge base category editing

Name: Add the category name within this field

Slug (Optional): The URL friendly version of the category name can be added here

Parent Category (Optional): Allows you to specify a parent category

Description (Optional): Here you can add content that provides more information on the category

Posts

Knowledge base posts

These are articles or rather topics within your site.

Articles can be added from the Posts > Add New section within your WordPress dashboard.

Knowledge base add new post

Post Formats

The theme provides two post formats to choose from when creating posts.

Knowledge base post format

Standard

This is the default post format. It renders the theme’s default blog post look.

Video

This post format will consider the embedded video in the post content. The video can either be from a third party video hosting service or uploaded and played directly from WordPress.

The video can be added from the “Video Post Format” meta box as illustrated in the screenshot below:

Adding video in knowledge base article

Video URL: Here you can specify the third-party video URL

Video File Upload: You can upload a video file to be self-hosted here

Video Poster Upload: Here you can provide an optional “Poster Image” which is the view preview image

Using the Heroic Glossary Plugin

The Heroic Glossary plugin is used to create a glossary of terms. You may think of it as a mini dictionary of words, acronyms, abbreviations or technical terms. This helps your audience understand technical terms, acronyms and abbreviations they may not be familiar with.
Its functionality can be added to a post or page via the Heroic Glossary Gutenberg block.

Heroic Glossary block

Once you add the block to the post, you can then add the Glossary terms you wish to have in place:

Using the Heroic Table Of Contents Plugin

The Heroic Table of Content of Contents plugin is used to add a table of Contents to your site.

This enables users to easily navigate through the site.

The plugins’ functionality can be added to a page by adding the Heroic Table Of Contents block.

Heroic Table of Content block

With the block added, you can then add the table of content items:

Adding table of content

Using the Posts as your front Page

If you install the demo content and recommended settings, the posts will be rendered on your front page. This is based on the default settings within the Settings > Reading section your WordPress dashboard.

Using the Posts as your front Page

Configure the Navigation Menu

In order to set up custom menus, you will need to navigate to the Appearance > Menu section and create a new menu. You can then add menu items such as posts, pages, categories and custom links.

Configure the Navigation Menu

Once the menu is created, you can then set it as the primary menu:

WordPress website menu structure

Configuration Options

Customizer Settings

You can customize various visual aspects of the theme using the WordPress Live Customizer. To do so you will need to navigate to the Appearance > Customize section within your WordPress dashboard.

Site Identity

Site Title: The title for your site

Tagline: A tagline for your site

Site Icon: An icon associated with your site

Menus

Allows you to create a menu and specify the menu location

Widgets

Default Sidebar: Here you can specify widgets for the main sidebar

Footer Widget Area: This holds the widgets within the footer

Home Page Settings

Provides options to choose what to display on the front page. Either the latest posts or a static page.

Additional CSS

This section can be used to add custom CSS codes.

10.2 Theme Options

The theme comes with a simple to use administration panel. You can access it by navigating to the Appearance > Theme Options section.

10.2.1 General Options

Theme general settings

Enable Live Search: This option enables the live search within the site

Search Text: Provides a field to specify the placeholder search text within the search field

Article Meta: Provides an option to specify the meta information to be rendered within the posts

Show Article Author Box: Enables you to show an author box at the end of an article

Show Related Articles: Provides an option to show related articles at the end of an article

Footer Copyright Text: Used to set a custom copyright text that will appear in the footer

Home Page Options

These settings allow you to configure the homepage.

Sidebar Layout: Provides an option to specify the sidebar for the homepage

Exclude Categories: Allows you to fill in a category ID that will not be included on the home page

Number Of Category Posts: Species the number of posts to show under each category

Category Post Ordering: Provides an option to determine the order of posts within a category

Show Category Counts: Determines whether to render the number of articles each category contains next to the category title

Show Sub Categories: Provides an option to determine whether sub categories will be rendered on the home page or not

Exclude Sub Categories: Allows you to fill in a sub-category ID that will not be included on the home page

Show Sub Category Counts: Determines whether to render the number of articles each sub-category contains next to the category title.

FAQ Options

Theme FAQ settings

These settings apply to the FAQ page.

FAQ Permalink Slug: Here you can specify the slug for your FAQ page

FAQ Sidebar: Used to set or disable the position of the FAQ page sidebar

Styling Options

Custom Logo: Provides an option to upload a logo for your site

Custom Favicon: Allows for the upload of a png/ico to be used as a website’s favicon

Footer Widget Columns: Provides a selection for the number of columns the footer widget should be displayed in

Theme Color: This option allows you to specify the default color used throughout the theme

Link Color: Provides an option to specify the color of your links

Link Color Hover: Provides an option to specify the color of your links once there is a hover action upon them

Custom CSS: This is a field within which you can add your own custom CSS section

Custom Shortcodes

The theme provides a number of Shortcodes that will help you to properly layout the structure of your content as well as having it styled

Custom Shortcodes

Shortcodes can be added within a page or post by clicking on the green icon within the editor toolbar.

You can then choose the Shortcode you wish to include and click “insert”.

Getting the most out of your theme

Featured Images

The theme supports the use of featured images. The theme supports auto-resizing of the featured images. Auto-resizing will only occur however when the image is uploaded for the first time, images that have previously been uploaded will not be resized. You can however use the Regenerate Thumbnails plugin to regenerate the thumbnails to fix this.

Getting the most out of your theme

To upload a post thumbnail, go to Posts > Add New or open an existing post in editing mode. Locate the Featured Image module and click the Set featured image link.

For more on how to use the WordPress’ Post Thumbnail feature, please see this article from WordPress on featured image support.

The post KnowHow Documentation first appeared on HeroThemes.

]]>
https://herothemes.com/kb/knowhow-documentation/feed/ 0