Changes between Version 26 and Version 27 of PrivateCommentPlugin


Ignore:
Timestamp:
Apr 21, 2015, 9:46:56 AM (9 years ago)
Author:
figaro
Comment:

Cosmetic changes

Legend:

Unmodified
Added
Removed
Modified
  • PrivateCommentPlugin

    v26 v27  
    11[[PageOutline(2-5,Contents,pullout)]]
    22
    3 = Private Comments =
     3= Private Comments
    44
    5 == Description ==
     5== Description
    66
    7 This trac plugin lets you create comments which are only visible for users with a special permission.
    8 To create such a comment you are able to check a new checkbox on the ticket page. If you leave the checkbox unchecked everybody can see the comment.
     7This plugin lets you create comments which are only visible for users with a special permission.
     8To create such a comment you need to check a checkbox with label "this comment is private" on the ticket page. If you leave the checkbox unchecked, then everybody can see the comment.
     9The label is configurable.
    910
    10 
    11 === Configuration Help: ===
     11=== Configuration Help
    1212
    1313After installation of this plugin you will be prompted to update your trac environment.
    1414
    15 Then you are able to set the name of the permission (default is `PRIVATE_COMMENT_PERMISSION`) in the admin-interface or in the trac.ini
     15Then you are able to set the name of the permission (default is `PRIVATE_COMMENT_PERMISSION`) in the admin-interface or in the `trac.ini` file.
    1616
    1717You have to give this permission to all groups and users who should see the private comments.
    1818
    19 If you want to change the color of the "this comment is private"- message you can do this by adding a css-class named "private_comment_marker" to your css.
     19If you want to change the color of the "this comment is private"- message you can do this by adding a CSS-class named "private_comment_marker" to your CSS stylesheets.
    2020
    2121The label of the checkbox is modifiable via the css-class "private_comment_checkbox".
    2222
    23 == Bugs/Feature Requests ==
     23== Bugs/Feature Requests
    2424
    25 === Old Comments ===
     25=== Old Comments
    2626
    27 Old comments can't be set private because they miss an entry in the private_comment table.
     27Old comments can't be set private, because they do not have an entry in the private_comment table. I created a script which creates the necessary entries in the private_comment table. Just place the script cpce.py into your trac context and run it.
    2828
    29 I created a script which creates the necessary entries
    30 in the private_comment table.
    31 Just place the script cpce.py into your trac context and run it
    32 
    33 === Email notification ===
     29=== Email notification
    3430
    3531Email notifcations are not filtered and, as far as I know, can't be filtered via a plugin.
    36 To filter the notifications I made some minor core changes. If a comment is private the text
    37 'the ticket is processed internally' will be set as comment text.
     32To filter the notifications I made some minor core changes. If a comment is private the text 'the ticket is processed internally' will be set as comment text.
    3833
    3934You can install the filtering by using the notification_patch.patch file from svn.
    4035
    41 === Other Bugs  ===
     36=== Other Bugs
    4237
    4338Existing bugs and feature requests for PrivateCommentPlugin are
     
    4742[http://trac-hacks.org/newticket?component=PrivateCommentPlugin&owner=mhenke new ticket].
    4843
    49 == Download ==
     44[[TicketQuery(component=PrivateCommentPlugin&group=type,format=progress)]]
     45
     46== Download
    5047
    5148Download the zipped source from [download:privatecommentplugin here].
    5249
    53 == Source ==
     50== Source
    5451
    5552You can check out PrivateCommentPlugin from [http://trac-hacks.org/svn/privatecommentplugin here] using Subversion, or [source:privatecommentplugin browse the source] with Trac.
    5653
    57 == Example ==
     54== Example
    5855
    5956How to add a private comment:
     
    6158[[Image(add_a_comment.png)]]
    6259
    63 
    6460How a user with the permission sees the comment:
    6561
    6662[[Image(view_comment_w_permission.png)]]
    67 
    6863
    6964How a user without the permission sees the comment:
     
    7166[[Image(view_comment_wo_permission.png)]]
    7267
    73 
    74 == Recent Changes ==
     68== Recent Changes
    7569
    7670[[ChangeLog(privatecommentplugin, 3)]]
    7771
    78 == Author/Contributors ==
     72== Author/Contributors
    7973
    8074'''Author:''' [wiki:mhenke] [[BR]]
    81 '''Maintainer:''' [wiki:mhenke] [wiki:rjollos][[BR]]
     75'''Maintainer:''' [[Maintainer]] [wiki:rjollos] [[BR]]
    8276'''Contributors:''' [[BR]]