The section provides you a guide to use all Forum features or to configure the Forum portlet to make it work in your desired manner.

In Forum, the role of each user group is clear and very important. Each role has a set of tasks that they can execute. Administrators and moderators are responsible for setting up and maintaining Forum. With the highest rights, the administrators are in charge of the entire management tasks, including form configurations, users management, permissions, categories, forums, topics and messages. With sub-sets of administrative permissions, the moderators will manage the respective sub-sets of the forum.

The user interface will indicate which features are available to you, based on your role.

To have an overall look of actions which users of each role can do in the Forum application, see the following table:

Features Description Administrator Moderator Regular user Guest
View details of Forum View categories, forums and many another information.
Subscribe to RSS feeds Provide the link to Forum for easy sharing.
Attach a file Upload attachments to a topic/post, preview and download attachments.
Search Do the simple and advanced search.
Bookmark Bookmark category, forum, topic.
Add a post Post reply, quote, private post, quick reply.
Edit a post Edit post, quote and private post.

Delete a post Delete post inside specific topic.
Add a topic Start a new topic.
Edit a topic Edit topic in a specific forum.

Delete a topic Delete topic inside a specific forum.

Lock/Unlock a topic Lock/Unlock topics inside a specific forum.

Add a poll & Vote Add a poll to topic and vote poll.
Rate a topic Evaluate a topic by rating star.
Add a tag Create new tags and tag a topic.
Private message Send or receive private messages.
Watch Subscribe to categories, forums, topics to receive notification mails of new posts or topics.
User Settings Change profile settings, personal forum settings.
Stick/unstick a topic Stick/unstick topics inside a specific forum.

Lock/unlock a topic Close/open topic inside a specific forum.
Split a topic Divide one topic into two separate topics.
Merge topics Combine two or more topics into one.
Manage a poll Create, edit, delete, close and reopen polls.
Move a topic/post Move one topic/post from a forum/topic to the other forum/topic.
Approve a topic/post Change new topics/posts from pending status to normal status so that guest, normal user can view.
Uncensor a post Allow a topic which has censored content to be displayed.
Show/hide a post Allow posts to be shown/hidden.
Manage pending tasks Manage all topics/posts waiting for moderation in one place.

Manage a watch Manage the subscription (watch). Edit and delete subscribed email.

Ban a user Ban users from accessing specific forums or categories

Add a forum Add a new forum to a specific category.

Edit a forum Change the title, description, moderator, permissions of a forum. However, moderators cannot set moderators for a forum.

Delete a forum Delete forums from a specific category.

Lock a forum Lock a forum so that it can be viewed only.

Unlock a forum Unlock a locked forum that allow doing basic action on unlocked forum.

Close/open a forum Close/open a forum. Closed forum are still manageable by administrator and moderators.

Move a forum Move forum from one category to the other category.

Export a forum Export a forum in the format of a .zip or .xml file.

Import a forum Import a forum from .zip/.xml file into the Forum application.

Add a category Add a new category.

Edit a category Edit a category and change properties.

Export a category Export categories in the format of a s.zip or .xml file.

Import a category Import categories from .zip/.xml file into the Forum application.

Delete a category Delete a category and all forum, topic, post inside it.

Administrate Sorting Sort forums, topics according to specific conditions.

Administrate Censor Define keywords that will be censored in forum.

Customize the notification template Define the content of the notification mails.

Customize BBCode Add, edit and delete the BBCode tags used in writing posts/topics.

Add a topic type Add topic types that help users easily know what topics are about at a glance .

Set up auto-pruning Set up auto-pruning to clean a large amount of obsolete and inactivate topics based on criteria.

Ban IPs Ban IPs on the whole Forum application (only administrators) and on only specific forums (both administrators and moderators).

Manage users Manage user's profile, promote users, ban users, view topic and post of a specific user.

Before reading, please notice that this document is divided into 3 parts which correspond to different user roles:

This section describes actions that a regular user can perform in the Forum application of eXo Platform.

See also

Once clicking Forum on the Administration bar, you will be directed to the Forum homepage. Here, you can see categories of Forum, forums in each category, forum statistics as shown below:

Like in Answers, you can do either of two search types (Quick Search or Advanced Search) anywhere in the Forum application, right on the homepage or inside each specific forum or topic that makes it easy to find the expected information.

The Advanced Search allows users to make a search with particular criteria corresponding to the object you want to find.

To perform the advanced search, do as follows:

1. Click at the top right of the Forum homepage when being in the Forum application or in the search pop-up or in the Search this category/Search this forum/Search this topic/ on the Action bar of each selected object.

Basing on where you want to search: category, forum or post, the search criteria will be changed accordingly.

2. Enter the search criteria.

3. Click the Search button to do search or Cancel to quit. Also, click the Clear Fields button to reset the inputted values.

Matched results will be shown in the Search Result form. There will be an alert message when there is no object matching with the search criteria.

Find in categories

  • To find in categories, select Category from the Search in drop-down menu.

Details:

FieldDescription
Terms The keyword related to your desired categories.
Scope The search scale. With the 'Full' option, returned results are those matching both title and content containing the entered keyword. With the 'Titles' option, only results matching the object's titles are returned.
Username

The name of the category creator. Input the name manually or click

to select users from a specific group.

Created between - and

The created date interval for searching. You can input the date manually or click

to select a date from the mini calendar.

Moderator

The name of the category moderator. Input the name manually or click

to select users from a specific group.

Find in forums

  • To find in forums, select Forum from the Search in drop-down menu.

Details:

FieldDescription
TermsThe search keyword.
StatusThe status of the forums.
StateThe state of the forums.
PostsThe interval of forum's posts number you want to search. Simply click and drag your cursor on the slidebar to define the post interval.
TopicsThe interval of forum's topics number you want to search. Click and drag your cursor on the slidebar to define the topic interval.
ModeratorThe name of the forums' moderators.

Find in topics

  • To find in topics, select Topic from the Search in drop-down menu.

Details:

FieldDescription
Terms The search keyword.
TypeThe type of the topic specified by the topic type name and its icon. It can be selected from the existing list.
StatusThe status of the topics.
StateThe state of the topics.
Created between - and

The created date interval in which you want to search for topics. You can input the date manually or click

to select a date from the mini calendar

Last Post between - and

The last post's created date interval in topics in which you want to search. You can input the date manually or click

to select a date from the mini calendar

Posts The number of the topic's posts interval in which you want to search for those topics. Simply click and drag the cursor on the slidebar to define the post interval.
Views The mumber of the views interval of topics in which you want to search. Simply click and drag the cursor on the slidebar to define the views interval.

Find in posts

  • To find in posts, select Post from the Search in drop-down menu.

Details:

FieldDescription
TermThe search keyword.
ScopeThe search scale to search. With the "Full" option, returned results are those matching both title and content. With the "Titles", the results only match the post titles.
Created between - and

The created date interval in which you want to search for posts. You can input the date manually or click

to select a date from the mini calendar

See also

1. Go into the forum where you want to start a new topic.

2. Click .

3. Enter the topic title, content. The title must be less than 100 characters (special charaters are accepted). You may set other optional properties if you want.

  • Click the Attach files link to attach files to your message. The max size for the attachment is 20Mb. Click the trash icon next to the attachment to remove it.

  • Use BBCodes to format text, or to insert images, videos and links.

4. Click Preview to see before submitting or Submit to finish your topic.

Note

In a forum that enables moderation, new topics will need reviewing and approving by moderators before being published.

When creating a topic, you can also add extra properties to this topic:

Go to the Options tab, you can select status, state, type of the topic and more.

Details:

FieldDescription
Type

Type of the topic specified by the topic type name and its icon. You can select it from the existing types. The administrator can add a new one by clicking the

icon (Note that only administrators can see

icon.

Posts Moderation Check this option if you want posts to be moderated before being viewed.
Posts Notification Check this option to enable the notification email when there are new posts in your topic.
Sticky Check this option to stick the topic. A sticky topic will be located at the top of the topics list. A sticky topic will not fall down in the list if any new posts are added.

To post a reply, select the topic you want to reply to. You can reply to any topic as long as it is not closed and restricted. While you are viewing the topic, you can reply to it via either of the following ways:

You can post a reply quickly with plain texts without taking into account its format.

1. Scroll down to the bottom of the topic to see the Quick Reply box.

2. Enter you message. Use BBCodes to format text insert images, videos, or links.

3. Optionally, click Preview to view your reply before submitting it.

4. Click Quick Reply to send you message.

After posting your post, it will be highlighted so you can notice it easily.

See also

You can post a reply with the full editor as follows:

1. Go to the topic you want to post a reply.

2. Click on the top or bottom of the topic.

3. Enter your message in the textbox. Use BBCodes to format texts, or insert images, videos and links.

Optionally, you can:

  • Attach files to the topic by clicking the Attach files link. The max size for the attachment is 10 Mb by default.

  • Select an icon or smiley for the post in the Icons and Smileys tab.

4. Optionally, click Preview to view your reply before submitting it.

5. Click Submit to finish.

If your post is the last one, its information will be shown at the Last Posts column of the forum.

The icon in the topic title allows you to jump to the last read post in that topic.

See also

BBCodes (Bulletin Board Codes) are special tags in bulletin boards to help users enrich their posts with formatting and inclusions. They are useful to provide guarded formatting capabilities to the forum users without the risk of breaking the html markup of the page. BBCode itself is similar in style to HTML: tags are enclosed in square braces "[" and "]" rather than "<" and ">" and it offers greater control over what and how something is displayed.

Depending on the BBCode template customized by administrators only, you may find it very easy to add BBCodes to your posts through a toolbar above the message area on the posting form. You can either type the BBCode tags manually or use the toolbar in the posting form. To easily get the BBCode tags without typing them, simply click on the respective icon which is shown in the toolbar above the message area.

Click on the tool bar to get the full list of build-in BBCode explanations and examples.

Every forum member has a publicly viewable profile. This includes information provided by the member, either during the registration process or later via the User settings.

Whenever you see a member's name in a topic, you can view his public profile quickly by clicking his username or avatar and select View Public Profile in the drop-down menu.

The View User Profile form will be displayed.

You may configure your settings yourself, such as personal profile, forum settings and subscriptions.

Click on the User bar to go to the Settings form. Once you opened the Settings form, you can control your personal settings, options and preferences via the following actions:

Moderators in Forum are responsible for managing contents of posts and replies before and after they are posted to the category where they are assigned as moderators.

See also

The followings are actions that a moderator can execute on topics:

Moderators can approve pending topics in forums that enable the 'Moderate Topic' option. All new topics added to these forums will be pending for approval. It means that nobody can view these topics except administrators and moderators of the forums. Pending topics are only viewable when they are approved.

The administrator and moderator will know the total number of pending topics at the right corner of their Forum Administration bar and User bar:

Moderator can view the list of topics to be moderated. See View all pending moderation tasks for more details.

Approve topics

The first way

1. Select topics by checking their relevant checkboxes then click on the Action bar if you are in a list of topics.

Or if you are in a topic, simply click on the Action bar.

2. Click Approve from the drop-down menu.

The second way

1. Click on the Action bar and click Approve from the drop-down menu. The Waiting for Approval form opens.

2. Select checkboxes corresponding to the posts you want to approve. You can preview the post when hovering your cursor over the post title.

3. Click Approve to accept your approval. Approved posts are shown normally for regular users to view and take some actions.

As a moderator, you have some specific rights on a post. To moderate a post, you need to select that post first by checking its relevant checkbox.

Next, click on the Action bar and select a desired action from the drop-down menu. All the moderation actions will be reached via this menu.

The followings are actions that a moderator can perform on a post:

All posts in a topic that requires post moderation will not be viewable before approval. This function is to approve posts which are pending for approval.

You can select to approve a single post or multiple posts at the same time. The moderator can view the list of tasks to be moderated. See View all pending moderation tasks for more details.

The first way

1. Select the posts to approve.

2. Click on the Action bar and select Approve from the drop-down menu.

The second way

1. Click on the Action bar and click Approve in the drop-down menu. The Waiting for Approval form opens.

2. Select checkboxes corresponding to the posts you want to approve. You will see the preview of the post when mouse over the post title.

3. Click Approve to accept your approval.

Approved posts are shown normally for regular users to view and take some actions.

The administrators and moderators can censor all topics, posts containing censored keywords. These censored keywords are specified by Administrator. All topics and posts containing these keywords will labeled with 'Pending and Censored' (for post).

The first way

  • Follow this method to uncensor a specific post/topic.

1. Select hidden posts/topics by selecting its checkboxes.

2. Click the Moderation on the Action bar and select Show from the drop-down menu.

The second way

  • Follow this method to uncensor posts/topics in the list of existing hidden posts/topics.

1. Click Moderation on the Action bar and select Show from the drop-down menu. A list of hidden posts appears.

2. Select hidden posts by selecting the respective checkboxes.

3. Click Show.

This function allows banning IPs that may be used by users who abuse the forum functions or violate the forum rules and policies.

This function is similar to the Ban IPs tool used by administrators. However, the Ban IPs tool used by administrators can ban IP from the whole forum, while moderator can only ban IP in a specific forum only.

Ban IP on a specific forum

1. Go to the forum you want to ban IP.

2. Click on the Action bar and select Banned IPs from the drop-down menu. The Banned IPs form opens.

3. Do the same actions as the Ban IPs section of Administrators.

With the highest rights, administrators are in charge of the entire management tasks, including configuring and customizing the Forum portlet, backing up data, managing users and granting permissions, managing categories and forums. Administrator has the global role.

See also

After adding the application to your Space, you have to configure the portlet settings to make it work in your desired way.

1. Click --> Portal --> Pages.

The Page Manager page will be displayed.

2. Click that corresponds to the Forum page in the pages list.

3. Hover your cursor over the Forum portlet then click in the quick toolbar.

The settings form allows you to configure the Forum portlet in various aspects.

Only administrators can do categories-related management tasks. To manage forums better, the administrators usually build a good forum structure using categories. So, a category is a set of forums containing all discussions about the same subject. See the following diagram to learn about one typical Forum structure.

When creating a new forum, you can also configure the forum notification settings and specify the permissions for members in that forum.

Add a new forum to a specific category

1. Go into the category to which you want to add new forum.

2. Click on Forum Administration bar or click on the Action bar and select Add Forum.

3. Enter the forum title which is required and description in the corresponding fields in the Forum form. The forum title must be less than 50 characters.

4. Click Save to finish.

The administrators and moderators of a forum may want to get updated of what is new in forums under their management. This can be done when creating a new forum.

When creating a forum, you can set moderation-related options as follows:

1. Select the Moderation Options tab in the Forum form.

2. Do actions in the relevant fields.

Details:

FieldDescription
Moderators The username of the moderators.
Auto-fill the moderator's email Check this option if you want the moderator's email is auto-filled. The email address will be taken from in moderator profile.
Email addresses to notify when there is a new post Enter the list of email addresses which will get the notification if any new post is created. This field will be filled automatically if the Auto-fill the moderator's email is checked.
Email addresses to notify when there is a new topic Enter the list of email addresses which will get the notification if any new topic is created.This field will be filled automatically if the Auto-fill the moderator's email is checked .
Moderate Topics By default, new topics must be always approved and visible to everyone. If this option is selected, new topics will be pending for approval before being viewable.

To take this action, click on the Forum Administrator bar. The User Management form will be displayed.

Now, you can search for specific users to edit their profiles or remove them from Forum.

The administrator can edit profiles of members and promote any users to an administrator or a moderator.

1. Click on the Action bar. The User Management form will be displayed.

2. Click corresponding to the user you want to promote. The profile of this user will be displayed right below the users list.

To promote the user, you have to edit the Moderator fields in Profile tab.

FieldDescription
Screen Name The name displayed in Forum.
User Title The title representing the role of user, by default. However, you can enter anything you want.
Forum Administrator Grant the Administrator role to a selected user or not. The Administration role of the default administrator cannot be edited in the User Management form.
Moderator of Categories

The list of categories moderated by the selected user. Click

to select a category.

Moderator of Forums

The list of forums moderated by the selected user. Click

to select a forum.

There are other methods to ban users from the Forum application or specific forums and categories. In case you know the username of the user who violated your forum policies, you can search and ban this user quickly.

In the User Management form, go to the Ban User tab.

Details:

FieldDescription
Banned Ban one user or not.
Duration The interval during which the user will be banned. This field is only edited when you ban this user in the 'Banned' field. In the ban duration, the banned user only can view forums and topics but he/she cannot post replies or send messages.
Reason The reason for banning this user.
Ban Count The ban times of the user.
Bans Log Other log information.
Ban Date The date when the ban takes effect.

See also

All of administrative tasks can be reached via the menu that appears after clicking on the Forum Administration bar. You can select a desired action from the following drop-down menu.

In this section, you are going to learn how to perform all of these administrative tasks and customizations:

If there are new posts in the category or topic that a user has watched, the user will receive the email notification like this.

This section will describe how to create and edit the email templates that can be used to send notification emails to users.

Click on the Forum Administration bar and click Notifications from the drop-down menu to open the Notifications form.

The Notification form consists of two tabs:

Details:

The followings are variables which can be used in the template:

The common variables for both tabs:

The variables used in the New Post Notification tab:

The variables used in the Moved Notification tab:

These variables are used to load the content dynamically. Thus, you should not edit them. In case the template is changed unexpectedly, you can go back to the default template by clicking . You can use the text editor to format the template as you wish.

By default, there are some default BBCode tags that are initialized via plugins: "[B]", "[I]", "[U]", "[FONT]", "[HIGHLIGHT]", "[IMG]", "[CSS]", "[URL]", "[GOTO]", "[QUOTE]", "[LEFT]", "[RIGHT]", "[CENTER]", "[JUSTIFY]", "[SIZE]", "[COLOR]", "[CSS]", "[EMAIL]", "[CODE]", "[LIST]", "[WIKI], "[SLIDESHARE]". You can add, edit or delete the BBCode tags.

Click on the Forum Administration bar and click BBCode from the drop-down menu to open the BBCode Manager form.

Here, you can do the following actions:

1. In the BBCode Manager form, click Add BBCode to open the Add BBCode form.

2. Input values into the Add BBCode form.

Details:

FieldDescription
Tag This is the text for BBCode, which goes inside the square bracket.
Replacement The HTML codes that replace the user-entered BBCode.
Description The brief description about this BBCode tag.
Example The sample of the BBCode in use.
Use option} Allow BBCode tag to have option or not.
Preview dialog Preview the rendered BBCodes.
Click this icon to see descriptions of each field.

3. Optionally, click Preview to preview your created BBCode tag.

4. Click Save to finish or Reset to clear all input fields.

The Export function is a best way to back up data in the Forum application. This function allows you to export categories and forums in the Forum application into the .zip or .xml file. When a category/forum is exported, all of its forum, topics, posts and properties are also exported. This exported file can be used to import into the Forum application.

1. Click on the Forum Administration bar.

2. Click Export from the drop-down menu to open the Export Categories form.

Details:

FieldDescription
File Name Enter the name of the exported file.
Export All Check this option to export all data in Forum, such as all categories, user profiles and forum statistics.
Only Categories Check this option to export the selected categories only.

3. Select categories and enter the file name into the File Name field.

4. Click Save.