saba/README.md

46 lines
1.9 KiB
Markdown
Raw Normal View History

2021-08-21 20:12:28 +00:00
# README
2023-11-04 20:37:42 +00:00
[![Release](https://img.shields.io/badge/release-2023.11.04-a2cbe9.svg)](https://git.dotclear.watch/JcDenis/saba/releases)
![Date](https://img.shields.io/badge/date-2023.11.04-c44d58.svg)
2023-10-20 19:11:30 +00:00
[![Dotclear](https://img.shields.io/badge/dotclear-v2.28-137bbb.svg)](https://fr.dotclear.org/download)
2023-08-13 19:20:39 +00:00
[![Dotaddict](https://img.shields.io/badge/dotaddict-official-9ac123.svg)](https://plugins.dotaddict.org/dc2/details/saba)
2023-10-20 19:11:30 +00:00
[![License](https://img.shields.io/badge/license-GPL--2.0-ececec.svg)](https://git.dotclear.watch/JcDenis/saba/src/branch/master/LICENSE)
2022-11-20 20:57:33 +00:00
2023-10-20 19:11:30 +00:00
## ABOUT
2021-08-21 20:12:28 +00:00
2023-10-20 19:11:30 +00:00
_saba_ is a plugin for the open-source web publishing software called [Dotclear](https://www.dotclear.org).
2021-08-21 20:12:28 +00:00
2023-11-04 20:37:42 +00:00
> Replace public search page and 404 page by a custom page that show related entries to visitor.
2021-08-21 20:12:28 +00:00
## REQUIREMENTS
2023-10-20 19:11:30 +00:00
* Dotclear 2.28
* PHP 8.1
2023-08-13 19:20:39 +00:00
* Custom templates if default theme is not used.
2023-10-20 19:11:30 +00:00
* Dotclear administrator permissions
2021-08-21 20:12:28 +00:00
## 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.
2021-08-21 20:12:28 +00:00
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
2023-10-20 19:11:30 +00:00
* [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))
2022-11-20 20:57:33 +00:00
## CONTRIBUTORS
2023-10-20 19:11:30 +00:00
* Jean-Christian Denis (author)
2022-11-20 20:57:33 +00:00
2023-08-13 19:20:39 +00:00
You are welcome to contribute to this code.