Skip to end of metadata
Go to start of metadata
Name Size Creator Creation Date Comment  
PNG File Topic screen.PNG 72 kB Ivan Gospodinov Mar 10, 2013 16:48    
PNG File Message_Reply screen.PNG 47 kB Ivan Gospodinov Mar 10, 2013 16:48    
PNG File Index screen.PNG 113 kB Ivan Gospodinov Mar 10, 2013 16:48    
PNG File Forum screen.PNG 28 kB Ivan Gospodinov Mar 03, 2013 00:17    

Introduction

At the meeting 20121031 (Dominic, Maria, Jana, Vladimir) we decided for RS3.6 to integrate an external forum system.
We looked at a number, and after some deliberation we selected jForum, which is:

  • one of the few available forums implemented in Java
  • a fully-featured reimplementation of PHP-BB, the most popular public forum system

See http://stackoverflow.com/questions/7864435/restful-interface-to-php-forum-software for lightweight REST-based forums (Vanilla and Elegg)

Functionality

  • forums have this superstructure: category, forum, topic, post
    (project admin creates category & forum; any user creates topic & post)
  • RS can create/use links to: topic & post
  • Post is a textual discussions with the ability to link any tool/semantic object
    • data fields: title, description, creator, created; reply-to
    • operations: create (new or reply), edit, delete
    • Description is rich-text (HTML based on TinyMCE)
      • can include multimedia and links to tools/semantic objects
      • can insert a link either from the basket, or using the TinyMCE button

Forum Spec

02/03/2013

Forum messages (posts) are grouped into topics that are grouped into forums that are grouped into categories.
Each topic contains an original Message and Reply Messages (if any). Both are called Messages, i.e. one topic can contain several Messages, one of which is the original message and the rest are its reply messages (answers).

The Forum tab screens

There are several interlinked Forum tab screens:

1. Index screen
Invoked when:

  • The user logs in the Nuxeo DM system and clicks the Forum tab
  • The user clicks the link Forum Index inside the Forum screen or Topic screen (see bellow)

Example of an Index screen:

The Index screen contains:

  • A list of categories. Each category contains a list of forums (e.g. the category "test" contains the forums "General Discussion", "News and Announcements", "Bronze Age Art", and "Coins and Medals"). For each forum the following information is given:
    • A forum name that is a link that if clicked invokes the Forum screen (see bellow)
    • An icon indicating the status of the category
    • Number of Topics = the number of topics contained in the forum
    • Number of Messages = the number of topics contained in the forum + the total number of replies for all the topics
    • Last message - contains date and time of creation and a link icon to last message that if clicked invokes the Topic screen (see bellow)
  • A link to new messages since the user's last visit (displayed only at the first visit to Index screen in one log-in session)
  • Statistics about the users online
  • A legend about the status of a forum:
    • New Messages - indicates that the forum has new messages - the icon is highlighted
    • No New Messages - indicates that the forum does not have new messages - the icon is not highlighted
    • Blocked Forum - indicates that the forum is blocked

2. Forum screen
Invoked when the user clicks the name of a particular forum in the Index screen

Example of a Forum screen:

The Forum screen contains:

  • A list of topics for a particular forum. For each topic the following information is given:
    • A topic name that is a link that if clicked invokes the Topic screen (see bellow)
    • Number of Answers - number of replies for each topic
    • Number of Views
    • Last message - contains:
      • date and time of creation
      • a link to last message (arrow icon) that if clicked invokes the Topic scren (see bellow)
  • The button New Post that if clicked invokes the Message/Reply screen (see bellow)
  • The link Forum Index that if clicked invokes the Index screen

3. Topic screen
Invoked when:

  • The user clicks the name of a particular topic in Forum screen
  • The user clicks the link icon in Last Message in Index screen or Forum screen
  • The user creates, edits, or replies to a message and Submits the creation form (see bellow)
  • The user posts a link to Data or Image annotation into a forum Message (see bellow)

Example of a Topic screen:

The Topic screen contains:

  • A list of the Message and it Reply Messages. The Message is on top of the list. The Reply Messages are ordered chronologically underneath - the latest at the bottom of the list. The following Message and reply details are displayed:
    • Date and time of creation
    • Creator
    • Subject
    • Description content
  • Replies created by the current user contain the button Edit that if pressed invokes the Message/Reply screen (see bellow)
  • The button Post Reply that if clicked invokes invokes the Message/Reply screen (see bellow)
  • The link Forum Index that if clicked invokes the Index screen

4. Message/Reply screen
Invoked when:

  • The user clicks the button New Post in the Forum screen
  • The user selects the option Post to Forum from action button (down arrow) in a Data/Image annotation

Example of a Message/Reply screen

The Message/Reply screen displays:

  • Subject edit box that:
    • is empty if a new Message is being created
    • contains the name of the Topic if a Reply Message is being created
    • contains information about the Data/Image annotation if the screen was invoked by a Data/Image annotation
  • TinyMCE editor form to input a Message description that:
    • is empty if an original Message is created from Forum screen
    • contains the link to the Data/Image annotation if the Message is created from a Dana/Image annotation
    • contains some of the standard TinyMCE buttons
  • The link Forum Index that if clicked invokes the Index screen
  • The button Submit that if clicked invokes:
    • the Topic screen if the new topic is not empty - the new Message is created
    • a warning message stating that creation of an empty topic is not allowed - the new Message is not created
  • a Review Message area (only if Reply Message is being created) that displays details about the message and its replies.
  • buttons Edit to the right of every Reply Message that was created by the user. Messages created by other users cannot be edited by the current user, hence they lack the Edit button. If clicked, the Edit button invokes the Message/Reply screen that allows for editing of the existing Message/Post. The Original Messages do not contain the button Edit, even if they were created by the current user.

Forum actions

1. Create a new original Message
This action creates a new original Message and a new Topic, correspondingly.
It can be done 2 ways:

  • navigating to Forum screen and clicking the button New Post
  • clicking the action button (down arrow) in Data/Image annotation, selecting option Post to Forum, and choosing one of the expanded forum name that would hold the new Topic

Both ways invoke screen 4 that does not contain the Review Message area.
When a new Message (belonging to a particular forum) is created, the following counters are increased by 1:

  • The Topics number in screen 1 (for that forum)
  • The Messages number in screen 1 (for that forum)

The new Message appears on top of the list of topics in screen 2.
The new Message appears on top of the list in the Latest Forum Posts area in the Dashboard tab.

2. Create a new Reply Message
This action creates a reply to a Topic.
It is done by navigating to the Topic screen and clicking the button Post Reply.
This invokes screen 4 that contains the Review Message area.
When a new Reply Message (belonging to a particular topic that belongs to a particular forum) is created, the following counters are increased by 1:

  • The Messages number in screen 1
  • The Answers number in screen 2

The new Reply appears at the bottom of replies list in screen 3
The new Reply Message appears on top of the list in the Latest Forum Posts area in the Dashboard tab.

3. Edit a Message/Reply
It is done by navigating to Topic screen and clicking one of the buttons Edit.
The user can edit only his/her own Replies.
Replies that are created by a different user lack the button Edit.
If clicked, the button Edit invokes screen 4.

4. Post Data/Image annotation to Forum (promote to forum)
This action creates a Message (Topic) that contains a link to a Data/Image annotation
It is done by navigating to a Data/Image annotation, clicking the action button (down arrow), selecting the option Post to Forum, and choosing one from the expanded forum names.
This invokes screen 4.
The creation form contains a link to the Data/Image annotation.
The created message generates the same results as described in action 1.
Clicking the Data/Image annotation link invokes the Data/Image annotation.

Labels:
None
Enter labels to add to this page:
Please wait 
Looking for a label? Just start typing.