periodical/README.md

55 lines
2.2 KiB
Markdown

# README
[![Release](https://img.shields.io/badge/release-2023.11.04-a2cbe9.svg)](https://git.dotclear.watch/JcDenis/periodical/releases)
![Date](https://img.shields.io/badge/date-2023.11.04-c44d58.svg)
[![Dotclear](https://img.shields.io/badge/dotclear-v2.27-137bbb.svg)](https://fr.dotclear.org/download)
[![Dotaddict](https://img.shields.io/badge/dotaddict-official-9ac123.svg)](https://plugins.dotaddict.org/dc2/details/periodical)
[![License](https://img.shields.io/badge/license-GPL--2.0-ececec.svg)](https://git.dotclear.watch/JcDenis/periodical/src/branch/master/LICENSE)
## ABOUT
_periodical_ is a plugin for the open-source web publishing software called [Dotclear](https://www.dotclear.org).
> 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
* Dotclear 2.28
* PHP 8.1+
* Dotclear admin permissions to configure plugin
* Dotclear usage,contentadmin permissions to link feeds
## 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](https://git.dotclear.watch/JcDenis/periodical/src/branch/master/LICENSE)
* [Packages & details](https://git.dotclear.watch/JcDenis/periodical/releases) (or on [Dotaddict](https://plugins.dotaddict.org/dc2/details/periodical))
* [Sources & contributions](https://git.dotclear.watch/JcDenis/periodical) (or on [GitHub](https://github.com/JcDenis/periodical))
* [Issues & security](https://git.dotclear.watch/JcDenis/periodical/issues) (or on [GitHub](https://github.com/JcDenis/periodical/issues))
* [Discuss & help](https://forum.dotclear.org/viewtopic.php?id=42289)
## CONTRIBUTORS
* Jean-Christian Denis (author)
You are welcome to contribute to this code.