https://github.com/tractorcow/silverstripe-knowledgebase

Knowledge base module for silverstripe; Basic FAQ, categorisation, and article search
https://github.com/tractorcow/silverstripe-knowledgebase

Last synced: about 1 month ago
JSON representation

Knowledge base module for silverstripe; Basic FAQ, categorisation, and article search

• Host: GitHub
• URL: https://github.com/tractorcow/silverstripe-knowledgebase
• Owner: tractorcow
• Created: 2012-05-04T03:35:14.000Z (over 12 years ago)
• Default Branch: master
• Last Pushed: 2012-05-27T23:57:38.000Z (over 12 years ago)
• Last Synced: 2024-10-16T16:49:48.114Z (3 months ago)
• Language: PHP
• Size: 125 KB
• Stars: 3
• Watchers: 3
• Forks: 2
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# Knowledge Base module for Silverstripe

This module provides basic knowledge base functionality for silverstripe with the following features:

 * Article full text search with as-you-type drop-down suggestions

 * Article categorisation

 * Ajax powered article rating system (star system) which can be easily turned off

There is nothing really special about this, but it gives you everything you need

to build a simple knowledge base.

This module has been tested to work (and look terrible) out of the box with the

2.4 blackcandy theme installed; Other themes will require an additional subtheme.

## Credits and Authors

 * Damian Mooyman - 

## Requirements

 * SilverStripe 2.4.7, may work on lower versions

 * PHP 5.2

## Installation Instructions

 * Extract all files into the 'knowledgebase' folder under your Silverstripe root.

 * Template away!

## General housekeeping

 * The knowledge base is designed to operate in a hierarchy similar to the below:

 * Knowledge Base root page

  * Category 1

		* Article

		* Category 1.1

			* Article

		* Category 1.2

			* Article

	* Category 2

		* Article

If you want to arrange your knowledge base into a slightly different structure 

(for instance, without categories) you may need to do a bit of re-coding. Submit 

a feature request if it doesn't work the way you want or expected it to.

## Options

You can disable ratings by using the following code in your _config.php

```php

KnowledgeBaseArticle::$rating_enabled = false;

```