Changes between Version 99 and Version 100 of DiscussionPlugin


Ignore:
Timestamp:
Aug 13, 2015, 9:47:52 AM (9 years ago)
Author:
figaro
Comment:

Cosmetic changes

Legend:

Unmodified
Added
Removed
Modified
  • DiscussionPlugin

    v99 v100  
    11[[PageOutline(2-5,Contents,pullout)]]
     2
    23= Discussion Forum Plugin
    34
    45== Description
    56
    6 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.
    7 
    8 == Screenshots
    9 
    10 To get an idea how the forums look, see [attachment:discussion_list.png], [attachment:admin.png] and [attachment:thread.png].
     7This plugin adds discussion forums to Trac.
     8
     9Key features:
     10 * Any number of forums can be added and organized to forum groups.
     11 * Users can create topics in forums and reply to them which together creates discussion threads.
     12 * Threaded or flat view to topics and its replies is supported.
     13 * Each forum has a list of moderators who can delete topics, replies, etc.
     14 * Plugin is administrated directly or via Trac administration interface with appropriate permissions granted.
     15 * Appending new forums and topics either as new replies shows up in timeline.
     16 * Searching capability in topics and replies is supported too.
     17
     18=== Screenshots
     19
     20Discussion list:
     21
     22[[Image(discussion_list.png, 450px)]]
     23
     24Admin page:
     25
     26[[Image(admin.png, 450px)]]
     27
     28Thread:
     29
     30[[Image(thread.png, 450px)]]
    1131
    1232== Bugs/Feature Requests
     
    1535
    1636If you have any issues, create a
    17 [/newticket?component=DiscussionPlugin&owner=Blackhex new ticket] but read BugReporting page first, please.
     37[/newticket?component=DiscussionPlugin new ticket] but read BugReporting page first, please.
     38
     39[[TicketQuery(component=DiscussionPlugin&group=type,format=progress)]]
    1840
    1941== Download
     
    2547You can [http://trac-hacks.org/svn/discussionplugin check out] !DiscussionPlugin using Subversion, or [source:discussionplugin browse the source] with Trac.
    2648
    27 == Dependencies
    28 
    29 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.
    30 
    31 == Plugin Versions
    32 
    33 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:
     49== Installation
     50
     51=== Dependencies
     52
     53If you need spam filtering features, then the SpamFilterPlugin is required. In other cases, disable a !DiscussionSpamFilter component. On Trac versions older than 0.10, the DiscussionPlugin depends on a WebAdminPlugin, since many configuration options are available only on appropriate WebAdminPlugin's pages.
     54
     55Sqlite version 3 or PostgreSQL is required as the database for running this plugin.
     56
     57=== Plugin versions
     58
     59This plugin names its branches according to Trac versions:
    3460
    3561|| Plugin Branch || Trac Branch              || Plugin Version ||
     
    3864|| 0.11          || 0.11-stable (and forward-compatible up to Trac 1.1.1 by now) || 0.9dev         ||
    3965
    40 Main difference between 0.5 and 0.6 version is that 0.6 uses Genshi templates and 0.5 !ClearSilver ones.
     66The Main difference between version 0.5 and 0.6 version is that 0.6 uses Genshi templates and 0.5 !ClearSilver templates.
    4167
    4268New installations should use [http://trac-hacks.org/changeset/13910/discussionplugin/0.11?old_path=%2F&old=13910&format=zip revision 13910], while the source is going through a phase of cleanup and redesign including temporary regression and partial malfunction.
    4369
    44 == Installation
    45 
    46 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:
    47 
    48 {{{
    49 #!ini
     70=== Installation and Configuration steps
     71
     72For general information about Trac plugins installation see TracPlugins.
     73
     74The plugin is configurable from {{{trac.ini}}} file, see TracIni for more on this topic. The following variables controls DiscussionPlugin's behavior:
     75
     76{{{#!ini
    5077[discussion]
    5178title = Discussion
     
    89116   * {{{lastreply}}}.
    90117 {{{topic_sort}}}:: 
    91    to sort Topic lists.  It has values
     118   to sort Topic lists. It has values
    92119   * {{{id}}},
    93120   * {{{forum}}},
     
    100127
    101128 {{{forum_sort_direction}}} and {{{topic_sort_direction}}}::
    102     are directions of that sorting. They may be
     129    are directions of that sorting:
    103130   * {{{asc}}} and
    104131   * {{{desc}}}.
    105132
    106133 {{{topics_per_page}}} and {{{messages_per_page}}}::
    107     options controlls number of items displayed in topic and message lists at each page of pagination.
    108 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.
    109 
    110 
    111 If you run Trac in environment which needs to enable plugins explicitly put in trac.ini these lines:
     134    options controls number of items displayed in topic and message lists at each page of pagination.
     135You can type list of email addresses into {{{smtp_always_cc}}} option to send all discussion plugin email notification to them. Previous example shows default values for these options.
     136
     137If you run Trac in an environment which needs to enable plugins explicitly, put in `trac.ini` these lines:
    112138
    113139{{{#!ini
     
    130156
    131157{{{#!sh
    132 # trac-admin <path_to_environment> upgrade
    133 }}}
    134 
    135 For now sqlite version 3 or PostgreSQL is required as SQL backend for running this plugin.
     158$ trac-admin <path_to_environment> upgrade
     159}}}
    136160
    137161== Permissions
    138162
    139 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.
     163This plugin defines the following permissions:
     164 * With `DISCUSSION_VIEW` permission you can view all topics and you can post replies to them with `DISCUSSION_APPEND` permission.
     165 * Attachments can be added to the topics with `DISCUSSION_ATTACH` permission.
     166 * The `DISCUSSION_MODERATE` permission gives you rights to delete replies or topics where you are defined as a moderator.
     167 * The `DISCUSSION_ADMIN` permission gives you administrator rights to create, modify or delete forum groups, forums and topics.
     168
     169You can add these permissions by typing the following commands from commandline or you can use web administration interface to do it for you:
    140170
    141171{{{#!sh
    142 # trac-admin <path_to_environment> permission add <user> DISCUSSION_VIEW
    143 # trac-admin <path_to_environment> permission add <user> DISCUSSION_APPEND
    144 # trac-admin <path_to_environment> permission add <user> DISCUSSION_ATTACH
    145 # trac-admin <path_to_environment> permission add <user> DISCUSSION_MODERATE
    146 # trac-admin <path_to_environment> permission add <user> DISCUSSION_ADMIN
     172$ trac-admin <path_to_environment> permission add <user> DISCUSSION_VIEW
     173$ trac-admin <path_to_environment> permission add <user> DISCUSSION_APPEND
     174$ trac-admin <path_to_environment> permission add <user> DISCUSSION_ATTACH
     175$ trac-admin <path_to_environment> permission add <user> DISCUSSION_MODERATE
     176$ trac-admin <path_to_environment> permission add <user> DISCUSSION_ADMIN
    147177}}}
    148178