DEPRECATION WARNING
This documentation is not using the current rendering mechanism and is probably outdated. The extension maintainer should switch to the new system. Details on how to use the rendering mechanism can be found here.
Configuration Reference¶
Technical information: Installation, Reference of TypoScript options, configuration options on system level, how to extend it, the technical details, how to debug it and so on.
Language should be technical, assuming developer knowledge of TYPO3. Small examples/visuals are always encouraged.
Target group: Developers
TypoScript Reference¶
You must either use the plugin.tt_board_list TypoScript prefix or the plugin.tt_board_tree. This depends if you want to configure the list or the tree plugins. In the reference only the plugin.tt_board_list is mentioned for simplification.
View Properties¶
View Property Details¶
- templateFile
- pid_list
- PIDforum
- PIDprivacyPolicy
- code
- defaultCode
- alternatingLayouts
- date_stdWrap
- time_stdWrap
- age_stdWrap
- dontParseContent
- typolink
- tree
- iconCode
- iconCode.joinBottom
- iconCode.join
- iconCode.line
- iconCode.blank
- iconCode.thread
- iconCode.end
- emoticons
- allowCaching
- displayCurrentRecord
- wrap1
- wrap2
- color1
- color2
- color3
templateFile¶
plugin.tt_board_list.templateFile =
resource
The template-file. | See example in ‘template/board_template1.tmpl’
pid_list¶
plugin.tt_board_list.pid_list =
string
The pid’s from where to fetch categories, forums and so on. Default is the current page. Accepts multiple pid’s commaseparated!
PIDforum¶
plugin.tt_board_list.PIDforum =
positive integer
PID for the forum page. | You can set this to change the page where the BACKLINK leeds to.
PIDprivacyPolicy¶
plugin.tt_board_list.PIDprivacyPolicy =
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.tt_board_list.code =
string
Code to define, what the script does. Case sensitive.
Code Label Description LIST_CATEGORIES Category, Forum: List List the first level of pages as categories and the second level as forums. LIST_FORUMS Forum: List 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 Thread 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.tt_board_list.defaultCode =
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.tt_board_list.alternatingLayouts =
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 :html:`<!--###POST###--> ... <!--###POST###-->` this is used all the time. If you define a similar subpart :html:`<!--###POST_1###--> ... <!--###POST_1###-->` 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 :html:`<!--###POST_2###--> ... <!--###POST_2###-->` … 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.tt_board_list.date_stdWrap =
stdWrap
stdWrap for the display of a date.
Suggestion: date_stdWrap.strftime= %e-%m-%y
time_stdWrap¶
plugin.tt_board_list.time_stdWrap =
stdWrap
stdWrap for the display of a time.
Suggestion: time_stdWrap.strftime= %H:%M:%S
age_stdWrap¶
plugin.tt_board_list.age_stdWrap =
stdWrap
stdWrap for the display of an age.
Suggestion: age_stdWrap.strftime= 1
dontParseContent¶
plugin.tt_board_list.dontParseContent =
boolean
Normally the content which is output it htmlspecialchar’ed and nl2br’ed. This flag prevents that.
tree¶
plugin.tt_board_list.tree =
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.tt_board_list.iconCode =
boolean
Enables the four icons below. The default without this is the examples you see below.
iconCode.joinBottom¶
plugin.tt_board_list.iconCode.joinBottom =
string
HTML-Code for a “joinBottom” element in a tree-structure. Eg “-“
iconCode.thread¶
plugin.tt_board_list.iconCode.thread =
string
The icon for an element with reply-elements (called a thread)
iconCode.end¶
plugin.tt_board_list.iconCode.end =
string
The icon for an element without any replys (and “end”)
allowCaching¶
plugin.tt_board_list.allowCaching =
boolean
If set, caching of the each page represented with a tt_board_uid is allowed to be cached.
displayCurrentRecord¶
plugin.tt_board_list.displayCurrentRecord =
boolean
If set, certain settings are manipulated in order to let the script render a single item - the $cObj->data.
wrap1¶
plugin.tt_board_list.wrap1 =
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.
- :aspect:`Example:`
Code:
wrap1.wrap = <strong> |</strong>
Form Properties¶
code= POSTFORM, POSTFORM_REPLY, POSTFORM_THREAD
Property | Data type | stdWrap | Default |
---|---|---|---|
postform | FORM cObject | no | tt_content.mailform.20 |
postform_newThread | FORM cObject | no | tt_content.mailform.20 |
moderatorEmail | string | no | |
moderatorEmail_newThread | string | no | |
memberOfGroups | string | no |
Form Property Details¶
postform¶
plugin.tt_board_list.postform =
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.tt_board_list.postform_newThread =
cObject
This is the alternative configuration of the form for new threads. It defaults to postform .
moderatorEmail¶
plugin.tt_board_list.moderatorEmail =
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.tt_board_list.moderatorEmail_newThread =
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.tt_board_list.memberOfGroups = 1,2
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 list_categories .
Category List Properties Details¶
code= LIST_CATEGORIES:
noForums¶
plugin.tt_board_list.noForums = 1
Disables the view of forums. Default is to display forums in categories.
numberOfRecentPosts¶
plugin.tt_board_list.noForums = 10
Set the number of recent posts in a forum to display together with the categories list.
title_stdWrap¶
plugin.tt_board_list.title_stdWrap =
stdWrap
subtitle_stdWrap¶
plugin.tt_board_list.subtitle_stdWrap =
stdWrap
count_stdWrap¶
plugin.tt_board_list.count_stdWrap =
stdWrap
forum_title_stdWrap¶
plugin.tt_board_list.forum_title_stdWrap =
stdWrap
forum_description_stdWrap¶
plugin.tt_board_list.forum_description_stdWrap =
stdWrap
forum_posts_stdWrap¶
plugin.tt_board_list.forum_posts_stdWrap =
stdWrap
forum_threads_stdWrap¶
plugin.tt_board_list.forum_threads_stdWrap =
stdWrap
last_post_author_stdWrap¶
plugin.tt_board_list.last_post_author_stdWrap =
stdWrap
post_title_stdWrap¶
plugin.tt_board_list.post_title_stdWrap =
stdWrap
post_content_stdWrap¶
plugin.tt_board_list.post_content_stdWrap =
stdWrap
post_replies_stdWrap¶
plugin.tt_board_list.post_replies_stdWrap =
stdWrap
post_author_stdWrap¶
plugin.tt_board_list.post_author_stdWrap =
stdWrap
cache_timeout¶
plugin.tt_board_list.cache_timeout =
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 .
Thread View Properties¶
code= FORUM
“Forum: Single” The following properties are all prepended view_thread .
Property | Data type | stdWrap | Default |
---|---|---|---|
single | boolean | no | 0 |
forum_title_stdWrap_ | stdWrap | yes | |
post_thread_code_stdWrap_ | stdWrap | yes | |
post_title_stdWrap_ | stdWrap | yes | |
post_content_stdWrap_ | stdWrap | yes | |
post_replies_stdWrap_ | stdWrap | yes | |
post_author_stdWrap_ | stdWrap | yes |
single¶
plugin.tt_board_list.single = 1
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_threads or thread_tree. thread_tree is config for the thread_tree which shows a list of the elements in the current thread.
Submit Form Properties¶
See example in static template from extensions ‘Message Board Setup’ The following properties are all prepended processScript (section FEData.tt_board).
Property | Data type | stdWrap | Default |
---|---|---|---|
sendToMailingList | boolean, a | no | |
notify | boolean | no | |
notify_from_ | string | no | |
newReply.msg | resource | no | |
newThread.msg | resource | no | |
newThread.debug_ | boolean | no |
sendToMailingList¶
FEData.tt_board.processScript.sendToMailingList =
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.tt_board.processScript.notify = ` :ref:`t3tsref:data-type-boolean
Enable email notification in forums.
notify_from¶
FEData.tt_board.processScript.notify_from = ` :ref:`t3tsref:data-type-string
Enable email notification in forums.
newReply-msg¶
FEData.tt_board.processScript.newReply.msg = ` :ref:`t3tsref:data-type-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.tt_board.processScript.newThread.msg = ` :ref:`t3tsref:data-type-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.tt_board.processScript.debug = ` :ref:`t3tsref:data-type-boolean
Outputs the mail information directly in browser. For debugging only.
Property | Data type | stdWrap | Default |
---|---|---|---|
clearCacheForPids | list | no |
clearCacheForPids¶
plugin.tt_board_list.clearCacheForPids = ` :ref:`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 |
FAQ¶
Possible subsection: FAQ