disclaimer/README.md

112 lines
3.4 KiB
Markdown
Raw Normal View History

2015-04-22 15:25:24 +00:00
# README
2022-12-21 00:40:42 +00:00
[![Release](https://img.shields.io/github/v/release/JcDenis/disclaimer)](https://github.com/JcDenis/disclaimer/releases)
[![Date](https://img.shields.io/github/release-date/JcDenis/disclaimer)](https://github.com/JcDenis/disclaimer/releases)
[![Issues](https://img.shields.io/github/issues/JcDenis/disclaimer)](https://github.com/JcDenis/disclaimer/issues)
[![Dotclear](https://img.shields.io/badge/dotclear-v2.24-blue.svg)](https://fr.dotclear.org/download)
[![Dotaddict](https://img.shields.io/badge/dotaddict-official-green.svg)](https://plugins.dotaddict.org/dc2/details/disclaimer)
[![License](https://img.shields.io/github/license/JcDenis/disclaimer)](https://github.com/JcDenis/disclaimer/blob/master/LICENSE)
2022-12-21 10:16:30 +00:00
## WHAT IS DISCLAIMER ?
2015-04-22 15:25:24 +00:00
2022-12-21 10:16:30 +00:00
_disclaimer_ is a plugin for the open-source
web publishing software called Dotclear.
2015-04-22 15:25:24 +00:00
2022-12-21 10:16:30 +00:00
It add a disclaimer to your blog entrance.
2015-04-22 15:25:24 +00:00
2022-12-21 10:16:30 +00:00
This plugin is inspired from plugin "Private mode" by Osku.
2015-04-22 15:25:24 +00:00
2022-12-21 10:16:30 +00:00
## REQUIREMENTS
2015-04-22 15:25:24 +00:00
2022-12-21 10:16:30 +00:00
_disclaimer_ requires:
2015-04-22 15:25:24 +00:00
2022-12-21 10:16:30 +00:00
* admin permissions on blog
* Dotclear 2.24
2015-04-22 15:25:24 +00:00
2022-12-21 10:16:30 +00:00
## USAGE
2015-04-22 15:25:24 +00:00
2022-12-21 10:16:30 +00:00
First install _disclaimer_, manualy from a zip package or from
Dotaddict repository. (See Dotclear's documentation to know how do this)
2015-04-22 15:25:24 +00:00
2022-12-21 10:16:30 +00:00
You can activate and setup _disclaimer_ from blog preferences page.
2015-04-22 15:25:24 +00:00
2022-12-21 10:16:30 +00:00
## LINKS
2015-04-22 15:25:24 +00:00
2022-12-21 10:16:30 +00:00
* License : [GNU GPL v2](https://www.gnu.org/licenses/old-licenses/lgpl-2.0.html)
* Source & contribution : [GitHub Page](https://github.com/JcDenis/disclaimer)
* Packages & details : [Dotaddict Page](https://plugins.dotaddict.org/dc2/details/disclaimer)
* Help & discuss : [Dotclear forum](http://forum.dotclear.org/viewtopic.php?id=40000)
## CONTRIBUTORS
* Jean-Christian Denis (author)
* Pierre Van Glabeke
You are welcome to contribute to this code.
## HELP (in french)
2015-04-22 15:25:24 +00:00
### Paramètres
La configuration du plugin est situé dans
la rubrique "Disclaimer" de la page des paramètres du blog.
#### Activer le plugin
Permet d'activer ou non la page d'avertissement.
#### Se souvenir de l'utilisateur
Permet d'envoyer un cookie au visiteur pour qu'il n'ait pas
à revalider l'avertissement lors d'une visite ultérieure.
#### Titre
C'est le titre principale de la page d'avertissement.
#### Lien de sortie
Lien vers lequel sera renvoyé le visiteur s'il refuse les termes.
#### Avertissement
Texte principal de la page d'avertissement, cette page accepte le code html.
(sauf si l'attribut encode_html est actif dans les templates)
#### Liste des robots autorisés à indexer les pages du site
Liste des robots d'indexation séparés par un point-virgule.
Cela permet au robot utilisant ce user-agent de ne pas être bloqué par
le disclaimer.
#### Désactiver l'autorisation d'indexation par les moteurs de recherches
Permet de désactiver la fonction de recherche de user-agent et de rediriger
tous les user-agent vers le disclaimer.
### Templates
Le fichier de template par default pour la page d'avertissement
se situe dans le repertoire "/default-template/mustek/disclaimer.html" ou
2022-12-21 10:16:30 +00:00
"/default-template/dotty/disclaimer.html" du plugin.
Il sera utilisé par défaut, sinon il faut le copier
dans le repertoire /tpl de votre thème pour le modifier.
2015-04-22 15:25:24 +00:00
### Balises
Le plugin ajoute les balises de template suivantes :
#### DisclaimerTitle
Titre de l'avertissement.
#### DisclaimerText
Texte de l'avertissement.
#### DisclaimerFormURL
A mettre dans l'attribut "action" de la balise "form".
Ces balises supportent les attributs communs.