Changes between Version 9 and Version 10 of WikiNotificationPlugin


Ignore:
Timestamp:
Jan 14, 2008 3:36:39 PM (6 years ago)
Author:
s0undt3ch
Comment:

--

Legend:

Unmodified
Added
Removed
Modified
  • WikiNotificationPlugin

    v9 v10  
    55============================== 
    66 
    7 Trac Wiki Notification is a plugin that allows users(even anonymous, 
     7Trac WikiNotification_ is a plugin that allows users(even anonymous, 
    88as long as email is set) to select the wiki pages that they wish to 
    99be notified(by email) when a change occurs on it. 
    1010 
    11 You can find more info on the 
    12 `Trac WikiNotification <http://wikinotification.ufsoft.org/>`_ site where bugs and new 
     11**Note**: The user updating the wiki page won't be notified about his own 
     12changes. 
     13 
     14You can find more info on the trac WikiNotification_ site where bugs and new 
    1315feature requests should go to. 
    1416 
     
    2426   ctxtnavadd.* = enabled 
    2527 
    26  
    27 Available Config Options 
    28 ------------------------ 
    29 These are the options available to include on your *trac.ini*. 
     28Available Configuration Options 
     29------------------------------- 
     30These are the options available to include on your ``trac.ini`` under 
     31``wiki-notification``. 
    3032 
    3133=====================  ====================  ================================ 
    3234 **Config Setting**     **Default Value**     **Explanation** 
    3335---------------------  --------------------  -------------------------------- 
    34 *redirect_time*        5 (in seconds)        The default seconds a redirect should take when 
     36*redirect_time*        5 (in seconds)        The default seconds a redirect 
     37                                             should take when 
    3538                                             watching/un-watching a wiki page. 
    36                                              This value is also definable per user, ie, user 
    37                                              is able to configure this, of course for himself. 
     39                                             This value is also definable per 
     40                                             user, ie, user is able to 
     41                                             configure this, of course for 
     42                                             himself. 
    3843---------------------  --------------------  -------------------------------- 
    39 *smtp_always_bcc*      *empty*               Email address(es) to always send notifications to, 
    40                                              addresses do not appear publicly (Bcc:). 
     44*smtp_always_bcc*      *empty*               Email address(es) to always send 
     45                                             notifications to, addresses do 
     46                                             not appear publicly (Bcc:). 
    4147---------------------  --------------------  -------------------------------- 
    42 *smtp_always_cc*       *empty*               Email address(es) to always send notifications to, 
    43                                              addresses can be see by all recipients (Cc:). 
     48*smtp_always_cc*       *empty*               Email address(es) to always send 
     49                                             notifications to, addresses can 
     50                                             be seen by all recipients (Cc:). 
    4451---------------------  --------------------  -------------------------------- 
    45 *smtp_from*            trac.wiki\@localhost  Sender address to use in notification emails. 
     52*smtp_from*            trac.wiki\@localhost  Sender address to use in 
     53                                             notification emails. 
    4654---------------------  --------------------  -------------------------------- 
    47 *use_public_cc*        False                 Recipients can see email addresses of other 
    48                                              CC'ed recipients. If this option is 
    49                                              disabled(the default), recipients are put on BCC. 
     55*use_public_cc*        False                 Recipients can see email 
     56                                             addresses of other CC'ed 
     57                                             recipients. If this option is 
     58                                             disabled(the default), recipients 
     59                                             are put on BCC. 
    5060=====================  ====================  ================================ 
     61 
     62If you want to override these settings then you can include it like the 
     63following example:: 
     64 
     65   [wiki-notification] 
     66   redirect_time = 5 
     67   smtp_always_bcc = 
     68   smtp_always_cc = 
     69   smtp_from = trac.wiki@localhost 
     70   use_public_cc = false 
     71 
     72 
     73**Note**: For an up-to-date version of this info please `read this`_. 
    5174 
    5275 
     
    5477------------------------- 
    5578 
    56 Trac WikiNotification can be installed with `Easy Install 
    57 <http://peak.telecommunity.com/DevCenter/EasyInstall>`_ by typing:: 
     79Trac WikiNotification can be installed with `Easy Install`_ by typing:: 
    5880 
    5981    > easy_install TracWikiNotification 
     82 
    6083 
    6184Trac 0.11 support 
    6285~~~~~~~~~~~~~~~~~ 
    6386 
    64 As of time of this writing (Jan 5 2008), 0.11 support available only in trunk version (svn). Which is natural, since Trac 0.11 is still in beta as well. You won't need ``ctxnavadd`` no more. To install this development version type:: 
     87As of time of this writing (Jan 5 2008), 0.11 support available only in trunk 
     88version (svn). Which is natural, since Trac 0.11 is still in beta as well. 
     89You won't need ``ctxnavadd`` no more. 
     90 
     91To install this development version type:: 
    6592 
    6693   > easy_install http://wikinotification.ufsoft.org/svn/trunk 
    6794 
     95Aditional Notes(from user input) 
     96~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 
    6897 
    69 Some notes for the *noobs* amongst us: 
    70  
    71 1. ``easy_install`` is run from the command line (on Linux) not from within Python. 
    72  
    73 2. After installing any plugin for Trac you'll need to restart Apache to see it (not all changes to ``trac.ini`` require a restart but adding a plugin does). 
    74  
    75 3. Make sure to add the new plugin to ``trac.ini``: 
    76  
    77 :: 
    78  
    79   [components] 
    80   wikinotification.* = enabled 
     98* ``easy_install`` is run from the command line (on Linux) not from within 
     99  Python. 
    81100 
    82101 
    83 4. Also should be noted that the trac.ini configuration for the wiki notification should look something like: 
     102* After installing any plugin for Trac you'll need to restart Apache to see 
     103  it (not all changes to trac.ini require a restart but adding a plugin does). 
    84104 
    85 :: 
    86105 
    87   [wiki-notification] 
    88   smtp_always_cc = someone@somedomain 
    89   smtp_from = trac.wiki@localhost 
     106* Make sure to add the new plugin to ``trac.ini`` :: 
    90107 
    91 5. **Another note**: a user will never get a notice of his/her own wiki modification (which is a little tricky when testing the plugin :)) 
     108    [components] 
     109    wikinotification.* = enabled 
     110 
     111 
     112* Also should be noted that the ``trac.ini`` configuration for the wiki 
     113  notification should look something like:: 
     114 
     115    [wiki-notification] 
     116    smtp_always_cc = someone@somedomain 
     117    smtp_from = trac.wiki@localhost 
     118 
     119 
     120* **Another note**: a user will never get a notice of his/her own wiki 
     121  modification (which is a little tricky when testing the plugin :)) 
     122 
     123 
     124.. _read this: http://wikinotification.ufsoft.org/browser/trunk/README 
     125.. _Easy Install: http://peak.telecommunity.com/DevCenter/EasyInstall 
     126.. _WikiNotification: http://wikinotification.ufsoft.org 
     127}}}