EXT: HBook¶

Text parsing¶

The HBook automatically parses the entry text for common BBCode tags (like [B][/B] for bold printing and so on...) and substitutes them with the proper HTML tags. Smilies like :) or ;) are substituted with a proper image. The HBook also parses links and email addresses found in the entry text.

Security issues¶

The HBook offers several ways of spam protection. Any entry containing a word found on a specific black list is not saved at all. This black list contains common spam words like “sex”, “porn”, and so on. Furthermore, an entry can optionally be verified by a randomly generated verification code that has to be copied manually from an image into an input field during entry creation. The administrator can block single IP addresses for a certain amount of time.

HBook entries can be administrated either by backend users using the Typo3 proprietary forms or by frontend users using a specific page protected by the Typo3 frontend authentification.

Step 1: Listing all entries¶

Now the time has come to include the HBook into your website. Create a new page and insert a new content element. In the section “plugins” you will find the HBook plugin. You can now configure this HBook instance when editing this content record. At first, you should select 'List all entries' in the 'What to display' field in the 'General settings' section. In this setting the HBook will list all guestbook entries. You can change the sorting mode by changing the 'Order By' field in the 'Display' section.

Step 2: Creating new entries¶

Now you can list all guestbook entries that were ever submitted. But this makes sense only, if visitors can submit entries at all. For this, you can either add 'Create new entry' to the 'What to display' field in the record you created in step 1, or create a new page with a new content element and then set 'What to display' to 'Create new entry' there.

NOTE : If you create a new page for entry creation you have to tell the HBook where to store the guestbook entries. The best way is to create a SysFolder (create a new page and select 'SysFolder' as page type) and set the 'Entry storage page' in both plugin instances to this page.

Step 3: Editing entries¶

If you want to edit guestbook entries, you can either do this using the Typo3 proprietary backend forms (go to the entry storage page you propably specified in step 2, select 'List' and then select the HBook entry you want to edit). If you want certain frontend users (for example moderators on a bigger page) to have the right to edit guestbook entries without giving them backend access, you can create a new page with a new HBook instance. Here, you set 'What to display' to 'Edit entry'. Remember to set the 'Entry storage page'.

In the plugin displaying the entry list, you should now set the 'edit page' in the 'General settings' section to the page you just created.

To prevent every ordinary visitor from editing guestbook entries, you should restrict the access to this page to a certain group of fe_users.

General properties¶

Entry creation¶

The entry creation configuration can be accessed by plugin.tx_hbook_pi1.create

Entry listing¶

The entry listing configuration can be accessed by plugin.tx_hbook_pi1.display