periodical/README.md

58 lines
2.2 KiB
Markdown

# README
[![Release](https://img.shields.io/github/v/release/JcDenis/periodical)](https://github.com/JcDenis/periodical/releases)
[![Date](https://img.shields.io/github/release-date/JcDenis/periodical)](https://github.com/JcDenis/periodical/releases)
[![Issues](https://img.shields.io/github/issues/JcDenis/periodical)](https://github.com/JcDenis/periodical/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/periodical)
[![License](https://img.shields.io/github/license/JcDenis/periodical)](https://github.com/JcDenis/periodical/blob/master/LICENSE)
## WHAT IS PERIODICAL ?
_Periodical_ is a plugin for the open-source
web publishing software called Dotclear.
You can manage and publish automatically lists of posts
at regular periods. For exemple, you just need to add posts to a period
and they will be publish ones after the others every week.
## REQUIREMENTS
_periodical_ requires:
* admin permissions to configure plugin
* usage,contentadmin permissions to link feeds
* Dotclear 2.26
* PHP >= 8.1
## NOTICE
This plugin creates a new table on Dotclear database !
## USAGE
First install _periodical_, manualy from a zip package or from
Dotaddict repository. (See Dotclear's documentation to know how do this)
Main settings are accessible from blog preference page.
When enabled you have a menu in main sidebar menu called _Periodical_
under "Plugins" group, follow it to manage periods.
When you edit a post you have a new sidebar option called _Periodical_
to link this post to a period.
You can also add or remove period to multiple posts from posts actions page.
## LINKS
* License : [GNU GPL v2](https://www.gnu.org/licenses/old-licenses/lgpl-2.0.html)
* Source & contribution : [GitHub Page](https://github.com/JcDenis/periodical)
* Packages & details : [Dotaddict Page](https://plugins.dotaddict.org/dc2/details/periodical)
* Discuss & help : [Dotclear Forum](https://forum.dotclear.org/viewtopic.php?id=42289)
## CONTRIBUTORS
* Jean-Christian Denis
You are welcome to contribute to this code.