|Version 69 (modified by timh@…, 4 years ago) (diff)|
Discussion Forum Plugin
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.
To get an idea how the forums look, see BlackTrac discussion.
Download and Source
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|
Main difference between 0.5 and 0.6 version is that 0.6 uses Genshi templates and 0.5 ClearSilver ones.
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.
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
There are few wiki macros available:
Displays link to forum with id <id> and text <text>. Second argument is optional.
Displays link to topic with id <id> and text <text>. Second argument is optional.
Displays link to reply with id <id> and text <text>. Second argument is optional.
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.
Discuss this on the [forum:5 Trac Development forum]. Useful threads are [topic:23 this one] and [topic:96 this one].
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:
- Better permission system (maybe using 0.11 permissions policies).
- email2trac support.
- 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.
-  by rjollos on 2014-02-21 07:28:08
0.9dev: Do a db.commit after each transaction, because having a single db.commit doesn't seem to be effective either due to scoping issues, or because the statement isn't encountered in certain scenarios. Refs #11592.
-  by rjollos on 2014-02-21 04:20:18
0.9dev: Keep db object in scope when using a cursor. Refs #11592.
Also fixed an unresolved import and removed logging of SQL because it is implicitly logged (see the [trac] debug_sql configuration item).
-  by rjollos on 2014-02-21 02:55:28
0.9dev: Fixed indentation and trimmed whitespace using reindent.py.
-  by rjollos on 2014-02-21 00:40:53
0.9dev: Fix for Cannot operate on a closed cursor because db object is out-of-scope when using the cursor to retrieve timeline events. Refs #11592.
-  by rjollos on 2013-11-30 21:44:03
Removed unused parameter from request arguments.
-  by rjollos on 2013-06-14 11:31:07
Fixes #11129, Refs #8764: Follow-on to , fixing second location that SpamFilter.test is called. Patch by retracile.
-  by mbdecke on 2013-03-24 16:06:01
changed anchor, when replying to topic, jumping directly to input-form marked with anchor 'reply'
"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:
- Make a directory to hold the source:
- Grab the source from Subversion (for version 0.11):
svn co http://trac-hacks.org/svn/discussionplugin/0.11/
- Use easy_install to install from the source directory:
Maybe this worked. At least it claims to have installed. The more intuitive version: "easy_install TracDiscussion" didn't work.
(101.9 KB) -
added by Blackhex 2 years ago.
Screenshot of discussion listing.
(139.7 KB) -
added by Blackhex 2 years ago.
Screenshot of administration interface.
(144.1 KB) -
added by Blackhex 2 years ago.
Screenshot of message list in a thread.
Download all attachments as: .zip