Forum

The Forum app is a convenient way for you to create, edit and maintain a forum with an unlimited amount of categories, threads and posts on your website - and with a minimum of effort.

Forums are useful for many reasons:

  • They allow for user generated content to be posted, discussed and used
  • They build engagement – with an active forum, especially if monitored and used by staff, your users will have a convincing reason to return to your site and build a relationship with your business
  • They are a good way to build a community, as they allow users to engage with each other in productive ways
  • They are helpful to people with questions, both because they may access the knowledge of the community and any community managers you have, but also because old threads can provide excellent help
  • They provide long trail traffic, as threads and answers are indexed by and available through search engines

In this article, you can learn how to add and configure the Forum app on your solution.

For security reasons, anonymous user posting to the forum has been disabled. Please update your templates to account for this.

To use the Forum app, it must be added to a paragraph on a page.

From the paragraph you then have access to the app settings window (Figure 2.1).

From here, you can control the behavior of the app – or remove it altogether.

Figure 2.1 The Forum app header

Over all, a forum consists of categories, threads, and posts – and a few other things, like an editor and some other assorted settings. In the following, all of the settings relevant to each subject are listed together – even if they occasionally are not next to each other on the app settings UI.

But first things first – with the display settings (Figure 3.1) you can specify whether you want to use categories on your forum, which is useful if you want to have different areas, e.g. General and Off-topic, or only want to list the threads of a single category.

Figure 3.1 The Display settings

Your other settings are affected by your choice here, as most of the Category settings are irrelevant if you don’t use categories (naturally).

If you selected list forum categories in the display setting, you will have access to the category settings (Figure 4.1).

Figure 4.1 The Category settings

With the Category settings, you can

  • Select or deselect the categories you want to activate for this instance of the forum app (you may have more than one forum across your solution, or may want to archive a particular category, etc.). You can read about creating categories below, under managing forum content.
  • Select a template used to render the list of categories
  • Select a sorting criteria for the categories – if Selected sort order is chosen, the sort order will match the order of the categories in the category selector above.

If you selected List forum threads in the display settings, you must specify a main category to publish from and create threads in (Figure 4.2).

Figure 4.2 Publishing threads from a single category

The thread settings (Figure 5.1) allow you to control how threads are rendered.

Figure 5.1 The thread settings

With the thread settings, you can:

  • Select a list threads template which controls how lists of threads are displayed
  • Select a sort order, controlling which threads should be shown at the top – last created, last answered, or last updated
  • Select a show thread template which controls how an individual thread with all replies is rendered

Unless your forum fails to engage your users, you will eventually end up with a lot of threads. To make things manageable, use the threads paging settings (Figure 5.2).

Figure 5.2 Threads paging settings

With the threads paging settings you can:

  • Activate or deactivate paging
  • Specify the number of threads on each page
  • Customize the style of the buttons used to navigate from page to page

Each thread will consist of a number of posts – and the post settings (Figure 6.1) controls how you render the Create post screen. You may specify a subject prefix to auto-use when creating new posts in a thread. Leave blank for no prefix.

Figure 6.1 CreatePost settings

Some threads will garner a lot of attention – enough to make paging sensible. To make things manageable, use the posts paging settings (Figure 6.2).

Figure 6.2 Posts paging settings

With the posts paging settings you can:

  • Activate or deactivate paging
  • Specify the number of posts on each page
  • Customize the style of the buttons used to navigate from page to page

If you use the forum for support purposes, it can be useful to enable users to mark replies as an answer (Figure 7.1) – this allows you (and other users) too see at a glance what has been answered and what hasn’t.

Figure 7.1 The answer settings

You can choose between allowing any logged in user to do so, and restricting it to the thread creator or any moderators on your forum.

When creating new threads or posts, the user will use an editor – you can control how that editor is rendered with the editor settings (Figure 8.1).

Figure 8.1 The Editor settings

You can:

  • Specify a width and a height for the editor
  • Select a color palette controlling the editor color scheme
  • Select, edit or create a stylesheet controlling the editor layout
  • Select a default editor configuration
  • Include custom plugins – currently only a syntax highlighter is available, which highlights code when using the insert code block button in an editor

Many of your users may not access your forum all the time, and some parts of the forum may not see a lot of use. To help users out, you can let them sign up for email notifications (Figure 9.1) – they will then receive an email when a category or thread is posted in.

Figure 9.1 The newsletter subscription settings

With the newsletter subscription settings you must:

  • Specify a sender email for the notifications
  • Enter a subject text – and optionally check include message title
  • Select, edit or create an email template for the notification emails

When using the Forum app, all content is structured in three hierarchical levels; categories, threads and posts.

  • Categories serve to sort conversations by their overall topic.
  • Under a category any user can choose to start a thread by asking a question or making a comment.
  • All replies in a thread are called posts.

To help you manage forum content, click Apps > Forum to access the backend forum content interface (Figure 10.1).

Figure 10.1 The forum content interface

The forum content interface consists of:

  • The All categories area on the left hand side, which allows you to easily navigate your categories
  • The forum content pane, which allows you to navigate categories, threads and posts – and create or edit them from the backend.
  • The right click menu (Figure 10.2), which provides you with convenient shortcuts for e.g. creating, deleting or deactivating categories, threads and posts – the precise options depend on the content type.
Figure 10.2 The category right-click menu

Categories must be created from the backend – and then included in an instance of the forum app using the App Settings – but all other types of content can be created from the frontend.

To create a new category, click New category in the forum content toolbar (Figure 11.1).

Figure 11.1 Creating a new category

This opens the category edit window (Figure 11.2).

Figure 11.2 Creating a new category

From the category edit window, you must:

  • Name the category
  • Optionally provide it with a description
  • Activate or deactivate it

Once you save the forum, you will be able to click the Moderators button and select one or more users as moderators. Moderators may edit or delete any thread or post within the category.

To create a new thread, either select a category and click New thread in the toolbar, or right click a category and select New thread from the right-click menu.

Either way will open the edit thread view (Figure 12.1).

Figure 12.1 Creating a new thread from the backend

From here, you must fill in the details of the new thread – heading, author, e-mail (of author), date of publication, etc. – before saving it using the toolbar.

Please note that you can activate (or deactivate) and sticky threads from this view – as well as attach a file to it, or move it to another category.

From here, you must fill in the details of the new post – heading, author, e-mail (of author), date of publication, etc. – before saving it using the toolbar.

database

There is no database specific information for this subject.

ForumAnswerVotes

Contains answer votes for a message (ForumMessageId) by a logged in user (ForumUserId).

Field name Data type Length
ForumMessageId int 4
ForumUserId int 4
ForumAnswerVoteAutoId int 4

ForumCategory

Contains categories for the Forum app.

Field name Data type Length
ForumCategoryId int 4
ForumCategoryName nvarchar 250
ForumCategoryDescription nvarchar Max
ForumCategoryActive bit 1
ForumCategoryAreaId int 4
ForumCategoryCreatedDate datetime 8

ForumMessage

Contains posts in the Forum app. Category membership is defined by ForumMessageCategoryId. Replies are indicated by having a value for ForumMessageParentId

Field name Data type Length
ForumMessageId int 4
ForumMessageParentId int 4
ForumMessageCategoryId int 4
ForumMessageName nvarchar 250
ForumMessageBody nvarchar Max
ForumMessageCreated datetime 8
ForumMessageAuthor nvarchar 250
ForumMessageAuthorEmail nvarchar 250
ForumMessageAuthorId int 4
ForumMessageNotifyAuthor bit 1
ForumMessageIsSticky bit 1
ForumMessageIsAnswer bit 1
ForumMessageAnswerVotes int 4
ForumMessageIsActive bit 1

ForumUserRelation

Contains thread / category subscribtion (ForumUserRelationForumCategoryId, ForumUserRelationThreadId) for an extranet user (ForumUserRelationUserId) or an anonymous users email (ForumUserRelationEmail).

Field name Data type Length
ForumUserRelationId int 4
ForumUserRelationUserId int 4
ForumUserRelationForumCategoryId int 4
ForumUserRelationThreadId int 4
ForumUserRelationName nvarchar 255
ForumUserRelationEmail nvarchar 255
ForumUserRelationType int 4