eXo Platform 3.0

- Prev
- Next

## Chapter 1. Applications

## Portlets

### Forum Portlet

#### Overview

The Forum portlet is a discussion space where users can post or read messages on different topics.

Portlet name | ForumPortlet
War name | forum.war
Description | The Forum portlet is a full features bulletin board application.

- Declaration template

    <portlet-application>
      <portlet>
        <application-ref>forum</application-ref>
        <portlet-ref>ForumPortlet</portlet-ref>
      </portlet>
    </portlet-application>

#### Preferences

Preference name | Possible value | Default value | Description
--- | --- | --- | ---
useAjax | `true`, `false` | `true` | To define if links in the forum will be plain hrefs or javascript ajax links (better for SEO) or not.
showForumActionBar | `true`, `false` | `true` | This is the UIForumActionBar. If the value is set true, the UIForumActionBar is shown, and if the value is set false, the UIForumActionBar is hidden.
forumNewPost | `day number` | `1` | To specify if a post is new. If the post is created within the set period, it is new in the forum.
enableIPLogging | `true`, `false` | `true` | This enables using the IPLogging function in the forum.
enableIPFiltering | `true`, `false` | `true` | This enables the IPFiltering function to be used in the forum.
invisibleCategories | `id categories` | `empty` | The list of all categories shown. If the value is set empty, all categories of the forum will be shown.
invisibleForums | `id forums` | `empty` | The list of all forums shown. If the value is set empty, all forums will be shown.
uploadFileSizeLimitMB | `integer` | `20` | To define the maximum size of the uploaded file in MB.
isShowForumJump | `true`,`false` | `true` | To specify if ForumJump is shown or not.
isShowIconsLegend | `true`,`false` | `true` | To specify if IconsLegend is shown or not.
isShowModerators | `true`,`false` | `true` | To specify if moderators are shown or not.
isShowPoll | `true`,`false` | `true` | To specify if Poll is shown or not.
isShowQuickReply | `true`,`false` | `true` | To specify if QuickReply is shown or not.
isShowRules | `true`,`false` | `true` | To specify if Rules are shown or not.
isShowStatistics | `true`,`false` | `true` | To specify if statistics are shown or not.

#### Portlet.xml

- See the portlet.xml file in the project following this path: forum/WEB-INF/portlet.xml

#### Events

Name | Description
--- | ---
ForumLinkEvent | This event is to setRender for UIForumLinkPortlet and to setValue for UIForumLinks.
ReLoadPortletEvent | This event is to reload UIForumPortlet.
OpenLink | This event is to update values for UIForumLinks.
ForumPollEvent | This event is to setRender for UIForumPollPortlet.
ForumModerateEvent | This event is to setRender for UIForumModeratorPortlet.
ForumRuleEvent | This event is to setRender for UIForumRulePortlet.
QuickReplyEvent | This event is to setRender for UIForumQuickReplyPortlet.

### Answers Portlet

#### Overview

Portlet name | War name | Description
--- | --- | ---
AnswersPortlet | faq.war |

#### Portlet Preferences

The Answers portlet consists of preferences as follows:

Preference name | Possible value | Default value | Description |
enableViewAvatar | `true`, `false` | `true` | To enable users to view the avatar of owner posting the question. |
enableAutomaticRSS | `true`, `false` | `true` | To enable users to get RSS automatically. |
enableVotesAndComments | `true`, `false` | `true` | To enable users to give votes and comments for the question. |
enableAnonymousSubmitQuestion | `true`, `false` | `true` | To enable anonymous users to submit questions. |
display | `approved`, `both` | `both` | To enable admins to view unapproved questions in the questions list in UIQuestions. |
SendMailAddNewQuestion | `string` | `empty` | To display the content of sent email when a new question is added. |
SendMailEditResponseQuestion | `string` | `empty` | To display the content of email when a response is edited. |
emailMoveQuestion | `string` | `empty` | To display the content of email when a question is moved. |
orderBy | `alphabet`, `created` | `alphabet` | To arrange questions in the alphabet or created date order. |
orderType | `asc`, `desc` | `asc` | To display questions in the ascending or descending order. |
isDiscussForum | `true`, `false` | `false` | To enable the DiscussQuestions function. |
idNameCategoryForum | `CategoryName,` ForumName`` | `empty` | To select categories and forums for the DiscussionQuestions function. |
uploadFileSizeLimitMB | `integer` | `20` | To set the maximum size of uploaded file. |

#### Portlet.xml

- See the portlet.xml file in the project following this path: /webapps/faq/WEB-INF/portlet.xml

### FAQ Portlet

##### Overview

Portlet name | War name | Description
--- | --- | ---
FAQPortlet | faq.war |

##### Portlet Preferences

FAQ portlet has portlet preferences that you can configure to alter the behavior.

At runtime you can use the portlet EDIT mode to set the preferences:

Alternatively, you can configure the portlet in portet-preferences.xml file.

Preference name | Possible values | Default value | Description |
--- | --- | --- | --- | ---
useAjax | `true`, `false` | `false` |  |

##### Portlet.xml

- See the portlet.xml file in the project following this path: /webapps/faq/WEB-INF/portlet.xml

### Polls Portlet

#### Basic information of Poll portlet

Portlet name | PollPortlet
War name | poll.war
Description |

#### Portlet Preferences

Preference name | Possible values | Default value | Description
--- | --- | --- | ---
pollIdShow | `string` | `empty` | The Id of poll is displayed in the poll portlet.

#### Portlet.xml

- See the portlet.xml file in the project following this path: poll/WEB-INF/portlet.xml

## Gadgets

### Overview

Gadget name | pollslist
War name | poll.war
Description | The list of polls.

### Preferences

Preference name | pollId
Description | id of poll which is displayed in Pollgadget.

### Links to used REST services

Links to used REST services:

- portal/rest/private/ks/poll/viewpoll/pollId

- portal/rest/private/ks/poll/votepoll/pollId/indexVote

- Prev
- Up
- Home
- Next