wiki:DiscussionPlugin

Version 69 (modified by timh@…, 4 years ago) (diff)

Installation

Discussion Forum Plugin

Description

The DiscussionPlugin adds discussion forums to Trac. An arbitrary number of forums can be added, organised to forum groups. Users can create topics in forums and reply to them which together creates discussion threads. Threaded or flat view to topics and its replies is supported. Each forum has a list of moderators who can delete topics, replies, etc. Plugin is administrated directly or via WebAdminPlugin with appropriate rights. Appending new forums and topics either as new replies shows up in timeline. Searching capability in topics and replies is supported too.

Live Example

To get an idea how the forums look, see BlackTrac discussion.

Bugs/Feature Requests

Existing bugs and feature requests for DiscussionPlugin are here.

If you have any issues, create a new ticket but read BugReporting page first, please.

Download and Source

You can download zipped sources, check out using Subversion, or browse the source with Trac.

Dependencies

DiscussionPlugin depends on WebAdminPlugin since many configuration options are available only on appropriate WebAdminPlugin's pages. The SpamFilterPlugin is also required.

Plugin Versions

As many other plugins in this site even this plugin names its branches according to Trac versions. Here is a simple table explaining this convention for DiscussionPlugin:

Plugin Branch Trac Branch Plugin Version
0.9 0.9-stable 0.5
0.10 0.10-stable 0.5
0.11 0.11-stable 0.6

Main difference between 0.5 and 0.6 version is that 0.6 uses Genshi templates and 0.5 ClearSilver ones.

Installation

After installing plugin's egg you can set in trac.ini configuration file following variables:

[discussion]
title = Discussion
default_display = tree
forum_sort = id
forum_sort_direction = asc
topic_sort = id
topic_sort_direction = asc

Option title changes title of main navigation bar button, default_display defines default display mode for message list. Possible values are tree, flat, flat-asc and flat-desc. flat is synonym for flat-desc. forum_sort is column by which will be sorted forum lists. Possible values are: id, group, name, subject, time, moderators, description, topics, replies, lasttopic and lastreply. Topic lists may be sorted with topic_sort option. It has values id, forum, subject, time, author, body, replies and lastreply. Options forum_sort_direction and topic_sort_direction are directions of that sorting. They may be asc and desc. Previous example shows default values for these options.

If you run Trac in environment which needs to enable plugins explicitly put in trac.ini these lines:

[components]
# Enable this component for 0.11 branch and 0.10 branch from revision r3518.
tracdiscussion.api.DiscussionApi = enabled

tracdiscussion.admin.DiscussionWebAdmin = enabled
tracdiscussion.core.DiscussionCore = enabled
tracdiscussion.init.DiscussionInit = enabled
tracdiscussion.search.DiscussionSearch = enabled
tracdiscussion.timeline.DiscussionTimeline = enabled
tracdiscussion.wiki.DiscussionWiki = enabled
tracdiscussion.notification.DiscussionNotifyEmail = enabled

The next step is to upgrade your environment:

# trac-admin <path_to_environment> upgrade

For now sqlite version 3 or PostgreSQL is required as SQL backend for running this plugin.

Permissions

Discussion plugin defines four permissions. With DISCUSSION_VIEW permission you can view all topics and you can post replies to them with DISCUSSION_APPEND permission. DISCUSSION_MODERATE permission gives you rights to delete replies or topics where are you defined as moderator. DISCUSSION_ADMIN permission gives you administrator rights to create, modify or delete forum groups, forums and topics. You can add these permissions by typing following commands from commandline or you can use WebAdminPlugin to do it for you.

# trac-admin <path_to_environment> permission add <user> DISCUSSION_VIEW
# trac-admin <path_to_environment> permission add <user> DISCUSSION_APPEND
# trac-admin <path_to_environment> permission add <user> DISCUSSION_MODERATE
# trac-admin <path_to_environment> permission add <user> DISCUSSION_ADMIN

Macros

There are few wiki macros available:

[forum:<forum_id> <text>]

Displays link to forum with id <id> and text <text>. Second argument is optional.

[topic:<topic_id> <text>]

Displays link to topic with id <id> and text <text>. Second argument is optional.

[message:<message_id> <text>]

Displays link to reply with id <id> and text <text>. Second argument is optional.

[[ViewTopic(<topic_subject>)]]

Displays content of topic with subject <topic_subject>. If no subject given displays content of topic with same subject as name of current wiki page. Currently there is a limitation of post length using this macro because of using GET method of HTML form.

Example

Discuss this on the [forum:5 Trac Development forum]. 
Useful threads are [topic:23 this one] and [topic:96 this one].

Attachments

Foreign files can also be attached to topics and then linked in replies. For this purpose you can use general Trac attachment link syntax with disscussion domain and topic resource:

[attachment:discussion:topic/<topic_id>:<filename>]
[raw-attachment:discussion:topic/<topic_id>:<filename>]
[[Image(discussion:topic/<topic_id>:<filename>)]] 

There are also two custom macros doing the same and they simplifies the syntax a bit:

[topic-attachment:<topic_id>:<filename>]
[raw-topic-attachment:<topic_id>:<filename>]

Planned Features

  • Better permission system (maybe using 0.11 permissions policies).
  • email2trac support.

Notes

  • Branch 0.9 of plugin is considered as deprecated and not developed anymore.
  • Please test if all links and forms redirects page to proper location after request processing in 0.11 branch. If they don't or any error occurs, create a ticket describing error or behavior you expect.

Feedback

Are you using this plugin?
  • Yes, it's usefull. (sgrayban, cboos, okaori, wadeb, s0undt3ch, ttressieres, imme, dh1jc, talameelombu, Tharban, athomas, jtuchscherer, xvirus, osimons, Sincklation, manni, izzy, ericalens, KevinGabbert, mwehr, renzo, marcvs, eskil, rjollos, koolhand, edo, colski, dfleming, lucasrangit, miezuit, lhr870630, hasienda, arnisandy, lucid, AdrianFritz, akliewer99)
  • No, it's useless.
  • No, I don't need it. (dfaerch, harmy, prz)
  • I think it will help

  • You don't have permission to vote. You may need to login.

Change Log

[13945] by hasienda on 2014-05-31 23:44:08
DiscussionPlugin: Extend use of new attribute getter api method, refs #11706.

Preventing TypeError in case of invalid ID argument is required for this
use, and doesn't hurt for others anyway.

[13944] by hasienda on 2014-05-31 23:14:21
DiscussionPlugin: Review wiki macros and syntax provider code, refs #756 and #11706.

This includes a wide range of changes from adding another db access method to
api over moving SQL into model module to correcting resource ID as
required for fine-grained permission support.

Adding the missing import from trac.resource as follow-up to [9640] suggests
rare use of discussion WikiMacros so far.

[13942] by hasienda on 2014-05-30 22:32:02
DiscussionPlugin: Hotfix for topic (attachment parent) Trac resource, refs #756 and #11800.

I've been expecting issues when moving on towards unified resources and
resource permissions. This is another hack before being able to associate
attachments with full resource path, not just topic, the current shortcut.

[13939] by hasienda on 2014-05-24 00:44:45
DiscussionPlugin: Change listeners got incomplete objects, refs #6783 and #8981.

Fixed tag-related change listeners to get discussion item IDs, what caused
KeyErrors before, just raised a couple of other issues. Not all of these
issues are resolved yet. I decided to initially catch listener errors with
logged warnings for improved API method robustness.

Moved time stamp generation nearer to db action and letting _add_item()
return the added item ID obsoleted four api methods at once.

[13938] by hasienda on 2014-05-23 21:43:39
DiscussionPlugin: Narrow user selection according to granted permissions, refs #756.

You should be able to choose only users with appropriate permissions as
moderators, and the same applies to subscriptions. This is still not 100%
correct, because ultately fine-grained permisions could affect this too.

[13936] by hasienda on 2014-05-22 22:47:08
DiscussionPlugin: Reorganize search source code, refs #756 and #11706.

In fixing discussion resource links this is a follow-up to [13914].

The remains after moving db access code to model don't justify to keep
search as a separate module. Added search should help preventing further
regressions for this functionality.

[13935] by hasienda on 2014-05-22 22:27:13
DiscussionPlugin: Complete db access API methods, refs #11706.

A missing import from previous modifications has been spotted on creation of
corresponding tests.

Author/Contributors

Author: Blackhex
Contributors: athomas

"After installing plugin's egg you can set in trac.ini configuration file following variables: "

For folks like me, who are not python programmers...and who don't install trac plugins every day, it would be really helpful to include a couple lines about how to actually "install the plugin's egg"...really helpful...especially in a section called "installation"...maybe I'll look and see how phpbb is doing these days...


Ick. I didn't find installation "intuitively obvious". Best I could figure was to do the following:

  1. Make a directory to hold the source:

mkdir /home/me/src
cd /home/me/src

  1. Grab the source from Subversion (for version 0.11):

svn co http://trac-hacks.org/svn/discussionplugin/0.11/

  1. Use easy_install to install from the source directory:

easy_install file:///home/me/src/0.11/

Maybe this worked. At least it claims to have installed. The more intuitive version: "easy_install TracDiscussion" didn't work.

Attachments (3)

Download all attachments as: .zip