saba/README.md

# README

[![Release](https://img.shields.io/github/v/release/JcDenis/saba)](https://github.com/JcDenis/saba/releases)
[![Date](https://img.shields.io/github/release-date/JcDenis/saba)](https://github.com/JcDenis/saba/releases)
[![Issues](https://img.shields.io/github/issues/JcDenis/saba)](https://github.com/JcDenis/saba/issues)
[![Dotclear](https://img.shields.io/badge/dotclear-v2.26-blue.svg)](https://fr.dotclear.org/download)
[![Dotaddict](https://img.shields.io/badge/dotaddict-official-green.svg)](https://plugins.dotaddict.org/dc2/details/saba)
[![License](https://img.shields.io/github/license/JcDenis/saba)](https://github.com/JcDenis/saba/blob/master/LICENSE)

## WHAT IS SABA ?

saba : Search Across Blog's Archive is a plugins for the open-source 
web publishing software called Dotclear.

It replaces public search page and 404 page by a custom page that 
show related entries to visitor.

## REQUIREMENTS

 saba requires: 

  * administrator permissions
  * Dotclear 2.26
  * Custom templates if default theme is not used.

## USAGE

First install saba, mannualy from a zip package or from 
Dotaddict repository. (See Dotclear's documentation to know how do this)

Go to ''Blog preference'', active plugin saba for search and 404,
go to ''Widgets'', add and configure ''Advanced search'' widget.

If you use a custom theme (not Dotclear's default theme) 
you must create custom templates that match yours. 
You can find exemple in plugins/saba/default-tempaltes.

## MORE

 * License : [GNU GPL v2](https://www.gnu.org/licenses/old-licenses/lgpl-2.0.html)
 * Source & contribution : [GitHub Page](https://github.com/JcDenis/saba)
 * Packages & details : [Dotaddict Page](https://plugins.dotaddict.org/dc2/details/saba)

## CONTRIBUTORS

 * Jean-Christian Denis

 You are welcome to contribute to this code.