Changes between Version 73 and Version 74 of DiscussionPlugin
- Timestamp:
- Dec 8, 2010, 10:09:25 PM (13 years ago)
Legend:
- Unmodified
- Added
- Removed
- Modified
-
DiscussionPlugin
v73 v74 3 3 == Description == 4 4 5 The DiscussionPlugin adds discussion forums to Trac. An arbitrary number of forums can be added, organi sed 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 WebAdminPluginwith appropriate rights. Appending new forums and topics either as new replies shows up in timeline. Searching capability in topics and replies is supported too.5 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 rights. Appending new forums and topics either as new replies shows up in timeline. Searching capability in topics and replies is supported too. 6 6 7 7 == Live Example == … … 38 38 == Dependencies == 39 39 40 DiscussionPlugin depends on WebAdminPlugin since many configuration options are available only on appropriate WebAdminPlugin's pages. The SpamFilterPlugin is also required.40 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. 41 41 42 42 == Plugin Versions == … … 44 44 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: 45 45 46 || Plugin Branch || Trac Branch || Plugin Version ||47 || 0.9 || 0.9-stable || 0.5 ||48 || 0.10 || 0.10-stable || 0.5 ||49 || 0.11 || 0.11-stable || 0.6||46 || Plugin Branch || Trac Branch || Plugin Version || 47 || 0.9 || 0.9-stable || 0.5 || 48 || 0.10 || 0.10-stable || 0.5 || 49 || 0.11 || 0.11-stable, 0.12-stable || 0.6, 0.7 || 50 50 51 51 Main difference between 0.5 and 0.6 version is that 0.6 uses Genshi templates and 0.5 !ClearSilver ones. … … 63 63 topic_sort = id 64 64 topic_sort_direction = asc 65 smtp_always_cc = 65 66 }}} 66 67 67 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.68 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}}}. 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. 68 69 69 70 If you run Trac in environment which needs to enable plugins explicitly put in trac.ini these lines: … … 71 72 {{{ 72 73 [components] 73 # Enable this component for 0.11 branch and 0.10 branch from revision r3518. 74 tracdiscussion.admin.DiscussionWebAdmin = enabled 74 75 tracdiscussion.api.DiscussionApi = enabled 75 76 tracdiscussion.admin.DiscussionWebAdmin = enabled77 76 tracdiscussion.core.DiscussionCore = enabled 78 77 tracdiscussion.init.DiscussionInit = enabled 78 tracdiscussion.notification.DiscussionNotifyEmail = enabled 79 79 tracdiscussion.search.DiscussionSearch = enabled 80 tracdiscussion.spamfilter.DiscussionSpamFilter = enabled # Optional, disable if you don't have SpamFilterPlugin. 80 81 tracdiscussion.timeline.DiscussionTimeline = enabled 81 82 tracdiscussion.wiki.DiscussionWiki = enabled 82 tracdiscussion.notification.DiscussionNotifyEmail = enabled 83 83 84 }}} 84 85 … … 93 94 == Permissions == 94 95 95 Discussion plugin defines f our 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 WebAdminPluginto do it for you.96 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. 96 97 97 98 {{{ 98 99 # trac-admin <path_to_environment> permission add <user> DISCUSSION_VIEW 99 100 # trac-admin <path_to_environment> permission add <user> DISCUSSION_APPEND 101 # trac-admin <path_to_environment> permission add <user> DISCUSSION_ATTACH 100 102 # trac-admin <path_to_environment> permission add <user> DISCUSSION_MODERATE 101 103 # trac-admin <path_to_environment> permission add <user> DISCUSSION_ADMIN … … 109 111 [forum:<forum_id> <text>] 110 112 }}} 111 Displays link to forum with id <id> and text <text>. Second argument is optional.113 Displays a link to forum with id <id> and text <text>. Second argument is optional. 112 114 113 115 {{{ 114 116 [topic:<topic_id> <text>] 115 117 }}} 116 Displays link to topic with id <id> and text <text>. Second argument is optional.118 Displays a link to topic with id <id> and text <text>. Second argument is optional. 117 119 118 120 {{{ 119 121 [message:<message_id> <text>] 120 122 }}} 121 Displays link to reply with id <id> and text <text>. Second argument is optional. 123 Displays a link to reply with id <id> and text <text>. Second argument is optional. 124 125 {{{ 126 [last-forum:<forum_group_id> <text>] 127 }}} 128 Displays a link to the last forum created in forum group with id <id> and text <text>. Second argument is optional. 129 130 {{{ 131 [last-topic:<forum_id> <text>] 132 }}} 133 Displays a link to the last topic created in forum with id <id> and text <text>. Second argument is optional. 122 134 123 135 {{{ … … 125 137 }}} 126 138 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. 139 140 {{{ 141 [[RecentTopics(<forum_id>,<number_of_topics>)]] or [[RecentTopics(<number_of_topics>)]] 142 }}} 143 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. 127 144 128 145 === Example === … … 157 174 == Notes == 158 175 159 - Branch 0.9 of plugin is considered as deprecated and not developed anymore.160 - 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.176 - Branches 0.9 and 0.10 of the plugin are considered as deprecated and not developed anymore. User-contributed backporting patches are welcomed though. 177 - Branch 0.11 of the plugin is tested mainly with Trac 0.12 now. If you encounter some problem on Trac 0.11, just create a ticket about it. Separate branch 0.12 will be created only in case of significant differences between Trac 0.11 and 0.12 relevant to the plugin. 161 178 162 179 == Support == … … 175 192 176 193 '''Author:''' [wiki:Blackhex Blackhex] [[BR]] 177 '''Contributors:''' [wiki:athomas athomas] [ [BR]]194 '''Contributors:''' [wiki:athomas athomas] [wiki:lucid] [[BR]]
