fac/README.md

49 lines
2.1 KiB
Markdown

# README
[![Release](https://img.shields.io/badge/release-1.5-a2cbe9.svg)](https://git.dotclear.watch/JcDenis/fac/releases)
![Date](https://img.shields.io/badge/date-2023.10.16-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/fac)
[![License](https://img.shields.io/badge/license-GPL--2.0-ececec.svg)](https://git.dotclear.watch/JcDenis/fac/src/branch/master/LICENSE)
## ABOUT
_fac_ is a plugin for the open-source web publishing software called [Dotclear](https://www.dotclear.org).
> Add options to the sidebar of post edition page to link en extenal feed to the bottom of an entry.
## REQUIREMENTS
* Dotclear 2.28
* PHP 8.1+
* A theme that contents behavior publicEntryAfterContent
* Dotclear superadmin to configure feeds formats
* Dotclear admin permissions to configure plugin
* Dotclear usage or contentadmin permissions to link feeds
## USAGE
First install _fac_, manualy from a zip package or from
Dotaddict repository. (See Dotclear's documentation to know how do this)
Superadmin can configure, add, remove feeds formats on plugins configuration.
Admin can configure fac activation et selected page where to display feeds.
When you edit a post you have a new sidebar menu called "Linked feed"
to link a feed to this post.
You can also add or remove feed to multiple post from posts actions page.
This plugins also supports pages from plugin "muppet".
## LINKS
* [License](https://git.dotclear.watch/JcDenis/fac/src/branch/master/LICENSE)
* [Packages & details](https://git.dotclear.watch/JcDenis/fac/releases) (or on [Dotaddict](https://plugins.dotaddict.org/dc2/details/fac))
* [Sources & contributions](https://git.dotclear.watch/JcDenis/fac) (or on [GitHub](https://github.com/JcDenis/fac))
* [Issues & security](https://git.dotclear.watch/JcDenis/fac/issues) (or on [GitHub](https://github.com/JcDenis/fac/issues))
## CONTRIBUTORS
* Jean-Christian Denis (author)
You are welcome to contribute to this code.