.. You may want to use the usual include line. Uncomment and adjust the path. .. include:: ../Includes.txt .. role:: underline ============= EXT:mm\_forum ============= :Author: Ines Willenbrock :Created: 2008-09-24T23:24:14 :Changed by: Hauke Preuß :Changed: 2010-06-13T13:27:09.710000000 :Classification: mm_forum :Description: The keywords help with categorizing and tagging of the manuals. You can combine two or more keywords and add additional keywords yourself. Please use at least one keyword from both lists. If your manual is NOT in english, see next tab "language" ---- forEditors (use this for editors / german "Redakteure") forAdmins (use this for Administrators) forDevelopers (use this for Developers) forBeginners (manuals covering TYPO3 basics) forIntermediates (manuals going into more depth) forAdvanced (covering the most advanced TYPO3 topics) see more: http://wiki.typo3.org/doc_template#tags ---- :Author: Martin Helmich, Mittwald CM Service GmbH & Co. KG :Email: m.helmich@mittwald.de :Info 4: :Language: en |img-1| |img-2| EXT:mm\_forum - mm\_forum .. _EXT-mm-forum: EXT:mm\_forum ============= Extension Key: mm\_forum Language: en Keywords: Copyright 2000-2009, Martin Helmich, Mittwald CM Service GmbH & Co. KG, This document is published under the Open Content License available from http://www.opencontent.org/opl.shtml The content of this document is related to TYPO3 \- a GNU/GPL CMS/Framework available from www.typo3.org .. _Table-of-Contents: Table of Contents ----------------- `EXT:mm\_forum 1 <#__RefHeading__5597_465104789>`_ **`Introduction 3 <#__RefHeading__5599_465104789>`_** `What does it do? 3 <#__RefHeading__5601_465104789>`_ `Getting started 3 <#__RefHeading__5603_465104789>`_ **`Screen shots 13 <#__RefHeading__5605_465104789>`_** **`Users manual 18 <#__RefHeading__5607_465104789>`_** `Data organization 18 <#__RefHeading__5609_465104789>`_ `Create new topics and posts 18 <#__RefHeading__5611_465104789>`_ `Editing posts 19 <#__RefHeading__5613_465104789>`_ `BBCode 19 <#__RefHeading__5615_465104789>`_ `Private Messaging System 20 <#__RefHeading__5617_465104789>`_ `Polls 21 <#__RefHeading__5619_465104789>`_ `File attachments 22 <#__RefHeading__5621_465104789>`_ `Forum Moderation/Administration 22 <#__RefHeading__5623_465104789>`_ `How to search? 24 <#__RefHeading__5625_465104789>`_ **`Administration 25 <#__RefHeading__5627_465104789>`_** `Categories and Boards 25 <#__RefHeading__5629_465104789>`_ `Tools 25 <#__RefHeading__5631_465104789>`_ `Data import 26 <#__RefHeading__5633_465104789>`_ `Install module 30 <#__RefHeading__5635_465104789>`_ `Search index 30 <#__RefHeading__5637_465104789>`_ `User rights management 31 <#__RefHeading__5639_465104789>`_ `Special listings 31 <#__RefHeading__5641_465104789>`_ `Extending the user profile 32 <#__RefHeading__5643_465104789>`_ `User ranks 35 <#__RefHeading__5645_465104789>`_ `Statistics module 35 <#__RefHeading__5647_465104789>`_ `mm\_forum and RealURL 36 <#__RefHeading__5649_465104789>`_ `Custom rootline menu 37 <#__RefHeading__5651_465104789>`_ `Cronjobs 38 <#__RefHeading__5653_465104789>`_ **`Configuration 40 <#__RefHeading__5655_465104789>`_** `Constants Reference 40 <#__RefHeading__5657_465104789>`_ `TypoScript setup reference 43 <#__RefHeading__5659_465104789>`_ **`Customization 53 <#__RefHeading__5661_465104789>`_** `Template editing and design sets 53 <#__RefHeading__5663_465104789>`_ `Buttons 54 <#__RefHeading__5665_465104789>`_ `Topic icons 54 <#__RefHeading__5667_465104789>`_ **`FAQ 55 <#__RefHeading__5669_465104789>`_** **`Known problems and solutions 56 <#__RefHeading__5671_465104789>`_** **`Team 57 <#__RefHeading__5673_465104789>`_** **`Change log 58 <#__RefHeading__5675_465104789>`_** .. _Introduction: Introduction ------------ The *mm\_forum* extension aims to be a full-featured discussion board plug-in for TYPO3 users. The first version was created for the German TYPO3 bulletin board `typo3.net `_ and it is designed to serve large groups of user. The version you downloaded is a beta version, so although this version should be stable in most aspects, it is possible that still some bugs might occur. For more information please take a closer look at the official bug tracker on the TYPO3 forge ( `http://forge.typo3.org/projects/show /extension-mm\_forum `_ ). There, you will also find the mm\_forum Subversion repository from where you can retrieve the most current development snapshot. .. _What-does-it-do: What does it do? ^^^^^^^^^^^^^^^^ The mm\_forum is a frontend plugin that adds a discussion board to your TYPO3-based website. The extension was originally written to be used for discussing questions about TYPO3 in the TYPO3 portal TYPO3.net by **Mittwald CM Service** . The extension currently consists of six different plugins and one backend module. These plugins provide the following features: **Message Board** – The *mm\_forum : Forum* plugin offers all the basic functionalities of a full-featured discussion board, e.g. the display of different message boards as well as threads and posts contained in these message boards. **User registration** – The *mm\_forum : User registration* plugin contains an own form for user registration. The mm\_forum extensions extends the user table by several new fields such as various new contact data (ICQ, MSN, AIM, YIM, Skype), interests or occupation. **Private messaging** – The *mm\_forum : Private messaging* plugin implements a messaging system allowing users to write private messages among each other. **Indexed Search** – The *mm\_forum : Search* plugin contains an own indexed search engine allowing very fast search queries. **User details** – The *mm\_forum : User settings* plugin offers functionalities for the user to edit his/her own user information. **Portal information** – The *mm\_forum : Portal information* plugin displays a complete list of all users that are currently on-line or have been recently on-line. Furthermore, it shows interesting statistics, like the amount of posts written in the forum. **Backend Administration module** – The backend module of the *mm\_forum* extension offers a wide range of functionalities allowing the administrator to easily configure the mm\_forum extension. The administrator is able to set up all message boards and categories, he/she can edit the mm\_forum template files, configure the smilies and BBCodes used in the forum plugin and even import data from an already existing phpBB message board. .. _Getting-started: Getting started ^^^^^^^^^^^^^^^ .. _Install-extension: Install extension """"""""""""""""" The first step to install the mm\_forum extension is – of course – to import it into your TYPO3 environment using the extension manager. To do so, go to the extension manager and select “Import extensions” in the drop-down menu on the top of the page: |img-3| Then select the extension file you downloaded from in the select box labeled “Upload extension file directly” and click on “Install”: |img-4| Before using mm\_forum,you need to tell mm\_forumwhere to find and store its data. For this, you should create a new page where your forum data are to be stored. Probably the best solution to do this would be to create a SysFolder for the data. You will also need an additional SysFolder for user data. If you have already a login system running on your site, you will probably be using this for your forum. Then you do not need another SysFolder for user data. |img-5| Now it is time to configure your extension. You will have noticed that an additional menu item appeared in your TYPO3 navigator that is labeled “mm\_forum”. If you do not see this button, reload the page once. |img-6| This menu item will take you to the mm\_forum backend module, which will allow you to properly configure your mm\_forum. If you see a scrollbar at the right part of the TYPO3 backend click on the bar between the tree and the forum backend module to see the complete backend module. The first thing you will have to do is to specify the mm\_forum data storage page (which you have just created) and the TYPO3 frontend user page: |img-7| Hit the folder icon next to the input field to open a page tree where you will be able to select your mm\_forum data storage page. In the next installation step, you will be asked to specify the user page. You can do this the same way as you did with the storage page. In the following installation step, you will be asked to specify two groups, the default user group and the administrator group. These two groups will be used by the mm\_forum to distinguish different user authentications. Later on you can add more groups, but these two are the only ones that are really required. If you have already some user groups existing, you can select these using the folder icon next to the input field. Just like in the steps before, you will have a page tree where you will be able to select the regarding group. Notice that all groups have to be located on the user storage page which you specified one step before. |img-8| If you do not have any groups at all yet, you can create a new group by hitting the plus icon. After you hit this icon, a form will be displayed where you can input all necessary options for the new user group. When you have specified everything, just click “Save and Close” and you will get back to the mm\_forum installation. Now you can select the newly created user group using the folder icon. The new user groups was stored automatically on the page you specified as user storage page. Do so with both groups. After setting all these values, the basic installation of the mm\_forumextension is complete. Now you will see the complete mm\_forum configuration tool, where you can set a lot of properties. As you can see, most of these fields are already filled out with the values you have specified during the installation or with default values, so regularly you do not need to change anything to run the mm\_forum. To use mm\_forum you must set is the **Board page** property in the **Forum** category. This is the page where you have placed your main mm\_forum plugin (too see how to do this, read the following chapter). .. _Create-Page-Content: Create Page Content """"""""""""""""""" Now you have successfully configured everything that is necessary to get started with the *mm\_forum* extension. All you have to do now is to create some pages and insert the required *mm\_forum* plugins on these pages. **Very important:** You have to include some mm\_forum static templates on the pages where mm\_forum plugins are used. It it recommended to include the static templates only where needed because they are quite huge. You can find a step by step tutorial is at the end of this chapter. As you will notice, the mm\_forum extension contains six different plugins, all with different functionalities (and different importance). The central plugin is the **mm\_forum : Forum** plugin. Since this plugin offers plenty functionalities, you will have to specify what the plugin has to show, by specifying a value in the “What to display” field. Consider the following table to get to know which plugin uses which configurations: .. ### BEGIN~OF~TABLE ### .. _mm-forum-Forum: mm\_forum :: Forum ~~~~~~~~~~~~~~~~~~ .. container:: table-row Plugin mm\_forum :: Forum What to display Message board Displays Displays the basic functionalities of the *mm\_forum* extension. This means the display of categories, message boards, threads and posts. For these options, you will not have to specify anything, the extension handles this on its own. This option also offers forms to create new entries and so on. .. _Unknown-Property: ((Unknown Property)) ~~~~~~~~~~~~~~~~~~~~ .. container:: table-row Plugin What to display Latest posts Displays Displays a list of the latest topic, meaning the topics that were last written in. .. _Unknown-Property: ((Unknown Property)) ~~~~~~~~~~~~~~~~~~~~ .. container:: table-row Plugin What to display List the user's posts Displays This option shows the post history of a *mm\_forum* user, i.e. presents a list of all posts this user has ever written. .. _Unknown-Property: ((Unknown Property)) ~~~~~~~~~~~~~~~~~~~~ .. container:: table-row Plugin What to display Email subscriptions Displays Shows the threads that are tagged as *observed* by the user that is currently logged in. .. _Unknown-Property: ((Unknown Property)) ~~~~~~~~~~~~~~~~~~~~ .. container:: table-row Plugin What to display Favorites Displays Shows the threads that are tagged as favorite by the user that is currently logged in. .. _Unknown-Property: ((Unknown Property)) ~~~~~~~~~~~~~~~~~~~~ .. container:: table-row Plugin What to display Reported posts Displays This options shows a list of all posts that were reported by users. A page containing this plugin should be only accessible by the administrator group. .. _Unknown-Property: ((Unknown Property)) ~~~~~~~~~~~~~~~~~~~~ .. container:: table-row Plugin What to display List post queue Displays This option lists all posts and topics that still have to be published by a moderator. This is only the case if the mm\_forum is used as „moderated board“, i.e. if moderators have to confirm all postings. .. _mm-forum-User-registration: mm\_forum :: User registration ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. container:: table-row Plugin mm\_forum :: User registration What to display [no configuration possibilities] Displays Implements a user registration form. .. _mm-forum-Private-messaging: mm\_forum :: Private messaging ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. container:: table-row Plugin mm\_forum :: Private messaging What to display [no configuration possibilities] Displays Contains the private messaging system. .. _mm-forum-Search: mm\_forum :: Search ~~~~~~~~~~~~~~~~~~~ .. container:: table-row Plugin mm\_forum :: Search What to display [no configuration possibilities] Displays Offers a indexed search function. .. _mm-forum-User-settings: mm\_forum :: User settings ~~~~~~~~~~~~~~~~~~~~~~~~~~ .. container:: table-row Plugin mm\_forum :: User settings What to display [no configuration possibilities] Displays Displays form allowing the user to edit his/her own user settings. .. _mm-forum-Portal-information: mm\_forum :: Portal information ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. container:: table-row Plugin mm\_forum :: Portal information What to display [no configuration possibilities] Displays Displays general information about the *mm\_forum* . This includes a list of users that are currently logged in and useful statistics. .. ###### END~OF~TABLE ###### If you select the item “Message board” in the “What to display” field, you will see another configuration item named “Show special page”. Here you will be able to select a special sub page of the “Message board” configuration to be displayed. This may be a listing of unread posts or posts that have not yet been answered. Setting this item on a separate page will create a shortcut to the actual “Message board” plugin (where the “Show special page” field is not set) which will be called with the regarding parameters (see **Administration** **► Special listing** ).After setting up the categories (see **Administration** **►Categories and Boards)** you canlimit the display to selected categories. It is recommended that you set up each of this plugins on a single page in the page tree. However, it is not necessary to implement all of these plugins. This may be useful if an administrator does not want to have a private messaging functionality implemented. See the screen shot below in order to see how you to set up the different plugins. |img-9| Finally, you have to specify the page where you have placed the main **mm\_forum :: Forum** (with “What to display” set to “Message board”) plugin on in the mm\_forum configuration tool. The regarding property can be found in **Install** **►** **Forum** **► Board page** . In this field you can open a page tree where you can just select your main mm\_forum page. If you decided to use the mm\_forum :: Private messaging plugin as well, you will also have to specify the page this plugin is placed on in the configuration tool ( **Install ► Private messaging ► Private messaging page** ) .. _Setup-the-forum: Setup the forum """"""""""""""" Now you have inserted the message board on your page. However, at this moment, there are no categories at all. To change this, go to the *mm\_forum* backend module in **Web** **►** **mm\_forum** . |img-10| In this module you have the opportunity to do all the forum administration. You have access to the following administrative settings: - **User administration** : Offers functions for administrating the mm\_forum users. - **Board Administration** : Create categories and message boards. - **Templates** : Edit the HTML Templates. - **Tools** : Add new smilies and post parser functions. - **Data import** : Import all your data from an existing phpBB board or the chc\_forum extension. - **Extend user profil** Add additional fields to the user profil. - **Install** Configuration options for the forum. - **Statistics** View statistics like new posts per month. - **User ranks** Configure user ranks. - **Updater** Update the extension from SVN. Use with care, as the svn- version might be unstable. .. _User-Administration: User Administration ~~~~~~~~~~~~~~~~~~~ In this form you can edit the forum users which are created in the user storage folder. |img-11| .. _Board-Administration: Board Administration ~~~~~~~~~~~~~~~~~~~~ This option allows the administrator to configure the message board structure. The mm\_forum is divided into categories and boards. So first you should set up a category and then add some message boards to this category. See the screenshot below to see how to create categories and message boards. You can read **Administration** **►** **Categories and Boards** for more information on how to administrate the forum structure. |img-12| .. _Templates: Templates ~~~~~~~~~ |img-13| In this section you can select a design set and edit the templates contained in it. This should be used only by experienced users. You can read **Customing** **►** **Template editing and design sets** of mm\_forum for more information. .. _Tools: Tools ~~~~~ In the Tools section you can add new emoticons or post parser options. Core emoticons and post parser functions are available by default. |img-14| .. _Data-import: Data import ~~~~~~~~~~~ The *mm\_forum* backend module offers the functionality to import all data from an existing phpBB message board or a CHC forum that is already installed as TYPO3 extension. The data import is classified into several steps. .. _Step-1-Select-import-procedure: Step 1: Select import procedure ''''''''''''''''''''''''''''''' In this step, you can choose, which forum data you want to import into the *mm\_forum* . You can import data from a phpBB board or an instance of the **CHC Forum** , a TYPO3 extension. The CHC import brings also an import possibility for private messages used in the **CWT Community** extension. .. _Step-2-Select-database-connection: Step 2: Select database connection '''''''''''''''''''''''''''''''''' Here you can select the database connection. You can use this feature to import data from an external database server. In most cases, you should just be able to select “Use local TYPO3 database”. .. _phpBB-import-step-3-Define-table-prefix: phpBB import step 3: Define table prefix '''''''''''''''''''''''''''''''''''''''' All MySQL tables used by the phpBB board are prefixed with a certain prefix. So the names of the phpBB boards follow the general pattern [prefix]\_[table name], for example phpbb\_posts. In the first step, you have to define the used prefix: |img-15| After having entered the table prefix, the import tool will check if all phpBB tables actually exist in the database. NOTE: The import tool uses a list of phpBB tables that is used in phpBB version 2.0.22. Is is possible that in older phpBB versions some of the tables used by 2.0.22 do not yet exist. In this case, the import tool will present a warning that one or more tables do not exist. Nevertheless you can continue by ignoring the warnings. |img-16| Only if some essential phpBB tables are missing, you will not be able to continue to the next step. If the import tool has found the phpBB tables, you can proceed with step 4. .. _phpBB-import-step-4-Select-import-data: phpBB import step 4: Select import data ''''''''''''''''''''''''''''''''''''''' In step 2 you can select, which data will be imported from the phpBB tables. If you have just installed the *mm\_forum* extension, it is recommended to import all data. |img-17| As you can see, the import tool displays the phpBB tables that are necessary for the import process. If one of these tables is not found and you try to import this data none the less, you will not be able to continue the data import. If you have selected the data you want to import, just proceed with step 5. .. _phpBB-import-step-5-Specify-import-options: phpBB import step 5: Specify import options ''''''''''''''''''''''''''''''''''''''''''' In this step, you will have to configure some further options that are necessary before the import is accomplished. |img-18| The import tool will recommend default values for most of the fields (in this case mostly the page UIDs you specified during the installation). In the majority of cases you should be able to leave all these values just the way they are. If everything is correct, hit “Continue” to proceed with step 6. .. _phpBB-import-step-6-Perform-import: phpBB import step 6: Perform import ''''''''''''''''''''''''''''''''''' In step 4, the data import will finally be performed. You will see a list of what records are imported from the phpBB tables and where necessary also a list of errors that occurred during the data import. .. _CHC-import-step-3-Select-import-data: CHC import step 3: Select import data ''''''''''''''''''''''''''''''''''''' Here you may select what data you want to import. You can choose between importing the CHC Forum data or the CWT Community data, or – of course – both. If one of these two extensions is not installed, you will not be able to perform this import process. |img-19| .. _CHC-import-step-4: CHC import step 4: '''''''''''''''''' After hitting “Continue” the CHC/CWT data import will start automatically. Please notice that all existing mm\_forum data will be deleted before importing the CHC/CWT data. .. _Screen-shots: Screen shots ------------ The mm\_forum opens with a view of all categories and sub forums to which the current user has access to: |img-20| When the user clicks on one of the boards, the extension returns a list of all topics which are available in this message board. |img-21| The user clicks on a topic and receives the list of posts that are contained in this topics. The user has also the possibility to write a reply to an existing topic, which will be appended at the end of the topic. |img-22| |img-23| The user is allowed to edit his profile in order to add a email address, messenger information, change password or add an avatar. |img-24| The extension has its own private messaging system where the user is allowed to see incoming or outgoing private messages, write new messages, move older messages to an archive or delete messages. |img-25| If you want to show an overview about the logged in users this will look like the following. **Note: If you have TYPO3 version 4 or higher you must install the extension sys\_stat. If you have a lower version, this extension is installed automatically.** |img-26| The mm\_forum extension has its own search engine. The user can select a special forum or select all forum in which will be searched or can select a different sorting method for posts |img-27| Also a backend module will be installed with the mm\_forum extension |img-28| .. _generated: ((generated)) ^^^^^^^^^^^^^ .. _How-to-include-the-static-templates: How to include the static templates """"""""""""""""""""""""""""""""""" Click on the “Template” menu item on your TYPO3 navigator. |img-29| Go to the site(s) where you are using mm\_forum plugins. Create an extension template (if none exists). |img-30| |img-31| If there is an extension template, edit the whole template record. Go to the “Includes” tab an include static templates (from extensions). Please note that in mm\_forum uses by default a new pagebrowser that needs the extension “pagebrowse” and the static template included. |img-32| .. _Static-templates-Prototype-or-jQuery: Static templates: Prototype or jQuery """"""""""""""""""""""""""""""""""""" New in mm\_forum 1.9.0 is the support of jQuery. As a result there are two static templates: One for prototype and one for jQuery. **Warning:** Only one static “mm\_forum Javascript” template is allowed to be included. If you include all mm\_forum templates you will get Javascript errors and mm\_forum will not work as expected. Choose one of the following configurations (Prototype or jQuery): |img-33| |img-34| **Attention:** Please include the static “mm\_forum Javascript” template before the main static mm\_forum template. Otherwise some functions will be broken! .. _Users-manual: Users manual ------------ .. _Data-organization: Data organization ^^^^^^^^^^^^^^^^^ The central elements of the *mm\_forum* message board are the **boards** themselves. These are grouped in **categories** .Access to boards and categories can be limited to specific user groups. You can specify which groups may read and which groups may write in a certain category or board. This allows you for example to create an internal section in which administrators and moderators can lead internal discussions, an internal board for special work groups or a board that all user can read, but only administrators can write in, that might be used as an announcement board. Furthermore, you can specify moderator groups separately for each category and forum. Only members of these groups will have moderating access to these categories and forums. Please note that all permissions that you specify for top level categories are inherited to the categories' child boards. The boards contain **topics** . Each topic represents a discussion on a specific subject. Users' contributions to a topic are represented by **posts** . In the default view of a topic, all posts belonging to this topic are listed in the order they were written in. Since each topic is usually about one central point of discussion or a problem, there is a possibility to mark a topic as solved, when a solution to the problem has been found. This makes is easier for other users searching for solutions for their problems to see whether an issue has already been solved. .. _Create-new-topics-and-posts: Create new topics and posts ^^^^^^^^^^^^^^^^^^^^^^^^^^^ |img-35| As you know, all posts are organized in topics. Before writing an own post a topic has to be created. Topics are created by clicking the “New Topic” button. You will get an input form where you will be able to enter the new topic's title and the text of the first post of the topic. Additionally you can create a poll or attach one or more files to the post depending on the settings in **Install** **►** **Forum** **►** **File attachments** . After saving the new topic it will be displayed in the topic list of the regarding board. Users can reply to other posts. If a user writes a replying post to another post, it will be appended to the same topic. To reply to a topic, you can either click the button “Reply” at the bottom auf the page or the button “quote” below a specific post. If you hit the “quote” button, you will quote this post in your new post. This will prove useful if you want to refer directly to something another user wrote. In any case, you will see an input form that is similar to the one you see when you create a new topic. However, you will not be able to specify a title, since only topics have titles. In both the topic creation and post creation form you will have access to some predefined so-called BBCodes. These allow you to apply some formatting to your post's text (see the regarding chapter). If you have completed your post, you can hit either “Preview” or “Save”. If you hit “Preview”, you will see a preview of what your post will look like, but the post will not yet be saved. You can save your post by hitting the “Save” button. .. _Editing-posts: Editing posts ^^^^^^^^^^^^^ Users have a limited possibility to edit their own posts. A user can edit his/her post, until nobody replied to this post. If you edit a post, you will see the same form you see when you create a new post. Moderators and administrators have the authorization to edit all users' posts at all times, even if they have already been answered. .. _BBCode: BBCode ^^^^^^ The *mm\_forum* extension offers so-called BBCode allowing users who write posts to format their posts. BBCode is a mark-up language for text formatting similar to HTML, but with a much simpler syntax. The advantage of this system is, that on the one hand it is easier to use than a direct input of HTML code, which frightens a lot of inexperienced users. On the other hand, the use of BBCode is much more saver than allowing HTML codes, since now HTML in posts can be completely disabled, preventing that a user disrupts the page's layout using defective HTML or even attack the visitor's system using implemented Java Script code (in technical jargon, this issue is called *Cross Site Scripting* , or short *XSS* ***`:sup:`0` <#sdfootnote1sym>`_*** ). All this is impossible. The most common BBCode elements, as they are used for example in other message boards, are already included in the mm\_forum extension. Usually, you wrap the passage you want to format with a specific opening and closing tag. Closing tags are marked with a slash ( / ). For example, to print a text in bold type you might use the following BBCode: :: [b]This text is written in bold print.[/b] This text isn't. The following table presents an overview on the BBCode elements that come along with the *mm\_forum* extension. Using the *mm\_forum* backend module, you can configure your own BBCode elements (see the **Administration** **► Tools** ). .. ### BEGIN~OF~TABLE ### .. _: :: "" .. container:: table-row BB code :: [b]...[/b] Description Bold Example :: [b]Bold text[/b]. Normal text. .. _: :: "" .. container:: table-row BB code :: [i]...[/i] Description Italic Example :: [i]Italic text[/i]. .. _: :: "" .. container:: table-row BB code :: [u]...[/u] Description Underlined Example .. _: :: "" .. container:: table-row BB code :: [color=COLOR]...[/color] Description Prints a text in color. For COLOR you can either specify a color (like “red”, “green”, “black” etc.) or give an hex code like #FF0000 Example :: [color=red]Red text[/color] [color=#00ff00]Green text[/color] .. _: :: "" .. container:: table-row BB code :: [url]...[/url] [url=...]...[/url] Description Applies a hyperlink to another web page to the text. You can either just wrap the link with the [URL] tags or specify the link inside the opening tag and give a link text inside the two tags. Also links to email addresses. Example :: [url]http://www.typo3.net[/url] [url=http://www.typo3.net]Click me[/url] .. _: :: "" .. container:: table-row BB code :: [link]...[/link] Description Same as [URL] Example :: [link]http://www.typo3.net[/link] .. _: :: "" .. container:: table-row BB code :: [img]...[/img] Description Includes an image to your post. For IMAGELINK you have to specify the image's URL. Example :: [img]myimage.jpg[/img] .. _: :: "" .. container:: table-row BB code :: [size=...]...[/size=...] [size=...]...[/size] Description Spezifies the size of the text. You can use values between 1 and 9. The text will be wrapped in Bigger Text if you use 2 as value. Example :: [size=2]Bigger Text[/size=2] [size=2]Bigger Text[/size] .. ###### END~OF~TABLE ###### .. _Private-Messaging-System: Private Messaging System ^^^^^^^^^^^^^^^^^^^^^^^^ The *mm\_forum* extension has got its own private messaging system and you can insert it as a regular page content. In order to do this you must insert the Plugin **mm\_forum :: Private messaging** on your selectedpage. After this you can go to the frontend and you are now ready to use the private messaging system. In this system you have the following opportunities: - **Read private messages:** Of course, you can read private messages that other users have sent to you. You will see the message's sender and the message text. - **Write new messages/Reply to messages:** You can write new messages to other users or reply to messages that other users have sent to you. A pop up search window that updates itself in real-time will help you to find your message's recipient. - **Move messages to archive/Delete private messages:** To keep your inbox clearly arranged, you can delete messages. If you do not want to delete messages, although they are not current anymore, you can move them into an archive directory. In order to read a PM you must click on the message you want to read. Now you have the opportunity to answer the message or delete the message. If you want to answer, click on the button “reply”. Then you will get a input form with prefilled input fields. It is the same input form as the new PM form. If you want to change the recipient, click on the button “Search” and you will get a list with all registered users. Now you can click on the user you want to send the PM. If you know the recipients name you can input it in the input field directly. With an AJAX function you will get a recommended list where you can select the requested user name (it is required that you have Java Script enabled for this). |img-36| |img-25| |img-37| .. _Polls: Polls ^^^^^ Provided that polls are enabled in the mm\_forum configuration tool and that the currently logged in user is authorized to create polls, it is possible to attach a poll to each topic. A poll consists of a question and several answering possibilities. Users can vote for one of these answering possibilities. Of course, every user can only participate once on a specific poll. If a user has already participated on a poll or if the poll has expired (see later), he/she will see the poll results, even with a graphical representation. You can create a poll either on topic creation or afterwards, when editing the first post of a topic. The poll creation form is part of the post creation form and looks like this: |img-38| As you can see, the number of answering possibilities is not fixed. You can add additional answering possibilities to the existing ones or on the other hand delete already existing answering possibilities. Only filled fields will be saved, meaning, if you leave an answer field empty, no answer will be created. If you set the poll expiration date, the poll will expire after this date and no one will be able to participate on it any more. Besides from creating a poll together with a new topic, you can also create polls afterwards. To do so, just edit the topic's first post and you will have the same options as you have in the new topic form. In order to edit or delete an existing poll, you also have to edit the topic's first post. To delete a poll, just uncheck the “Attach poll” check box. .. _File-attachments: File attachments ^^^^^^^^^^^^^^^^ Users have the possibility to upload files to the server the mm\_forum extension is installed on and to attach them to their posts. Of course, this feature has to be enabled in the mm\_forum configuration. There you can configure which file types you want to allow and how many attached files per post you want to allow. In order to attach a file to your post, select a file from your computer in the file attachment field in the post creation form. Notice the maximum file size for attachments. The default value for the maximum file size is 1 megabyte, but the actual value may depend on the forum configuration. The forum extension will not accept any files that are bigger than allowed. Furthermore, there are some file types that are not accepted by the forum extension. However, these denied file types also depend on the forum configuration. If the file type of a file you want to upload is not accepted, you will notice. |img-39| Just hit the “Save” button and your file upload will take place. Notice that, depending on the file size, the upload may take a moment. If you have uploaded an image file, the mm\_forum will display a preview image in the post listing view allowing users to take a look at attached image files before downloading them. However, this is another feature that depends on the forum configuration. .. _Forum-Moderation-Administration: Forum Moderation/Administration ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ .. _The-moderated-forum-mode: The moderated forum mode """""""""""""""""""""""" As of version beta 0.1.2, you can set the mm\_forum to the moderated mode. In this mode, postings made by users will not appear instantaneously in the forum, but will rather be stored in an inactive status until they are published by a moderator. The idea behind this feature is the possibility for moderators to be able to better control what their users write. To be able to publish the post that are stored in the so called „post queue“, you have to insert a „List post queue“ content element (see section „Getting started“). You should protect this page against unauthorized access using the TYPO3 internal access control functionalities. |img-40| The moderator panel for publishing posts looks like on the following screenshot. The moderator has different options on what to do with the queued posts. The posts can either be marked to be - **published (P):** In this case, the queued post or topic will be inserted into the public area of the forum. At the same time, the post/topic will be removed from the post queue so that it disappears from this list view. The post/topic will be visible as any regular post in a usual (non-moderated) mm\_forum instance. - **ignored (I):** If a moderator does not know what to do with a post, maybe because the post's content is, although it does not violate any board regulations directly, highly questionable, while at the same time he wants to publish the remaining unquestionable posts, he can select a queued post/topic to be ignored. The post/topic will neither be published nor deleted and remains in the post queue list. - **deleted (D):** If a posts violates board regulations or any laws, the moderator can decide to just delete the post without publishing it. The post will not be published and not appear on the post queue list any more. The moderated mode can be enabled using the mm\_forum configuration module. .. _The-administration-panel: The administration panel """""""""""""""""""""""" If you have defined administrators in the backend they will have some more possibilities in the forum. For example, members of the administrator group see a special administrator panel on the top of every topic they visit, where a moderator has got some special options: - **Topic title:** Here you can change the topic's title. - **Topic prefix:** You can apply a specific prefix to a topic. A list of predefined prefixes is defined in plugin.tx\_mmforum\_pi1.prefixes. In the **prefix listing** special view, users have the possibility to have only topics with a certain prefix listed. - **Move topic:** Moderators can move a topic from one forum to another. - **Close topic:** If a topic is closed, regular users will not be able to write in it anymore. However, moderators and administrators will still be able to reply to this topic. - **Fix topic:** Regularly, in the topic listing view, topics are ordered descending by the time the last reply was written. Topics marked as fixed will always be displayed on the top of the topic list, no matter when the last reply was written. - **Delete topic:** Ok, this should be self-explaining... .. _Post-reports: Post reports """""""""""" Each user is allowed to report a post to the moderators and administrators. He/she must input a reason for this post being reported. |img-41| Regularly, this feature is used for users to report posts that violate either the board rules or even laws so that these posts can be deleted and the authors be warned or banned. If you create the content element **Plugin: mm\_forum :: Forum** and select **Reported posts** in **What to display** ,all moderators and administrators get a list with the reported posts and check the reported posts. **NOTE: Since the mm\_forum extension does not check the user authentication in the post alert listing, it is necessary that you protect this page using the TYPO3 internal user authentication functionality.** |img-42| .. _How-to-search: How to search? ^^^^^^^^^^^^^^ The mm\_forum extension has got its own search module and you can put it as a normal page content element. But at first you must index your board. For this you must logged in as a administrator into the frontend and go to the page with the search form. There you will find a link to start the indexation process. To make the search indexation automatically, you will have to write your own CronJob which starts the indexation function. |img-27| This link is only shown for administrators. After you indexed your board, you can input your search word in the input field and click on button “Start search”. The mm\_forum search brings various filter options. These are explained in the mm\_forum search quick guide. .. _Administration: Administration -------------- .. _Categories-and-Boards: Categories and Boards ^^^^^^^^^^^^^^^^^^^^^ You can use the backend module to configure the categories and boards in the *mm\_forum* . To do so, select “Board administration” from the drop down list. In this view, you will see the whole forum structure in a tree view. On the first level there are the categories, while on the second level the subordinate message boards are listed. To create a new category, just click on the **New Category** item in the tree view. To create a new message board, click on the New Forum item in the child branch of the category you want to create a new forum for. To edit a category or message board, click the regarding object in the tree view. In both the category and the forum forms you have the following input fields to fill out. - **Title:** This is the forum/category name. Should be self-explaining. - **Description (forum form only):** A short description of the regarding forum. This will be displayed below the forum name in the forum listing view. - **Order:** This field describes the position of this category/forum in relation to the other categories/forums. The categories/forums will be displayed in exactly the same order as specified in the backend module. - **Read/Write access:** Here you can specify, which user groups should be allowed to read or to write in this category or forum. If you do not specify anything, all users will be able to read or to write in this category/forum. Subordinate forums will inherit this attribute from their parent category, although you can also specify group rights for single forums. For more information on user access management, you can read **Administration** **► User rights management** . By clicking on the page icon in the bottom right corner of the form while editing an existing category or forum you can open the advanced category/forum editing form that allows you to edit nearly every attribute of the category/forum record in the database. This feature should used only by administrators. |img-28| .. _Tools: Tools ^^^^^ Under the point “Tools” you will find several useful tools allowing you to customize your version of the *mm\_forum* extension. .. _BB-Codes: BB Codes """""""" With this tool, you can define your own BBCode elements. In the *mm\_forum* extension, a BBCode consists of three elements. First the code itself, second a regular expression telling how the code is recognized in a post's text and third a replacement pattern. The second and the third value are parsed by the PHP function preg\_replace(see `http://www.php.net/preg\_replace `_ for further information). Furthermore, you can take a look at the already existing BBCode elements that were installed along with the *mm\_forum* in order to understand how the BBCode implementation system works. .. _Smilies: Smilies """"""" You can also add custom smilies to your mm\_forum. Defining a new smiley is very simple. You just have to define which image file should be used for the smiley (the backend module looks for smiley images in the directory EXT:mm\_forum/res/smilies) and the code this image is associated with. This code will be replaced later on with the actual image. .. _Syntax-Highlighting: Syntax Highlighting """"""""""""""""""" The mm\_forum extension uses the Generic Syntax Highlighter plugin (GeSHi) by Nigel McNie in order to offer syntax highlighting of code samples in various programming languages. To configure which highlighting options you want to offer, you can select the **Syntax highlighting** option in the **Tools** menu. The syntax highlighter options work pretty much like the BBCode options. You can specify a programming language (you can only select languages that are supported by GeSHi) and a replacement pattern (again, see `http://www.php.net/preg\_replace `_ for further information). .. _Data-import: Data import ^^^^^^^^^^^ Using the data import tool, you can import data from other forum applications, like for example the phpBB board or the CHC Forum extension for TYPO3. .. _phpBB-data-import: phpBB data import """"""""""""""""" Using the phpBB data import tool, you can import nearly all data from an already existing phpBB board into your newly created *mm\_forum* board. The import tool is specified for the newest phpBB version, which is 2.0.22. .. _Step-1-Select-import-procedure: Step 1: Select import procedure ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ In this step, you can choose, from which application you want to import. For a phpBB data import, of course you choose **phpBB** as import option. .. _Step-2-Select-database-connection: Step 2: Select database connection ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ In this step you can specify a database connection that is to be used for the data import. This allows you to import data from an external MySQL server. If you select **Use local TYPO3 database** , the local database will be used for the data import. In case you select an external server as data origin, you will have to specify the connection data for the MySQL database on this server, i.e. the server address and a MySQL user name and password. On the other hand, if you choose to import from the local database, you will not have to specify any access data, since this data is already known to the import script. .. _Step-3-Define-table-prefix: Step 3: Define table prefix ~~~~~~~~~~~~~~~~~~~~~~~~~~~ All phpBB tables are prepended with a specific prefix, allowing to distinguish different phpBB installations in the same database. Since the install tool does not know, what prefix your phpBB tables have, you will have to specify this prefix before starting the import process. This you do in step 1. |img-16| As soon as you click on “Update”, the install tool will check in the database, if all required phpBB tables do actually exist. Since in some of the latest phpBB versions, some new tables were added, the import tool does not make a great deal of some tables missing. However, it will display a warning message and ask you to confirm if you really want to go on with the import. At this point you do not have to worry about the import maybe going wrong. If there is a vital table missing, you will get to know in the next step. However, if the install tool does not find any of the required phpBB tables, you will not be able to proceed with the data import. **NOTE: Although all phpBB table names follow the pattern [prefix]\_[table name], you will not have to append the underscore (\_) to the prefix you specify. This will be done automatically.** .. _Step-4-Select-import-data: Step 4: Select import data ~~~~~~~~~~~~~~~~~~~~~~~~~~ |img-17| In this step, you can specify, what data exactly you want to have imported. The import tool will show you, which tables are required for each data. If one of these tables does not exist, you will not be able to perform the import. You will also notice, that there are interdependencies between the different data areas. The reason for this is that there is a high amount of references between different tables. For example, in the post table it is stored, which user did create a certain post. Now of course without importing the users also, the link between the post table and the user table will be broken and it would be impossible to determine who actually wrote this post. However, it is possible to import all the data in several steps, since the import tool knows, which data have already been imported and which have not. If you have selected everything you want to import, you may proceed with step 3. .. _Step-5-Specify-import-options: Step 5: Specify import options ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ |img-18| On this page, you can define further options for data import. The fields you see on this form are depend on the fields you selected for import in step 2. The import script proposes default values for most of the fields, that it gets from the data you specified during the installation. However, you should check this data before importing. You have also the possibility to completely clear all data from the *mm\_forum* tables before importing. If you have just installed the extensions, this will not be necessary, since the tables are still empty anyway. Anyway, this feature might prove useful, if you want to override data that already exists, maybe from a previous data import. **NOTE: Although TYPO3 handles database record deletion by just setting a “deleted” flag to 1 while the actual record remains in the database, this is not practised if you select all data to be deleted in the import tool. The records will be deleted by a MySQL DELETE order, so be careful when deleting the entire *mm\_forum* database.** :underline:`**You will not be able to get back your data once it has been erased.**` When you are sure that all settings are correct, you may proceed with step 4. .. _Step-6-Perform-import: Step 6: Perform import ~~~~~~~~~~~~~~~~~~~~~~ |img-43| In step 4, finally the actual data import will take place. However, if you checked one of the “clear all” fields in step 3, you will be asked, if you really want to delete all data. Additionally, since this process might also affect the global fe\_users table, you will have the possibility to define, which entries from the fe\_users table shall not be deleted. You can do this by just defining a list of user UIDs and user group UIDs. The users/user groups with these UIDs will not be deleted. Alternatively, you can also define a complete MySQL WHERE-clause. After you have entered all these settings, you will be able to start the import. .. _Data-organization-relations-between-phpBB-and-mm-forum: Data organization relations between phpBB and mm\_forum ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ The mm\_forum and the phpBB software have different ways to organize their regarding data. That is why there are so many setting you can make before actually performing the import. For example, the phpBB distinguishes between forums and categories, a difference that the mm\_forum does not make. So both the phpBB category and the phpBB forum data are imported in the *tx\_mmforum\_forums* table. Another difference is in how the phpBB and mm\_forum handle user authentications. The phpBB user authentication offers a wider range of options regarding access control, which makes this more flexible, but also more complicated. For example, the phpBB makes a difference between the right to create new topics, to create new posts and to edit posts, while in the mm\_forum, all these rights are combined in the *write access* field. In addition, the mm\_forum does not have an extra table for storing user authentication like the *phpbb\_auth\_access* table in the phpBB board, but stores these data directly in the forums table. Furthermore, the phpBB offers some functionalities that are not implemented in the mm\_forum, such as the mm\_forum offers some functionalities that are not implemented in the phpBB. For example, the phpBB offers the possibility to create polls or to change between different color profiles. Since these functions are not supported in the mm\_forum, the regarding data will of course not be imported. .. _CHC-Forum-CWT-Community-data-import: CHC Forum/CWT Community data import """"""""""""""""""""""""""""""""""" Using the CHC Forum import tool, you can import all data from the CHC Forum TYPO3 extension. **Please notice that all mm\_forum data will be erased before the CHC Forum data import.** **NOTE: Although TYPO3 handles database record deletion by just setting a “deleted” flag to 1 while the actual record remains in the database, this is not practiced if you select all data to be deleted in the import tool. The records will be deleted by a MySQL DELETE order, so be careful when deleting the entire *mm\_forum* database.** :underline:`**You will not be able to get back your data once it has been erased.**` .. _Step-1-Select-import-procedure: Step 1: Select import procedure ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ This step is analog to the regarding step of the phpBB import. Of course, you will have to select **CHC Forum** instead of **phpBB** . .. _Step-2-Select-database-connection: Step 2: Select database connection ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ This step is also analogue to step 2 of the phpBB import. .. _Step-3-Select-import-data: Step 3: Select import data ~~~~~~~~~~~~~~~~~~~~~~~~~~ In this step, you can choose which data you want to import. You can import all data from the CHC Forum extension. Furthermore, you can import the private messages from the CWT Community extension. If one of these extension is not installed, you will – of course – not be able to import the regarding data. The missing of one of these extensions will not affect the data import of the remaining data. Hit “continue” to start the data import. .. _Step-4-Conduct-data-import: Step 4: Conduct data import ~~~~~~~~~~~~~~~~~~~~~~~~~~~ In this step the actual data import of the CHC/CWT data will take place. The import script will show you how much records were imported. .. _Install-module: Install module ^^^^^^^^^^^^^^ You can use the installation module to configure your mm\_forum in a very easy way. The input fields in the configuration module are described in detail and should be self-explaining. You will find more on the configuration module in the **Configuration** chapter. .. _Search-index: Search index ^^^^^^^^^^^^ The search function in the mm\_forum :: Search plugin needs a search index in order to function properly. Only indexed posts will be found in a search process. So, in order to guarantee a high search efficiency, an indexing has to take place in regular intervals. In general, there are two ways, to index the posts of the *mm\_forum* for the search function. .. _The-manual-Mode: **The manual Mode** """"""""""""""""""" If you are logged in as an administrator, you will see a link labeled **Start indexing** below the search function. If this link is clicked, the script will automatically update the search index. However, this has to be done manually in regular intervals. A more elegant solution is the automatic indexing using a CronJob. .. _The-CronJob-mode: **The CronJob mode** """""""""""""""""""" .. _Web-based-cronjob-call: Web based cronjob call ~~~~~~~~~~~~~~~~~~~~~~ If you have access to a *crontab* you can call the index script by using the text browser LYNX. Insert the following line into your *crontab* and the script will run all 15 minutes: :: -*/15 * * * * user Lynx "http://www.domain.tld/forum/search.html?tx_mmforum_pi4[ind_auto]=1&tx_mmforum_pi4[indexingPassword]=admin" –accept_all_cookies > /dev/null This line (notice that the code above is a single line!) calls the text browser **Lynx** every 15 minutes. Of course you will have to change the URL to the page where you have inserted the **mm\_forum :: Search** plugin. Furthermore, you will have to change the user name to a specific system user, and the password to a value defined in the constant :code:`plugin.tx\_mmforum.indexingPassword` . The result of the page call is put to /dev/null. It is highly recommended to change the indexing password specified in the TS constants (see above) to another value than “admin”. Of course you are free to alter the indexing internal from 15 minutes to every interval that you like. You should however notice, that the search is the more precise than the interval gets shorter. If you have no access to *crontab* you can use a web cron service. Ask *Google* for good service. .. _Internal-cronjob: Internal cronjob ~~~~~~~~~~~~~~~~ You can also set up the indexing cronjob using a command-line PHP script. Take a look at the chapter **Administration – Cronjobs** for more detailed information on how to set up a CLI cronjob. .. _User-rights-management: User rights management ^^^^^^^^^^^^^^^^^^^^^^ The mm\_forum extension offers a flexible user rights administration. As you may have already seen in **Administration s** **Categories and Boards** , you can specify for each board and category which user groups may read or write in this category or board. You can specify several user groups that are allowed to read or to write in a board or category, however, users have to be in only one of these user groups to have access to this category or board. Another interesting aspect is, that boards inherit the access settings from their parent category. This means that all boards in a category that can be read only by administrators, can also only be read by administrators, without this being specified in the regarding board records.An interesting consequence of this fact is, that this provides you with a possibility, to combine user access settings in many ways. If there is for example a category that is only accessible by Group A, and this category contains a board that is only accessible by Group B, then this board is in fact only accessible by users that are in fact members of Group A AND Group B. On the other hand, a board that is accessible by Group A and Group B, may be accessible by users that are members of either Group A OR Group B (or Group A AND Group B). If you do not specify any groups at all, all users will have access to this category board. However, there is one small discrepancy: If no groups are specified in the **Read** -field, then all users are allowed to read posts in this board; even visitors that are not logged in at all. On the other hand, of to groups are specified in the **Write** -field, then only visitors that are logged in are allowed to write something; the visitors that are not logged in are not allowed to write contributions in any case. In other words, there is no difference between leaving the Write-field empty and just specifying the *mm\_forum* default user group that contains all users. Because all of this might seem very abstract, you will find a list of possible applications of this user rights management possibility in the following paragraph. - **Internal sections:** By limiting read and write access to moderators and/or administrators, you can create an internal section in which moderators and administrators can discuss about internal topics that the rest of the community does not have to know about. - **Announcement boards:** By allowing read access to all users and limiting access to e.g. moderators and administrators or a special group of news reporters, you can create an announcement board in which only a small group of users can write announcements that can be read by all users. .. _Special-listings: Special listings ^^^^^^^^^^^^^^^^ .. _Prefix-listing: Prefix listing """""""""""""" As you may have noticed, moderators and administrators have the possibility to apply a certain prefix to a topic, like e.g. “HowTo” or “Info”. The *mm\_forum* extension offers a functionality to display all topics with a certain prefix. The idea behind this feature is that moderators can e.g. apply the prefix “HowTo” to topics where a solution to a certain problem is explained in a very easy and comprehensible way or that contain a detailed description on how to do something, and that users can later on see all topics marked as e.g. “HowTo”. To implement a prefix listing functionality on your site, you just have to create a link to the page the **mm\_forum :: Forum** plugin is placed on, supplemented with the following parameters: :: &tx_mmforum_pi1[action]=list_prefix&tx_mmforum_pi1[list_prefix][prfx]=PREFIX Replace PREFIX with your own custom prefix (without brackets). .. _Unanswered-posts: Unanswered posts """""""""""""""" You can also list all posts that have not yet been answered. To go to this special list view, you have to create a link to the page the **mm\_forum :: Forum** plugin is placed on, supplemented with the following parameters: :: &tx_mmforum_pi1[action]=list_unans .. _Unread-posts: Unread posts """""""""""" Furthermore you can list topics that contain replies the user that is currently logged in has not yet read. To access this special list view, you have to create a link to the page the **mm\_forum :: Forum** plugin is placed on, supplemented with the following parameters: :: &tx_mmforum_pi1[action]=list_unread .. _Link-to-special-listing-pages-using-FlexForms: Link to special listing pages using FlexForms """"""""""""""""""""""""""""""""""""""""""""" As of *mm\_forum* version 0.0.4, you have a FlexForm configuration field for the **mm\_forum :: Forum** plugin. There you will have the possibility to create a shortcut to one of these special listing without specifying such a complicated url as mentioned above. You just have to create a new page in the page tree, insert a new instance of the **mm\_forum :: Forum plugin** on it. In the FlexForms configuration of this new instance, you set “What to display” to “Message board” and “Show special page” to “List unanswered topics”, or to whatever you like. **NOTE: You will have to save the plugin instance once after setting “What to display” to “Message board” before you will be able to see the “Show special page” item.** If this plugin is called in the frontend, it will redirect the visitor to the main instance of **mm\_forum :: Forum** (defined in the TS constants in plugin.tx\_mmforum\_boardPID), with the URL being supplemented with the correct parameters (that are also explained above). .. _Extending-the-user-profile: Extending the user profile ^^^^^^^^^^^^^^^^^^^^^^^^^^ .. _Basics: Basics """""" The mm\_forum extension offers the possibility to extend the user profile by a (theoretically) unlimited amount of additional fields. These fields can then be filled out by the users on registration and edited later on. The administrator can define whether the information entered in these fields shall be public or only visible to the administrator. |img-44| To extend the user profile, go to the menu point **Extend user profile** in the mm\_forum backend module. Here you will see a list of fields the user profile was already extended with. Here you will see that most of the input fields that are displayed during user registration and editing are actually handled as a custom user field. These default user fields are imported with the static table data during the installation of the extension. You can use the button labelled *New field* to create an additional profile field. You can sort the profile fields using the up and down buttons. The *delete* , *up* and *down* buttons should be self-explaining. Using the *Edit* button, you get to the user field editing form. Here, you have the possibility to configure your user field to the finest detail: - **Field Name** . This is the title of the user field. It will be used as label in the registration and editing form and the public profile overview. This field is multilingual, so by clicking the flag, you can add a translation in a language of your choice. - **Required** . This check box defines whether this field is required to be filled in by the user. If the user leaves a required field empty on registration or an update, an error message will be displayed. - **Restricted visibility** . If this field is checked, its contents will only be visible to the user him-/herself and to the administrator. - **Link with fe\_user table** . Here you can define, in which column of the fe\_user table the contents of this field are to be saved. If you leave this property empty, the contents of this field will be stored in an additional table and not in the fe\_user table. - **Field Type** . Here you can specify the field type of you user field. There are four predefined field types (text field, radio button, check box and selection list). However, by using the custom field, you can specify a user field of any type you like. See the section *Custom user fields* of this manual for more information. |img-45| .. _Custom-user-fields: Custom user fields """""""""""""""""" Although the interface presents a set of predefined field types, every user field is defined by a certain typo script configuration. If you choose one of the four predefined types, this configuration will be written automatically. If you choose *Custom* , you are on your own. In the typo script configuration, three content elements have to be defined. These are called *label* , *input* and *output* . The label object is used for generating the field label in forms and the public profile. The input object is used to generate a input field for the registration or user editing form, while the output object is used to render the read-only output for the public profile. All these objects have to be regular typo script objects. The rest is up to you. A variable named “fieldvalue” will be loaded into the data array, allowing you to dynamically access the user field's field value. Furthermore, the markers ###USERFIELD\_NAME###, ###USERFIELD\_UID### and ###USERFIELD\_VALUE### will be substituted in the generated content. To make the whole topic more understandable, you will find an example field configuration in the following paragraph. This will create a simple checkbox in the user settings field. The field value will be translated to “1” or “0” in the public user profile: :: label = TEXT label { value = Likes beer } input = COA input.1 = TEXT input.1.value = input.2 = CASE input.2 { default = TEXT default.value = 0 = TEXT 0.value = 1 = TEXT 1.value = key.field = fieldvalue } output = CASE output { key.field = fieldvalue 0 = TEXT 0.value = No 1 = TEXT 1.value = Yes } Another example field configuration for extending the user profile with a dropdown field: :: label = TEXT label { value = Design } input = CASE input { stdWrap.wrap = default = TEXT default.value = 1 = TEXT 1.value = 2 = TEXT 2.value = key.field = fieldvalue } output = TEXT output { value ( ) } .. _User-ranks: User ranks ^^^^^^^^^^ The mm\_forum extension offers a functionality for forum users to obtain user ranks in dependence of their post count. In simple words: The more posts a user has written, the higher is his/her rank. The user ranks can be configured using the **User ranks** section in the mm\_forum Backend module. |img-46| The post count described in this table is the minimum post count a user has to have in order to obtain this rank. In the example above, a user with 30 posts would have the rank “Newbie”. Ranks with the predicate “special rank” can be applied to certain user groups. Users from these groups will always have this rank no matter their post count. This is a useful feature in order to label administrators or moderators as just that. To apply a rank to a user group, edit the regarding user group using the TYPO3 list-module. There you will be able to select the user rank applied to this group: |img-47| If the user rank is marked as “exclusive” (see picture above), this is the only user rank members of this group will have. If a user rank is not exclusive, members of this group will have two ranks, first the one that is dependent from their post count, and then the one resulting from the group configuration. If the rank is marked as exclusive, than only this rank will be displayed. .. _Statistics-module: Statistics module ^^^^^^^^^^^^^^^^^ As of version beta 0.1.0, the mm\_forum extension includes a statistics module allowing you to see information on the development of the amount of posts, topics and user registration. You can select between different resolutions, which reaches from whole months as smallest units down to single hours. |img-48| .. _mm-forum-and-RealURL: mm\_forum and RealURL ^^^^^^^^^^^^^^^^^^^^^ The mm\_forum extension offers some special functionalities in order to support the RealURL extension. Because the mm\_forum extension works with a whole lot of parameters, it is very difficult to configure RealURL to create nice looking links in the mm\_forum extension. In the res/ directory in the mm\_forum extension directory, you will find two example files for a mm\_forum RealURL configuration, once in English and in German (tx\_mmforum\_realurl\_en.txt respectively tx\_mmforum\_realurl\_de.txt). In this file, the fixedPostVars array of the RealURL configuration is stored. You have to copy this array into your RealURL configuration array in the localconf.php file. If for example your RealURL configuration array looks like this (notice that some passages have been cut for lack of space): :: $TYPO3_CONF_VARS['EXTCONF']['realurl']['_DEFAULT'] = array( 'init' => array( 'enableCHashCache' => 1 ), 'preVars' => array( [...] ), 'fileName' => array ( [...] ), 'postVarSets' => array( '_DEFAULT' => array (), ), 'pagePath' => array( [...] ), ); you will have to insert the fixedPostVars array like this (notice the passages in red): :: $TYPO3_CONF_VARS['EXTCONF']['realurl']['_DEFAULT'] = array( 'init' => array( 'enableCHashCache' => 1 ), 'preVars' => array( [...] ), 'fileName' => array ( [...] ), 'postVarSets' => array( '_DEFAULT' => array (), ), 'fixedPostVars' => array( [...] 'PI1_PID' => 'mm_forum_pi1', 'PI3_PID' => 'mm_forum_pi3' ), 'pagePath' => array( [...] ), ); One final step will be to replace the place holders 'PI1\_PID' and 'PI3\_PID' with the page UIDs you have places the plugin **mm\_forum :: Forum** or **mm\_forum :: Private messaging** on. **It is important you do this last step. Otherwise, the mm\_forum will not work with RealURL!** If you run the mm\_forum with this RealURL configuration, you will notice that the links that are generates do not look really nice. Instead, you will see links like these: :: forum/user//////admin as RealURL representation for e.g. :: index.php?id=forum&tx_mmforum_pi1[action]=forum_view_profil&tx_mmforum_pi1[user_id]=3 The reason for this lies in how RealURL handles parameters. Due to the RealURL configuration, RealURL expects a lot of parameters (since the mm\_forum works with a lot of parameters). This means, that a mm \_forum-RealURL-URL is generated following the pattern below: :: forum_page/[action]/[forum id]/[topic id]/[post id]/[page]/[user] Now of course, if one of these parameters is not being submitted, RealURL just leaves out this parameter, resulting in multiple slashes (like ////) because the regarding parameters are not submitted. You can encourage the mm\_forum extension to submit more parameters that are not actually needed for the content generation, but allow RealURL to generate nicer URLs. For example, if a topic is displayed, regularly only the tx\_mmforum\_pi1[tid] parameter is expected. Now, when generating the link to this topic, the mm\_forum can also append a tx\_mmforum\_pi1[fid] parameter to the URL, describing the board the topic is placed on. So the board name will also appear in the URL generated by RealURL. You can enable this feature by setting the property General **► Enable RealURL support** in the mm\_forum configuration module or **mm\_forum – General** **►** **Enable RealURLspecial links** in the TypoScript constants. .. _Custom-rootline-menu: Custom rootline menu ^^^^^^^^^^^^^^^^^^^^ As you will probably have noticed, the main mm\_forum plugin brings an own rootline menu with it. Now if you already have your own rootline menu integrated in the page layout, this can be very disturbing, since there are now two rootlines on your page, one for the page structure and one for the mm\_forum. So it would be a nice feature to integrate the mm\_forum rootline into the page rootline. For this, you first have to disable the original mm\_forum rootline. Do so by checking **Disable mm\_forum rootline** in the mm\_forum configuration module. After doing this, the mm\_forum rootline will not be displayed anymore at all. Now you have to integrate the rootline into your own menu. If you have already a rootline menu integrated into your site, something similar like this will stand in your TypoScript setup: :: ROOTLINE = HMENU ROOTLINE { special = rootline 1 = TMENU 1 { NO = 1 } } Change this configuration to the following (pay attention to the lines in red): :: ROOTLINE = HMENU ROOTLINE { special = userfunction special.userFunc = tx_mmforum_pi1->createRootline special.userNameField = {$plugin.tx_mmforum.userNameField} 1 = TMENU 1 { NO = 1 } } This will replace the default rootline with a special rootline created by the mm\_forum extension. Probably you only want this special rootline on your mm\_forum page, so it would be best to create an extension template for this. As of version 0.1.2, the custom rootline function accepts the parameter “entryLevel”, that allows you to define on which level of the page tree the rootline menu shall start. See the following example to see how the entryLevel property is used: :: special = userfunction special.userFunc = tx_mmforum_pi1->createRootline special.entryLevel = 2 special.userNameField = {$plugin.tx_mmforum.userNameField} Please pay attention to the parameter “userNameField”. It is copied from the TypoScript configuration and is necessary if you want to use another field of the fe\_user table than “username”. Have a look at the “Constants Reference” for more information: :: special = userfunction special.userFunc = tx_mmforum_pi1->createRootline special.userNameField = {$plugin.tx_mmforum.userNameField} .. _Cronjobs: Cronjobs ^^^^^^^^ As of version 0.1.5, the mm\_forum extension offers the possibility to execute certain PHP scripts as cronjobs directly on the server (meaning that you do not have to call a specific URL anymore). The mm\_forum cronjobs can be configured using the mm\_forum install tool in the TYPO3 backend. You will notice that there is a certain redundancy in the configuration variables for the cronjobs, like for example the language has to be specified for the cronjobs. This is necessary since the cronjobs are not executed from within the TYPO3 framework and thus do not have access to the TYPO3 configuration variables (like for example the TypoScript setup). It should be self evident that the whole cronjob thing only works on UNIX-like system. Suggestions on how to realize a cronjob-like setup on Windows based systems are appreciated. .. _Available-cronjobs: Available cronjobs """""""""""""""""" In the following section you will find a list of all cronjobs you can set up: .. _publish: 'publish' ~~~~~~~~~ This cronjob notifies a certain frontend user group (can be configured in the mm\_forum install tool), typically the moderator group, about posts that wait to be published by a moderator. Of course, this only makes sense if the forum is run in the moderated mode. The email that is sent to the recipients contains a full list of all posts that are to be published. .. _messaging: 'messaging' ~~~~~~~~~~~ This cronjob notifies users about new PMs that were received after the last notification mail. The email is sent only to users who have enabled this feature in their user profile. .. _indexing: 'indexing' ~~~~~~~~~~ This cronjob starts the search indexation process. .. _Setting-up-a-cronjob: Setting up a cronjob """""""""""""""""""" First of all, in order to set up a cronjob on your system, you need – of cource – SSH access, except your hosting provider offers the possibility to set up a cronjob automatically. After logging in, you can edit the crontab using the shell command :: crontab -e Alternatively, you can put your cronjob into an own file and place it into the /etc/cron.d or /etc/cron.hourly directory. All cronjobs are started by the script :code:`cli.tx\_mmforum\_cron.php` . This script expects a parameter telling the script what exactly to do. To identify the cronjobs, you can use the cronjob names mentioned above. **Please regard that it is necessary to start the cronjob script using it's absolute path; not a relative path.** For example, a typical cronjob entry could look like the following: :: */15 * * * * /srv/www/typo3conf/ext/mm_forum/cron/cli.tx_mmforum_cron.php indexing > var/log/mm_forum/indexing.log This cronjob will start the indexing process every 15 minutes and write the results of the cronjob into a logfile. .. _Configuration: 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: 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. .. _generated: ((generated)) """"""""""""" .. _Example: Example ~~~~~~~ :: plugin.tx_mmforum.adminGroup = 1; plugin.tx_mmforum.moderatorGroup = 2; plugin.tx_mmforum.userGroup = 3; .. _General: General """"""" .. ### BEGIN~OF~TABLE ### .. _team-name: team\_name ~~~~~~~~~~ .. container:: table-row Property team\_name Data type string Description The name of your forum team. This name will be used as signature in automatically sent emails. Default Your team .. _support-mail: support\_mail ~~~~~~~~~~~~~ .. container:: table-row Property support\_mail Data type string Description The email address for support mails. This address will be displayed in case of errors in the extension and things like that. Default support@your-domain.com .. _mailer-mail: mailer\_mail ~~~~~~~~~~~~ .. container:: table-row Property mailer\_mail Data type string Description The email address for emails which are send to users for example registration email Default noreply@your-domain.com .. _dateFormat: dateFormat ~~~~~~~~~~ .. container:: table-row Property dateFormat Data type string Description The default date format. This will be used in nearly all *mm\_forum* plugins. See `http://www.php.net/date `_ for the correct syntax. Default d. m. y [H:i] .. _site-name: site\_name ~~~~~~~~~~ .. container:: table-row Property site\_name Data type string Description Defines the name of the website. Used e.g. in mails sent by the message board. Default your-domain.com .. _adminGroup: adminGroup ~~~~~~~~~~ .. container:: table-row Property adminGroup Data type integer Description Default user group for administrators Default .. _moderatorGroup: moderatorGroup ~~~~~~~~~~~~~~ .. container:: table-row Property moderatorGroup Data type integer Description Default user group for moderators Default .. _userGroup: userGroup ~~~~~~~~~ .. container:: table-row Property userGroup Data type integer Description Default user group for new registered users Default .. _userPID: userPID ~~~~~~~ .. container:: table-row Property userPID Data type integer Description The page ID of the fe\_user storage page Default .. _storagePID: storagePID ~~~~~~~~~~ .. container:: table-row Property storagePID Data type integer Description The page ID of the mm\_forum data storage page (set -1 to disable) Default .. _realUrl-specialLinks: realUrl\_specialLinks ~~~~~~~~~~~~~~~~~~~~~ .. container:: table-row Property realUrl\_specialLinks Data type boolean Description Enables or disables mm\_forum RealURL support. See **Administration** **► mm\_forum and RealURL** for more information. Default 0 .. _disableRootline: disableRootline ~~~~~~~~~~~~~~~ .. container:: table-row Property disableRootline Data type boolean Description Disables the mm\_forum rootline allowing you to implement the mm\_forum rootline into your own rootline menu. Default 0 .. _informal: informal ~~~~~~~~ .. container:: table-row Property informal Data type boolean Description Use informal language. Affects only german language set (different use of Sie and Du). Default 0 .. _userNameField: userNameField ~~~~~~~~~~~~~ .. container:: table-row Property userNameField Data type string Description Database field used for a user's username Default username .. _useCaptcha: useCaptcha ~~~~~~~~~~ .. container:: table-row Property useCaptcha Data type boolean Description Enables use of the captcha library on registration. Requires the captcha library to be installed. Default 1 .. ###### END~OF~TABLE ###### .. _File-paths: File paths """""""""" .. ### BEGIN~OF~TABLE ### .. _path-smilie: path\_smilie ~~~~~~~~~~~~ .. container:: table-row Property path\_smilie Data type string Description The path to your smilie directory. Default EXT:mm\_forum/res/smilies/ .. _path-img: path\_img ~~~~~~~~~ .. container:: table-row Property path\_img Data type string Description The path to your image directory. Default EXT:mm\_forum/res/img/default/ .. _postparser-insertButton-path: postparser.insertButton\_path ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. container:: table-row Property postparser.insertButton\_path Data type string Description The path to the directory containing the buttons for the BBCode buttons Default EXT:mm\_forum/res/img/default/editor\_icons .. _path-template: path\_template ~~~~~~~~~~~~~~ .. container:: table-row Property path\_template Data type string Description The path to the default template directory Default EXT:mm\_forum/res/tmpl/ .. _path-altTemplate: path\_altTemplate ~~~~~~~~~~~~~~~~~ .. container:: table-row Property path\_altTemplate Data type string Description The path to the alternative template directory. This is where user defined design sets are stored. Default fileadmin/ext/mm\_forum/tmpl/ .. ###### END~OF~TABLE ###### .. _Message-Board: Message Board """"""""""""" .. ### BEGIN~OF~TABLE ### .. _notifyMail-sender: notifyMail\_sender ~~~~~~~~~~~~~~~~~~ .. container:: table-row Property notifyMail\_sender Data type string Description This email address will be specified as sender in mails send to inform users about new posts in topics they observed Default .. _boardName: boardName ~~~~~~~~~ .. container:: table-row Property boardName Data type string Description The name of this board. This will also be used in automatically sent emails and some other places. Default .. _boardPID: boardPID ~~~~~~~~ .. container:: table-row Property boardPID Data type int (page-UID) Description Here you enter the UID of the page the mm\_forum :: Forum plugin is placed on. Used for internal links. Default .. _postsPerPage: postsPerPage ~~~~~~~~~~~~ .. container:: table-row Property postsPerPage Data type int Description Specifies how much posts are to be displayed on one page in the post listing view. Default 10 .. _threadsPerPage: threadsPerPage ~~~~~~~~~~~~~~ .. container:: table-row Property threadsPerPage Data type int Description Specifies how much threads are to be displayed on one page in the thread listing view. Default 30 .. _displayRealName: displayRealName ~~~~~~~~~~~~~~~ .. container:: table-row Property displayRealName Data type boolean Description 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. Default 1 .. _user-hotPosts: user\_hotPosts ~~~~~~~~~~~~~~ .. container:: table-row Property user\_hotPosts Data type int Description Defines how much posts a user has to write until he/she is awarded with a special icon below his/her user name. Default 5000 .. _topic-hotPosts: topic\_hotPosts ~~~~~~~~~~~~~~~ .. container:: table-row Property topic\_hotPosts Data type int Description Defines how much posts a topic has to contain to be marked as hot topic. Default 10 .. _spamblock-interval: spamblock\_interval ~~~~~~~~~~~~~~~~~~~ .. container:: table-row Property spamblock\_interval Data type int Description The time in seconds a user has to wait between writing two posts. Default 20 .. _signatureLimit: signatureLimit ~~~~~~~~~~~~~~ .. container:: table-row Property signatureLimit Data type int Description The maximum signature length in lines. All lines beyond this limit are cut off. Default 6 .. _attachment-enable: attachment\_enable ~~~~~~~~~~~~~~~~~~ .. container:: table-row Property attachment\_enable Data type boolean Description Enables file attachments Default 1 .. _attachment-allow: attachment\_allow ~~~~~~~~~~~~~~~~~ .. container:: table-row Property attachment\_allow Data type list Description Comma separated list of allowed file extensions. Use \* to allow all file extensions Default \* .. _attachment-deny: attachment\_deny ~~~~~~~~~~~~~~~~ .. container:: table-row Property attachment\_deny Data type list Description 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. Default php,php3 .. _attachment-filesize: attachment\_filesize ~~~~~~~~~~~~~~~~~~~~ .. container:: table-row Property attachment\_filesize Data type int Description Maximum file size for file attachments Default 1045504 bytes (=1 MB) .. _attachment-preview: attachment\_preview ~~~~~~~~~~~~~~~~~~~ .. container:: table-row Property attachment\_preview Data type boolean Description Enables preview images for image attachments Default 1 .. _attachment-count: attachment\_count ~~~~~~~~~~~~~~~~~ .. container:: table-row Property attachment\_count Data type int Description Maximum number of attached files Default 1 .. _polls-enable: polls\_enable ~~~~~~~~~~~~~ .. container:: table-row Property polls\_enable Data type boolean Description Enables polls. Default 1 .. _enableShadows: enableShadows ~~~~~~~~~~~~~ .. container:: table-row Property enableShadows Data type boolean Description 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. Default 1 .. _signatureBBCodes: signatureBBCodes ~~~~~~~~~~~~~~~~ .. container:: table-row Property signatureBBCodes Data type boolean Description This function defines if BBCodes should be allowed in user signatures or not. Default 1 .. _enableRanks: enableRanks ~~~~~~~~~~~ .. container:: table-row Property enableRanks Data type boolean Description Enables user ranks. User ranks can be configured using the backend module. Default 1 .. _moderatedBoard: moderatedBoard ~~~~~~~~~~~~~~ .. container:: table-row Property moderatedBoard Data type boolean Description Enables the moderated forum. If set, new entries and topics have to be approved by a moderator before being displayed in the forum. Default 0 .. _topicIconMode: topicIconMode ~~~~~~~~~~~~~ .. container:: table-row Property topicIconMode Data type string Description Set to 'classic' in order to use the classic forum and topic icons, or to 'modern' to use new icons Default modern .. ###### END~OF~TABLE ###### .. _Search: Search """""" .. ### BEGIN~OF~TABLE ### .. _indexCount: indexCount ~~~~~~~~~~ .. container:: table-row Property indexCount Data type int Description 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. Default 50 .. _indexingPassword: indexingPassword ~~~~~~~~~~~~~~~~ .. container:: table-row Property indexingPassword Data type string Description 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!** Default 21232f297a57a5a743894a0e4a801fc3 .. _sword-minLength: sword\_minLength ~~~~~~~~~~~~~~~~ .. container:: table-row Property sword\_minLength Data type int Description The minimum search word length in characters. Default 2 .. _resultsPerPage: resultsPerPage ~~~~~~~~~~~~~~ .. container:: table-row Property resultsPerPage Data type int Description The amount of results that are to be displayed on on page. Default 10 .. ###### END~OF~TABLE ###### .. _Private-messages: Private messages """""""""""""""" .. ### BEGIN~OF~TABLE ### .. _pmBlocktime: pmBlocktime ~~~~~~~~~~~ .. container:: table-row Property pmBlocktime Data type int Description Time in seconds a user has to wait between writing two private messages. Default 30 .. _pmPID: pmPID ~~~~~ .. container:: table-row Property pmPID Data type int Description The UID of the page the **mm\_forum :: Private messaging** plugin is placed on. Default .. ###### END~OF~TABLE ###### .. _TypoScript-setup-reference: 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-General-settings: plugin.tx\_mmforum (General settings) """"""""""""""""""""""""""""""""""""" The :code:`plugin.tx\_mmforum` object contains general configuration variables that are used by all plugins. The specific plugins inherit all configuration from this object. This means that changing a value here will affect all mm\_forum plugins. .. ### BEGIN~OF~TABLE ### .. _storagePID: storagePID ~~~~~~~~~~ .. container:: table-row Property storagePID Data type int Description The page UID of the mm\_forum data storage page Default :: {$plugin.tx_mmforum.storagePID} .. _userPID: userPID ~~~~~~~ .. container:: table-row Property userPID Data type int Description The page UID of the mm\_forum user storage page Default :: {$plugin.tx_mmforum.userPID} .. _pid-forum: pid\_forum ~~~~~~~~~~ .. container:: table-row Property pid\_forum Data type int Description The page UID of the main mm\_forum plugin page. If you do not specify this parameter, the mm\_forum plugin will try to determine the regarding page by itself. Default :: {$plugin.tx_mmforum.boardPID} .. _userProfilePID: userProfilePID ~~~~~~~~~~~~~~ .. container:: table-row Property userProfilePID Data type int Description The page UID of the page that is to be used for displaying a user's profile. Default :: {$plugin.tx_mmforum.userProfilePID} .. _pm-id: pm\_id ~~~~~~ .. container:: table-row Property pm\_id Data type int Description The page UID of the page the messaging plugin is used on. This parameter is used to generate links to the messaging plugin from other plugins. Default :: {$plugin.tx_mmforum.pmPID} .. _grp-admin: grp\_admin ~~~~~~~~~~ .. container:: table-row Property grp\_admin Data type int Description The UID of the administrator fe\_groups record. Default :: {$plugin.tx_mmforum.adminGroup} .. _userGroup: userGroup ~~~~~~~~~ .. container:: table-row Property userGroup Data type int Description The UID of the forum default fe\_group record Default :: {$plugin.tx_mmforum.userGroup} .. _path-avatar: path\_avatar ~~~~~~~~~~~~ .. container:: table-row Property path\_avatar Data type string Description Defines the path to the avatar directory. Default :: uploads/tx_mmforum/ .. _path-img: path\_img ~~~~~~~~~ .. container:: table-row Property path\_img Data type string Description Path to the image directory Default :: {$plugin.tx_mmforum.path_img} .. _path-smilie: path\_smilie ~~~~~~~~~~~~ .. container:: table-row Property path\_smilie Data type string Description Path to the smilie directory Default :: {$plugin.tx_mmforum.path_smilie} .. _informal: informal ~~~~~~~~ .. container:: table-row Property informal Data type boolean Description Use informal language. Affects only german language set (different use of Sie and Du). Default :: {$plugin.tx_mmforum.informal} .. _dateFormat: dateFormat ~~~~~~~~~~ .. container:: table-row Property dateFormat Data type string Description The default date format. This can either be a format string for the strftime `:sup:`0` <#sdfootnote2sym>`_ function or the date `:sup:`0` <#sdfootnote3sym>`_ function. Default :: {$plugin.tx_mmforum.dateFormat} .. _userNameField: userNameField ~~~~~~~~~~~~~ .. container:: table-row Property userNameField Data type string Description Database field used for the user name Default :: {$plugin.tx_mmforum.userNameField} .. _boardName: boardName ~~~~~~~~~ .. container:: table-row Property boardName Data type string Description This board's name. Default :: {$plugin.tx_mmforum.boardName} .. _teamName: teamName ~~~~~~~~ .. container:: table-row Property teamName Data type string Description The administration team's name. Default :: {$plugin.tx_mmforum.team_name} .. _siteName: siteName ~~~~~~~~ .. container:: table-row Property siteName Data type string Description This site's name. Default :: {$plugin.tx_mmforum.site_name} .. _disableRootline: disableRootline ~~~~~~~~~~~~~~~ .. container:: table-row Property disableRootline Data type boolean Description Enables/Disables the rootline Default :: {$plugin.tx_mmforum.disableRootline} .. _realURL-specialLinks: realURL\_specialLinks ~~~~~~~~~~~~~~~~~~~~~ .. container:: table-row Property realURL\_specialLinks Data type boolean Description Enables/Disables RealURL support. Default :: {$plugin.tx_mmforum.realURL_specialLinks} .. _notifyingMail-sender: notifyingMail.sender ~~~~~~~~~~~~~~~~~~~~ .. container:: table-row Property notifyingMail.sender Data type string Description The sender name of automatically generated emails. Default :: {$plugin.tx_mmforum.notifyMail_sender} .. _notifyingMail-topicLinkPrefix-override: notifyingMail.topicLinkPrefix\_override ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. container:: table-row Property notifyingMail.topicLinkPrefix\_override Data type string Description 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[...] Default .. _images: images ~~~~~~ .. container:: table-row Property images Data type array Description 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. Default See EXT:mm\_forum/res/ts/tx\_mmforum\_base.txt .. _buttons-image-normal: buttons\_image.normal ~~~~~~~~~~~~~~~~~~~~~ .. container:: table-row Property buttons\_image.normal Data type cObj Description The configuration of normal sized image buttons. Default .. _buttons-image-small: buttons\_image.small ~~~~~~~~~~~~~~~~~~~~ .. container:: table-row Property buttons\_image.small Data type cObj Description The configuration of small sized image buttons Default .. _buttons-text-normal: buttons\_text.normal ~~~~~~~~~~~~~~~~~~~~ .. container:: table-row Property buttons\_text.normal Data type cObj Description The configuration of normal size text buttons Default .. _buttons-text-small: buttons\_text.small ~~~~~~~~~~~~~~~~~~~ .. container:: table-row Property buttons\_text.small Data type cObj Description The configuration of small sized text buttons Default .. _buttons: buttons ~~~~~~~ .. container:: table-row Property buttons Data type array Description This object must be an array containing two content objects called 'normal' and 'small' defining how buttons should be rendered in the mm\_forum frontend. By default, this object is just a copy of either the buttons\_image or buttons\_text object. Default :: < plugin.tx_mmforum.buttons_text .. ###### END~OF~TABLE ###### .. _plugin-tx-mmforum-validator: plugin.tx\_mmforum.validator ~~~~~~~~~~~~~~~~~~~~~~~~~~~~ This array contains configuration options for the validator class. The validator parses everything that is displayed in the frontend by the mm\_forum plugins. The main task of the validator object is to mask special characters in user input and by doing so to prevent XSS attacks. .. ### BEGIN~OF~TABLE ### .. _quotes: quotes '''''' .. container:: table-row Property quotes Data type string Description Determines what to do with quote characters. There are three possible options for this attribute: **none** – Quote characters will not be parsed at all, meaning that all quote characters entered by users just stay quote characters **double** – Parses double quotes to the regarding HTML entity (meaning "). **all** – Parses all quotes to the regarding HTML entities (double quotes to " and single quotes to ') `:sup:`0` <#sdfootnote4sym>`_ Default :: none .. _charset: charset ''''''' .. container:: table-row Property charset Data type string Description The character set that is used to replace special characters. You can set this value either to 'auto', which means that the default frontend character set will be used, or you can specify a specific character set. Default :: auto .. _stripTags: stripTags ''''''''' .. container:: table-row Property stripTags Data type bool Description If this attribute is set, HTML tags found in user input will be deleted completely (otherwise the brackets would just be replaced with < and >) `:sup:`0` <#sdfootnote5sym>`_ . Default :: 0 .. _replace: replace ''''''' .. container:: table-row Property replace Data type string Description Determines which special characters to replace. This attribute accepts two values: **specialchars** – only special characters will be parsed (meaning double quotes and tag brackets). The htmlspecialchars `:sup:`0` <#sdfootnote6sym>`_ function will be used for this. **all** – all characters that have an equivalent HTML entity will be replaced by this entity. The htmlentities `:sup:`0` <#sdfootnote7sym>`_ function will be used for this. Default :: specialchars .. ###### END~OF~TABLE ###### .. _plugin-tx-mmforum-postparser: plugin.tx\_mmforum.postparser ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ This array contains post parser options. .. ### BEGIN~OF~TABLE ### .. _bb-code-linktarget: bb\_code\_linktarget '''''''''''''''''''' .. container:: table-row Property bb\_code\_linktarget Data type string Description The target for dynamically generated links in posts texts defined by the [url] or [link] BBCode. **NOTE** : This attribute is deprecated. It is generally easier to just specify the link target directly in the bbcode replacement pattern. However, you can integrate the marker ###TARGET### in your BBCode replacement pattern (this is not the case by default) and it will automatically be replaced by this value. Default :: _blank .. _bb-code-linkclass: bb\_code\_linkclass ''''''''''''''''''' .. container:: table-row Property bb\_code\_linkclass Data type string Description The CSS class for dynamically generated links in posts texts defined by the [url] or [link] BBCode. **NOTE** : This attribute is deprecated, just like the bb\_code\_linktarget attribute. If you implement the marker ###CSS\_CLASS### in your replacement pattern (just like the link target, this is not the case by default), this marker will be substituted with this value. Default :: link_10 .. _bb-code-parser: bb\_code\_parser '''''''''''''''' .. container:: table-row Property bb\_code\_parser Data type boolean Description Enables parsing of BBCode. Set this value to 1 to enable the parsing of BBCodes and set it to 0 to disable the parsing mechanism. Default :: 1 .. _syntaxHighlighter: syntaxHighlighter ''''''''''''''''' .. container:: table-row Property syntaxHighlighter Data type boolean Description Enables syntax highlighting using GeSHi. The regarding tags and substitution patterns are defined in the syntaxhighlighting configuration. Default :: 1 .. _smilie-generator: smilie\_generator ''''''''''''''''' .. container:: table-row Property smilie\_generator Data type boolean Description Enables the automatic replacement of smilies. The regarding data is defined in the smilie configuration in the backend module. Default :: 1 .. _zitat-div: zitat\_div '''''''''' .. container:: table-row Property zitat\_div Data type boolean Description Enables the automatic parsing of [quote=author] bbcodes. Note that the quote bbcode is not defined along with the other bbcodes but is hardcoded in the extension sourcecode. Default :: 1 .. _sh-linestyle-bg: sh\_linestyle\_bg ''''''''''''''''' .. container:: table-row Property sh\_linestyle\_bg Data type string (color) Description Defines the background color for code fields. Default :: #gggggg .. _sh-linestyle-bg2: sh\_linestyle\_bg2 '''''''''''''''''' .. container:: table-row Property sh\_linestyle\_bg2 Data type string (color) Description Defines the alternative background color for code fields. This color is used for alternating line background colors. Default :: #ghfghf .. _quoteClass: quoteClass '''''''''' .. container:: table-row Property quoteClass Data type string Description The CSS class that is to be used for quotation divs Default :: tx-mmforum-pi1-pt-quote .. _codeClass: codeClass ''''''''' .. container:: table-row Property codeClass Data type string Description The CSS class that is to be used for code containers Default :: tx-mmforum-pi1-pt-code .. ###### END~OF~TABLE ###### .. _plugin-tx-mmforum-pi1-mm-forum-Forum: plugin.tx\_mmforum\_pi1 (mm\_forum :: Forum) """""""""""""""""""""""""""""""""""""""""""" .. ### BEGIN~OF~TABLE ### .. _rssPID: rssPID ~~~~~~ .. container:: table-row Property rssPID Data type int Description The UID of the page the RSS feed is located on. Leave this field empty in order to disable the RSS feed. Default :: {$plugin.tx_mmforum.rssPID} .. _moderated: moderated ~~~~~~~~~ .. container:: table-row Property moderated Data type bool Description Defines if the board runs in moderated mode. See section **User manual : Moderation** for more information on the moderated mode. Default .. _avatar-width: avatar\_width ~~~~~~~~~~~~~ .. container:: table-row Property avatar\_width Data type int Description Width of avatar images that are displayed in the forum Default :: 100 .. _avatar-height: avatar\_height ~~~~~~~~~~~~~~ .. container:: table-row Property avatar\_height Data type int Description Height of avatar images that are displayed in the forum Default :: 100 .. _hotposts: hotposts ~~~~~~~~ .. container:: table-row Property hotposts Data type int Description Defines how much replies there have to be in a topic to make it a “hot topic” Default :: {$plugin.tx_mmforum.topic_hotPosts} .. _user-hotposts: user\_hotposts ~~~~~~~~~~~~~~ .. container:: table-row Property user\_hotposts Data type int Description 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. Default :: {$plugin.tx_mmforum.user_hotPosts} .. _post-limit: post\_limit ~~~~~~~~~~~ .. container:: table-row Property post\_limit Data type int Description Number of posts that are displayed on a topic page. Default :: {$plugin.tx_mmforum.postsPerPage} .. _topic-count: topic\_count ~~~~~~~~~~~~ .. container:: table-row Property topic\_count Data type int Description Number of topics that are display on a forum page Default :: {$plugin.tx_mmforum.threadsPerPage} .. _prefixes: prefixes ~~~~~~~~ .. container:: table-row Property prefixes Data type string Description This field contains a comma-separated list of predefined prefixes that moderators can apply to topics. Default :: {$plugin.tx_mmforum.prefixes} .. _noListPrefixes: noListPrefixes ~~~~~~~~~~~~~~ .. container:: table-row Property noListPrefixes Data type string Description A comma-separated list of prefixes that users should not be able to filter in the list\_prefix view. Default :: Test .. _spamblock-interval: spamblock\_interval ~~~~~~~~~~~~~~~~~~~ .. container:: table-row Property spamblock\_interval Data type int Description 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. Default :: {$plugin.tx_mmforum.spamblock_interval} .. _signatureLimit: signatureLimit ~~~~~~~~~~~~~~ .. container:: table-row Property signatureLimit Data type int Description Specifies a maximum line count for user signatures. Signatures that are longer than specified here are cropped to the maximum length. Default :: {$plugin.tx_mmforum.signatureLimit} .. _postalerts-statusColors: postalerts.statusColors ~~~~~~~~~~~~~~~~~~~~~~~ .. container:: table-row Property postalerts.statusColors Data type array of colors Description 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 Default :: .open = #ffdddd .work = #ffffdd .done = #ddffdd .. _enableShadows: enableShadows ~~~~~~~~~~~~~ .. container:: table-row Property enableShadows Data type bool Description Defines if “shadow topics” are to be displayed in the topic listing view. Ff a topic is moved from one forum to another, a shadow topic is generated in the old forum poining to the topic at its new location. Default :: {$plugin.tx_mmforum.enableShadows} .. _template: template ~~~~~~~~ .. container:: table-row Property template Data type array Description 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. Default See EXT:mm\_forum/ext\_typoscript\_setup.txt .. _scripts-editor: scripts.editor ~~~~~~~~~~~~~~ .. container:: table-row Property scripts.editor Data type string Description This field defines the path to the Javascript file containing functions for the text input field. Default :: typo3conf/ext/mm_forum/res/scripts/editor_javascript.inc.js .. _topicIconMode: topicIconMode ~~~~~~~~~~~~~ .. container:: table-row Property topicIconMode Data type string Description This parameter defines the style of topic and board icons used in the mm\_forum frontend. There are two possible values: **modern** – Modern icons that are generated dynamically using a typoscript configuration. **classic** – The classic icons known from early versions of mm\_forum Default :: {$plugin.tx_mmforum.topicIconMode} .. _topicIcon: topicIcon ~~~~~~~~~ .. container:: table-row Property topicIcon Data type cObj Description A content object that is used to generate dynamic topic and forum icons. See the section **Customization : Topic** icons for more information on this topic. Default .. ###### END~OF~TABLE ###### .. _plugin-tx-mmforum-pi1-polls: plugin.tx\_mmforum\_pi1.polls ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ The plugin.tx\_mmforum\_pi1.polls object contains detailed configuration of the polls feature. .. ### BEGIN~OF~TABLE ### .. _enable: enable '''''' .. container:: table-row Property enable Data type boolean Description Enables polls. Default :: {$plugin.tx_mmforum.polls_enable} .. _minAnswers: minAnswers '''''''''' .. container:: table-row Property minAnswers Data type int Description The minimum amount of answering possibilities for polls Default :: 2 .. _expired-stdWrap: expired\_stdWrap '''''''''''''''' .. container:: table-row Property expired\_stdWrap Data type stdWrap `:sup:`0` <#sdfootnote8sym>`_ Description stdWrap for the poll expiration date label. Default .. _pollBar-colorMap: pollBar\_colorMap ''''''''''''''''' .. container:: table-row Property pollBar\_colorMap Data type array Description Array of colors for the bars used to display the poll result. Element names are 1 to n and 'default' Default :: 1 = #ff0000 2 = #00ff00 3 = #0000ff 4 = #ff00ff default = #ff0000 .. _restrictToGroups: restrictToGroups '''''''''''''''' .. container:: table-row Property restrictToGroups Data type list Description A comma separated list of user groups allowed to create polls. Leave this field empty in order to allow all users to create polls. Default :: {$plugin.tx_mmforum.polls_restrict} .. _poll-icon: poll\_icon '''''''''' .. container:: table-row Property poll\_icon Data type cObj Description A content object describing a poll's icon Default cObj (IMAGE) `:sup:`0` <#sdfootnote9sym>`_ .. ###### END~OF~TABLE ###### .. _plugin-tx-mmforum-pi1-attachments: plugin.tx\_mmforum\_pi1.attachments ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. ### BEGIN~OF~TABLE ### .. _enable: enable '''''' .. container:: table-row Property enable Data type boolean Description Enables upload of file attachments. Default :: {$plugin.tx_mmforum.attachment_enable} .. _maxCount: maxCount '''''''' .. container:: table-row Property maxCount Data type int Description The maximum amount of attachments that a single post can contain. Default :: {$plugin.tx_mmforum.attachment_count} .. _attachmentDir: attachmentDir ''''''''''''' .. container:: table-row Property attachmentDir Data type string Description The directory uploaded attachments will be stored in. Default :: uploads/tx_mmforum/ .. _maxFileSize: maxFileSize ''''''''''' .. container:: table-row Property maxFileSize Data type int Description Maximum file size for file attachments Default :: {$plugin.tx_mmforum.attachment_filesize} .. _allow: allow ''''' .. container:: table-row Property allow Data type list Description Comma separated list of allowed file extensions. Use \* to allow all file extensions Default :: {$plugin.tx_mmforum.attachment_allow} .. _deny: deny '''' .. container:: table-row Property deny Data type list Description 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. Default :: {$plugin.tx_mmforum.attachment_deny} .. _maxFileSize-stdWrap: maxFileSize\_stdWrap '''''''''''''''''''' .. container:: table-row Property maxFileSize\_stdWrap Data type stdWrap Description stdWrap for the maxFileSize label in the post creation form. Default .. _imagePreview: imagePreview '''''''''''' .. container:: table-row Property imagePreview Data type boolean Description Enables preview images for image attachments Default :: {$plugin.tx_mmforum.attachment_preview} .. _imagePreviewObj: imagePreviewObj ''''''''''''''' .. container:: table-row Property imagePreviewObj Data type cObj Description A content object rendering the preview image. Default cObj (IMAGE) .. _attachment-stdWrap: attachment\_stdWrap ''''''''''''''''''' .. container:: table-row Property attachment\_stdWrap Data type stdWrap Description stdWrap for the whole file attachment item in the post listing view. Default .. _attachmentLabel-stdWrap: attachmentLabel\_stdWrap '''''''''''''''''''''''' .. container:: table-row Property attachmentLabel\_stdWrap Data type stdWrap Description stdWrap for the file attachment label in the post listing view. Default .. _attachmentLink-stdWrap: attachmentLink\_stdWrap ''''''''''''''''''''''' .. container:: table-row Property attachmentLink\_stdWrap Data type stdWrao Description stdWrap for the file attachment link in the post listing view. Default .. _attachmentEditLabel-stdWrap: attachmentEditLabel\_stdWrap '''''''''''''''''''''''''''' .. container:: table-row Property attachmentEditLabel\_stdWrap Data type stdWrap Description stdWrap for the file attachment editing label in the post editing form. Default .. ###### END~OF~TABLE ###### .. _plugin-tx-mmforum-pi1-list-topics: 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. .. ### BEGIN~OF~TABLE ### .. _prefix-wrap: prefix\_wrap '''''''''''' .. container:: table-row Property prefix\_wrap Data type string (wrap) Description The wrap around topic prefixes. Default :: [ | ]  .. _pagenav-wrap: pagenav\_wrap ''''''''''''' .. container:: table-row Property pagenav\_wrap Data type string (wrap) Description The wrap around a topic's page navigation. Default ::
|
.. _listunread-pagenav-wrap: listunread\_pagenav\_wrap ''''''''''''''''''''''''' .. container:: table-row Property listunread\_pagenav\_wrap Data type string (wrap) Description The wrap around a topic's page navigation in the unread topic listing view. Default ::
(  |  )
.. _lastPostDate-stdWrap: lastPostDate\_stdWrap ''''''''''''''''''''' .. container:: table-row Property lastPostDate\_stdWrap Data type stdWrap Description The stdWrap function for the date of a topic's last post's date. Default .. _lastPostTopicTitle: lastPostTopicTitle '''''''''''''''''' .. container:: table-row Property lastPostTopicTitle Data type bool Description This parameter defines if the title of the most current topic is to be displayed in forum overview. Default :: 1 .. _lastPostTopicTitle-innerStdWrap: lastPostTopicTitle\_innerStdWrap '''''''''''''''''''''''''''''''' .. container:: table-row Property lastPostTopicTitle\_innerStdWrap Data type stdWrap Description The inner stdWrap function for the most current topic's title Default .. _lastPostTopicTitle-outerStdWrap: lastPostTopicTitle\_outerStdWrap '''''''''''''''''''''''''''''''' .. container:: table-row Property lastPostTopicTitle\_outerStdWrap Data type stdWrap Description The outer stdWrap function for the most current topic's title Default .. _lastPostUserName-stdWrap: lastPostUserName\_stdWrap ''''''''''''''''''''''''' .. container:: table-row Property lastPostUserName\_stdWrap Data type stdWrap Description The stdWrap for the user name of the last post's author. Default .. ###### END~OF~TABLE ###### .. _plugin-tx-mmforum-pi1-list-posts: 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. .. ### BEGIN~OF~TABLE ### .. _userinfo-username-stdWrap: userinfo.username\_stdWrap '''''''''''''''''''''''''' .. container:: table-row Property userinfo.username\_stdWrap Data type stdWrap Description stdWrap for user name Default .. _userinfo-realname-stdWrap: userinfo.realname\_stdWrap '''''''''''''''''''''''''' .. container:: table-row Property userinfo.realname\_stdWrap Data type stdWrap Description stdWrap for user's real name Default .. _userinfo-crdate-stdWrap: userinfo.crdate\_stdWrap '''''''''''''''''''''''' .. container:: table-row Property userinfo.crdate\_stdWrap Data type stdWrap Description stdWrap for user's registration date Default .. _userinfo-creator-stdWrap: userinfo.creator\_stdWrap ''''''''''''''''''''''''' .. container:: table-row Property userinfo.creator\_stdWrap Data type stdWrap Description stdWrap for the „topic creator“ string Default .. _userinfo-avatar-cObj: userinfo.avatar\_cObj ''''''''''''''''''''' .. container:: table-row Property userinfo.avatar\_cObj Data type cObj Description cObj of the avatar image. „file“ is automatically set to the path of the avatar image. Default .. _signature-stdWrap: signature\_stdWrap '''''''''''''''''' .. container:: table-row Property signature\_stdWrap Data type stdWrap Description stdWrap for the user's signature Default .. _prefix: prefix '''''' .. container:: table-row Property prefix Data type cObj Description A content object describing a topic's prefix Default .. _closed: closed '''''' .. container:: table-row Property closed Data type cObj Description A content object describing a topic's closed status Default .. _userinfo-topicauthor-wrap: userinfo\_topicauthor\_wrap ''''''''''''''''''''''''''' .. container:: table-row Property userinfo\_topicauthor\_wrap Data type string (wrap) Description The wrap around a user's user name in the post listing view Default :: [ | ]
.. _userinfo-content-wrap: userinfo\_content\_wrap ''''''''''''''''''''''' .. container:: table-row Property userinfo\_content\_wrap Data type string (wrap) Description The wrap around all information on a user in the post listing view Default :: |
.. _userinfo-admin-wrap: userinfo\_admin\_wrap ''''''''''''''''''''' .. container:: table-row Property userinfo\_admin\_wrap Data type string (wrap) Description The wrap around the string signifying a user's administrator status Default :: [ | ] .. _userinfo-moderator-wrap: userinfo\_moderator\_wrap ''''''''''''''''''''''''' .. container:: table-row Property userinfo\_moderator\_wrap Data type string (wrap) Description The wrap around the string signifying a user's moderator status. Default :: [ | ] .. _userinfo-realName-wrap: userinfo\_realName\_wrap '''''''''''''''''''''''' .. container:: table-row Property userinfo\_realName\_wrap Data type string (wrap) Description The wrap around the string displaying a user's real name. Default :: |
.. _highlight-wrap: highlight\_wrap ''''''''''''''' .. container:: table-row Property highlight\_wrap Data type string (wrap) Description The wrap around matching search words in post texts. Default :: | .. ###### END~OF~TABLE ###### .. _plugin-tx-mmforum-pi1-display: plugin.tx\_mmforum\_pi1.display ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ This array contains general display options. .. ### BEGIN~OF~TABLE ### .. _rootline-seperator: rootline.seperator '''''''''''''''''' .. container:: table-row Property rootline.seperator Data type string Description The separator between different root line items Default ::  »  .. _linkButton-cssClass: linkButton.cssClass ''''''''''''''''''' .. container:: table-row Property linkButton.cssClass Data type string Description The CSS class used for CSS buttons in the plugin Default :: tx-mmforum-button .. _listItem-evenClass: listItem.evenClass '''''''''''''''''' .. container:: table-row Property listItem.evenClass Data type string Description The CSS class used for even list items Default :: tx-mmforum-list-even .. _listItem-oddClass: listItem.oddClass ''''''''''''''''' .. container:: table-row Property listItem.oddClass Data type string Description The CSS class used for odd list items Default :: tx-mmforum-list-odd .. ###### END~OF~TABLE ###### .. _plugin-tx-mmforum-pi1-postForm: plugin.tx\_mmforum\_pi1.postForm ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ This array contains display options for post creation forms. .. ### BEGIN~OF~TABLE ### .. _smiliesAsDiv: smiliesAsDiv '''''''''''' .. container:: table-row Property smiliesAsDiv Data type boolean Description 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 Default 0 .. _smiliesAsDiv-allWrap: smiliesAsDiv.allWrap '''''''''''''''''''' .. container:: table-row Property smiliesAsDiv.allWrap Data type string (wrap) Description Wrap for all smilies (if displayed in divs) Default ::
|
.. _smiliesAsDiv-itemWrap: smiliesAsDiv.itemWrap ''''''''''''''''''''' .. container:: table-row Property smiliesAsDiv.itemWrap Data type string(wrap) Description Wrap for each smilie item (if displayed in divs) Default ::
|
.. ###### END~OF~TABLE ###### .. _plugin-tx-mmforum-pi1-user-profile: plugin.tx\_mmforum\_pi1.user\_profile ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. ### BEGIN~OF~TABLE ### .. _crdate-stdWrap: crdate\_stdWrap ''''''''''''''' .. container:: table-row Property crdate\_stdWrap Data type stdWrap Description The stdWrap function for the date field in the user profile Default .. ###### END~OF~TABLE ###### .. _plugin-tx-mmforum-pi2-mm-forum-User-registration: plugin.tx\_mmforum\_pi2 (mm\_forum :: User registration) """""""""""""""""""""""""""""""""""""""""""""""""""""""" .. ### BEGIN~OF~TABLE ### .. _templateFile: templateFile ~~~~~~~~~~~~ .. container:: table-row Property templateFile Data type string Description Defines the path to the template file Default EXT:mm\_forum/res/tmpl/fe\_user\_reg/fe\_user\_registrierung.html .. _img-border: img\_border ~~~~~~~~~~~ .. container:: table-row Property img\_border Data type int Description Border property for images Default {$plugin.tx\_mmforum.img\_border} .. _supportMail: supportMail ~~~~~~~~~~~ .. container:: table-row Property supportMail Data type string Description Support team email address Default {$plugin.tx\_mmforum.support\_mail} .. _Emailsender: Emailsender ~~~~~~~~~~~ .. container:: table-row Property Emailsender Data type string Description Sender name of automatically generated emails. Default {$plugin.tx\_mmforum.support\_mail} .. _username-allowed: username\_allowed ~~~~~~~~~~~~~~~~~ .. container:: table-row Property username\_allowed Data type string Description A list of characters that a user name may consist of. Default a-z0-9äüö\_.ß .. _username-minLength: username\_minLength ~~~~~~~~~~~~~~~~~~~ .. container:: table-row Property username\_minLength Data type int Description The minimum user name length. Registration attempts with a user name shorter than this parameter will fail. Default 3 .. _username-maxLength: username\_maxLength ~~~~~~~~~~~~~~~~~~~ .. container:: table-row Property username\_maxLength Data type int Description The maximum user name length. Registration attempts with a user name longer than this parameter will fail. Default 30 .. _useCaptcha: useCaptcha ~~~~~~~~~~ .. container:: table-row Property useCaptcha Data type bool Description Defines whether to use the captcha library in order to validate user registrations. Default {$plugin.tx\_mmforum.useCaptcha} .. ###### END~OF~TABLE ###### .. _plugin-tx-mmforum-pi3-mm-forum-Private-messaging: plugin.tx\_mmforum\_pi3 (mm\_forum :: Private messaging) """""""""""""""""""""""""""""""""""""""""""""""""""""""" .. ### BEGIN~OF~TABLE ### .. _block-time: block\_time ~~~~~~~~~~~ .. container:: table-row Property block\_time Data type int Description 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. Default 30 .. _mailerEmail: mailerEmail ~~~~~~~~~~~ .. container:: table-row Property mailerEmail Data type string Description Email address of the PHP mailer. Default {$plugin.tx\_mmforum.mailer\_mail} .. _unreadWrap: unreadWrap ~~~~~~~~~~ .. container:: table-row Property unreadWrap Data type string (wrap) Description Wrap for unread messages in the message listing view. Default :: | .. _template: template ~~~~~~~~ .. container:: table-row Property template Data type array Description 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. Default See EXT:mm\_forum/ext\_typoscript\_setup.txt .. ###### END~OF~TABLE ###### .. _plugin-tx-mmforum-pi4-mm-forum-Search: plugin.tx\_mmforum\_pi4 (mm\_forum :: Search) """"""""""""""""""""""""""""""""""""""""""""" .. ### BEGIN~OF~TABLE ### .. _template: template ~~~~~~~~ .. container:: table-row Property template Data type string Description Template file name. Default EXT:mm\_forum/res/tmpl/default/search/tmpl\_search.html .. _noIndex-boardUIDs: noIndex\_boardUIDs ~~~~~~~~~~~~~~~~~~ .. container:: table-row Property noIndex\_boardUIDs Data type list Description This field contains a comma-separated list of board UIDs. These boards will not be indexed by the indexing process. Default .. _sword-minLength: sword\_minLength ~~~~~~~~~~~~~~~~ .. container:: table-row Property sword\_minLength Data type int Description The minimum length for search words. Default {$plugin.tx\_mmforum.sword\_minLength} .. _resultsPerPage: resultsPerPage ~~~~~~~~~~~~~~ .. container:: table-row Property resultsPerPage Data type int Description The amount of search results that are to be displayed on one page. Default {$plugin.tx\_mmforum.resultsPerPage} .. _matchWrap: matchWrap ~~~~~~~~~ .. container:: table-row Property matchWrap Data type string (wrap) Description This field defines the wrap around passages matching the search words. Default :: | .. _indexCount: indexCount ~~~~~~~~~~ .. container:: table-row Property indexCount Data type int Description Amount of topics that are to be indexed at a time. Default {$plugin.tx\_mmforum.indexCount} .. _indexingPassword: indexingPassword ~~~~~~~~~~~~~~~~ .. container:: table-row Property indexingPassword Data type string Description MD5 hash of the indexing password. Default {$plugin.tx\_mmforum.indexingPassword} .. _displaySearchDuration: displaySearchDuration ~~~~~~~~~~~~~~~~~~~~~ .. container:: table-row Property displaySearchDuration Data type bool Description If enabled, the duration of a search will be displayed along with the search results. Default 0 .. _postPath: postPath ~~~~~~~~ .. container:: table-row Property postPath Data type stdWrap Description stdWrap function for the post path (i.e. the URL leading to a search result post) Default .. ###### END~OF~TABLE ###### .. _plugin-tx-mmforum-pi5-mm-forum-User-settings: plugin.tx\_mmforum\_pi5 (mm\_forum :: User settings) """""""""""""""""""""""""""""""""""""""""""""""""""" .. ### BEGIN~OF~TABLE ### .. _template: template ~~~~~~~~ .. container:: table-row Property template Data type string Description Defines the path to the template file used by this plugin. Default EXT:mm\_forum/res/tmpl/change\_user/main.html .. _userFields: userFields ~~~~~~~~~~ .. container:: table-row Property userFields Data type string Description A comma-separated list of fields the user is allowed to edit. Default zip,city,www,tx\_mmfeuserreg\_occ,tx\_mmfeuserreg\_interests,email,tx\ _mmforum\_yim,tx\_mmforum\_msn,tx\_mmforum\_aim,tx\_mmforum\_icq,tx\_m mforum\_skype,tx\_mmforum\_user\_sig .. _avatar: avatar ~~~~~~ .. container:: table-row Property avatar Data type cObj Description An IMAGE-cObj defining the display of the user's avatar. Default .. _minPasswordLength: minPasswordLength ~~~~~~~~~~~~~~~~~ .. container:: table-row Property minPasswordLength Data type int Description The minimum password length Default 6 .. _icons: icons ~~~~~ .. container:: table-row Property icons Data type array of cObj Description This array contains an array of content objects each describing an icon for each section of the user profile form. The following elements are evaluated: **settings** – The icon for personal settings (name, contact data) **settings2** – The icon for board preferences. **avatar** – The icon for the avatar form **password** – The icon for the password form Default .. ###### END~OF~TABLE ###### .. _plugin-tx-mmforum-pi6-mm-forum-Portal-information: plugin.tx\_mmforum\_pi6 (mm\_forum :: Portal information) """"""""""""""""""""""""""""""""""""""""""""""""""""""""" .. ### BEGIN~OF~TABLE ### .. _templateFile: templateFile ~~~~~~~~~~~~ .. container:: table-row Property templateFile Data type string Description Defines the path to the template file used by this plugin. Default EXT:mm\_forum/res/tmpl/portalinfo/mm\_forum\_pi6.tmpl .. _onlineTime: onlineTime ~~~~~~~~~~ .. container:: table-row Property onlineTime Data type int Description The time in seconds that has to pass before a user is not counted as online anymore. Default 600 .. _showPostCount: showPostCount ~~~~~~~~~~~~~ .. container:: table-row Property showPostCount Data type boolean Description Determines if the plugin should show how many posts a user has written today. Default 1 .. _importantInformation-wrap: importantInformation\_wrap ~~~~~~~~~~~~~~~~~~~~~~~~~~ .. container:: table-row Property importantInformation\_wrap Data type string (wrap) Description The wrap around important parts of the portal information. Default :: | .. _userList-groupTitle-wrap: userList.groupTitle\_wrap ~~~~~~~~~~~~~~~~~~~~~~~~~ .. container:: table-row Property userList.groupTitle\_wrap Data type string (wrap) Description The wrap around group titles in the user list. Default :: | .. ###### END~OF~TABLE ###### .. _Customization: Customization ------------- Most web masters would probably like to adapt the mm\_forum to the looks of their website. In this section, I will introduce several ways to customize the mm\_forum extension exactly to your needs. .. _Template-editing-and-design-sets: Template editing and design sets ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ To change the look and feel of the mm\_forum extension you are allowed to edit all HTML template files in the backend module. In order to do this go to **Tools** **► mm\_forum** and select option “Templates” and than select the template file you want to edit. |img-49| The mm\_forum extension works with different design sets. These design sets contain the templates needed for generating the mm\_forum output. Each design is meant to contain the same template files describing different designs for outputting the same things. You can edit the mm\_forum templates directly in the backend module. However, you will not be able to edit template files that are in the default design set. To edit template files, you have to create a new design set. The backend module will do this by just copying the default design set into a new directory. The reason for this is that the default design set is overwritten each time the administrator updates the extension, so editing files directly in the default design set would be extremely risky. Custom design sets are stored in a directory outside the mm\_forum extension directory. By default, this alternative template directory is fileadmin/ext/mm\_forum/tmpl/. This value can be changed using the mm\_forum configuration tool. You can specify one design set as **active** . The template files from the active design set will be used for rendering the content of the mm\_forum in the frontend. The mm\_forum style sheet file is also affected by the design set mechanism, which allows you to totally vary the mm\_forum output just be defining different design sets. Of course you can also edit the template files directly in the EXT:mm\_forum/res/tmpl/ directory or define other template files in Typoscript. To see which TypoScript values you have to change for that, see the fully documented file EXT:mm\_forum/ext\_typoscript\_setup.txt. **NOTE: It is not recommended to edit any files directly in the extension directory, since your changes might be overwritten during future updates. Instead, you should either change the file paths in Typoscript to your custom files or work with design sets.** A design set contains also CSS files and images. This means, when you create a new design set, all mm\_forum images will be duplicated into this new design set too, allowing you to edit and store these update- save. .. _Buttons: Buttons ^^^^^^^ All buttons used in the mm\_forum are generated using Typoscript templates. These can be found in the „buttons“ object of the regarding plugin. The parameters of the button are stored in the data array of the content object (accessible for example by stdWrap.field). There are the following fields: .. ### BEGIN~OF~TABLE ### .. _: :: "" .. container:: table-row Field name :: button_iconname Description The name of the icon used for this button .. _: :: "" .. container:: table-row Field name :: button_label Description The text label used for this button .. _: :: "" .. container:: table-row Field name :: button_link Description The link of the button .. _: :: "" .. container:: table-row Field name :: button_atagparams Description Additional parameters for the buttons -Tag .. ###### END~OF~TABLE ###### By default, the mm\_forum contains two button templates, one for text based buttons and one for image buttons. These are stored in plugin.tx\_mmforum\_pi1.buttons\_text and plugin.tx\_mmforum\_pi1.buttons\_image. This allows you to switch between text and image buttons by just copying the regarding object into the buttons object: :: plugin.tx_mmforum_pi1.buttons < plugin.tx_mmforum_pi1.buttons_text In version 0.1.6, text buttons are enabled by default. .. _Topic-icons: Topic icons ^^^^^^^^^^^ You can switch between classic and modern topic icons. The classic icons are identical with those used in the previous versions of the mm\_forum extension. The modern icons by default consist of an „icon map“ and are configured by a Typoscript template located in plugin.tx\_mmforum\_pi1.topicIcon. The necessary topic parameters are stored in the data array of the content object (accessible for example by stdWrap.field). There are the following fields: .. ### BEGIN~OF~TABLE ### .. _: :: "" .. container:: table-row Field name :: unread Description Equals 1 if the topic is unread, otherwise 0 .. _: :: "" .. container:: table-row Field name :: unanswered Description Equals 1 if the topic is unanswered, otherwise 0 .. _: :: "" .. container:: table-row Field name :: closed Description Equals 1 if the topic is closed, otherwise 0 .. _: :: "" .. container:: table-row Field name :: solved Description Equals 1 if the topic is solved, otherwise 0 .. _: :: "" .. container:: table-row Field name :: hot Description Equals 1 if the topic is hot, otherwise 0 .. ###### END~OF~TABLE ###### .. _FAQ: FAQ --- - **I have installed the mm\_forum but I do not see anything!** Make sure that you have set up all page relations correctly in the mm\_forum configuration module. The most important items are the **Board data** , **User data** and **Forum page** values. - **I see the mm\_forum but the CSS does not appear to be included!** If your PAGE object in your Typoscript setup is not called “page”, please add the following line to your setup: :code:`your-page- name.includeCSS.mm\_forum = {$plugin.tx\_mmforum.stylePath}/css/mm\_forum.css` - **I have a problem with the mm\_forum. In the extension manager I see some developer-relevant warnings. Are these errors the cause for my problem?** No. That is why the warnings are labelled as “developer relevant”. - **mm\_forum doesn't work after updating the extension.** Please check whether the static mm\_forum templates are still included in your TypoScript template. - **jQuery is not defined / "element.dispatchEvent is not a function"** Please check whether the static mm\_forum JavaScript template is still included in your TypoScript template BEFORE the mm\_forum static template.Have a look at the end of chapter `Getting started <#__RefHeading__5603_465104789>`_ (introduction) for more information. The headlines are: “How to include the static templates” & “Static templates: Prototype or jQuery” - **The insertion of smilies / BBCode does not work.** Please check whether the static mm\_forum JavaScript template is still included in your TypoScript template BEFORE the mm\_forum static template.Have a look at the end of chapter `Getting started <#__RefHeading__5603_465104789>`_ (introduction) for more information. The headlines are: “How to include the static templates” & “Static templates: Prototype or jQuery” .. _Known-problems-and-solutions: Known problems and solutions ---------------------------- - **In the frontend, an error message is displayed saying that the class 'GeSHi' would already be declared.** The mm\_forum extension includes the **Generic Syntax Highlighter** class (GeSHi), therefore some problems might occur in connection to other extensions that use GeSHi. However, this is not a problem of the mm\_forum extension, since in the mm\_forum extension, the GeSHi class in only included if it did not exist until the time of inclusion. On the other hand it cannot be guaranteed that other extensions check this before including the GeSHi class. - **Users that were imported from a phpBB forum cannot log in!** If you import user data from a phpBB message board, you should install the extension **kb\_md5fepw** . The reason for this it that in the phpBB board, user passwords are stored only as encrypted MD5 hash, while the regular TYPO3 authentication method uses clear text passwords. Since the MD5 algorithm is a one-way encryption, there is no (easy) way to retrieve the clear text passwords from the MD5 hashes. The kb\_md5fepw extension changes the TYPO3 authentication method to work with MD5 encrypted passwords. - **Some forms can not be submitted when the server OS is a Windows system!** This is related to how Windows handles URLs. Windows uses backslashes (\) in URLs which occasionally leads to 'hiccups' in the forum system. A workaround for this problem should be to either use the config.baseURL variable or to switch to Linux. Just joking. .. _Team: Team ---- .. _generated: ((generated)) ^^^^^^^^^^^^^ .. _Team-leader: Team leader """"""""""" **Martin Helmich** , `m.helmich@mittwald.de `_ .. _Developers: Developers """""""""" - **Björn Detert** , `b.detert@mittwald.de `_ - **Benjamin Mack** , `benni@typo3.org `_ - **Georg Ringer** , `mail@ringerge.org `_ .. _User-manual: User manual """"""""""" - **Ines Willenbrock** , `icy@icys-scholle.de `_ - **Stefan Lang** .. _Bugtracker-organization-and-testing: Bugtracker organization and testing """"""""""""""""""""""""""""""""""" **Ines Willenbrock** , `icy@icys-scholle.de `_ .. _Initial-development: Initial development """"""""""""""""""" - **Holger Trapp** (now Steinmeier) - **Ines Halstenberg** - **Stefan Horenkamp** - **Steffen Kamper** , `steffen@dislabs.de `_ - **Markus Walter** , `markuswalter@airpost.net `_ .. _Contributors: Contributors """""""""""" .. _Translators: Translators ~~~~~~~~~~~ - **Bülent Aydin** ( `http://www.openpoint.de `_ ): Turkish translation, sponsored by **Alexander Maringer** ( `http://www.maringer-it.de `_ ) - **Stas Kobzar** ( `http://doodo.info `_ ): Russian translation - **Roman Savochenko** : Ukranian translation - **Guy Sinden** ( `http://abis-freiburg.de `_ ):French translation - **Rob Vonk** ( `http://www.robvonk.com `_ ): Dutch translation - **Katja Lampela** : Finnish translation .. _Source-code-extensions: Source code extensions ~~~~~~~~~~~~~~~~~~~~~~ **Cyrill Helg** ( `http://www.solnet.ch `_ ): Board subscriptions .. _Change-log: Change log ---------- .. _generated: ((generated)) ^^^^^^^^^^^^^ .. _Beta-1-9-0: Beta 1.9.0 """""""""" - **Frontend administration:** The forum extension now features a frontend administration plugin that allows administrators to manage categories and forums using a frontend plugin. - **Data import:** The data import module has been completely redesigned. Please note that this module has been outsourced into the mm\_forum\_import extension. - **Salted passwords:** The mm\_forum extension now supports the mechanism for salted passwords introduced in TYPO3 4.3. - **Extensible backend module:** The backend module can easily be extended using a special typoscript configuration. Have a look at the mm\_forum\_import extension in order to see the mechanism working. - **Pagebrowser:** The forum now uses the pagebrowse Extension by Dmitry Dulepov to display the page navigation. - **Miscellaneous:** The version 1.9 includes a lot of minor new features and bugfixes. Please see http://forge.typo3.org/versions/show/212 for a full list. .. _Beta-1-8-0: Beta 1.8.0 """""""""" - **New backend module:** The backend module has been completely overworked in both function and aesthetics. - **User fields:** The extended user field handling has been improved. While in older versions, all fields had to be configured using TypoScript, there are now predefined templates for creating text fields, check boxes, radio buttons, drop-down selection lists, …In the same step, the user editing forms (i. e. registration and profile editing) have been revised. Now, all fields (except user name and password) can be fully configured in the backend module. - **Ratings:** The mm\_forum uses the ratings extension provided by Netcreators BV for rating forums, topics, posts and users. The rating option can be enabled or disabled for each element type separately using a Typoscript option. - **Documentation:** The documentation has been brought up-to-date regarding both content and layout. Thanks to Ines Willenbrock. - **Compatibility with TYPO3 4.3:** The extension has been thoroughly tested with TYPO3 4.3.0-alpha3 and a lot of compatibility issues have been fixed. If any more problems should occur with the final version of TYPO3 4.3, feel free to report them at `http://forge.typo3.org `_ . - **Performance tuning - Caching mechanisms:** Some caching mechanisms were added to the extension which improves the performance of the mm\_forum frontend plugins. When used with TYPO3 4.3, the extension used the built-in caching interface, otherwise an self-developed interface will be used. - **Performance tuning – Database layout, code structure:** Both the forum and topic index views and messaging inbox view have been optimized by adding some missing indexes to the database tables (remember to bring your database structure up-to-date when upgrading) and by tweaking the mm\_forum source code. Credits to go Christopher Lörken. - **Extensive code reorganisation:** The source code of the mm\_forum extension has been reorganized in order to reduce redundancies in the code and to make the code conform to the official TYPO3 coding guidelines. Thanks to Benjamin Mack of the TYPO3 Core development Team. .. _Beta-0-1-7: Beta 0.1.7 """""""""" - **Multiple file attachments:** The maximum number of file attachments can now be set using an attribute in the Configuration module. Thanks to Georg Ringer for contributing to this feature. - **Improved cronjob features:** Crobjobs can now be started using a command line call instead of calling a script in the browser. Furthermore, there are more available cronjobs. - **Updated default design template:** The default design template was modernized and the orange color was replaced with a dark blue. - **RSS Feeds:** The mm\_forum extension now supports an RSS export of forum data - **Documentation:** Added a FAQ section and removed the Todo section since it was out of date anyway. .. _Beta-0-1-6: Beta 0.1.6 """""""""" - **Updated icon generation:** Implemented a new method if topic and board icon generation. However, the old icon generation mechanism is still available. Both mechanisms can be switched using the install module. See **Customizing** **► Topic icons** for more information. - **German manual:** There is a german version of this manual available in the docs/ directory of the extension. Thanks to Stefan Lang for translating this document. - **Extensive bug fixing:** See `http://bugs.typo3.net `_ .. _Beta-0-1-5: Beta 0.1.5 """""""""" - **Cronjobs:** The mm\_forum now supports cron jobs in order to perform regulary occuring events, like for example informing users about new private messages once a day. See **Administration** **► Cronjobs** for more information. More cronjob features will follow in the next versions. - **Captcha support:** The mm\_forum extension now offers support for the captcha extension. The extension is implemented in the registration plugin in order to validate new user registrations. Captcha validation can be enabled/disabled using the mm\_forum installation tool. - **Board subscriptions:** Additional to the possibility to subscribe certain topics (meaning the option of being notified when somebody replies to a subscribed topic), users can now subscribe entire boards. In this case, the user will be notified when a new topic was opened in this board. This feature was implemented by Cyrill Helg ( `cyrill.h@solnet.ch `_ ). - **Translations:** Implemented a Russian translation. Credits go to Stas Kobzar ( `http://doodo.info `_ ). - **Minor improvements:** - **User profile linking:** Link generation to user profiles is now being handled by a single function (tx\_mmforum\_pi1::getUserProfileLink) that can be extended by the hook profileLink\_postLinkGen. This makes it easier for developers to connect the mm\_forum extension with other community extensions. - **Longer BB code replacements** The maximum length of a BB code replacement was incremented from 255 bytes to 65535 bytes. This makes it possible to implement more complex BB codes. - **Notifications** Email notification about new PMs is now optional (though enabled by default) and can be enabled/disabled in the user settings plugin. - **Bug fixes:** See `http://bugs.typo3.net `_ . .. _Beta-0-1-4: Beta 0.1.4 """""""""" - **Translations:** Implemented a French and a dutch translation for the mm\_forum extension. Credits go to Guy Sinden ( `http://abis- freiburg.de `_ ) for the French translation and to Rob Vonk ( `http://www.robvonk.com `_ ) for the dutch translation.Furthermore, an informal German translation was added (using the address “Du” instead of “Sie”). The informal language mode is theoretically available for all languages and can be enabled using the mm\_forum configuration module. - **Bug fixes:** See `http://bugs.typo3.net `_ . .. _Beta-0-1-3: Beta 0.1.3 """""""""" - **Security issues:** Several security issues have been fixed. See the official security bulletin 20070919-1 for more details - **Translations:** Implemented a finnish translation for the mm\_forum extension. Credits to Katja Lampela. - **Bug fixes:** Bug fixing as usual. See the official mm\_forum bug tracker on `http://bugs.typo3.net `_ for more information on which bugs were fixed. - **Changed design templates:** change\_user/main.html (modified)forum/list\_post.html (modified)forum/favorites.html (modified)forum/polls.html (modified)forum/search.html (deleted)forum/post\_del.html (deleted) .. _Beta-0-1-2: Beta 0.1.2 """""""""" - **User ranks:** An optional user ranking functionality was implemented. Users now can obtain a higher rank by writing more posts. See **Administration** **► User ranks** for more information. - **Moderated forum:** Implemented a functionality to use the mm\_forum as moderated board. This means that topics and posts have to be cleared by a moderator before becoming public. The feature can be enabled/disabled using the configuration module. - **Bug fixes:** Some minor bugs were fixed. See the official mm\_forum bug tracker on `http://bugs.typo3.net `_ for more information on which bugs were fixed. - **Changed design templates:** forum/login\_error.html (modified)forum/postqueue.html (added) .. _Beta-0-1-1: Beta 0.1.1 """""""""" - **Improved user name verification:** The user name verification in the mm\_forum :: User registration plugin was changed to a “deny all, allow some” directive. The list of allowed characters can be changed in TypoScript. This guarantees a higher security and flexibility. - **Fixed some security issues:** Some security issues were fixed. Before, users were able to insert Javascript on a mm\_forum page using manipulated BBCodes. This was fixed by a more restrictive regular expression syntax. It is necessary to re-import the static data after updating. - **Added some minor features:** Some minor features were added: - After changing something in the mm\_forum configuration module, the cache does not have to be cleared anymore, since the configuration module does this automatically now. - BBCodes in user signatures can now be disabled. The regarding option can be found in the “Forum” section in the configuration module. - A user list can now be displayed. It is part of the mm\_forum :: Forum plugin and can be selected using the FlexForms configuration. - **Bug fixes:** Some minor bugs were fixed. See the official mm\_forum bug tracker on `http://bugs.typo3.net `_ for more information on which bugs were fixed. .. _Beta-0-1-0: Beta 0.1.0 """""""""" - **Statistics module:** A statistics module was implemented allowing the administrator to see interesting statistics, like the development of the post or topic amount. - **Bug fixes:** A lot of minor bugs were fixed. See the official mm\_forum bug tracker on `http://bugs.typo3.net `_ for more information on which bugs were fixed. .. _Alpha-0-0-7: Alpha 0.0.7 """"""""""" - **Poll system:** Implemented a poll system. A poll can now be attached to a topic where users can participate on it. Authorization for poll creation can be handled by restricting poll creation to certain user groups. The phpBB import was updated to import phpBB polls (see **Users Manual** **►** **Polls** on page 21 for more information). - **File attachments:** Realized file attachments. Users can upload files to the server and attach them to posts. The file attachment system can be configured easily using the configuration tool (see **Users Manual** **►** **File attachments** on page 22 for more information) - **Extend user profile:** Implemented a possibility to extend the user profile. The user profile can be extended with an unlimited amount of additional fields which may be configured freely using a TypoScript configuration (see **Administration** **► Extending the user profile** on page 32 for more information) - **Latest posts:** Implemented the possibility to display a list of the latest topics. This means a list of the topics that was last written in. See **Introduction ► How to install** on page 5 for more information. - **Bug fixes:** A lot of minor bugs were fixed. See the official mm\_forum bug tracker on `http://bugs.typo3.net `_ for more information on which bugs were fixed. .. _Alpha-0-0-6: Alpha 0.0.6 """"""""""" - Implemented a dynamic backend configuration form allowing a much easier installation. Administrators do not have to enter page and group UIDs in two different forms in the backend anymore. Instead, users have a very comfortable installation form in the backend module. - Improved template handling by relocating custom design set folders to a directory outside the mm\_forum extension directory. - Improved RealURL support. - Fixed some minor bugs (see *mm\_forum* bug tracker on `http://bugs.typo3.net `_ ) .. _Alpha-0-0-5: Alpha 0.0.5 """"""""""" - Implemented a better RealURL support by fixing some bugs related to RealURL and adding an option to add more parameters to a url in order to generate nicer links (see section **Administration** **► mm\_forum and RealUrl** on page 36). - Implemented the CHC Forum/CWT Community data import. See **Administration ► Data import ► CHC Forum/CWT Community data import** for more information. Credits to **Nepa Design** ( `http://www.nepa- design.de/ `_ ). - The BBCode buttons that are displayed above a post creation form are now created dynamically in dependence of the BBCodes that were specified in the backend module. - Implemented a better design template handling using different design sets (See **Administration ► Changing Look and Feel** on page Fehler: Referenz nicht gefunden) .. _Alpha-0-0-4: Alpha 0.0.4 """"""""""" - Updated some MySQL-table and -field names to TYPO3 guideline conform values (like for example *tx\_mmpm\_inbox* to *tx\_mmforum\_pminbox* ). **It is required to run the update wizard after upgrading to version 0.0.4** (see section **Administration** **► Updating** ) - Implemented a FlexForm configuration for the **mm\_forum :: Forum** plugin. Furthermore, the configuration of special listing pages was simplified. For the configuration of the mm\_forum :: Forum plugin using FlexForms, see **Introduction ► How to install** on page 5. For more about special listing, see **Administration ► Special listings** on page 31. - Added a possibility to limit the categories that are displayed to a certain predefined set of categories. This offers a functionality similar to multiple mm\_forum instances, as it is described in the **To-Do list** (page Fehler: Referenz nicht gefunden). - Added a possibility to display the users' real names in the post listing view, that can be enabled/disabled using the TypoScript constants (see **Configuration ► Constants Reference ► Message board** on page 41) - Resolved a big problem denying users access to their own topics, furthermore some minor bug fixes (see *mm\_forum* bug tracker on `http://bugs.typo3.net `_ ) .. _Alpha-0-0-3: Alpha 0.0.3 """"""""""" - Implemented a more flexible user rights administration using different fe\_groups (see section **Administration** **► User rights management** in the documentation, page 31) - Implemented a function to automatically start an indexing process for the **mm\_forum :: Search** plugin (see section **Administration ► Search index** in the documentation, page 30) - Replaced the registration form with a table free layout (credits to Claudia Höhne ) - Some minor bug fixes (see *mm\_forum* bug tracker on `http://bugs.typo3.net `_ ) .. _Alpha-0-0-2: Alpha 0.0.2 """"""""""" Some minor bug fixes (see *mm\_forum* bug tracker on `http://bugs.typo3.net `_ ) .. _Alpha-0-0-1: Alpha 0.0.1 """"""""""" First release of mm\_forum `0 <#sdfootnote1anc>`_ See `http://en.wikipedia.org/wiki/Cross- site\_scripting `_ for more details on this topic. `0 <#sdfootnote2anc>`_ See `http://www.php.net/strftime `_ for more information `0 <#sdfootnote3anc>`_ See `http://www.php.net/date `_ for more information `0 <#sdfootnote4anc>`_ See `http://www.php.net/htmlspecialchars `_ for more information on quotation character replacement `0 <#sdfootnote5anc>`_ See `http://www.php.net/strip\_tags `_ for more information `0 <#sdfootnote6anc>`_ See `http://www.php.net/htmlspecialchars `_ for more information `0 <#sdfootnote7anc>`_ See `http://www.php.net/htmlentities `_ for more information `0 <#sdfootnote8anc>`_ See TSRef, page 22 or `http://typo3.org/documentation/document- library/references/doc\_core\_tsref/4.1.0/view/5/1/ `_ `0 <#sdfootnote9anc>`_ See TSRef, page 75 or `http://typo3.org/documentation/document- library/references/doc\_core\_tsref/4.1.0/view/8/6/ `_ 62 .. ######CUTTER_MARK_IMAGES###### .. |img-1| image:: img-1.png .. :align: left .. |img-2| image:: img-2.png .. :border: 0 .. :height: 21 .. :hspace: 9 .. :id: Grafik2 .. :name: Grafik2 .. :width: 87 .. |img-3| image:: img-3.png .. :align: bottom .. :border: 0 .. :height: 108 .. :id: graphics19 .. :name: graphics19 .. :width: 205 .. |img-4| image:: img-4.png .. :align: bottom .. :border: 0 .. :height: 154 .. :id: Grafik1 .. :name: Grafik1 .. :width: 669 .. |img-5| image:: img-5.png .. :align: bottom .. :border: 0 .. :height: 67 .. :id: graphics21 .. :name: graphics21 .. :width: 215 .. |img-6| image:: img-6.png .. :align: bottom .. :border: 0 .. :height: 206 .. :id: Grafik3 .. :name: Grafik3 .. :width: 127 .. |img-7| image:: img-7.png .. :align: bottom .. :border: 0 .. :height: 165 .. :id: Grafik34 .. :name: Grafik34 .. :width: 669 .. |img-8| image:: img-8.png .. :align: bottom .. :border: 0 .. :height: 243 .. :id: Grafik7 .. :name: Grafik7 .. :width: 669 .. |img-9| image:: img-9.png .. :align: bottom .. :border: 0 .. :height: 408 .. :id: Grafik4 .. :name: Grafik4 .. :width: 550 .. |img-10| image:: img-10.png .. :align: bottom .. :border: 0 .. :height: 175 .. :id: Grafik29 .. :name: Grafik29 .. :width: 669 .. |img-11| image:: img-11.png .. :align: bottom .. :border: 0 .. :height: 210 .. :id: Grafik13 .. :name: Grafik13 .. :width: 669 .. |img-12| image:: img-12.png .. :align: bottom .. :border: 0 .. :height: 540 .. :id: Grafik8 .. :name: Grafik8 .. :width: 669 .. |img-13| image:: img-13.png .. :align: bottom .. :border: 0 .. :height: 569 .. :id: Grafik9 .. :name: Grafik9 .. :width: 669 .. |img-14| image:: img-14.png .. :align: bottom .. :border: 0 .. :height: 278 .. :id: Grafik15 .. :name: Grafik15 .. :width: 669 .. |img-15| image:: img-15.png .. :align: bottom .. :border: 0 .. :id: graphics5 .. :name: graphics5 .. :width: 100% .. |img-16| image:: img-16.png .. :align: bottom .. :border: 0 .. :id: graphics6 .. :name: graphics6 .. :width: 100% .. |img-17| image:: img-17.png .. :align: bottom .. :border: 0 .. :id: graphics7 .. :name: graphics7 .. :width: 100% .. |img-18| image:: img-18.png .. :align: bottom .. :border: 0 .. :id: graphics8 .. :name: graphics8 .. :width: 100% .. |img-19| image:: img-19.png .. :align: bottom .. :border: 0 .. :id: graphics31 .. :name: graphics31 .. :width: 100% .. |img-20| image:: img-20.png .. :align: bottom .. :border: 0 .. :id: Grafik10 .. :name: Grafik10 .. :width: 100% .. |img-21| image:: img-21.png .. :align: bottom .. :border: 0 .. :id: Grafik12 .. :name: Grafik12 .. :width: 100% .. |img-22| image:: img-22.png .. :align: bottom .. :border: 0 .. :id: Grafik11 .. :name: Grafik11 .. :width: 100% .. |img-23| image:: img-23.png .. :align: bottom .. :border: 0 .. :id: Grafik17 .. :name: Grafik17 .. :width: 100% .. |img-24| image:: img-24.png .. :align: bottom .. :border: 0 .. :id: Grafik14 .. :name: Grafik14 .. :width: 100% .. |img-25| image:: img-25.png .. :align: bottom .. :border: 0 .. :id: Grafik18 .. :name: Grafik18 .. :width: 100% .. |img-26| image:: img-26.png .. :align: bottom .. :border: 0 .. :height: 125 .. :id: Grafik19 .. :name: Grafik19 .. :width: 669 .. |img-27| image:: img-27.png .. :align: bottom .. :border: 0 .. :id: Grafik5 .. :name: Grafik5 .. :width: 100% .. |img-28| image:: img-28.png .. :align: bottom .. :border: 0 .. :id: graphics29 .. :name: graphics29 .. :width: 100% .. |img-29| image:: img-29.png .. :align: left .. :border: 0 .. :height: 199 .. :id: Grafik37 .. :name: Grafik37 .. :width: 148 .. |img-30| image:: img-30.png .. :align: left .. :border: 0 .. :height: 307 .. :id: Grafik38 .. :name: Grafik38 .. :width: 549 .. |img-31| image:: img-31.png .. :align: left .. :border: 0 .. :height: 274 .. :id: Grafik39 .. :name: Grafik39 .. :width: 251 .. |img-32| image:: img-32.png .. :align: left .. :border: 0 .. :height: 467 .. :id: Grafik40 .. :name: Grafik40 .. :width: 565 .. |img-33| image:: img-33.png .. :align: left .. :border: 0 .. :height: 96 .. :id: Grafik41 .. :name: Grafik41 .. :width: 254 .. |img-34| image:: img-34.png .. :align: left .. :border: 0 .. :height: 87 .. :id: Grafik42 .. :name: Grafik42 .. :width: 256 .. |img-35| image:: img-35.png .. :align: middle .. :border: 0 .. :id: Grafik21 .. :name: Grafik21 .. :width: 100% .. |img-36| image:: img-36.png .. :align: bottom .. :border: 0 .. :id: Grafik6 .. :name: Grafik6 .. :width: 100% .. |img-37| image:: img-37.png .. :align: bottom .. :border: 0 .. :id: Grafik20 .. :name: Grafik20 .. :width: 100% .. |img-38| image:: img-38.png .. :align: left .. :border: 0 .. :height: 236 .. :id: Grafik25 .. :name: Grafik25 .. :width: 669 .. |img-39| image:: img-39.png .. :align: left .. :border: 0 .. :height: 79 .. :id: Grafik26 .. :name: Grafik26 .. :width: 669 .. |img-40| image:: img-40.png .. :align: left .. :border: 0 .. :height: 182 .. :id: Grafik27 .. :name: Grafik27 .. :width: 669 .. |img-41| image:: img-41.png .. :align: left .. :border: 0 .. :height: 207 .. :id: Grafik32 .. :name: Grafik32 .. :width: 669 .. |img-42| image:: img-42.png .. :align: left .. :border: 0 .. :height: 142 .. :id: Grafik22 .. :name: Grafik22 .. :width: 669 .. |img-43| image:: img-43.png .. :align: bottom .. :border: 0 .. :id: graphics16 .. :name: graphics16 .. :width: 100% .. |img-44| image:: img-44.png .. :align: bottom .. :border: 0 .. :height: 415 .. :id: Grafik30 .. :name: Grafik30 .. :width: 669 .. |img-45| image:: img-45.png .. :align: bottom .. :border: 0 .. :id: Grafik31 .. :name: Grafik31 .. :width: 100% .. |img-46| image:: img-46.png .. :align: bottom .. :border: 0 .. :id: graphics32 .. :name: graphics32 .. :width: 100% .. |img-47| image:: img-47.png .. :align: bottom .. :border: 0 .. :height: 120 .. :id: graphics33 .. :name: graphics33 .. :width: 547 .. |img-48| image:: img-48.png .. :align: bottom .. :border: 0 .. :height: 502 .. :id: graphics18 .. :name: graphics18 .. :width: 669 .. |img-49| image:: img-49.png .. :align: bottom .. :border: 0 .. :height: 429 .. :id: Grafik28 .. :name: Grafik28 .. :width: 669