Event triggered when a new Guestbook entry is added.

Parameters

• entry_id - The entry id (int)
• entry_sender - The name the sender entered (string)
• entry_email - The E-mail address entered (string)
• entry_homepage - The homepage entered (string)
• entry_message - The message entered (string)
• entry_country - The country entered (string)
• entry_location - The location entered (string)
• entry_date - The post date (string)
• entry_approved - Whether the entry is activated at once, 1 if it is, -1 if not (int)

Parameters

• id - Viestin id (int)

Parameters

• entry_id - The entry id (int)

Parametrit

• id - Viestin id (int)

What does it do?

The guestbook module is a content module and a CMSMS tagmodule. It gives visitors the ability to leave a message, for example about how they like the website.

Security

The user must belong to a group with the 'Modify Guestbook Entries' permission in order to add, edit, or delete guestbook entries.
In order to be able to modify the guestbook entry template, 'Modify Guestbook Template' permission is required.

How do I use it?

The easiest way is to create a new page and change the "Content Type" to Guestbook. This way you will be able to set the guestbook options as page properties.
If you want to add the module after some other content you can insert it using the cms_module tag. This will insert the guestbook into your template/page anywhere you wish.
The code would look something like: {cms_module module="Guestbook" number="5" shownow="1" smiley="1"}

What Parameters Exist?

• (optional) textleng="1000" - Sets how many characters can be entered. The default is 1000 characters. This parameter affects both server-side and client-side validation.
• (optional) number="10" - Maximum number of entries on a page. Leaving it empty will show 10 entries
• (optional) mailnoti="youremail@example.com" - E-mail address to send a notification to if a message was submitted
• (optional) sortasc="1" - Sort guestbook items in ascending date order (new posts will go to the end).
• (optional) dateformat="dateformat" - Change the way the Date will display, it takes the MySQL format codes
• (optional) shownow="1" - Shows messages right after submission, without approval by an admin.
• (optional) smiley="1" - Translate text-based smileys to image smileys and shows the smiley table on the entry submit form.
• (optional) showaddform="1" - Shows the insert form on the first page. Replaces the "New Guestbook Entry" button.
• (optional) lang="xx_XX" - Custom locale. For example lang="de_DE".

What Design potentials are there?

The database template that is used to show a guestbook entry can be edited from the admin panel.

An example stylesheet for the default database template is installed with the module.
The default stylesheet is deleted when the module is uninstalled and may be overwitten by an upgrade, so you might want to use a copy if you modify it.
Attach the stylesheet to the page template used.

These variables are assigned in the guestbook entry template:

    date_title
    date
    time
    time_hour_title
    
    sender_title
    sender
    
    country
    
    e_mail_title
    e_mail
    
    homepage_title
    homepage
    
    message_title
    message
    

In the module directory there's a directory called templates where all other templates are stored. You can modify these to fit your needs:

admin_entries_top.tpl -> The paganition and row names for the entry list
admin_entries_entry.tpl -> The list of guestbook entries
admin_entries_bottom.tpl -> The bottom of the guestbook entries admin form
admin_entry.tpl-> The form used to insert or edit guestbook entries
admin_template_edit.tpl -> Used for editing the guestbook entry database template

newguest.tpl -> Button to go to the entry form
insertform.tpl -> The guestbook entry form
smiley.tpl -> The smiley table
prevnext.tpl -> The buttons to go to the previous and next pages (will show only if entries do not fit on one page)
success_message.tpl-> The message that will show in place of the insert form after successful post submission.

Inside the template directory there's a directory called db. This stores the guestbook entry template that is copied to the database during module installation and when the template is restored to default from the admin panel.
By default the file guestbook_entry-default.tpl is used, but if a (custom) file guestbook_entry.tpl is present, this file will be used instead.

Importing gastbuch messages

If you have one of the beta "gastbuch" module versions installed and want to import your guestbook messages into the Guestbook module, a script is available to do so. Simply point your browser to the file gastbuch-import.php in the module folder (for example: http://www.example.com/cms/modules/Guestbook/gastbuch-import.php) before uninstalling the old gastbuch module.

• Version 1.0

  • Renamed module (from gastbuch) to Guestbook to represent the projects natural language and follow CMS Made Simple module naming conventions.
  • Enabled handling (deleting, activating and deactivating) of multiple guestbook entries from the admin panel.
  • There are now seperate 'Modify Guestbook Entries' and 'Modify Guestbook Template' permissions.
  • A default/example stylesheet is installed (and uninstalled) with the module
  • The database template can be restored to default
  • Changed to tabbed navigation
  • Cleanup/rewrite of the guestbook(item) database template and the variables used in it.
  • Translated many variable names and code comments to english.
  • Moved some admin and log messages to the language file.
  • Re-formatted source code for better readability.

• Version 0.9

  • The guestbook frontend now uses a database template (in stead of the showmessage*.tpl files) that can be modified from the admin panel
  • The dateformat parameter is now called dateformat (was dateform). Note: this means you will have to recreate any guestbook content pages or manually edit the tables cms_content and cms_content_props
  • New french translation and modified translations for other languages from the translation center

• Version 0.8

  Fixed:
  • not working smileys on gastbuch Content page in version 0.7
  Cleanup:
  • mainly removal of unneccary references to the global $gCms
  • renamed email textfield to e_mail (it was called betreff, probably an old subject field)
  Improvements:
  • newly submitted newsentry is shown in the list
  • brackets around submitter country are no longer shown if a country wasn't entered
  • translated the lang file to dutch (except for help and changelog)
  • the gastbuch module now makes use of translations entered in the translation center translations.cmsmadesimple.org
  Changed:
  • The template variable name for the country in showmessage.tpl is now called $country (was $countryshow in previous versions)

• Version 0.7

  • Added lang attribute to support multiple locales
  • Show insert form on the first page
  • Fixed bug with textlength javascript not working
  • Fixed a few minor bugs

• Version 0.6

  • Redesigned source code for better readability
  • Added lang attribute to support multiple locales
  • Added showaddform parameter
  • Fixed bug with textlength javascript not working in case of "Content" content type
  • Merged vorzu and backzu templates into one
  • Added template success_message.tpl
  • Fixed a few minor bugs caused by mismatches in lang variable names

• Version 0.5

  The guestbook was modified with better design and functions, for example: Template based Content, Spam protection for inserted e-mails, etc.

• Version 0.4

  The gastbuch module is now a new module