Knowledge Center

Provides an easy to use, responsive, centralized repository of FAQs with advanced configuration and display options.

Documentation

Author: eMarket Design
Last Updated: 2017-02-27

Introduction

Feature rich, responsive centralized FAQ solution

Concepts

The following is the definition(s) of the concept(s) covered in the context of Knowledge Center app:

Last Updated: 2015-10-29

Panels

Any short length content which may be used to display term definitions, frequently asked questions etc.

Last Updated: 2017-02-24

Quick Start

Knowledge Center Community Introduction

Watch Knowledge Center Community introduction video to learn about the plugin features and configuration.

EMD CSV Import Export Extension helps you get your data in and out of WordPress quickly, saving you ton of time

EMD CSV Import Export Extension helps bulk import, export, update entries from/to CSV files. You can also reset(delete) all data and start over again without modifying database. The export feature is also great for backups and archiving old or obsolete data.

EMD Advanced Filters and Columns Extension for finding what's important faster

EMD Advanced Filters and Columns Extension for Knowledge Center Community edition helps you:

  • Filter entries quickly to find what you're looking for
  • Save your frequently used filters so you do not need to create them again
  • Sort entry columns to see what's important faster
  • Change the display order of columns
  • Enable or disable columns for better and cleaner look
  • Export search results to PDF or CSV for custom reporting

Working with Panels

Using Knowledge Center, you can create, modify, delete, and search panel records, associated taxonomies, or relationships.

Last Updated: 2017-02-27

Creating Panels

To create panel records in the admin area:

  1. Log in to your Administration Panel.
  2. Click the 'Panels' tab.
  3. Click the 'Add New' sub-tab or the “Add New” button in the panel list page.
  4. Start filling in your panel fields. You must fill all required fields. All required fields have red star after their labels.
  5. As needed, set panel taxonomies and relationships. All required relationships or taxonomies must be set.
  6. When you are ready, click Publish. If you do not have publish privileges, the "Submit for Review" button is displayed.
  7. After the submission is completed, the panel status changes to "Published" or "Pending Review". Users must have "publish" right to publish panels. Users who do not have "publish" right can still create panels; however, these panels must be reviewed and approved by a user with panel "publish" right. Check Roles and Responsibilities section of this document to see which access groups have panel "publish" right.
Last Updated: 2015-10-29

Modifying Panels

Panels can be modified by clicking on the "Edit" link under the panel title in the panel list page in the admin area. Make any necessary changes and then click Publish.

Last Updated: 2015-10-29

Searching Panels

In Knowledge Center, users are only allowed to search panels they have access to. Users who have access to panels can search using the filter system in the panel admin area.

Last Updated: 2015-10-29

Scheduling Panels

To schedule Panels for publication on a future time or date in the admin area:

  1. Log in to your Administration Panel.
  2. Click the 'Panels' tab.
  3. Click the 'Add New' sub-tab or the “Add New” button in the panel list page.
  4. Start filling in your panel fields. You must fill all required fields. All required fields have red star after their labels.
  5. As needed, set panel taxonomies and relationships. All required relationships or taxonomies must be set.
  6. When you are ready, click "Edit" in the Publish area next to the words "Publish immediately". You can also change the publish date to a date in the past to back-date Panels. Change the settings to the desired time and date. You must also hit the "Publish" button when you have completed the panel to publish at the desired time and date.
  7. After the submission is completed, the panel status changes to "Published".
Last Updated: 2015-10-29

Password Protected Panels

To create a password protected panel in the admin area:

  1. Log in to your Administration Panel.
  2. Click the 'Panels' tab.
  3. Click the 'Add New' sub-tab or the “Add New” button in the panel list page.
  4. Start filling in your panel fields. You must fill all required fields. All required fields have red star after their labels.
  5. As needed, set panel taxonomies and relationships. All required relationships or taxonomies must be set.
  6. Click the "Edit" link next to Visibility in the publish box and select "Password protected".
  7. Enter a password that will be required to view that panel in the text field. The password is limited to 20 characters.
  8. When you are ready, click the "Publish" button (or "Update" if the panel is already published.)
  9. After the submission is completed, the panel status changes to "Published".

Only an Administrator and users with "publish" right can change the password set for your panel or modify visibility setting by clicking the "Visibility: Edit" link again.

When panel content is password protected, panel title displays the text "Protected: " before the panel Title and the content prints a password form with this text: "This content is password protected. To view it please enter your password below:".

If multiple panels have the same password, one will only have to enter the required password once. Only one password is tracked at a time so if you visit two different panels with two different password, you must re-enter the panel password to access content. WordPress saves passwords for maximum 10 days. After this period expires, one must reenter the password again to view the protected content.

Last Updated: 2015-10-29

Private Panels

Panels can be privately published to remove them from panel lists and feeds.

To create a private panel in the admin area:

  1. Log in to your Administration Panel.
  2. Click the 'Panels' tab.
  3. Click the 'Add New' sub-tab or the “Add New” button in the panel list page.
  4. Start filling in your panel fields. You must fill all required fields. All required fields have red star after their labels.
  5. As needed, set panel taxonomies and relationships. All required relationships or taxonomies must be set.
  6. Click the "Edit" link next to Visibility in the publish box and select "Private".
  7. Once you change the visibility to private, the panel status changes to "Privately Published".
  8. When you are ready, click the "UPDATE" button.

Only an Administrator and users with "publish" right for the panel can change visibility setting by clicking the "Visibility: Edit" link again.

Last Updated: 2015-10-29

Previewing Panels

To preview panel content press the "Preview" button - a button directly above the “publish” button - in the publish box before officially publishing or sending for review.

Last Updated: 2015-10-29

Draft Panels

To create a draft panel in the admin area:

  1. Log in to your Administration Panel.
  2. Click the 'Panels' tab.
  3. Click the 'Add New' sub-tab or the “Add New” button in the panel list page.
  4. Start filling in your panel fields. You must fill all required fields. All required fields have red star after their labels.
  5. As needed, set panel taxonomies and relationships. All required relationships or taxonomies must be set.
  6. When you are ready, click "Save Draft" button in the publish box.
  7. After the submission is completed, the panel status stays at "Draft".
Last Updated: 2015-10-29

Panel Author

Once the panel is published the user who created the panel is assigned as the panel author. Panel authors can view and edit the panel. One can change the panel author from the author box. The author box drop down is limited to the users who have panel "publish" right.

Last Updated: 2015-10-29

Setting KC Groups

KC Group can be set by clicking on the desired option in "KC Groups" box and updating/saving the panel. Setting a value for KC Group is optional. KC Group is also not organized hierarchically meaning there's no relationship from one KC Group value to another.

KC Groups do not have preset values.

Last Updated: 2015-10-29

Setting KC Tags

KC Tag can be set by typing the desired option in the empty text field and clicking "Add" button in "KC Tags" box and updating/saving the panel. Setting a value for KC Tag is optional. KC Tag is also not organized hierarchically meaning there's no relationship from one KC Tag value to another.

KC Tags do not have preset values.

Last Updated: 2015-10-29

Displaying Panels

Displaying Panel archives can be done by creating a link in the Appearance Menus Screen in the admin area.

Alternatively, if you'd like to display a specific Panel, you can select the link from Panel metabox and add it to your menu. If you don't see Panel metabox, check the Screen Options to ensure it is set to display.

To create a custom link for Panel archives:

  1. Goto Appearance in the admin menu and click on Menus link
  2. On the right hand side, pick the menu you’d like to include from Select a menu to edit dropdown
  3. Under Links menu navigation item, type in /panels to the URL field
  4. Type in Panels or another label describing the custom link URL in the Link Text field
  5. Click “Add to menu” button to add the item to the menu
  6. Pick “primary location” under “Menu Settings” below the menu
  7. Save your menu
  8. Go to the frontend and click on the link you created to access Panels. Panel archive page content is only displayed to the authorized users who have access permissions.
Last Updated: 2015-10-29

Locking Panels

In Knowledge Center, Panels are locked during editing, preventing other users from accessing and modifying the Panel.

If a user clicks to edit one of the Panel records that's currently locked they are presented with three options in a pop-up dialog:

  1. Go Back - Return to the Panels listing.
  2. Preview - Preview the current state of the Panel that's being edited.
  3. Take Over - Lock out the current editor of the Panels and begin editing. (The other user will receive a notification)

The user that has been locked out receives the following dialog, and is no longer able to edit the Panel. It can take up to 15 seconds for the current Panel editor to be notified that another user has taken over.

Last Updated: 2016-04-04

Using Panel Rating

You can use Panel Rating to create interactions from users.

Panel Rating module :

  • Supports accepting ratings from logged-in users, visitors or both
  • Allows users to rate Panels
  • Stores user logs. The logs can be accessed by administrators.
  • Allows "star", "like" or "thumbs" rating modes
  • Supports custom font, custom image, font awesome and dashicons icon types
  • Supports Google Rich Snippets
  • Allows customization of rating stats area using rating tags
  • Allows customization of rating area using rating tags
  • Allows to filter and search user ratings using multiple criteria and more
  • Allows to hide or disable rating
  • Features user rating integrity protection through IP, cookie or both

Click on ratings menu link under KC Settings menu to access configuration options.

Panel Rating feature is provided by wpas rating extension which is sold separately and must be activated to be used.

Widgets

Widgets provide a simple and easy-to-use way of displaying content and features on your sidebars or dashboard.

Sidebar widgets can be added, removed, and rearranged on the WordPress Administration Appearance > Widgets panel. Dashboard widgets can be enabled or disabled using Screen Options tab in your app dashboard page. All widgets have drag-and-drop functionality.

The following sections list the Knowledge Center widgets:

Last Updated: 2015-10-29

Featured Panels sidebar widget

Featured Panels is an entity sidebar widget. It shows latest 5 published panel records without any page navigation links.

Last Updated: 2015-10-29

Recent Panels sidebar widget

Recent Panels is an entity sidebar widget. It shows latest 5 published panel records without any page navigation links.

Standards

Standard views display a single type of content in a custom format and can be used in place of archive views. Administrators can display standard views using their shortcodes by choosing the name of the view you want to display from the WPAS component list after clicking on the WPAS toolbar button on any page.

The following sections list the Knowledge Center standard views available:

Last Updated: 2015-10-29

Frequently Asked Questions

"Frequently Asked Questions" is a standard view which displays -1 Panel records per page with a post status of publish in ascending order by menu_order. Page navigation is disabled. If you choose to install setup pages during plugin activation, a WordPress page is created with a title of "Frequently Asked Questions". You can visit this page to access the view. To display it in another page or post, use [std_panel] shortcode or select the view name from the WPAS component list after clicking on the WPAS toolbar button.

Administration

Plugins are managed from the Plugins screen in the Administration Screens of your WordPress site. All Plugins listed on this screen are found in your wp-content/plugins directory. Each Plugin has a description in its header section of what it does, an author and website to refer to, and a version number. Find Knowledge Center from the list.

Last Updated: 2017-02-27

Installation

To install your Knowledge Center Plugin using the built-in plugin installer:

  1. Download Knowledge Center Plugin to your desktop.
  2. Go to Plugins "Add New".
  3. Under Upload, click "Browse".
  4. Find the knowledge-center-community-VERSION.zip file.
  5. Click Install Now to install the Knowledge Center Plugin.
  6. A popup window will ask you to confirm your wish to install the Plugin.
  7. Click Proceed to continue with the installation. The resulting installation screen will list the installation as successful or note any problems during the install.
  8. If successful, click Activate Plugin to activate it, or Return to Plugin Installer for further actions.

Replace VERSION in instructions with the version number of Knowledge Center you want to install. After the activation, the Knowledge Center plugin setup may display notification asking if you if you'd like to install setup pages or skip setup page installation, click the appropriate button.

Last Updated: 2015-10-29

Uninstallation

To uninstall your Knowledge Center Plugin using the built-in plugin installer:

  1. Go to Plugins screen.
  2. Find the Knowledge Center Plugin you wish to deactivate and uninstall.
  3. Click Deactivate.
Last Updated: 2017-02-27

Plugin Updates and Upgrades

WordPress auto-update system displays notification in the Admin Bar and also on the plugins page when new version of the Knowledge Center is available.

To install the new version, simply hit the "Update automatically" button. WordPress will automatically download the new package, extract it and replace the old files. No FTP, removing old files, and uploading is required.

Upgrading your plugin

We offer different plugin editions to better match your needs. If you purchased a different edition of Knowledge Center, follow the steps below to upgrade your plugin:

  1. Go WordPress plugins page and deactivate and optionally delete the current Knowledge Center Community edition.
  2. Install the new edition based on the instructions in WordPress Codex
  3. Activate the new edition
  4. Go to Plugin Settings page and save settings

Upgrading Knowledge Center Community edition does not have any impact on your existing data but it is always a good idea to back up your WordPress database as a rule of thumb before any changes.

Using Plugin Extensions

Knowledge Center Community edition is configured to work with many plugin extensions. Most plugin extensions work regardless of the edition unless specified specifically in the plugin page.

if you purchased a plugin extension, follow the instructions in WordPress Codex to install and activate your plugin extension like any other WordPress plugin.

If your extension comes with a license key, you must save and activate your license key to get software updates and support.

Last Updated: 2017-02-27

Changing Entity Base Slug

The default entity base slug can be changed within entity tab of settings page in KC Settings menu. After you update, make sure to refresh your site's Permalinks under Settings. You can only change base slug if post name based permalink structure is selected.

Last Updated: 2017-02-27

Resolving theme related conflicts

For the most part, Knowledge Center templates will integrate nicely with most WordPress themes. However you may run into issues when the default Knowledge Center content wrappers do not match your chosen theme or your theme's CSS rules overwrite Knowledge Center CSS rules.

Theme related issues manifest themselves by;

  • Breaking your layout on Knowledge Center pages and shifting your sidebars into incorrect positions
  • Some random text getting displayed in header or footer of your site
  • Some sections in plugin pages not getting displayed as in the plugin's demo site.

Theme related issues can potentially affect all single, taxonomy, archive and shortcode pages because Knowledge Center uses templates of its own to display these pages and it’s impossible for eMDPlugins to know exactly what markup or CSS rules your theme uses.

The following is a Developer level documentation. If you’re unfamiliar with code/templates and resolving potential conflicts, we strongly suggest to hire us or a developer to complete the project for you. Please also note that our complimentary support team is unable to assist with customization per our Support Policy.

There are three methods to resolve theme related issues;

  • Copying and modifying your theme's header.php and footer.php
  • Copying and modifying your theme's page.php
  • Adding custom CSS rules

Modifying header.php and footer.php

  1. Go to your theme's folder -- wp-content/themes/YOURTHEME/
  2. Copy header.php of your theme as header-emdplugins.php
  3. Copy footer.php of your theme as footer-emplugins.php
  4. Remove the conflicting code from header-emdplugins.php and/or footer-emplugins.php.
  5. This will make Knowledge Center use these newly created header and footer instead of your theme's default header and footer. Save the files. You’re done.

Copying and modifying your theme's page.php

If the issue can not be resolved through simply modifying the header and footer templates, you need to modify your theme's page.php.

Please note that this approach eliminates Your ability:

  • To set page templates for single, archive and taxonomy pages
  • To remove page navigation from archive and taxonomy pages.

from KC Settings, settings page.

To set up this template page:

  1. Duplicate your theme’s page.php file, and name it kc-com.php. This file should be found like this: wp-content/themes/YOURTHEME/kc-com.php.
  2. Open up your newly created kc-com.php in a text editor, or the editor of your choice.
  3. Next you need to find the loop (see The_Loop). The loop usually starts with a:

    <?php if ( have_posts() ) :

    and usually ends with:

    <?php endif; ?>

    This varies between themes. Once you have found it, delete it. In its place, put:

    <?php kc_com_content(); ?>
  4. This will make your theme use Knowledge Center’s loop instead. Save the file. You’re done.

Adding CSS rules

You add custom CSS rules in the Custom CSS field of Tools tab under KC Settings menu, settings page to overwrite your theme's default CSS. The custom css rules added in the settings are not deleted when your plugin gets updated.

You can learn CSS language by completing the tutorials at w3schools.com

Last Updated: 2017-02-27

Localization(l10n)

Knowledge Center can be translated into any language by editing kc-com-emd-plugins.pot and kc-com.pot files.

  • kc-com-emd-plugins.pot file is for the components used in Knowledge Center.
  • kc-com.pot file is for the Knowledge Center specific strings that need to be translated.

Follow the steps below to fully translate Knowledge Center into the desired language:

  1. Copy kc-com-emd-plugins.pot as language specific .po file such as kc-com-emd-plugins-tr_TR.po.
  2. Copy kc-com.pot as language specific .po file such as kc-com-tr_TR.po.
  3. Use your favorite PO file editor and complete translation strings in the .po files you created.
  4. When translations are completed, create .mo file of each .po file.
  5. Create wp-content/languages/kc-com directory
  6. Put translated .mo files and .po files in the directory above to protect them from getting deleted during plugin updates.
  7. Change the language to the translated language from Settings > General > Site Language.
  8. Repeat the process until you get all strings translated
  9. .
Last Updated: 2015-10-29

Screen Options

Screen Options is displayed as a hanging tab under the toolbar. Click on the Screen Options tab to expand the options available for a particular Screen, check (or uncheck) the desired options, then click the Screen Options hanging tab to collapse the Screen Options. Each screen may have a different set of Screen Options.

Edit page screen options allow the user to decide the edit boxes ,such as taxonomies, relationships or specific boxes such as authors, are presented in the edit area. You can turn on and off the ones that are not needed for a particular edit session.

List page screen options allow users to set the number of records displayed in the list table.

Last Updated: 2017-02-27

Creating Shortcodes

Shortcodes are small blocks of reusable code that can be inserted in a page to generate dynamic and often complex functionality. There is no limit in number of shortcodes that can be created and used. Multiple shortcodes can be used in the same page.

Examples

The following shortcode creates a Frequently Asked Questions page with panels of KC Groups category.

[std_panel filter="tax::kb_group::is::YOUR TAXONOMY VALUE;"]

The following shortcode creates a Frequently Asked Questions page with panels of KC Groups category.

[std_panel filter="attr::emd_panel_id::is::YOUR ATTRIBUTE VALUE;"]

The following shortcode creates a Frequently Asked Questions page with panels of KC Groups category where ID is emd_panel_id .

[std_panel filter="attr::emd_panel_id::is::YOUR ATTRIBUTE VALUE;tax::kb_group::is::YOUR TAXONOMY VALUE;"]

The following shortcode creates a Frequently Asked Questions page with the published panels of KC Groups category where ID is emd_panel_id in descending order by comment count, displaying 15 panels with no pagination.

[std_panel filter="attr::emd_panel_id::is::YOUR ATTRIBUTE VALUE;tax::kb_group::is::YOUR TAXONOMY VALUE;misc::post_status::is::publish;misc::order::is::DESC;misc::posts_per_page::is::15;misc::has_pages::is::false;misc::orderby::is::comment_count;"]

Note: Replace YOUR ATTRIBUTE VALUE with the value stored for that attribute and YOUR TAXONOMY VALUE with the slug of the corresponding taxonomy value.

Last Updated: 2017-02-27

Customizations

Knowledge Center offers extensive customization options from plugin settings, settings page. The following customizations can be done without changing your theme's template files:

  • Enable or disable all fields, taxonomies and relationships from backend and/or frontend
  • Set any entity and/or archive base slug
  • Set the page template of any entity, taxonomy and/or archive page to sidebar on left, sidebar on right or no sidebar (full width)
  • Hide the previous and next post links on the frontend for single posts
  • Hide the page navigation links on the frontend for archive posts
  • Display or hide any custom field
  • Display any side bar widget on plugin pages using EMD Widget Area
  • Set custom CSS rules for all plugin pages including plugin shortcodes

If your customization requirements are more complex and can not be resolved through the list of options provided above, you need to implement advanced customization techniques.

Advanced Customizations

Note:The following is a Developer level documentation. If you’re unfamiliar with code/templates/localization and resolving potential conflicts, we strongly suggest to hire us or a developer to complete the project for you. Please also note that our complimentary support team is unable to assist with customization per our Support Policy.

Knowledge Center advanced customization can be done on 3 different areas;

  • Look & Feel - changing layout and overall presentation of content
  • Functionality - adding, deleting or modifying existing plugin functionality
  • Strings - changing the field names

Plugin customization can be implemented by using 4 different methods:

Customizing functionality

If you'd like to modify the functionality, you need to modify the plugin design (sold separately) using WP App Studio ProDev API access (sold separately and monthly development plans are available).

Customizing look & feel

If you like to customize how HTML elements are to be displayed on screen, you can add custom CSS rules with higher specificity to your theme's style.css file.

If you'd like to customize layouts of Knowledge Center, Please follow the steps below:

  1. Create "emd_templates" directory under your theme's directory.
  2. Copy the layout files that you want to customize into "emd_templates" directory which you created in step 1 from PLUGIN-ROOT/layouts directory
  3. Modify the file based on your needs

The layout files you added in the "emd_templates" has always precedence over the plugin's layout files. If the customized files get deleted, the layouts which came with your plugin are displayed. We recommend that you create a child theme if you'd like to minimize the risk of accidental deleting of the "emd_templates" directory because of theme updates.

The following layout file types can be customized:

  • Single view page
  • Archive view page
  • Taxonomy view page
  • Search form result page
  • Standard list page
  • Integration page
  • Org chart record and tooltip layout page

Customizing strings

Knowledge Center labels and messages can be customized to better match your needs through language files. The customization is very similar to localization but recommended for US English users only. If your language is different than US English, you should localize instead of customize. The customization can be done for the strings included in kc-com-emd-plugins.pot and kc-com.pot files.

The following steps cover the string customization of labels and messages.

  • kc-com-emd-plugins.pot file is for the translatable strings of components used in Knowledge Center.
  • kc-com.pot file is for the Knowledge Center specific strings that need to be translated.

Follow the steps below to fully customize Knowledge Center labels and messages:

  1. Copy kc-com-emd-plugins.pot as language specific .po file such as kc-com-emd-plugins-en_US.po.
  2. Copy kc-com.pot as language specific .po file such as kc-com-en_US.po.
  3. Use your favorite PO file editor or plugin and complete customization of strings in the .po files you created.
  4. When customization are completed, create .mo file of each .po file.
  5. Create wp-content/languages/kc-com directory.
  6. Put customized .mo files and .po files in the directory above to protect them from getting deleted during plugin updates.
  7. Repeat the process until you get all strings customized. If you do not need a string to be customizes, leave it as it is.

All customization can be done by yourself or emarketdesign.com. Open a support ticket, if you prefer us to do the customization for you.

Glossary

Below is the list of attribute and taxonomy definitions.

Last Updated: 2015-10-29

Panel

Any short length content which may be used to display term definitions, frequently asked questions etc.

ID
Unique identifier for a panel. It is incremented by 1. Being a unique identifier, it uniquely distinguishes each instance of Panel entity. ID is filterable in the admin area. ID does not have a default value.
Featured
Featured is filterable in the admin area. Featured does not have a default value.
Context color
Colors the panel header to highlight or group similar content. Context color has a default value of "'default'".Context color is displayed as a dropdown and has predefined values of: default, primary, success, info, danger, warning.
Initial State
Sets the initial state of a panel\'s content. Initial State does not have a default value.
Title
Title is a required field. Title is filterable in the admin area. Title does not have a default value.
Content
Content does not have a default value.