TetraBB.com Home of Tetra-WebBBS and TetraBB PRO

This document describes how to install and configure the Smiley Format Plugin version 2.10 or later.
Setup of older versions is similar, only they are not preconfigured to show icons on the formatting buttons.

Motivation

This plugin adds clickable smileys and/or format buttons to your message post-form.
Clickable smiley and Format button are independent of each other. You may enable either, both, or none of the two.

Requirements

• You must have a working installation of the forum scripts, at least Tetra-WebBBS 6.00 or later.
• You must have set up %SmileyCode and/or %FormatCode.

Installation

• Clickable Smileys
  To get clickable smileys working make sure you have defined %SmileyCode.
  At your option, define the appropriate variables in smiley_format.pl if you have a larger number of smileys and want to use the optional popup window for 'more smileys'.
• Formatting Buttons
  To get formatting buttons to work make sure you have defined %FormatCode.
  • Since version 2.10 this plugin comes with a basic set of icons for a nice display of the formatting buttons and is preconfigured to use these icons. Make sure to upload the '/plugins' folder found in the plugin's download package to the appropriate place on your server.
    Example: /public_html/webbbs/icons/plugins/red.png  is the default location for the 'red' formatting button.
  • To use the preconfigured formatting buttons,  you may use the following example to define %FormatCode in your settings.pl file.
    Note though: the last three pairs of lines in the example are commented because 'quotes', 'code' and 'image' tags may not be considered default formatting options. To use either of them simply remove the hash mark (#) to enable the appropriate format code and the preconfigured buttons.

    %FormatCode = (
        '[h1]'    => '<h1>',
        '[/h1]'   => '</h1>',
        '[h2]'    => '<h2>',
        '[/h2]'   => '</h2>',
        '[h3]'    => '<h3>',
        '[/h3]'   => '</h3>',
        '[b]'      => '<b>',
        '[/b]'     => '</b>',
        '[i]'       => '<em>',
        '[/i]'      => '</em>',
        '[u]'      => '<u>',
        '[/u]'     => '</u>',
        '[center]'  => '<div style="text-align:center;">',
        '[/center]' => '</div>',
        '[big]'   => '<big>',
        '[/big]'  => '</big>',
        '[small]'  => '<small>',
        '[/small]' => '</small>',
        '[green]'  => '<span class="green">',
        '[/green]' => '</span>',
        '[red]'   => '<span class="red">',
        '[/red]'  => '</span>',
        '[blue]'  => '<span class="blue">',
        '[/blue]' => '</span>',
        '[yh]'  => '<span class="highlight_yellow">',
        '[/yh]' => '</span>',
        # '[q]' => '<blockquote><div class="quote">',
        # '[/q]' => '</div></blockquote>',
        # '[code]'  => '<PRE>',
        # '[/code]' => '</PRE>',
        # '[img]'  => '<img class="refimg" src="',
        # '[/img]' => '" border="0" alt="">',
    );

• Plugin the script
  NOTE: Since 2.10 the download package for this plugin uses a folder structure similiar to the core scripts. - This is to simplify installation of this plugin proceedu for newbies:
  • Upload smiley_format.pl to the folder where all the forum script files reside.
  • In section (3) of the entry script (webbbs_config.pl or admin_config.pl) files that you want the plugin enabled, add:

    require  'smiley_format.pl';

Notes

1. As with the other webbbs scripts, you need only one copy of the smiley_format.pl for all your boards.
2. This plugin works only with these settings:

   $SepPostFormIndex = 1;
   $SepPostFormRead  = 1;

   If the 2 variables are not so set, the plugin script will redefine them.

History

Download

Latest download available here.