Configuration Reference
TypoScript Reference
You must either use the plugin.
TypoScript prefix or the plugin.
. This depends if you want to configure the list or the tree plugins. In the reference only the plugin.
is mentioned for simplification.
View Properties
Property | Data type | stdWrap | Default |
---|---|---|---|
templateFile _ | resource | no | |
pid_list_ | string | yes | |
PIDforum | positive integer | no | |
PIDprivacyPolicy | positive integer | no | |
code | string | yes | |
defaultCode | string | no | |
alternatingLayouts | integer | no | 2 |
date_stdWrap_ | stdWrap | yes | |
time_stdWrap_ | stdWrap | yes | |
age_stdWrap_ | stdWrap | yes | |
dontParseContent | boolean | no | |
typolink | typolink | no | |
tree | boolean | no | |
iconCode | boolean | no | |
iconCode.joinBottom_ | string | yes | |
iconCode.join_ | string | yes | |
iconCode.line_ | string | yes | |
iconCode.blank_ | string | yes | |
iconCode.thread_ | string | yes | |
iconCode.end_ | string | yes | |
emoticons | boolean | no | 1 |
allowCaching | boolean | no | |
displayCurrentRecord | boolean | no | |
wrap1 | stdWrap | yes | |
wrap2 | stdWrap | yes | |
color1 | string | yes | |
color2 | string | yes | |
color3 | string | yes |
View Property Details
templateFile
plugin.
resource
The template-file. | See example in Resources/
.
pid_list
plugin.
string
The pids from where to fetch categories, forums and so on. Default is the current page. Accepts multiple pids commaseparated!
PIDforum
plugin.
positive integer
PID for the forum page. | You can set this to change the page where the BACKLINK leeds to.
PIDprivacyPolicy
plugin.
positive integer
PID for the privacy policy page in the TYPO3 page tree. On this page you must publish the privacy policy according to DSGVO and GDPR. If you have set this page and no sendToMailingList is set, then an additional privacy confirmation checkbox will appear.
code
plugin.
string
Code Label Description LIST_CATEGORIES Category, Forum: List List the first level of pages as categories and the second LIST_FORUMS Forum: Listt Lists the first level of pages as forums. POSTFORM Entry Form: General Creates a form from which to post to the forum POSTFORM_REPLY Entry Form: Reply as above, but ONLY if "tt_board_uid" is set for a reply! POSTFORM_THREAD Entry Form: New Threa as above, but ONLY if "tt_board_uid" is NOT set, which means "New Thread". FORUM Forum: Single Shows the content of the current forum. If the GLOBAL-var "tt_board_uid" is set with a uid of a board-item, either this item is shown or the thread. Depends on config. THREAD_TREE Forum: Tree (tree only) tree of threads HELP General: Help Help
defaultCode
plugin.
string
The default code (see above) if the value is empty. By default it's not set and a help screen will appear.
alternatingLayouts
plugin.
integer
Defines number of alternatingLayouts to look for.
This script has the ability to alternate between the use of template-subparts. It goes like this:
If you define a subpart like <!--###POST###--> ... <!--###POST###-->
this is used all the time.
If you define a similar subpart <!--###POST_
which might show another set of colors, this is used every second time instead of the default! This is because "alternateLayouts" is set to 2
If you define a similar subpart <!--###POST_
... this will be used every third time IF (!) "alternateLayouts" is set to 3. If you do now set it to three, the first two will be used only.
date_stdWrap
plugin.
stdWrap
stdWrap for the display of a date.
Suggestion: date_
time_stdWrap
plugin.
stdWrap
stdWrap for the display of a time.
Suggestion: time_
age_stdWrap
plugin.
stdWrap
stdWrap for the display of an age.
Suggestion: age_
dontParseContent
plugin.
boolean
Normally the content which is output it htmlspecialchar'ed and nl2br'ed. This flag prevents that.
typolink
plugin.
typolink
Used to generate the links.
tree
plugin.
boolean
If set the items in the threads are accepted to be a tree and not just a list to the same parent. This means that replys, will get the current tt_board_uid as parent no matter what. This is only desirable, if your board has a genuine tree-structure.
iconCode
plugin.
boolean
Enables the four icons below. The default without this is the examples you see below.
iconCode.joinBottom
plugin.
string
HTML-Code for a "joinBottom" element in a tree-structure. Eg "-"
iconCode.join
plugin.
string
as above, Eg. "|-"
iconCode.line
plugin.
string
as above, Eg. "| "
iconCode.blank
plugin.
string
as above, Eg. " "
iconCode.thread
plugin.
string
The icon for an element with reply-elements (called a thread)
iconCode.end
plugin.
string
The icon for an element without any replys (and "end")
emoticons
plugin.
boolean
Enables emotion icons: :-) :) etc.
allowCaching
plugin.
boolean
If set, caching of the each page represented with a tt_board_uid is allowed to be cached.
displayCurrentRecord
plugin.
boolean
If set, certain settings are manipulated in order to let the script render a single item - the $cObj->data.
wrap1
plugin.
stdWrap
Global Wrap 1. This will be splitted into the markers ###GW1B### and ###GW1E###. Don't change the input value by the settings, only wrap it in something.
- Example:
-
Code:
wrap1.wrap = <strong> |</strong>
wrap2
plugin.
stdWrap
Global Wrap 2 (see above)
color1
plugin.
string
Value for ###GC1### marker (Global colour 1)
color2
plugin.
string
Value for ###GC2### marker (Global colour 2)
color3
plugin.
string
Value for ###GC3### marker (Global colour 3)
Form Properties
code= POSTFORM, POSTFORM_REPLY, POSTFORM_THREAD
Property | Data type | stdWrap | Default |
---|---|---|---|
postform | FORM Content Objects (cObject) | no | tt_content.mailform.20 |
postform_newThread_ | FORM Content Objects (cObject) | no | tt_content.mailform.20 |
moderatorEmail | string | no | |
moderatorEmail_newThread_ | string | no | |
memberOfGroups | string | no |
Form Property Details
postform
plugin.
Content Objects (cObject)
Only the dataArray of this setting should be changed. You can add entries to the dataArray of the FORM cObject in order to change the view.
Configuration of the form for posting replies and possibly also new threads. Note, that two hidden-fields are forcibly added to the form: "parent" and "pid" (using .dataArray keys 9998-9999)!
postform_newThread
plugin.
Content Objects (cObject)
This is the alternative configuration of the form for new threads. It defaults to postform .
moderatorEmail
plugin.
string
Email address where to send the notification of new entries into the board. If set, this email-address will receive a mail whenever a new reply is submitted.
Example:
plugin.tt_board_list {
moderatorEmail = john@doe.com
}
moderatorEmail_newThread
plugin.
string
Same as moderatorEmail, however only for new threads. If set, this email-address will receive a mail when a new thread is created. If not set, defaults to moderatorEmail .
memberOfGroups
plugin.
Comma separated list of FE groups which a user must belong to, so that the post forms are shown and the submission of a post is allowed.
Category List Properties
code= LIST_CATEGORIES
"Category, Forum: List" The following properties are all prepended by
list_
.categories
Property | Data type | stdWrap | Default |
---|---|---|---|
noForums | boolean | no | |
numberOfRecentPosts | integer | no | 0 |
title_stdWrap_ | stdWrap | yes | |
subtitle_stdWrap_ | stdWrap | yes | |
count_stdWrap_ | stdWrap | yes | |
forum_title_stdWrap_ | stdWrap | yes | |
forum_description_stdWrap_ | stdWrap | yes | |
forum_posts_stdWrap_ | stdWrap | yes | |
forum_threads_stdWrap_ | stdWrap | yes | |
last_post_author_stdWrap_ | stdWrap | yes | |
last_post_city_stdWrap_ | stdWrap | yes | |
post_title_stdWrap_ | stdWrap | yes | |
post_content_stdWrap_ | stdWrap | yes | |
post_replies_stdWrap_ | stdWrap | yes | |
post_author_stdWrap_ | stdWrap | yes | |
post_city_stdWrap_ | stdWrap | yes | |
cache_timeout_ | integer | no | 300 |
Category List Properties Details
code= LIST_CATEGORIES:
noForums
plugin.
Disables the view of forums. Default is to display forums in categories.
numberOfRecentPosts
plugin.
Set the number of recent posts in a forum to display together with the categories list.
title_stdWrap
plugin.
stdWrap
subtitle_stdWrap
plugin.
stdWrap
count_stdWrap
plugin.
stdWrap
forum_title_stdWrap
plugin.
stdWrap
forum_description_stdWrap
plugin.
stdWrap
forum_posts_stdWrap
plugin.
stdWrap
forum_threads_stdWrap
plugin.
stdWrap
last_post_author_stdWrap
plugin.
stdWrap
last_post_city_stdWrap
plugin.
stdWrap
post_title_stdWrap
plugin.
stdWrap
post_content_stdWrap
plugin.
stdWrap
post_replies_stdWrap
plugin.
stdWrap
post_author_stdWrap
plugin.
stdWrap
post_city_stdWrap
plugin.
stdWrap
cache_timeout
plugin.
integer
The number of seconds the page is cached. Default is 5 minutes.
Forum List Properties
code= LIST_FORUMS
"Forum: List" The following properties are all prepended
list_
.forums
Property | Data type | stdWrap | Default |
---|---|---|---|
numberOfRecentPosts | integer | no | 0 |
forum_title_stdWrap_ | stdWrap | yes | |
forum_description_stdWrap_ | stdWrap | yes | |
forum_posts_stdWrap_ | stdWrap | yes | |
forum_threads_stdWrap_ | stdWrap | yes | |
last_post_author_stdWrap_ | stdWrap | yes | |
last_post_city_stdWrap_ | stdWrap | yes | |
post_title_stdWrap_ | stdWrap | yes | |
post_content_stdWrap_ | stdWrap | yes | |
post_replies_stdWrap_ | stdWrap | yes | |
post_author_stdWrap_ | stdWrap | yes | |
post_city_stdWrap_ | stdWrap | yes | |
cache_timeout_ | integer | no | 300 |
Thread View Properties
code= FORUM
"Forum: Single" The following properties are all prepended
view_
.thread
single
plugin.
If set, the items are displayed for themselves. Else the whole thread is normally displayed on one page. (This flag should probably be set together with the .tree-flag, if you use it, as this basically turns the board into a tree-like forum instead of a flat board-structure!
Thread List Properties
code = THREAD_TREE
"Forum: Tree" The following properties are all prepended
list_
orthreads thread_
.tree thread_
is config for the thread_tree which shows a list of the elements in the current thread.tree
thread_limit
plugin.
Max number of items
Submit Form Properties
See example in static template from extensions 'Message Board Setup'
The following properties are all prepended process
(section FEData.tt_board).
sendToMailingList
FEData.
boolean
If enabled, a copy of the post is sent to the configured email address. This is useful if you want to integrate the forum with a mailing list. On Typo3.com such a link is established. The reply address is set up in the Qmail MTA to pipe the content into a custom PHP shell-script which parses the email and inserts it into the forum.
Example from the ancient Typo3.com:
FEData.tt_board {
processScript {
sendToMailingList = 1
sendToMailingList {
email = typo3@netfielders.de
reply = [emailaddress which inserts into db]
namePrefix = Typo3Forum/
altSubject = Post from www.typo3.com
}
}
}
notify
FEData.
boolean
Enable email notification in forums.
notify_from
FEData.
string
Enable email notification in forums.
newReply-msg
FEData.
resource
Notification message template, first line is subject.
Example:
FEData.tt_board {
processScript {
newReply.msg = EXT:tt_board/Resources/Private/Templates/board_notify.txt
}
}
newThread-msg
FEData.
resource
Notification message template, first line is subject.
Example:
FEData.tt_board {
processScript {
newThread.msg = EXT:tt_board/Resources/Private/Templates/board_notify.txt
}
}
debug
FEData.
boolean
Outputs the mail information directly in browser. For debugging only.
Property | Data type | stdWrap | Default |
---|---|---|---|
clearCacheForPids | t3tsref:data-type-list | no |
clearCacheForPids
plugin.
t3tsref:data-type-list
This list of page ids is cleared in addition to the cache for the page of the item submitted.
Constants
Property | Data type | Default |
---|---|---|
moderatorEmail | string | |
moderatorEmail_newThread | string | |
emailCheck | boolean | |
captcha | string |
emailCheck
Constant
plugin.
string
If set the email address will be checked if it exists. Otherwise no entry will be made and an error message gets displayed.
captcha
Constant
plugin.
string
Usage of the captcha security string.
Set this to freecap
and install sr_freecap.
Or set this to captcha
and install captcha.
Example: Constants
plugin.tt_board {
captcha = freecap
}
FAQ
No FAQ yet.