typo3_forum¶
Classification: | typo3_forum |
---|---|
Version: | 1.0.0 |
Language: | en |
Description: | Manual covering TYPO3 extension typo3_forum |
Keywords: | forum |
Copyright: | 2011 |
Author: | Mittwald CM Service GmbH & Co. KG |
Email: | opensource@mittwald.de |
License: | This document is published under the Open Content License available from http://www.opencontent.org/opl.shtml |
Rendered: | 2017-06-01 07:02 |
The content of this document is related to TYPO3, a GNU/GPL CMS/Framework available from www.typo3.org <http://www.typo3.org/>
Table of Contents
Introduction¶
The typo3_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.
For more information please take a closer look at the official bug and issue tracker on the Github ( https://github.com/mittwald/typo3-forum/issues ). There, you will also find the typo3_forum develop branch from where you can retrieve the most current development snapshot.
If you have question or problems in setting up the extension, we open a Slack Channel on typo3.slack.org. #ext-typo3_forum.
What does it do?¶
The typo3_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 10 different plugins. These plugins provide the following features:
- Forum – The typo3_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 profile – The typo3_forum : View of the Profile of all users. The plugin offers functionalities for the user to edit his/her own user information.
- Moderation/Reports: List and edit reports – The typo3_forum : List of all topics and posts and reports for morderators.
- Users List – The typo3_forum : a listview of a all user
- Dashboard – The typo3_forum : The Dahshboard 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.
- Tags – The typo3_forum : Tags plugin offers the functionality to categorize topics and posts
- “MyTags” of a user – The typo3_forum : The plugin “MyTags” shows a list of the Tags from a user
- Private Messages – The typo3_forum : Private messaging plugin implements a messaging system allowing users to write private messages among each other.
- Posts List – The typo3_forum : The Plugin in shows a list of all posts of the forum
- Topics List – The typo3_forum : The Plugin in shows a list of all topics of the forum
Configuration¶
Target group: Developers
Template¶
Just override plugin.tx_typo3_forum.view
to use you own template. Default Template is found in EXT:typo3_forum/Resources/Private/
TypoScript Reference¶
- Configuration must be set in TypoScript
- Include Static Typoscript Template in BackendModule “Templates”
plugin.tx_typo3forum {
persistence {
# Pid for your main storage sysfolder
storagePid = 12
}
settings {
debug = 0
cutUsernameOnChar = 9
cutBreadcrumbOnChar = 40
popularTopicTimeDiff = 604800
useSqlStatementsOnCriticalFunctions = 1
pids {
# Insert pid of page where the fourm plugin is on
Forum = pid
# Insert pid of page where the User profile plugin is on
UserShow = pid
# Insert pid of page where the Users List plugin is on
UserList = pid
# Insert pid of page where the User profile plugin is on
UserEdit = pid
# Insert pid of page where the Dashboard plugin is on
Dashboard = pid
}
mailing {
# Insert name of the sender
sender.name = Name of Sender
# Insert Mail address of the sender
sender.address = Mail of Sender
}
}
}
Installation¶
Installation¶
- The first step to install the typo3_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 ?Get extensions? in the drop-down menu on the top of the page.
Then search for the extension key typo3_forum. After that click on Button ?Import and Install?:
In order to use typo3_forum you need to tell it where to find and store its data. For this, you should create a new SysFolder where your forum data is to be stored. The best solution would be to have a Subsysfolder for forums data and one for the forum user data.
Follow these steps in order to configure typo3_forum:
Create a new Record inside the Forum data Folder you just created. typo3_forum gives you a couple new options. First you?re gonna need a ?Forum?, you can name it however you want.
Fill out the fields ‘Title’ and ‘Description’ with the content you want.
With the Option ‘Children’ you can create subforum directly in this forom record. You can define every option for the subforum seperatly.
Next you must define the ‘ACLs’ for the forum operations. For the first installation you can define Login Level to Everyone for the Operations Read, Create new topic and Write posts.
The Option ‘Criteria’ you can leave blank for the first installation.
Now press the Button ‘Save and Close’ to save the record.
Then you have to include the static template ‘typo3_forum’ to your Page with the template record. There is a second static template ‘typo3_forum Bootstrap Template’ for including Bootstrap in Installation. If you already have included Bootstrap in your Site you don’t need the secound static template.
Now you have to set the PIDs via TypoScript for the forums page in setup field.
plugin.tx_typo3forum {
persistence {
storagePid = id from data sysfolder
}
settings {
pids {
Forum = id from page
}
}
}
To display your forum in the frontend you have to create a new record on a new page. Now create a new content element in the row where your forum should be displayed.
Click on the Tab ‘Plugins’ and choose the that the ?General Plugin? Element.
Within the settings in the Plugins - Tab for that Element you need to configure the Plugin. You must choose typo3_forum as the ‘Selected Plugin’ and confirm it by pressing the ?Ok? Button
Now a couple more Options should appear, under ?Plugin Options? please select ?Forum?.
At least you have to tell the Plugin where the forum data is stored, to do so select the folder that contains your data as ?Record Storage Page? and then press Save an Close.
If you?ve followed all the instructions correctly you should end up with a result like that:
Register and Login¶
The central elements of the typo3_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 user and the usergroup must have the Record Type “typo3_fourm user” and “typo3_forum group”. You must define it in the Extend Tab in the user or usergroup record.
The records must be created in your sysfolder for the user data over the List-View
Register¶
To have a user registration for your forum you must uae the Extension Frontend User Registration (sf_register). You will find a manuel for that here: https://docs.typo3.org/typo3cms/extensions/sf_register/
Login¶
To have a user login for your forum you must use SysExtension Frontend Login (fe_login).
Users Manual¶
Create News Topics and Posts¶
Create News Topics and Posts¶
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.
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 the ?Save?. <
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.
Private Messaging System¶
Private Messaging System¶
The typo3_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 typo3_forum :: Private Messages 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).
Migration from mm_forum Extension¶
Migrating extension mm_forum to typo3_forum¶
Many users who are using the old extension mm_forum were not able to use the updated extension typo3_forum because there was no way to migrate old forum data to the new extension. The new version 1.1.0 now enables the possibility to migrate old data. Please note: all mm_forum database tables must be available in the database. Please do not use ‘database analyser’ which will delete old database tables. Before you start migrating mm_forum to typo3_forum you have to configure the new extension typo3_forum completely. Afterwards you can start the migration. Please go the extension manager in your TYPO3 backend and search for ‘typo3_forum’. You will find a new button for the migration.
Press the button. Then you will be asked for the sysfolder’s PID where your users and usergroups are stored. Enter the sysfolder’s PID and push the ‘Update database!’ button.
The migration is started and all the old data will be copied to the database tables for typo3_forum. Depending on the size of your installation the process might need some time.
After the migration is done you will receive a confirmation that tells you which data has been migrated. Please note: You can run the migration process as often as you like.
The following data records will be migrated: Forums, Topics, Posts, Users, Usergroups, Private Messages and Attachments (the files have to be uploaded separately).
Known Problems¶
Use issue tracker on https://github.com/mittwald/typo3-forum/issues