SMF2.1:Smileys and Message Icons

Work in progress, expect frequent changes.

Please see SMF1.1:Smileys and Message Icons, SMF2.0:Smileys and Message Icons or SMF2.1:Smileys and Message Icons depending on the version of SMF you are using.

Smileys

With the rise of emojis in recent years, smileys are less prevalent in general, and are a less extensive feature of SMF, than they once were. While emojis are so closely tied to text, they almost are a special kind of text; smileys are purely graphic elements which can still be inserted into text, at least in software like SMF. Before 2.1, smiley files could only be GIF or PNG. But starting with 2.1, SVG can also be used to make smiley files.

In SMF, administrators can install as many sets of smileys as they like, giving their members a choice which set to use. Alternatively they may prefer to just provide their members with one set for everyone to use.

In Admin Center > Forum > Smileys and Message Icons there are six sub-menus or pages of options: Smiley Sets, Add Smiley, Edit Smileys, Set Smiley Order, Message Icons, and Settings.

Smiley Sets

Here on Admin Center > Forum > Smileys and Message Icons > Smiley Sets page, you will see a table listing of all the smiley sets that the administrator has installed on the forum.

Default - This is the far left column. A checkmark will appear beside the set the administrator has chosen as the forum's default. This is the set which will be shown to Guests, or non-logged-in members. If the administrator has not allowed members to choose their preferred set, everyone will see this set.
Name - This shows the name of the set.
URL - This shows the URL of the set.
Modify - This text link opens a small form where you can edit any of this data: Name, URL, or Default status. Be sure to click the Save button at the bottom right corner after you make your changes.
In the far right column are checkboxes. By checking a box, and clicking Delete Selected button, you can remove smiley sets.

Multiple Smiley Sets

Smiley sets can contain any number of smileys, but if multiple sets are allowed, they are configured according to two specific rules:

Smiley sets must display (in the message editor) the same kind of smileys. And
The same kind of smileys must have the same name.

For example, think of an imaginary forum that only offers three smileys - a happy, a sad, and an angry smiley. If the administrator offers more than one set, all the sets must have a happy, a sad, and an angry smiley. Note that the name referred to here, means the Tooltip or Description field, in the edit form -- not the filename.

If the sets are not configured according to these rules:

administrators will see new errors in the Error Log, whenever the smileys are used in messages; and
forum members may see either missing smileys in posted messages, or only the smiley code, instead of the graphic smiley image.

Note that the Admin Center automatically configures the two native smiley sets, Alienine's Set and Fugue's Set, according to these rules. But when administrators add new smileys, or new sets, they might need to manually configure them to meet these rules. See Add Smiley and Edit Smiley sections below.

Work in progress, expect frequent changes.

Installing New Smiley Sets

There are two ways to install new smiley sets. Administrators can either use the Package Manager, or upload it directly to their server.

Install a Smiley Set Using the Package Manager

The Package Manager can be used to install new smiley sets to the forum. This is the best way to install smiley sets which have been downloaded from the SMF Customization site, or other SMF sites. It works the same way as installing new modifications.

Smiley packages from SMF sites usually already meet the multiple set rules described in the Multiple Smiley Sets section, but not always. Administrators should double-check this after installing them. See the Enter Smiley Data section below, to learn how.

Upload a Smiley Set Directly to the Server

The other way to add a smiley set is to create a new directory inside the "Smileys" server directory. First, give it an appropriate name, like "blue_smiley_set", for example. Then upload all the actual graphic files (primarily PNG and/or GIF files, probably) into that directory.

Next, go to Admin Center > Smileys and Message Icons > Smiley Sets and click on the New Smiley Set button in the bottom right corner.

Name - Type a name for the set, which would likely be the same name that was given to the server directory, "blue_smiley_set" in this case.
URL - Click the dropdown menu and choose "blue_smiley_set".
Default Smiley Set - Check this box if this set is going to be the forum's default set.

Be sure to click the Save Changes button in the bottom right corner, when you finish.

This is the best way to install a custom set of smileys, which administrators may have compiled themselves. However, this technique may result in sets which do not meet the multiple sets rules, explained in the Multiple Smiley Sets section. Please see the next section, Enter Smiley Data, to learn how to configure them.

Enter Smiley Data

No matter which way the new smiley set has been installed, administrators should go next to Admin Center > Forum > Smileys and Message Icons > Edit Smileys and make sure all the individual data for each smiley is correct. The Admin Center is set up to configure smileys for the multiple sets rules, but you should always double-check. In any case, any of the smiley data can be edited here. Please see the Edit Smileys section for details.

On this page is a table containing all the individual smileys, and their unique data as described below. In the top right corner, be sure to select the newly installed set, or whichever set you need to edit. There are seven columns in this table.

The far left column has no title, but obviously is displaying the actual smiley graphics. You can edit any of the smiley's data by clicking on them, or by clicking Modify, five columns to the right.
Code - This column shows the combination of characters which will display the smiley when entered in the message editor.
Filename - This column gives the name of the smiley's file.
Location - This shows the location of the smiley. It can either be displayed in the message editor, or post form, More, or hidden. More is a small button in the row of smileys where they are displayed above the message editor. If all the smileys you have installed do not fit above the editor, you can put them in a popup window, which is activated by clicking the More button. Hidden means the smiley is installed, but cannot be used or even seen anywhere.
Tooltip or Description - This is the name of the smiley, which should match the equivalent smileys in all the other sets that are installed.
Modify - Click this text link if you want to edit any of the previous smiley data.
The last column on the right does not have a title, but contains checkboxes. This will allow you to edit the same data as the Modify text button, except you can edit more than one smiley at a time. In the bottom right corner is a dropdown menu titled With Selected. If you click on that, there are four choices for whichever smileys are checked:
- Make Hidden - This option hides the selected smileys but does not remove them.
- Show on Post Form - This option displays the selected smileys above the message editor.
- Show on Popup - This is the More button which is described above under Location. The selected smileys are displayed on the popup window.
- Remove - This removes the selected smileys from the forum.

Organize Smileys

At this point, administrators may also wish to set the order in which the smileys appear, in whichever place they have chosen for them to appear. On the Admin Center > Forum > Smileys and Message Icons > Set Smiley Order page, it is simple and intuitive to set the order. Please see Set Smiley Order for details.

Add Smiley

This page/sub-menu is displayed only if Enable customized smileys has been checked on the Settings page/sub-menu.

Generally, the Admin Center > Forum > Smileys and Message Icons > Add Smiley page allows administrators to install individual smileys, to sets which were previously uploaded. There are three ways to do it.

1. Install a smiley which has been previously uploaded, but never installed.

In the Image Source section, tick the Use Existing File option.
Click the Filename dropdown menu, and select the smiley you want to install. See the Preview to confirm you selected the right one.
In the Add a New Smiley section:
- Type a Code for the new smiley - This is the text code which will display a smiley in the message editor.
- Type a Tooltip or Description - This is the name which must be the same for equivalent smileys in different sets (all "sad" smileys, for example)
- From the dropdown menu, select the Location you want for this smiley. Post form or message editor; More is the button which opens a small popup window; and hidden means the smiley will not be displayed anywhere.
Click the Save Changes button when you finish all the settings.
Note that when you install a smiley in this manner, into one smiley set, it automatically is added to all other sets which may be in use.

2. Upload and install a new smiley to the server.

2A. Upload the same individual smiley to all smiley sets.
- In the Image Source section, tick the Upload New Smiley option.
- Leave the Same image for all sets box checked.
- For File to upload: Image to be used by all smiley sets. click the Browse button, and choose the smiley image file you want to upload.
- In the Add a New Smiley section:
  - Type a Code for the new smiley - This is the text code which will display this smiley in the message editor.
  - Type a Tooltip or Description - Whatever name you enter here will be applied to this smiley, in all the sets.
  - From the dropdown menu, select the Location you want for this smiley. Post form or message editor; More is the button which opens a small popup window; and hidden means the smiley will not be displayed anywhere.
- Click the Save Changes button when you finish all the settings.
2B. Upload different individual smileys to each smiley set. Note that even though these may be different smileys, they will all receive the same Code, Tooltip or Description Name, and Location.
- In the Image Source section, tick the Upload New Smiley option.
- Uncheck the Same image for all sets box.
- For File to upload click the Browse button for each set. You can upload different smileys or smiley files to each set.
- In the Add a New Smiley section:
  - Type a Code for the new smileys - This is the text code which will display these (possibly different) smileys in the message editor.
  - Type a Tooltip or Description - This name will apply to all these (possibly different) smileys.
  - From the dropdown menu, select the Location you want for these smileys. Post form or message editor; More is the button which opens a small popup window; and hidden means the smileys will not be displayed anywhere.
- Click the Save Changes button when you finish all the settings.

Whenever you add new smileys, make sure that they are configured so that they comply with the multiple sets rules.

**Page mostly updated to this point. Update in progress after this point**

Edit Smileys

This page/sub-menu is displayed only if Enable customized smileys has been checked on the Settings page/sub-menu.

This page allows adminstrators to easily edit any of the smiley data which has been previously entered. Find it: Admin Center > Forum > Smileys and Message Icons > Edit Smileys. Make sure that the multiple sets rules are followed, when editing smiley data.

The data is organized into tables, per smiley set. In the top right corner is a dropdown menu from which administrators can choose a set. There are seven columns in the table.

The first column has no title, but displays that actual smiley graphic. If you click on it, you can edit all the data for this smiley. See Modify below.
Code - This column shows the text code that displays each smiley in the message editor.
Filename - This column shows the name of each smiley's file - usually a PNG or GIF file.
Location - This column shows the Location which has been chosen for each smiley. Post form means the message editor; More is a small button which opens a small popup window, which can contain smileys that don't fit in the message editor; and Hidden means the smiley cannot be seen anywhere.
Tooltip or description - This column shows the name of the smiley. The equivalent smileys in each set share the same name.
Modify - This is a text link which opens a small form with which you can edit all the data for this smiley. Clicking on the smiley image in the first column opens the same form.
- Preview using smiley set - From the dropdown menu, choose which set you want to edit.
- Filename - Confirm that the correct file is selected from the relevant dropdown menu for the smiley you clicked to Modify. Or select another file. If you want to upload a new smiley, click the Browse button, and select a new smiley.
- Code - If you want to change the code for this smiley, type it here.
- Tooltip or Description - If you want to change the name of this smiley, type it here.
- Location - If you want to change where this smiley is displayed, change it here. See above to learn about different locations.
- When you finish all your changes, click the Save Changes button in the bottom right corner.
- If you want to delete a smiley from the forum, click the Delete Smiley button in the bottom right corner.
The last column is the checkboxes. This can save you a lot of time. You can perform the same action on more than one selected smiley, at once.
- Check the smileys on which you want to perform the same action.
- Click With Selected dropdown menu, in the bottom right corner of the table.
- Click on the action you want to perform:
  - Make hidden
  - Show on post form
  - Show on popup
  - Remove
- Note that whatever actions you perform on smileys in one set, is performed on the same smileys in all the sets.

Set Smiley Order

This page/sub-menu is displayed only if Enable customized smileys has been checked on the Settings page/sub-menu.

This small page, Admin Center > Forum > Smileys and Message Icons > Set Smiley Order, is simple and intuitive to use.

The Post Form section, shows all the installed smileys, in the same order that they appear in the message editor. Use the following steps to change their order:

Click on a smiley that you want to move. The next page that comes up shows the same display, except now it has down-pointing arrows between each smiley. In case you forgot, the smiley you clicked to move has a highlight of some kind (depending on you theme).
Click on the down-pointing arrows between the two smileys, where you want the highlighted smiley to remain. The next page that comes up shows the new order.
Continue until you have all the smileys in the order you like.

In the More section, you see the same thing, except it only shows the smileys which the administrator has chosen for the "More" button/popup window. It works the same way as the Post Form section.

Edit Message Icons

This button is visible only if Enable customized message icons has been checked in the Settings menu.

Viewing your message icons

The Edit Message Icons section is for managing your message icons on your forum.

You will see a six column table on this page. The first column shows the actual message icon image. The second column shows the filename of the message icon as the name you uploaded on to your server. The third column is the description of the message icon as you would see when hovering your mouse over a message icon. The fourth column shows the boards the message icon is in. Either it will say all boards, or a specific board you will find the icon. The fifth column shows a modify button so you can modify your message icons. The last column has a checkbox where you can remove the selected message icons by clicking the "Remove" button located at the bottom.

There is also an Add New Icon button alongside the Remove button. Selecting this enables the administrator to add more icons to those already available for messages. To add more icons you need to fill in the Filename and Tooltip or description as explained below.

Editing your message icons

When you click "Modify" next to any message icon you will see a page where you can see and edit the following:

Preview: Shows you the message icon your are currently editing.
Filename: The filename of the message icon, this needs to match a image uploaded on your server in Themes/default/images/Post
Tooltip or description: The description of your message icon. Which is what will show up when you hover your mouse over it.
Board: Either choose to allow members to use the message icon on every forum or just a specific board that you select from the dropdown.
Location: Pick the order you want the message icon to appear on the dropdown list on the post screen.

Settings

Groups allowed to manage smileys and message icons - Here it is possible to select the membergroups allowed to manage smileys and message icons.
Default Smiley Set - The set of smiley chosen from this drop-down list will be used as default smiley for the forum.
Enable smiley set selection by members - If selected the members will be able to change their set of smileys choosing from those available on the forum.
Enable customized smileys - Selecting this option it will be possible to set and use customized smileys different from those provided by default with SMF using the Add Smiley page.
Base URL to all smiley sets - The base URL for all the smiley sets.
Absolute path to all smiley sets - The base path where all the smiley sets are located. Each set then is stored in a separated subdirectory.
Enable customized message icons - Once selected it will be possible to add or remove message icons. The edit message icons option will not be visible unless this is checked.

As an administrator

Main

Configuration

Forum

Members

Maintenance

Miscellaneous

Navigation

Search

Tools