This page is still a beta!

1.5. Configuration

For the mm_forum extension to work properly, you have to set a lot of configuration properties. The easiest way to do this is using the mm_forum configuration module in the mm_forum backend module. This presents a very comfortable way of configuring the mm_forum. All configuration properties are described in detail in the configuration module.

However, you can also make the same specifications using the TYPO3 constant editor. You should notice that the configuration module defines default values that apply globally for the whole TYPO3 site. Settings made in the constants override these you made in the mm_forum configuration module and apply only on the page the regarding template is placed on and its sub pages. Finally, you can again override the settings made in the TypoScript constants by defining values directly in the TypoScript setup. All this allows a very flexible method of configuring the mm_forum extension.

The backend configuration module stores the settings made in it into an external TypoScript file that is located in the typo3conf directory. This file has to be located outside the mm_forum extension directory since otherwise all configuration would be overwritten on update.

Nevertheless, you should notice that the backend module itself will only be affected by the setting made in the configuration module. This means, if you change for example the storagePID in the constant editor, this will not affect the backend module. For this, you would have to change the storagePID in the configuration module.

Since the value fields in the configuration module are already described in detail right there, there is no need to explain them in this documentation again. However, in this section you will find extensive documentation on the TypoScript constants used by the mm_forum and the regarding TypoScript setup properties.

Constants Reference

In the following section, you will find a complete reference of all TypoScript constants used by the mm_forum extension. The probably best way to edit these constants would be to use the constants editor. The mm_forum constants are grouped in the sections mm_forum – General, mm_forum – Message board, mm_forum – File paths, mm_forum – Private messaging and mm_forum – Search. Another way to edit the constant values is to enter them into the constant configuration field directly. All mm_forum constants are located in the plugin.tx_mmforum object.

Example

plugin.tx_mmforum.adminGroup = 1;
plugin.tx_mmforum.moderatorGroup = 2;
plugin.tx_mmforum.userGroup = 3;

General

Property:

Data type:

Description:

Default:

team_name

string

The name of your forum team. This name will be used as signature in automatically sent emails.

Your team

support_mail

string

The email address for support mails. This address will be displayed in case of errors in the extension and things like that.

support@your-domain.com

mailer_mail

string

The email address for emails which are send to users for example registration email

noreply@your-domain.com

dateFormat

string

The default date format. This will be used in nearly all mm_forum plugins. See http://www.php.net/date for the correct syntax.

d. m. y [H:i]

site_name

string

Defines the name of the website. Used e.g. in mails sent by the message board.

your-domain.com

adminGroup

integer

Default user group for administrators

moderatorGroup

integer

Default user group for moderators

userGroup

integer

Default user group for new registered users

userPID

integer

The page ID of the fe_user storage page

storagePID

integer

The page ID of the mm_forum data storage page (set -1 to disable)

realUrl_specialLinks

boolean

Enables or disables mm_forum RealURL support. See Administration ► mm_forum and RealURL for more information.

0

disableRootline

boolean

Disables the mm_forum rootline allowing you to implement the mm_forum rootline into your own rootline menu.

0

informal

boolean

Use informal language. Affects only german language set (different use of Sie and Du).

0

userNameField

string

Database field used for a user's username

username

useCaptcha

boolean

Enables use of the captcha library on registration. Requires the captcha library to be installed.

1

File paths

Property:

Data type:

Description:

Default:

path_smilie

string

The path to your smilie directory.

EXT:mm_forum/res/smilies/

path_img

string

The path to your image directory.

EXT:mm_forum/res/img/default/

postparser.insertButton_path

string

The path to the directory containing the buttons for the BBCode buttons

EXT:mm_forum/res/img/default/editor_icons

path_template

string

The path to the default template directory

EXT:mm_forum/res/tmpl/

path_altTemplate

string

The path to the alternative template directory. This is where user defined design sets are stored.

fileadmin/ext/mm_forum/tmpl/

Message Board

Property:

Data type:

Description:

Default:

notifyMail_sender

string

This email address will be specified as sender in mails send to inform users about new posts in topics they observed

boardName

string

The name of this board. This will also be used in automatically sent emails and some other places.

boardPID

int (page-UID)

Here you enter the UID of the page the mm_forum :: Forum plugin is placed on. Used for internal links.

postsPerPage

int

Specifies how much posts are to be displayed on one page in the post listing view.

10

threadsPerPage

int

Specifies how much threads are to be displayed on one page in the thread listing view.

30

displayRealName

boolean

If set, the user's real name (if this is also set) will be displayed below the user's user name in the post listing view.

1

user_hotPosts

int

Defines how much posts a user has to write until he/she is awarded with a special icon below his/her user name.

5000

topic_hotPosts

int

Defines how much posts a topic has to contain to be marked as hot topic.

10

spamblock_interval

int

The time in seconds a user has to wait between writing two posts.

20

signatureLimit

int

The maximum signature length in lines. All lines beyond this limit are cut off.

6

attachment_enable

boolean

Enables file attachments

1

attachment_allow

list

Comma separated list of allowed file extensions. Use * to allow all file extensions

*

attachment_deny

list

Comma separated list of denyed file extensions. This overrules the allowed file extensions, so setting the allowed extensions to “*” and the denyed e.g. to “php” will result in all files except “php” being accepted.

php,php3

attachment_filesize

int

Maximum file size for file attachments

1045504 bytes (=1 MB)

attachment_preview

boolean

Enables preview images for image attachments

1

polls_enable

boolean

Enables polls.

1

enableShadows

boolean

Activates shadow topics. If a topic is moved from one forum to another, a shadow of this topic remains in the original forum pointing to the topic's new location.

1

signatureBBCodes

boolean

This function defines if BBCodes should be allowed in user signatures or not.

1

enableRanks

boolean

Enables user ranks. User ranks can be configured using the backend module.

1

moderatedBoard

boolean

Enables the moderated forum. If set, new entries and topics have to be approved by a moderator before being displayed in the forum.

0

topicIconMode

string

Set to 'classic' in order to use the classic forum and topic icons, or to 'modern' to use new icons

modern

Search

Property:

Data type:

Description:

Default:

indexCount

int

This constant defines how much topics are to be indexed by the automatic indexing process at a time. Giving this constant a high value leads to a larger amount of topics being indexed at a time. This means that the search index is more up-to-date, but also slows down the server.

50

indexingPassword

string

This constant defines the password that has to be submitted as variable for the automatic indexing script. Since the TYPO3-internal user authentication does not work for e.g. CronJobs that are used for automatic calls of this indexing script, this is necessary.

For security reasons, this value is only stored as MD5 hash.It is strongly advised that you change this password to another value of your choice!

21232f297a57a5a743894a0e4a801fc3

sword_minLength

int

The minimum search word length in characters.

2

resultsPerPage

int

The amount of results that are to be displayed on on page.

10

Private messages

Property:

Data type:

Description:

Default:

pmBlocktime

int

Time in seconds a user has to wait between writing two private messages.

30

pmPID

int

The UID of the page the mm_forum :: Private messaging plugin is placed on.

TypoScript setup reference

This TypoScript reference contains all setup properties that are not affected by changes in the constants. Regularly, there should be no necessity to change any of these values, however, by changing these values you get a wide range of additional administration possibilities.

plugin.tx_mmforum_pi1 (mm_forum :: Forum)

Property:

Data type:

Description:

Default:

storagePID

int

Page UID of mm_forum data storage page

{$plugin.tx_mmforum.storagePID}

userPID

int

Pdate UID of user storage page

{$plugin.tx_mmforum.userPID}

path_avatar

string

Defines the path to the avatar directory.

uploads/tx_mmforum/

avatar_width

int

Width of avatar images that are displayed in the forum

100

avatar_height

int

Height of avatar images that are displayed in the forum

100

path_img

string

Path to the image directory

{$plugin.tx_mmforum.path_img}

path_smilie

string

Path to the smilie directory

{$plugin.tx_mmforum.path_smilie}

pid_forum

int

Page UID of the page the mm_forum :: Forum plugin is placed on.

{$plugin.tx_mmforum.boardPID}

hotposts

int

Defines how much replies there have to be in a topic to make it a “hot topic”

10

user_hotposts

int

Defines how much posts a user has to write until he/she is featured with a special icon in the post listing view.

DEPRECATED: Not used any more since the introduction of user ranks.

5000

grp_admin

int

UID of the administragor group

{$plugin.tx_mmforum.adminGroup}

grp_mod

int

UID of the moderator group

{$plugin.tx_mmforum.moderatorGroup}

pm_id

int

Page UID of the private messaging plugin.

{$plugin.tx_mmforum.pmPID}

post_limit

int

Number of posts that are displayed on a topic page.

{$plugin.tx_mmforum.postsPerPage}

topic_count

int

Number of topics that are display on a forum page

{$plugin.tx_mmforum.threadsPerPage}

dateFormat

string

The default date format. See http://www.php.net/date for more information.

{$plugin.tx_mmforum.dateFormat}

prefixes

string

This field contains a comma-separated list of predefined prefixes that moderators can apply to topics.

{$plugin.tx_mmforum.prefixes}

noListPrefixes

string

A comma-separated list of prefixes that users should not be able to filter in the list_prefix view.

Test

spamblock_interval

int

Defines the minimum time in seconds a user has to wait between two posts. This is done to prevent spamming. To disable this feature, set this field to 0.

{$plugin.tx_mmforum.spamblock_interval}

signatureLimit

int

Specifies a maximum line count for user signatures. Signatures that are longer than specified here are cropped to the maximum length.

{$plugin.tx_mmforum.signatureLimit}

realURL_specialLinks

boolean

Enables/Disables RealURL support.

{$plugin.tx_mmforum.realURL_specialLinks}

disableRootline

boolean

Enables/Disables the rootline

{$plugin.tx_mmforum.disableRootline}

notifyingMail.sender

string

The sender name of automatically generated emails.

{$plugin.tx_mmforum.notifyMail_sender}

notifyingMail.topicLinkPrefix_override

string

With this property you can override the http host prefix in links used in automatically generated emails. These links follow the syntax [prefix_override]/index.php[...]

postalerts.statusColors

array of colors

This array defines the different colors used in the post alert listing:.open: The color used for open post alerts.work: The color used for post alerts that are currently under examination.done: The color used for post alert that have already been examined

.open = #ffdddd.work = #ffffdd.done = #ddffdd

boardName

string

This board's name.

{$plugin.tx_mmforum.boardName}

display

This array contains general display options.

Changing these values is only recommended for experienced administrators.

template

array

A list of all template files used in the mm_forum :: Forum plugin. See the file EXT:mm_forum/ext_typoscript_setup.txt for a complete list of all referenced template files.

See EXT:mm_forum/ext_typoscript_setup.txt

images

array

A list of all image files used in the mm_forum :: Forum plugin. See the file EXT:mm_forum/ext_typoscript_setup.txt for a complete list of all images used.

See EXT:mm_forum/ext_typoscript_setup.txt

scripts.editor

string

This field defines the path to the Javascript file containing functions for the text input field.

typo3conf/ext/mm_forum/res/scripts/editor_javascript.inc.js

postparser

This array contains configuration options for the post parser.

plugin.tx_mmforum_pi1.polls

Property:

Data type:

Description:

Default:

enable

boolean

Enables polls.

{$plugin.tx_mmforum.polls_enable}

minAnswers

int

The minimum amount of answering possibilities for polls

2

expired_stdWrap

stdWrap

stdWrap for the poll expiration date label

pollBar_colorMap

array

Array of colors for the bars used to display the poll result.

restrictToGroups

list

A comma separated list of user groups allowed to create polls. Leave this field empty in order to allow all users to create polls.

{$plugin.tx_mmforum.polls_restrict}

poll_icon

cObj

A content object describing a poll's icon

cObj (IMAGE)

plugin.tx_mmforum_pi1.attachments

Property:

Data type:

Description:

Default:

enable

boolean

Enables upload of file attachments

{$plugin.tx_mmforum.attachment_enable}

maxFileSize

int

Maximum file size for file attachments

{$plugin.tx_mmforum.attachment_filesize}

allow

list

Comma separated list of allowed file extensions. Use * to allow all file extensions

{$plugin.tx_mmforum.attachment_allow}

deny

list

Comma separated list of denyed file extensions. This overrules the allowed file extensions, so setting the allowed extensions to “*” and the denyed e.g. to “php” will result in all files except “php” being accepted.

{$plugin.tx_mmforum.attachment_deny}

maxFileSize_stdWrap

stdWrap

stdWrap for the maxFileSize label in the post creation form.

imagePreview

boolean

Enables preview images for image attachments

{$plugin.tx_mmforum.attachment_preview}

imagePreviewObj

cObj

A content object rendering the preview image.

attachment_stdWrap

stdWrap

stdWrap for the whole file attachment item in the post listing view.

attachmentLabel_stdWrap

stdWrap

stdWrap for the file attachment label in the post listing view.

attachmentLink_stdWrap

stdWrao

stdWrap for the file attachment link in the post listing view.

attachmentEditLabel_stdWrap

stdWrap

stdWrap for the file attachment editing label in the post editing form.

plugin.tx_mmforum_pi1.list_topics

This array contains display options for the topic listing view. Changing these values is only recommended for experienced administrators.

Property:

Data type:

Description:

Default:

prefix_wrap

string (wrap)

The wrap around topic prefixes.

<span class="tx-mmforum-pi1-listtopic-prefix">[ | ]</span>&nbsp;

pagenav_wrap

string (wrap)

The wrap around a topic's page navigation.

<div class="tx-mmforum-pi1-listtopic-pages"> | </div>

listunread_pagenav_wrap

string (wrap)

The wrap around a topic's page navigation in the unread topic listing view.

<div class="tx-mmforum-pi1-listtopic-pages" style="display:inline; padding:0px;">(&nbsp; | &nbsp;)</div>

plugin.tx_mmforum_pi1.list_posts

This array contains display options for the post listing view. Changing these values is only recommended for experienced administrators.

Property:

Data type:

Description:

Default:

userinfo.username_stdWrap

stdWrap

stdWrap for user name

userinfo.realname_stdWrap

stdWrap

stdWrap for user's real name

userinfo.crdate_stdWrap

stdWrap

stdWrap for user's registration date

userinfo.creator_stdWrap

stdWrap

stdWrap for the „topic creator“ string

userinfo.avatar_cObj

cObj

cObj of the avatar image. „file“ is automatically set to the path of the avatar image.

signature_stdWrap

stdWrap

stdWrap for the user's signature

prefix

cObj

A content object describing a topic's prefix

closed

cObj

A content object describing a topic's closed status

userinfo_topicauthor_wrap

string (wrap)

The wrap around a user's user name in the post listing view

<span style="font-size:10px; font-weight: bold;">[ | ]</span><br />

userinfo_content_wrap

string (wrap)

The wrap around all information on a user in the post listing view

<span style="font-size:10px;"> | </span><br />

userinfo_admin_wrap

string (wrap)

The wrap around the string signifying a user's administrator status

<span class="tx-mmforum-pi1-administrator">[ | ]</span>

userinfo_moderator_wrap

string (wrap)

The wrap around the string signifying a user's moderator status.

<span class="tx-mmforum-pi1-moderator">[ | ]</span>

userinfo_realName_wrap

string (wrap)

The wrap around the string displaying a user's real name.

<span style="font-size:10px;"> | </span><br />

highlight_wrap

string (wrap)

The wrap around matching search words in post texts.

<span class="tx-mmforum-pi1-highlight"> | </span>

plugin.tx_mmforum_pi1.display

This array contains general display options.

Property:

Data type:

Description:

Default:

rootline.seperator

string

The separator between different root line items

&nbsp;&raquo;&nbsp;

linkButton.cssClass

string

The CSS class used for CSS buttons in the plugin

tx-mmforum-button

listItem.evenClass

string

The CSS class used for even list items

tx-mmforum-list-even

listItem.oddClass

string

The CSS class used for odd list items

tx-mmforum-list-odd

plugin.tx_mmforum_pi1.postForm

This array contains display options for post creation forms.

Property:

Data type:

Description:

Default:

smiliesAsDiv

boolean

Determines whether smilies should be rendered in a table or rather wrapped by div tags. Consider that the default mm_forum CSS does not contain classes to format the div tags the smilies are wrapped with

0

smiliesAsDiv.allWrap

string (wrap)

Wrap for all smilies (if displayed in divs)

<div class=“tx-mmforum-pi1-smilies“> | </div>

smiliesAsDiv.itemWrap

string(wrap)

Wrap for each smilie item (if displayed in divs)

<div class="tx-mmforum-pi1-smilie"> | </div>

plugin.tx_mmforum_pi1.postparser

This array contains post parser options.

Property:

Data type:

Description:

Default:

bb_code_linktarget

string

The target for dynamically generated links in posts texts defined by the [url] or [link] BBCode.

_blank

bb_code_linkklass

string

The CSS class for dynamically generated links in posts texts defined by the [url] or [link] BBCode.

link_10

bb_code_bullet_img

string

This field contains a file path to the image that is to be used as bullet in bullet lists defined by the [list] BBCode

EXT:mm_forum/res/img/postparser-bb_code_bullet.gif

bb_code_parser

boolean

Enables parsing of BBCode

1

code_protection

boolean

Disables parsing in special code containers

1

syntaxHighlighter

boolean

Enables syntax highlighting using GeSHI

1

smilie_generator

boolean

Enables smilies

1

zitat_div

boolean

Enables quotes

1

links

boolean

Enables links

1

sh_linestyle_bg

string (color)

Defines the background color for code fields.

#gggggg

sh_linestyle_bg2

string (color)

Defines the alternative background color for code fields. This color is used for alternating line background colors.

#ghfghf

quoteClass

string

The CSS class that is to be used for quotation divs

tx-mmforum-pi1-pt-quote

codeClass

string

The CSS class that is to be used for code containers

tx-mmforum-pi1-pt-code

plugin.tx_mmforum_pi2 (mm_forum :: User registration)

Property:

Data type:

Description:

Default:

templateFile

string

Defines the path to the template file

EXT:mm_forum/res/tmpl/fe_user_reg/fe_user_registrierung.html

path_img

string

Path to the image directory

{$plugin.tx_mmforum.path_img}

img_border

int

Border property for images

{$plugin.tx_mmforum.img_border}

teamName

string

The administration team's name.

{$plugin.tx_mmforum.team_name}

siteName

string

This site's name.

{$plugin.tx_mmforum.site_name}

supportMail

string

Support team email address

{$plugin.tx_mmforum.support_mail}

userPID

int

Page UID of the user storage page

{$plugin.tx_mmforum.userPID}

userGroup

int

UID of the default user group.

{$plugin.tx_mmforum.userGroup}

Emailsender

string

Sender name of automatically generated emails.

{$plugin.tx_mmforum.support_mail}

images

array

An array of image file names.

Same as plugin.tx_mmforum_pi1.images

plugin.tx_mmforum_pi3 (mm_forum :: Private messaging)

Property:

Data type:

Description:

Default:

storagePID

int

UID of mm_forum data storage page.

{$plugin.tx_mmforum.storagePID}

userPID

int

UID of user data stroage page

{$plugin.tx_mmforum.userPID}

path_img

string

Path to image directory.

{$plugin.tx_mmforum.path_img}

block_time

int

This field defines the minimum time a user has to wait between sending to private messages. This is done to prevent spamming. To disable this feature, set this value to 0.

30

forum_pid

int

Page UID of the main forum plugin.

{$plugin.tx_mmforum.boardPID}

pm_pid

int

Page UID of the private messaging plugin.

{$plugin.tx_mmforum.pmPID}

date

string

Default date format.

{$plugin.tx_mmforum.dateFormat}

siteName

string

This site's name

{$plugin.tx_mmforum.site_name}

mailerEmail

string

Email address of the PHP mailer.

{$plugin.tx_mmforum.mailer_mail}

unreadWrap

string (wrap)

Wrap for unread messages in the message listing view.

<span class="tx-mmforum-pi3-pminbox-unread"> | </span>

realURL_specialLinks

boolean

Enables/Disables realUrl support.

{$plugin.tx_mmforum.realURL_specialLinks}

template

array

A list of all template files used in the mm_forum :: Private messaging plugin. See the file EXT:mm_forum/ext_typoscript_setup.txt for a complete list of all referenced template files.

See EXT:mm_forum/ext_typoscript_setup.txt

images

array

A list of all image files used in the mm_forum :: Private messaging plugin. See the file EXT:mm_forum/ext_typoscript_setup.txt for a complete list of all images used.

Same as plugin.tx_mmforum_pi1.images

plugin.tx_mmforum_pi4 (mm_forum :: Search)

Property:

Data type:

Description:

Default:

storagePID

int

Page UID of the mm_forum data storage page.

{$plugin.tx_mmforum.storagePID}

grp_admin

int

UID of the administrator group.

{$plugin.tx_mmforum.adminGroup}

template

string

Template file name.

EXT:mm_forum/res/tmpl/default/search/tmpl_search.html

path_img

string

Path to image directory.

{$plugin.tx_mmforum.path_img}

noIndex_boardUIDs

list

This field contains a comma-separated list of board UIDs. These boards will not be indexed by the indexing process.

pid_forum

int

Page UID of the main forum plugin.

{$plugin.tx_mmforum.boardPID}

sword_minLength

int

The minimum length for search words.

{$plugin.tx_mmforum.sword_minLength}

resultsPerPage

int

The amount of search results that are to be displayed on one page.

{$plugin.tx_mmforum.resultsPerPage}

image

array

A list of all image files used in the mm_forum :: Search plugin. See the EXT:mm_forum/ext_typoscript_setup.txt for a complete list of all images used.

Same as plugin.tx_mmforum_pi1.images

matchWrap

string (wrap)

This field defines the wrap around passages matching the search words.

<strong> | </strong>

indexCount

int

Amount of topics that are to be indexed at a time.

{$plugin.tx_mmforum.indexCount}

indexingPassword

string

MD5 hash of the indexing password.

{$plugin.tx_mmforum.indexingPassword}

plugin.tx_mmforum_pi5 (mm_forum :: User settings)

Property:

Data type:

Description:

Default:

template

string

Defines the path to the template file used by this plugin.

EXT:mm_forum/res/tmpl/change_user/main.html

storagePID

int

Page UID of the mm_forum data storage page.

{$plugin.tx_mmforum.storagePID}

date

string

The date format used by this plugin.

d.m.Y

userFields

string

A comma-separated list of fields the user is allowed to edit.

zip,city,www,tx_mmfeuserreg_occ,tx_mmfeuserreg_interests,email,tx_mmforum_yim,tx_mmforum_msn,tx_mmforum_aim,tx_mmforum_icq,tx_mmforum_skype,tx_mmforum_user_sig

path_avatar

string

The path to the avatar folder

uploads/tx_mmforum/

path_img

string

Path to the image directory.

{$plugin.tx_mmforum.path_img}

avatar

cObj

An IMAGE-cObj defining the display of the user's avatar.

minPasswordLength

int

The minimum password length

6

postparser

This array contains configuration options for the post parser.

Same as plugin.tx_mmforum_pi1.postparser

plugin.tx_mmforum_pi6 (mm_forum :: Portal information)

Property:

Data type:

Description:

Default:

templateFile

string

Defines the path to the template file used by this plugin.

EXT:mm_forum/res/tmpl/portalinfo/mm_forum_pi6.tmpl

storagePID

int

Page UID of the mm_forum data storage page.

{$plugin.tx_mmforum.storagePID}

userPID

int

Page UID of the user data storage page.

{$plugin.tx_mmforum.userPID}

onlineTime

int

The time in seconds that has to pass before a user is not counted as online anymore.

600

adminGroup

int

UID of the administrator group

{$plugin.tx_mmforum.adminGroup}

modGroup

int

UID of the moderator group

{$plugin.tx_mmforum.moderatorGroup}

userInfoPid

int

Page UID of the user profile view page. Regularly, this is the main mm_forum :: Forum plugin page.

{$plugin.tx_mmforum.boardPID}

showPostCount

boolean

Determines if the plugin should show how many posts a user has written today.

1

importantInformation_wrap

string (wrap)

The wrap around important parts of the portal information.

<span style="font-weight:bold;color:#8e8d8d;"> | </span>  

siteName

string

This site's name.

{$plugin.tx_mmforum.site_name}

userList.groupTitle_wrap

string (wrap)

The wrap around group titles in the user list.

<span style="font-weight:bold;"> | </span>