cmb69 / twocents_xh

Comment plugin for CMSimple_XH

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Twocents_XH – User Manual

Twocents_XH allows your visitors to add their two cents. ;) You can use it as a general commenting possibility on multiple pages, or as a guestbook on a single page, or both, and it can be used as comments plugin for Realblog_XH. As markup language a minimal subset of HTML is optionally available, which can be entered with a simple WYSIWYG editor.

Optionally you can enable comment moderation (i.e. comments will not be published automatically), be notified about new comments via email, and you can add spam prevention by using a conforming CAPTCHA plugin and a simple bad-word list.

Requirements

Twocents_XH is a plugin for CMSimple_XH. It requires CMSimple_XH ≥ 1.7.0, and PHP ≥ 7.1.0 with the JSON extension installed.

Download

The lastest release is available for download on Github.

Installation

The installation is done as with many other CMSimple_XH plugins. See the CMSimple_XH Wiki for further details.

  1. Backup the data on your server.

  2. Unzip the distribution on your computer.

  3. Upload the whole directory twocents/ to your server into the plugins/ directory of CMSimple_XH.

  4. Set write permissions for the subdirectories cache/, css/, config/ and languages/.

  5. Navigate to PluginsTwocents and check if all requirements are fulfilled.

Settings

The configuration of the plugin is done as with many other CMSimple_XH plugins in back-end of the Website. Select PluginsTwocents.

You can change the default settings of Twocents_XH under Config. Hints for the options will be displayed when hovering over the help icon with your mouse.

Localization is done under Language. You can translate the character strings to your own language (if there is no appropriate language file available), or customize them according to your needs.

The look of Twocents_XH can be customized under Stylesheet.

Usage

To place a comment facility on a page, write:

{{{twocents('%TOPICNAME%')}}}

%TOPICNAME% can be an arbitrary name, but it may contain only the letters a-z, the digits 0-9 and hyphens (-). The topicname is not necessarily related to the page heading; in fact it is just the name of a file that is stored in the subdirectory twocents/ of the content/ folder of CMSimple_XH. If you like you can display the comments for the same topic on different pages.

Some examples:

{{{twocents('guestbook')}}}
{{{twocents('article-1')}}}

To mark a certain topic as read-only, so that only the administrator is able to add comments, pass true as second argument to the function, for instance:

{{{twocents('archived', true}}}

Note that there must be at most one call of twocents on a single page.

You can configure the very simplistic spam protection in the language settings under SpamWords which a list of comma separated words. If any of these words are contained in the message (the actual case of the letters doesn't matter), the comment will automatically be hidden.

Administration

The administration of the comments happens on the pages where the comments are displayed. When you are logged in as administrator, you will see buttons to edit, hide/show and delete each comment.

In the plugin administration area you can convert existing comments from and to HTML, respectively, depending on the setting of the configuration option CommentsMarkup. Note that it is best to do this only when the site is in maintenance mode, and that you have to change this configuration option after the conversion.

Furthermore there is the possibility to import comments from the Comments and GBook plugins. To use this, you have to copy the data files of the Comments or GBook plugin into the data folder of Twocents_XH (which is the subfolder twocents/ of the content/ folder of CMSimple_XH). Note that some of the information will be ignored, e.g. the IP address and the uploaded image, as well as the markup when Twocents_XH is in plain text mode.

Limitations

Currently, posting comments from very old browsers such as IE 6 and IE 7 is not possible; the form submission will silently fail.

Troubleshooting

Report bugs and ask for support either on Github or in the CMSimple_XH Forum.

License

Twocents_XH is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.

Twocents_XH is distributed in the hope that it will be useful, but without any warranty; without even the implied warranty of merchantibility or fitness for a particular purpose. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with Twocents_XH. If not, see https://www.gnu.org/licenses/.

Copyright © 2014-2023 Christoph M. Becker

Credits

Twocents_XH uses HTML Purifier. Many thanks for publishing this great tool under LGPL.

The plugin logo has been designed by Alessandro Rei. Many thanks for publishing the icon under GPL.

Many thanks to the community at the CMSimple_XH Forum for tips, suggestions and testing. Special thanks to frase and lck for testing and valuable feedback.

And last but not least many thanks to Peter Harteg, the “father” of CMSimple, and all developers of CMSimple_XH without whom this amazing CMS would not exist.

About

Comment plugin for CMSimple_XH

License:GNU General Public License v3.0


Languages

Language:PHP 96.7%Language:HTML 3.2%Language:CSS 0.1%Language:JavaScript 0.0%