jfb-acp-dshoutbox [Jcink.com Wiki]

The D-Shoutbox

The shoutbox is an integrated mod that allows members to post quick messages without the need to reply to a topic. The shoutbox can be applied to each skin and moved around on the skin to allow the admin to decide where they want to put it. When applied to a skin, the shoutbox appears on every page. Though for users looking to see more info, they can always view the shoutbox's own page. (It's link is <yourforum>.b1.jcink.com/index.php?act=Shoutbox)

The Shoutbox, unlike most other mods starts off enabled on every Jcink forum.

Some of the features that the shoutbox has are:

  • Integrated with the forum (so word filters are carried over. See here how to add to the word filter.)
  • A separate ban system so users can be banned from shoutbox but not the forum.
  • A group permission system to allow admins to decide which groups can do what.
  • Ability to add/remove additional colors.
  • The ability to set the shoutbox's rules.
  • The ability to set the shoutbox to auto-refresh.
  • The ability to show user's avatars beside their shouts (when viewing the full page only.)
  • The ability to use BBcode in the shouts (including all custom BBcodes too. They must be typed in though.)
  • The ability to set a flood time to make it harder for spammers.
  • The shoutbox uses elements from the CSS so the shoutbox is styled along with your forum. (See the CSS guide for exact aspects.)

To disable the shoutbox completely

  1. On the left panel, click “Shoutbox” (This expands the shoutbox settings page so you can view them all.)
  2. Then click “Settings” (it is the second option.)
  3. In the right panel, look for: “Shoutbox Online?” set this to “No”
  4. Scroll to the bottom and click the “Save settings” button.
  5. Now, on the left panel again, click: “Skins & Templates”
  6. Then click “Board Wrappers”
  7. Now, on the right panel it will list every skin you have on your forum. Beside each of them is an “Edit” link. Click the link for the skin you want to remove it from.
  8. On the page that loads, look for a value of ”<% DSHOUTBOX %> ”… Remove that.
  9. Scroll to the bottom of the page and click the “Save changes” button.

Notes

  • You will have to repeat steps 6 through 9 for each skin that has the shoutbox enabled on it.
  • If you are using the “global bar manager” to configure your navigation bar, then you will have to manually remove the Shoutbox link.

To Re-enable Shoutbox

This is only for those who have removed their shoutboxes but now want their's back.

  1. On the left panel, click “Shoutbox” (This expands the shoutbox settings page so you can view them all.)
  2. Then click “Settings” (it is the second option.)
  3. In the right panel, look for: “Shoutbox Online?” set this to “Yes”
  4. Scroll to the bottom and click the “Save settings” button.
  5. Now, on the left panel again, click: “Skins & Templates”
  6. Then click “Board Wrappers”
  7. Now, on the right panel it will list every skin you have on your forum. Beside each of them is an “Edit” link. Click the link for the skin you want to remove it from.
  8. On the page that loads, add <% DSHOUTBOX %> somewhere in the page.
  9. Scroll to the bottom of the page and click the “Save changes” button.

Notes

  • You will have to repeat steps 6 through 9 for each skin that you want the shoutbox enabled on.
  • If you are using the “global bar manager” to configure your navigation bar, then you will have to manually place the Shoutbox link back in.

To Set Flood time

Flood time restricts how often a user can post and/or how long they have to wait before they can post another message. If you frequently use your shoutbox, you don't want to set flood time too high otherwise it will result in a lot of “You must wait <time>” messages. If you use the shoutbox a lot, a good flood time is probably 5-10 seconds. Similarly, if you use your shoutbox a lot, setting flood limit of 1-2 probably will be too low and result in lots of error messages telling users to wait. A good flood number is probably 5-10.

  1. Once in the ACP, On the left panel, click: “Shoutbox” (to expand the section and show the rest of the options)
  2. Then click: “Settings”
  3. On the right side, under the heading: “D-Shoutbox: Settings” look for: “Flood number for shouters?” Set this to a number. (This is how many shouts can be posted in a row before the system will deny further shouts from that user.)
  4. Then below that, set: “Flood time?”. (This is how long the user has to wait before they can post more shouts if they reach the flood number.)
  5. Finally, scroll to the bottom of the page and click the “Save Settings” button.

To add colours to the shoutbox

  1. On the left panel, scroll down and click on: “Shoutbox”
  2. Then click on: “Colors”
  3. In the right panel, Under the heading: “Add A Color” you will see a box. Simply type the name (or the 6 digit hexadecimal code, ex- 000000, 01056E or 0F0F0F, without the # symbol before the hex code.) of the colour into the box
  4. Then click the: “Add color” button.

Some sample colours can be found here (It lists both the hex code and the name of the colour. Note that not all color names can be used to easily add the color.)

To delete colours from the shoutbox

  1. On the left panel, scroll down and click on: “D-Shoutbox”
  2. Then click on: “Colors”
  3. Then click the check box beside the colour(s) that you want to delete.
  4. Then below the list of colours, click the button marked: “Delete selected”.

To configure permissions

  1. On the left panel, scroll down and click on: “Shoutbox”
  2. Then click on: “Group Permissions”
  3. On the right side of the page it will list all the member groups that have already been set up on the forum. Beside each of them is the “Edit” button. Click that for the group you want to edit.
  4. On the page that loads, you will see options for: Viewing the shoutbox, posting to the shoutbox, if they're a shoutbox moderator and if they have a limit of the number of shouts they can make per day (0 is unlimited, any other number means they can only post that many shouts per day). Configure the options as required.
  5. Then when you're done, click the “Save Permissions” button.

Notes

  • You will want to check up the permissions when first using the forum just to ensure they are configured the way you want them.
  • If you add any new user groups from the “Users and Groups” → “Manage User Groups” page, you may want to check the permissions here also just to be sure they are set to your liking.

Stop Guest Posting

Guest posting is a great feature that can allow unregistered members to ask questions with staff. However, spammers also can use this to post messages too. So you may not want to allow these people to post messages. Unfortunately you cannot stop spammers only without stopping all guests from being able to post messages.

  1. On the left panel, scroll down and click on: “Shoutbox”
  2. Then click on: “Settings”
  3. Now look for: “Guests able to post to the shoutbox?” and set this to “No”
  4. Now scroll to the bottom of the page and click “Save Settings”

If you later want to re-enable guest usage of your shoutbox, simply follow the steps listed above but set “Yes” instead of “No” in step 3.

To ban someone from the shoutbox

  1. On the left panel, scroll down and click on: “Shoutbox”
  2. Then click: “Ban A Member”
  3. In the right page now, beside the box that says: “Username To Ban” enter the username.
  4. Then click the “Ban user” button

The user will then be banned from the shoutbox. They will not be able to make any posts in the shoutbox or see any. Be aware that this does not affect their forum posting rights at all. (So banning them from your shoutbox won't stop them from posting on the forum.)

Unbanning someone from the shoutbox

  1. On the left panel, scroll down and click on: “Shoutbox”
  2. Then click: “Unban A Member”
  3. In the right page now, it will show every user that has been banned with a button and a checkbox beside their name.
  4. Then click the “Unban” button beside their name. (Or for multiple users, check the boxes then at the bottom click the “Unban Selected Users” button.)

The user(s) will then be unbanned from the shoutbox.

Deleting shouts by user

This allows the admin to delete all the shouts by a specific user. This can be very useful if a spammer posts a lot of garbage on your forum.

  1. On the left panel, scroll down and click on: “Shoutbox”
  2. Then click: “Delete Shouts By User”
  3. On the right page now, in the box enter the user's name.
  4. Then click the “Delete shouts” button. All the shouts will be cleared.

Notes:

  • Be sure to enter the user's name exactly as it appears.
  • There is no confirmation screen or pop up of any sort. So be certain that you have the correct user name entered AND that you actually want to delete all their shouts before pressing the button.
 
jfb-acp-dshoutbox.txt · Last modified: 2013/03/21 18:00 by crystal