Changes between Version 28 and Version 29 of PrivateCommentPlugin


Ignore:
Timestamp:
Dec 28, 2016, 8:24:36 PM (7 years ago)
Author:
figaro
Comment:

Moved example to functional description

Legend:

Unmodified
Added
Removed
Modified

  • PrivateCommentPlugin

    v28 v29  
    11[[PageOutline(2-5,Contents,pullout)]]
    22
    3 = Private Comments
     3= Add Private Comments
    44
    55== Description
    … …  
    99The label is configurable.
    1010
     11How to add a private comment:
     12
     13[[Image(add_a_comment.png, border=2)]]
     14
     15How a user with the permission sees the comment:
     16
     17[[Image(view_comment_w_permission.png, border=2)]]
     18
     19How a user without the permission sees the comment:
     20
     21[[Image(view_comment_wo_permission.png, border=2)]]
     22
    1123=== Configuration Help
    1224
    13 After installation of this plugin you will be prompted to update your trac environment.
     25After installation of this plugin you will be prompted to update your Trac environment.
    1426
    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` file.
     27Then you are able to set the name of the permission in the admin-interface or in the `trac.ini` file. The default value is `PRIVATE_COMMENT_PERMISSION`.
    1628
    1729You have to give this permission to all groups and users who should see the private comments.
    1830
    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 stylesheets.
     31If 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.
    2032
    21 The label of the checkbox is modifiable via the css-class "private_comment_checkbox".
     33The label of the checkbox is modifiable via the CSS-class "private_comment_checkbox".
    2234
    2335== Bugs/Feature Requests
    … …  
    2537=== Old Comments
    2638
    27 Old 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.
     39Old 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.
    2840
    2941=== Email notification
    3042
    31 Email notifcations are not filtered and, as far as I know, can't be filtered via a plugin.
     43Email notifications are not filtered and, as far as I know, can't be filtered via a plugin.
    3244To 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.
    3345
    … …  
    5668General instructions on installing Trac plugins can be found on the [TracPlugins#InstallingaTracplugin TracPlugins] page.
    5769
    58 == Example
    59 
    60 How to add a private comment:
    61 
    62 [[Image(add_a_comment.png)]]
    63 
    64 How a user with the permission sees the comment:
    65 
    66 [[Image(view_comment_w_permission.png)]]
    67 
    68 How a user without the permission sees the comment:
    69 
    70 [[Image(view_comment_wo_permission.png)]]
    71 
    7270== Recent Changes
    7371