July, 2023 - TP Docs is now running on the newest version of TinyPortal Version 2.3.1.!

Main Menu

Search articles

Search in titles
Search in article texts

Docs Navigation

TPShout - or Shoutbox - is a built-in module for TinyPortal that is in fact a box in which you can leave messages for others to see and thus maintain a simple "chat" on the site. Combined with permissions you will have much freedom in who can participate as well.

When you setup a shoutbox, there are a number of settings that control how the shoutbox works and how it is displayed. There are some settings that you can make in the shoutbox block itself (alllowing you to have different displays of the shoutbox in different blocks) and there are some General settings. These apply to ALL shoutbox blocks throughout the forum.

The general Settings for the Shoutbox can be made from the TinyPortal Admin screen, found via menu "Tinyportal > Manage TPshout"

When you enter the Admin screen, you are presented with an overview of shout messages in all shoutboxes. In this screen you can edit or delete shout messages in the shoutbox.

To go to the settings page click the [Settings] button.

Here you find all general settings relevant to TPShout.

Display smilies buttons
You can choose if you want to allow smilies in the chat or not. When activating smilies, a list of available smilies is displayed below the message entry field. Clicking on the + sign will show all available smilies.
Options: [Yes] / [No]

Display BBC buttons
You can choose to show the buttons for BBC code. Set to No for a cleaner look.
Options: [Yes] / [No]

Allow links to be posted
Is this is not allowed, any attempt to post a url link in the shoutbox will be blocked.
Options: [Yes] / [No]

Use scrolling
With this option set to On the shoutbox will automatically scroll, drawing attention to the chat.
Options: [No] / [Yes]

Speed for the scrolling (1 - 5)
Set the scroll speed. Experiment with your ideal setting!
Options: [Entry field]

Auto refresh in seconds (0 = disabled)
The shoutbox will automatically refresh: set the refresh interval in seconds. (Setting this too low can eat server resources)
Options: [Entry field]

Choose how to submit Shout
Controls what keystroke will actually submit the text to the shoutbox
  • with Enter - Submit by hitting Enter
  • with Ctrl/Cmd+Enter - Submit by hitting Enter + Ctrl or Cmd
  • with Shout button only - Submit by clicking the [Shout] button

Limit posts in shoutbox to
Sets how many posts are displayed as part of the shoutbox: is not all posts fit into the shoutbox (as set in previous setting) a scroll-bar will show. Older messages will disappear from view.
Options: [Entry field]

Maximum shout length in characters
Limits the amount of characters that can be used in a single shout message. The default value: 256
Options: [Entry field]

Time format
Default format: Y M d H:i:s
Options: [Entry field]

Shoutbox color settings
(Use hex color codes: an example of a Hex color representation is #123456. To use the default theme colors, leave these fields blank.)

Use membergroup color for user names
This setting will activate member names in the shoutbox to be displayed in the color of the member groups.
Options: [Yes] / [No]

Default shout text color
Change the color of the shout text in the shoutbox to your liking.
Default value: #000
Options: [Entry field]

Time text color
Change the color of the date / time text in the shoutbox to your liking.
Default value: #787878
Options: [Entry field]

In layouts 3 and 4 a striped pattern is applied in the shoutbox. These settings allow you to choose a pattern that fits with the theme colors of your forum. Leaving the fields blank will remove the striped pattern if desired.

Layouts 3 and 4: background color odd lines
Default value: #f0f4f7
Options: [Entry field]

Layouts 3 and 4: background color even lines
Default value: #fdfdfd
Options: [Entry field]

Hide shouts in the profile?
Controls if shouts made by a user can be seen in the user profile area.
Options: [Yes] / [No]

All additional settings for the shoutbox are made in the shoutbox blocks. See the article on creating a Shoutbox block for details:

Last updated 09/01/2022 by @rjen

Articles in « TP shoutbox »