107 lines
3.4 KiB
Markdown
107 lines
3.4 KiB
Markdown
# README
|
|
|
|
[](https://git.dotclear.watch/JcDenis/disclaimer/releases)
|
|
|
|
[](https://fr.dotclear.org/download)
|
|
[](https://plugins.dotaddict.org/dc2/details/disclaimer)
|
|
[](https://git.dotclear.watch/JcDenis/disclaimer/src/branch/master/LICENSE)
|
|
|
|
## ABOUT
|
|
|
|
_disclaimer_ is a plugin for the open-source web publishing software called [Dotclear](https://www.dotclear.org).
|
|
|
|
> It add a disclaimer to your blog entrance. This plugin is inspired from plugin "Private mode" by Osku.
|
|
|
|
## REQUIREMENTS
|
|
|
|
* Dotclear 2.28
|
|
* PHP 8.1+
|
|
* Dotclear admin permissions on blog
|
|
|
|
## USAGE
|
|
|
|
First install _disclaimer_, manualy from a zip package or from
|
|
Dotaddict repository. (See Dotclear's documentation to know how do this)
|
|
|
|
You can activate and setup _disclaimer_ from blog preferences page.
|
|
|
|
## LINKS
|
|
|
|
* [License](https://git.dotclear.watch/JcDenis/disclaimer/src/branch/master/LICENSE)
|
|
* [Packages & details](https://git.dotclear.watch/JcDenis/disclaimer/releases) (or on [Dotaddict](https://plugins.dotaddict.org/dc2/details/disclaimer))
|
|
* [Sources & contributions](https://git.dotclear.watch/JcDenis/disclaimer) (or on [GitHub](https://github.com/JcDenis/disclaimer))
|
|
* [Issues & security](https://git.dotclear.watch/JcDenis/disclaimer/issues) (or on [GitHub](https://github.com/JcDenis/disclaimer/issues))
|
|
* [Help & discuss](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)
|
|
|
|
### 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
|
|
"/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.
|
|
|
|
### 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.
|