saba/README.md

46 lines
1.9 KiB
Markdown

# README
[![Release](https://img.shields.io/badge/release-2023.10.20-a2cbe9.svg)](https://git.dotclear.watch/JcDenis/saba/releases)
![Date](https://img.shields.io/badge/date-2023.10.20-c44d58.svg)
[![Dotclear](https://img.shields.io/badge/dotclear-v2.28-137bbb.svg)](https://fr.dotclear.org/download)
[![Dotaddict](https://img.shields.io/badge/dotaddict-official-9ac123.svg)](https://plugins.dotaddict.org/dc2/details/saba)
[![License](https://img.shields.io/badge/license-GPL--2.0-ececec.svg)](https://git.dotclear.watch/JcDenis/saba/src/branch/master/LICENSE)
## ABOUT
_saba_ is a plugin for the open-source web publishing software called [Dotclear](https://www.dotclear.org).
> Replace public search page and 404 page by a custom page that
show related entries to visitor.
## REQUIREMENTS
* Dotclear 2.28
* PHP 8.1
* Custom templates if default theme is not used.
* Dotclear administrator permissions
## 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](https://git.dotclear.watch/JcDenis/saba/src/branch/master/LICENSE)
* [Packages & details](https://git.dotclear.watch/JcDenis/saba/releases) (or on [Dotaddict](https://plugins.dotaddict.org/dc2/details/saba))
* [Sources & contributions](https://git.dotclear.watch/JcDenis/saba) (or on [GitHub](https://github.com/JcDenis/saba))
* [Issues & security](https://git.dotclear.watch/JcDenis/saba/issues) (or on [GitHub](https://github.com/JcDenis/saba/issues))
## CONTRIBUTORS
* Jean-Christian Denis (author)
You are welcome to contribute to this code.