Getting Started

Welcome to the Knowledge Base documentation. Whether you are new or an advanced user, you can find useful information here.

Next steps:

How to install extension

  1. Login to Magento backend.
  2. Go to System > Tools > Compilations.

    If Compiler Status is Enabled, disable the compilation by clicking the button Disable in the upper right corner.

  3. Backup your store database and web directory.
  4. Download extension from your Personal Account.
  5. Unzip the extension locally.
  6. Copy contents of the folder step1 to the root directory of Magento store.
  7. Copy contents of the folder step2 to the root directory of Magento store.
  8. Completely clear the site cache.

    Go to System > Cache Management. Click button Flush Magento Cache. If you want to clear the cache manually, you need to remove a folder /var/cache at the server.

  9. Logout from Magento backend and login again.
  10. Go to System > Configuration > Mirasvit Extensions > System, at form Installed Extensions press the button Run validation tests for all extensions for check extension installation and configuration.
  11. If compilation was enabled before installation, you need to run recompilation process to enable compilation. Go to System > Tools > Compilation and click on Run Compilation Process.
    If you did not disable compilation and store is down after installation, follow the link and make next steps to recover the store.

Next step:

Temporary Disabling

To temporary disable an extension please follow the next steps:

  • Disable Compilation Mode (if enabled).
  • Remove following files:

    • app/etc/modules/Mirasvit_Kb.xml
  • If you have only one extension from Mirasvit installed, remove following file:

    • app/etc/modules/Mirasvit_MstCore.xml
  • Login in to Magento back-end and refresh site cache (if enabled).

Extension Removing

To uninstall an extension please follow the next steps:

  • Disable Compilation Mode (if enabled).
  • Remove following files:

    • app/etc/modules/Mirasvit_Kb.xml
  • If you have only one extension from Mirasvit installed, remove following file:

    • app/etc/modules/Mirasvit_MstCore.xml
  • Login in to Magento back-end and refresh site cache (if enabled).
  • Remove following folders:

    • app/code/local/Mirasvit/Kb
  • Remove templates and layouts files of the extension from your theme folder. The list of such files can be collected from files in the extension package.

How to upgrade extension

To upgrade extension follow next steps:

  1. Login to Magento backend.
  2. Go to System > Tools > Compilations.

    If Compiler Status is Enabled, disable the compilation by clicking the button Disable in the upper right corner.

  3. Backup your store database and web directory.

    If you have customizations, please, create a separate backup of app/code/local/Mirasvit before upgrading to the new version.

  4. Download new extension package from your Personal Account.
  5. Unzip the extension locally.
  6. Temporary disable extension. Check Temporary Disabling.
  7. Copy contents of the folder step1 to the root directory of Magento store.
  8. Copy contents of the folder step2 to the root directory of Magento store.
  9. Completely clear the site cache. Go to System > Cache Management. Click button Flush Magento Cache. If you want to clear the cache manually, you need to remove a folder /var/cache at the server.
  10. Logout from Magento backend and login again.
  11. If compilation was enabled before upgrade, you need to run recompilation process to enable compilation. Go to System > Tools > Compilation and click on Run Compilation Process.
    If you did not disable compilation and store is down after upgrade, follow the link and make next steps to recover the store.

General Settings

  • Base URL - Sets frontend base URL to the Knowledge Base (i.e. if you fill in: knowledge-base, your base URL will be: http://example.com/knowledge-base.html)

  • Enable Articles Rating - If option enabled, customers are able to rate articles.

  • Enable SEO Friendly URLs - If option enabled, extension will make SEO friendly URLs for categories and articles. (i.e. http://example.com/knowledge-base/where-s-my-stuff/track-your-package.html)

  • Limit of article's links on category view page - Sets limit of article's links on a category view page.

  • Top Link Menu Item Name - Sets title for a Knowledge Base menu item for a Top Link menu. If empty, link does not displayed.

How to configure Knowledge Base

Create a tree of categories to systematize and group information.

Go to Knowledge Base > Categories. Click the button Add Category. Fill in the following fields:

  • Title - Title of the category.
  • URL Key - URL key of the category.
  • Is Active
  • Store View - Store views, where the category will be shown.

Click the button Save Category.

figure

Create a new article for your Knowledge Base.
Go to Knowledge Base > Articles. Click the button Add New Article. Fill in the following fields:

  • Title - Title of the article.
  • Text - Text of the article. Uses WYSIWYG editor.
  • URL Key - URL key of the article.
  • Is Active
  • Store View - Store views, where the article will be shown.
  • Author
  • Tags - Tags, to facilitate search of the article. You can enter a comma-separted list of tags.

Click the Categories tab. Set category for the article. Click the button Save.

figure

Change Log

Change Log

1.0.6

(2017-07-26)

Features

  • Allowed category URL key exclusion from article URL

Fixed

  • Fixed redirect after voting on article
  • Fixed Top Link Title incorrect store dependency

1.0.5

(2016-09-13)

Fixed

  • Fixed store-based article display bug
  • Fixed article preview text generation at List view
  • Restored rating stars box at the Article view
  • Made inactive categories grayed in Category Edit dialog

Features

  • Added Overview block to categories

1.0.4

(2016-02-29)

Fixed

  • Fixed wrong link of paginator when search is multi-page
  • Added additional check for actual registering KB rewrites

1.0.3

(2016-02-29)

Features

  • Allow to display Knowledge Base link at the Top Link Menu

1.0.2

(2015-11-20)

Improvements

  • Admin routing patch. Compatibility with SUPEE-6788.

1.0.1

(2015-09-28)

Fixes

  • Tags from one store appeared in others
  • If two articles created with similar tags, that tags are doubled
  • Front end button Submit is not translated
  • Incorrect translations in article view
  • Float value in positive votes quantity

Improvements

  • Ability to set article position

1.0.0

(2014-01-24)

Features

  • Initial stable release

Manual