gb - some better readme linebreaks

This commit is contained in:
Ian 2013-09-05 10:59:34 +02:00
parent 11617703e3
commit 30675ecb3f
3 changed files with 52 additions and 49 deletions

View file

@ -84,7 +84,7 @@
* erased moderate option in sidebar plugin, which came with v.3.21, while sidebar now extends event plugin option setting.
* rebuild sidebar <serendipity_plugin_guestbook> to support event plugins 'auto-moderation' and 'showapp option' changes.
* added lang constant in <en>, <de> and <de-utf8>.
* added new config option to allow entry set auto-moderate via spamblock plugin, if its wordfilter option is activ and set to 'moderate'.
* added new config option to allow entry set auto-moderate via spamblock plugin, if its wordfilter option is active and set to 'moderate'.
* corrected small typo in german lang files.
* tweaked some small issues in guestbook CSS file.
* added spamblock return 'moderate_comments' value, to support adding entries to non-approved; this extends guestbooks config setting.

View file

@ -1,8 +1,8 @@
/******************************************************************************
* serendipty_event_guestbook.php, README, last modified 2013-08-27 *
* if you have a interesting hack or want to help, *
* serendipty_event_guestbook.php, README, last modified 2013-08-28 *
* If you have a interesting hack or want to help, *
* please leave a message in http://www.s9y.org/forums/ *
* have fun! Ian *
* Have fun! Ian *
******************************************************************************/
PLEASE NOTE
@ -35,7 +35,7 @@ S9Y :: GUESTBOOK :: CONFIG SETTINGS
* The 'Approve entries' defines the guestbook entries to be verified by admin in general,
before they show up in frontend (default: false).
* The 'Auto-moderate' defines the same behaviour for a single entry, if the SPAMBLOCK-plugin
wordfilter option is activ and set to 'moderate', caused by stopword matches (default: false).
wordfilter option is active and set to 'moderate', caused by stopword matches (default: false).
The guestbook content evaluation will still return captcha checking, if any spam check
evaluates true. This differs from normal spamblock behaviour!
* The 'Entry checks' sets an active and individual guestbook wordfilter array (default: pre-filled).
@ -46,29 +46,31 @@ S9Y :: GUESTBOOK :: CONFIG SETTINGS
S9Y :: GUESTBOOK :: ADMINISTRATION
* Backend and frontend administration is possible, if logged in. The frontend administration allows
purging entries only, but will ask you to proceed. No frontend administration.
* The backend sidebar has a new link to administer the guestbook. There are 4 main points to show up:
1. view approved entries,
2. view unapproved entries (if 'Approve entries' is set to true),
3. edit or insert an entry,
4. the database section.
* The administration area is in backend only.
* The backend sidebar carries a link to administer the guestbook. There are 4 main points to show up:
- view approved entries,
- view unapproved entries (if 'Approve entries' is set to true),
- edit or insert an entry,
- the database section.
* Each of the first 2, have the ability to (confirm), erase (immediately!), or re-edit a single entry
* The database section will allow: backup & download, or purge the SQL table instantly. (Be careful!)
* A link to SQL insert is shown, but not active, since this isn't trivial enough by now.
S9Y :: GUESTBOOK :: DESIGN
* All smarty tpls, images and the one main stylesheet of this plugin are located in the plugin folder
* All smarty tpls, images and stylesheets of this plugin are located in the plugin folder
and remain to stay there.
* If you are skilled and wish to have an individual frontend design, copy these files to your
template ( plugin_guestbook_entries.tpl, plugin_guestbook_form.tpl, style_guestbook_frontend.css ).
* If you are skilled and wish to have an personal frontend design, copy these files to your template
( plugin_guestbook_entries.tpl, plugin_guestbook_form.tpl, style_guestbook_frontend.css ).
* For changing the frontend entry background colors only, copy these neutral white css directives:
/* styles guestbook entry colors neutral */
/* the entry headline */ .guestbook_entrytop { background:none repeat scroll 0 0 #FFF; }
/* the entry background color */ .guestbook_entrybottom { background:none repeat scroll 0 0 #FFF; }
/* admin comment line */ span.guestbook_admin_comment { background:none repeat scroll 0 0 #FFF; }
/* the bottom shadow line */
/* the entry headline */
.guestbook_entrytop { background:none repeat scroll 0 0 #FFF; }
/* the entry background color */
.guestbook_entrybottom { background:none repeat scroll 0 0 #FFF; }
/* admin comment line */
span.guestbook_admin_comment { background:none repeat scroll 0 0 #FFF; }
/* the bottom shadow line */
#guestbook_entrybundle { -moz-border-radius: 0 0; background:none repeat scroll 0 0 #FFF; }
to the end of your templates user.css file, if you have one (suggested approach!).
In the other case copy the style_guestbook_frontend.css file to your template folder,
@ -84,9 +86,10 @@ S9Y :: GUESTBOOK :: DESIGN
#guestbook_entrybundle .guestbook_admin_comment blockquote p,
#guestbook_entrybundle .guestbook_admin_comment blockquote p q { color: #000; }
for a black text color (#000).
* No space between frontend entry blocks?
Add: .guestbook_splitentries { display: none; visibility: hidden; }
* The Intro, if set in config, can be modified with: #guestbook_wrapper .guestbook_intro {
* No space between frontend entry blocks? Add:
.guestbook_splitentries { display: none; visibility: hidden; }
* The Intro, if set in config, can be modified with:
#guestbook_wrapper .guestbook_intro {
padding: 0 none; text-align: left; border: 0 none; background:none repeat scroll 0 0 #FFF; }
* You can find a nice list of available web colours here: http://www.wackerart.de/rgbfarben.html.
Happy designing!
@ -205,7 +208,7 @@ NOT RELEASED | Version 3.xx [ 2013-00-00 ] |
and 'showapp option' changes.
* added lang constant in <en>, <de> and <de-utf8>
* added new config option to allow entry set auto-moderate via spamblock plugin, if its
wordfilter option is activ and set to 'moderate'
wordfilter option is active and set to 'moderate'
* corrected small typo in german lang files
* tweaked some small issues in guestbook CSS file
* added spamblock return 'moderate_comments' value, to support adding entries to non-approved;
@ -264,10 +267,10 @@ NOT RELEASED | Version 3.xx [ 2013-00-00 ] |
* Updated Serendipity guestbook sidebar plugin to select these entries only to v.1.12.
* Changed and added lang constants. The lang files <en>, <de> and <de-utf8> are now up to date.
* Some small tweaks to both of the frontend tpls and some more to the stylesheet.
* Some small tweaks to the frontend paginator and the url building, to be more friendly to mod_rewrite
setting via permalink or subpage.
* This upgrade may effect individual design settings. Please make sure to have a look to your frontend
tpls and the stylesheet!
* Some small tweaks to the frontend paginator and the url building, to be more friendly to
mod_rewrite setting via permalink or subpage.
* This upgrade may effect individual design settings. Please make sure to have a look to your
frontend tpls and the stylesheet!
-------------------------------------
@ -290,7 +293,7 @@ NOT RELEASED | Version 3.xx [ 2013-00-00 ] |
* Deleted the very old 'plugin_guestbook.tpl' file: this confuses newbies. Please do the same!
* button_background.png and shorttime.gif belong into plugins img folder.
* Please delete them in plugin folder to not confuse anybody.
* Added a blank.gif and a info.gif, which actually is the config help picture, into plugins img folder.
* Added blank.gif and info.gif, which is the config help picture, into plugins img folder.
* Changed plugin_guestbook_form.tpl.
* make use of the new smarty vars
@ -318,11 +321,11 @@ NOT RELEASED | Version 3.xx [ 2013-00-00 ] |
* One extra dynamic field added (dyn).
* I don't think there is any need to use mgroeninger's excellent dynamic function from contactform.
* In order to make things more configurable, these vars were changed or added (see also the lang files):
* In order to make things more configurable, these vars were changed or added (see lang files):
* 'headline' staticpage headline on top of page, by Garvin (v. 2.7).
* 'intro' is used for free additional text entry on top of guestbook page.
* 'pageurl' now called permalink, while pagetitle is used as the original (1.x) pageurl and for
staticpage_pagetitle, see below. (Sounds a bit messy, I know, but this is more straight!)
staticpage_pagetitle, see below. (Sounds messy, I know, but this is more straight!)
* 'pagetitle' is used in staticpages and other templates and defines the URL of the page
'index.php?serendipity[subpage]=name'.
* 'formorder' decide to have form appear first, default is form at end of entries.
@ -332,10 +335,10 @@ NOT RELEASED | Version 3.xx [ 2013-00-00 ] |
* 'showdynfield' this is a basic dynamic field as a mysql varchar(100) field.
Use with a input field in plugin_guestbook_form.tpl
and as a text output in plugin_guestbook_entries.tpl.
I tried it with a tinyblob field, but it is not a very good idea
to store binary data in databases, and so I came back to this small input text field.
If you want to change this field with another label name, set config dynfield to the
new name and submit.
I tried it with a tinyblob field, but it is not a very good idea to store
binary data in databases, and so I came back to this small input text field.
If you want to change this field with another label name, set config dynfield
to the new name and submit.
* Fixed a small bug in paginator function.
* General code clean up and moved things around. More documented code.
* Now this really is a fully template version (99.9% ;-)).
@ -356,15 +359,15 @@ NOT RELEASED | Version 3.xx [ 2013-00-00 ] |
| Version 2.0 to 2.4 - 2006-10-06 |
-------------------------------------
* Some link generation changes to function generate_EntriesPage() to make it work with/without mode_rewrite
* Some link generation changes to generate_EntriesPage() to make it work with/without mode_rewrite
* Entries SQL query and show now execute only when user is in 'entries view' or 'entry done' mode
* Guestbookform tpl action url is now: $serendipity['baseURL'] . $serendipity['indexFile'] . '#entry'
* Changed sidebar serendipity_event_staticpage.php to be compatible to guestbook 2.0 version too (code1).
* Changed sidebar serendipity_event_staticpage.php to be compat to guestbook 2.0 version too (code1).
In case you allready used this plugin to show a link to the guestbook plugin in your sidebar,
please go into admin panel, go to static pages, and say yes again to show guestbook plugin.
Doing this, changes to code will take effect.
* Made sidebar serendipity_plugin_guestbook work with 2.0 version only
* Target admin mail address should now be compat to old guestbook version 1.38, just one targetmail used
* Target admin mail address should now be compat to old guestbook v.1.38, just one targetmail used
* Markup config var makes tpl based entries output get parsed through S9y standard text formatting
and converting standard smilies
* Change old guestbook table now works for MySql (only?)
@ -374,7 +377,7 @@ NOT RELEASED | Version 3.xx [ 2013-00-00 ] |
* Generell clean up and messages tweaks.
* Now serendipity_event_guestbook is nearly full template based (see plugin_guestbook_entries.tpl
and plugin_guestbook_form.tpl)
* You will find images shorttime.gif, button_background.png and delete.png in $this_plugin/img dir now.
* You will find images shorttime.gif, button_background.png and delete.png in $this_plugin/img dir
* Change css (style_guestbook_backend.css) and template files to your needs
* Please check other lang files - actualy only <en>, <de> and <de-utf8> will work!
* Permalink ("pageurl") is a full path from http root eg. "/serendipity/pages/guestbook.html"

View file

@ -34,7 +34,7 @@
<body>
<div><a name="top" id="top"></a></div>
<div id="wrapper">
<div class="doc_edited">serendipity_event_guestbook/documentation_en.html, last modified 2013-08-25</div>
<div class="doc_edited">serendipity_event_guestbook/documentation_en.html, last modified 2013-08-28</div>
<div class="doc_block"><span class="white">PLEASE NOTE</span><br />
<br />
This Serendipity guestbook plugin is TEMPLATE based, configurable by its own stylesheet, has a FRONTEND and a BACKEND.<br />
@ -61,7 +61,7 @@
<li>The <span class="eye">'Show Captchas'</span> defines the use of Serendipity CAPTCHAS (requires Spamblock plugin activated) to prevent comment SPAM (<em>default: yes</em>).</li>
<li>The <span class="eye">'User Homepage'</span> defines a form field for the homepage of the user (<em>default: false</em>).</li>
<li>The <span class="eye">'Approve entries'</span> defines the guestbook entries to be verified by admin generally before they show up in frontend (<em>default: false</em>).</li>
<li>The <span class="eye">'Auto-moderate'</span> defines the same behaviour for a single entry, if the SPAMBLOCK-plugin wordfilter option is activ and set to 'moderate', caused by stopword matches (<em>default: false</em>). The guestbook content evaluation will still return captcha checking, if any spam check evaluates true. This differs from normal spamblock behaviour!</li>
<li>The <span class="eye">'Auto-moderate'</span> defines the same behaviour for a single entry, if the SPAMBLOCK-plugin wordfilter option is active and set to 'moderate', caused by stopword matches (<em>default: false</em>). The guestbook content evaluation will still return captcha checking, if any spam check evaluates true. This differs from normal spamblock behaviour!</li>
<li>The <span class="eye">'Entry checks'</span> sets an active and individual wordfilter array (<em>default: pre-filled</em>). Regular Expressions are allowed, separate strings by semicolons (;). You have to escape special chars with "\". If you leave this field empty, no special checks are done. This check is bypassed for users with USERLEVEL_ADMIN only!</li>
<li>The <span class="eye">'Date format'</span> defines an individual strftime() code for the entry datetime (<em>default: %a, %d.%m.%Y %H:%M</em>).</li>
</ul>
@ -69,12 +69,12 @@
<div class="skip"><a href="#top">Top</a></div>
<div class="readme_title">S9Y :: GUESTBOOK :: ADMINISTRATION</div>
<ul class="readme administration">
<li>Backend and frontend administration is possible, if logged in. The frontend administration allows erasing entries only, but will ask you to proceed.<br />Frontend administration got removed with 3.24 version.</li>
<li>The backend sidebar has a new link to administer the guestbook. There are 4 main points to show up:<br />
1. &nbsp; view approved entries,<br />
2. &nbsp; view unapproved entries (if <span class="eye">'Approve entries'</span> is set to true),<br />
3. &nbsp; edit or insert an entry,<br />
4. &nbsp; the database section.</li>
<li>The administration area is in backend only.</li>
<li>The backend sidebar carries a link to administer the guestbook. There are 4 main points to show up:<br />
- &nbsp; view approved entries,<br />
- &nbsp; view unapproved entries (if <span class="eye">'Approve entries'</span> is set to true),<br />
- &nbsp; edit or insert an entry,<br />
- &nbsp; the database section.</li>
<li>Each of the first two, have the ability to (confirm,) erase (immediately!), or re-edit a single entry.</li>
<li>The database section will allow: backup and download the plugin database table, or erase the SQL table instantly. Be careful working here!</li>
<li>A link to SQL insert is shown, but not active, since this isn't trivial enough by now.</li>
@ -83,8 +83,8 @@
<div class="skip"><a href="#top">Top</a></div>
<div class="readme_title">S9Y :: GUESTBOOK :: DESIGN</div>
<ul class="readme design">
<li>All smarty tpls, images and the one main stylesheet of this plugin are located in the plugin folder and remain to stay there.</li>
<li>If you are skilled and wish to have an individual frontend design, copy the files to change to your template folder only<br />
<li>All smarty tpls, images and stylesheets of this plugin are located in the plugin folder and remain to stay there.</li>
<li>If you are skilled and wish to have a personal frontend design, copy the files to change to your template folder:<br />
( plugin_guestbook_entries.tpl, plugin_guestbook_form.tpl, style_guestbook_frontend.css ).</li>
<li>In case you wish to change the <span class="eye">frontend entry background colors</span> only, copy these neutral white css directives:<br />
<span class="cssblock"><em>/* styles guestbook entry colors neutral */</em><br />
@ -189,7 +189,7 @@
<li>erased moderate option in sidebar plugin, which came with v.3.21, while sidebar now extends event plugin option setting.</li>
<li>rebuild sidebar &lt;serendipity_plugin_guestbook&gt; to support event plugins 'auto-moderation' and 'showapp option' changes.</li>
<li>added lang constant in &lt;en&gt;, &lt;de&gt; and &lt;de-utf8&gt;.</li>
<li>added new config option to allow entry set auto-moderate via spamblock plugin, if its wordfilter option is activ and set to 'moderate'.</li>
<li>added new config option to allow entry set auto-moderate via spamblock plugin, if its wordfilter option is active and set to 'moderate'.</li>
<li>corrected small typo in german lang files.</li>
<li>tweaked some small issues in guestbook CSS file.</li>
<li>added spamblock return 'moderate_comments' value, to support adding entries to non-approved; this extends guestbooks config setting.</li>