|Version 95 (modified by 3 years ago) (diff),|
Discussion Forum Plugin
Notice: This plugin is unmaintained and available for adoption.
The DiscussionPlugin adds discussion forums to Trac. An arbitrary number of forums can be added, organized 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 Trac administration interface with appropriate permissions granted. Appending new forums and topics either as new replies shows up in timeline. Searching capability in topics and replies is supported too.
Request for Adoption
The plugin is not actively developed anymore. If you would like to adopt its development contact user Blackhex.
Download the zipped source from [download:discussionplugin here].
If you need spam filtering feature working, the SpamFilterPlugin installation is required. In other cases, disable a DiscussionSpamFilter component. On older Trac versions, the DiscussionPlugin depends on a WebAdminPlugin since many configuration options are available only on appropriate WebAdminPlugin's pages. Since Trac 0.10, the WebAdminPlugin is internal part of the Trac.
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.11||0.11-stable (and forward-compatible up to Trac 1.1.1 by now)||0.9dev|
Main difference between 0.5 and 0.6 version is that 0.6 uses Genshi templates and 0.5 ClearSilver ones.
For general information about Trac plugins installation see TracPlugins. Plugin is configurable from
trac.ini file, see TracIni for more on this topic. The following variables controls DiscussionPlugin's behavior:
[discussion] title = Discussion default_topic_display = classic default_message_display = tree forum_sort = lasttopic forum_sort_direction = asc topic_sort = lastreply topic_sort_direction = asc topics_per_page = 30 messages_per_page = 50 smtp_always_cc =
- changes title of main navigation bar button,
changes between two possible displays of topic list - the
defines default display mode for message list.
Possible values are
flatis synonym for
is column by which will be sorted forum lists.
Possible values are:
to sort Topic lists. It has values
are directions of that sorting. They may be
- options controlls number of items displayed in topic and message lists at each page of pagination.
You can type list of e-mail addresses into
smtp_always_cc option to send all discussion plugin e-mail notification to them. 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] tracdiscussion.admin.DiscussionWebAdmin = enabled tracdiscussion.api.DiscussionApi = enabled tracdiscussion.core.DiscussionCore = enabled tracdiscussion.init.DiscussionInit = enabled tracdiscussion.notification.DiscussionEmailNotification = enabled tracdiscussion.search.DiscussionSearch = enabled tracdiscussion.spamfilter.DiscussionSpamFilter = enabled # Optional, disable if you don't have SpamFilterPlugin. tracdiscussion.timeline.DiscussionTimeline = enabled tracdiscussion.wiki.DiscussionWiki = enabled tracdiscussion.tags.DiscussionTagProvider = enabled tracdiscussion.tags.DiscussionTags = enabled tracdiscussion.ajax.DiscussionAjax = 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 five permissions. With DISCUSSION_VIEW permission you can view all topics and you can post replies to them with DISCUSSION_APPEND permission. Attachments can be added to the topics with DISCUSSION_ATTACH 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 web administration interface 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_ATTACH # 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 a link to forum with id <id> and text <text>. Second argument is optional.
Displays a link to topic with id <id> and text <text>. Second argument is optional.
Displays a link to reply with id <id> and text <text>. Second argument is optional.
Displays a link to the last forum created in forum group with id <id> and text <text>. Second argument is optional.
Displays a link to the last topic created in forum 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.
[[RecentTopics(<forum_id>,<number_of_topics>)]] or [[RecentTopics(<number_of_topics>)]]
Displays list of recently changed topics in a forum <forum_id> or in all forums, if <forum_id> is not specified, grouped by the day of their last change. Second argument <number_of_topics> limits the number of recently changed topics displayed.
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 discussion 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 simplify the syntax a bit:
- Better permission system (maybe using 0.11 permissions policies).
- email2trac support.
- Branches 0.9 and 0.10 of the plugin are considered as deprecated and not developed anymore. User-contributed backporting patches are welcomed though.
- Branch 0.11 of the plugin is tested mainly with Trac>=1.0. If your sure that you've encountered a problem on Trac 0.11, just create a ticket about it. Separate branch 1.0 will be created only before significant changes to the plugin. So this will likely not happen before adoption of Trac 1.0 db API changes.
If you have any troubles with plugin's installation or configuration and your problem is generally Trac related, you can ask on #trac channel at Freenode IRC network to get the quickest answer, or use the trac-users mailing-list.