[[PageOutline(2-5,Contents,pullout)]]

= Private Comments

== Description

This plugin lets you create comments which are only visible for users with a special permission.
To 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.
The label is configurable.

=== Configuration Help

After installation of this plugin you will be prompted to update your trac environment.

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.

You have to give this permission to all groups and users who should see the private comments.

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.

The label of the checkbox is modifiable via the css-class "private_comment_checkbox".

== Bugs/Feature Requests

=== Old Comments

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.

=== Email notification

Email notifcations are not filtered and, as far as I know, can't be filtered via a plugin.
To 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.

You can install the filtering by using the notification_patch.patch file from svn. 

=== Other Bugs

Existing bugs and feature requests for PrivateCommentPlugin are 
[report:9?COMPONENT=PrivateCommentPlugin here].

If you have any issues, create a 
[/newticket?component=PrivateCommentPlugin new ticket].

[[TicketQuery(component=PrivateCommentPlugin&group=type,format=progress)]]

== Download

Download the zipped source from [export:privatecommentplugin here].

== Source

You can check out PrivateCommentPlugin from [/svn/privatecommentplugin here] using Subversion, or [source:privatecommentplugin browse the source] with Trac.

== Installation

General instructions on installing Trac plugins can be found on the [TracPlugins#InstallingaTracplugin TracPlugins] page.

== Example

How to add a private comment:

[[Image(add_a_comment.png)]]

How a user with the permission sees the comment:

[[Image(view_comment_w_permission.png)]]

How a user without the permission sees the comment:

[[Image(view_comment_wo_permission.png)]]

== Recent Changes

[[ChangeLog(privatecommentplugin, 3)]]

== Author/Contributors

'''Author:''' [wiki:mhenke] [[BR]]
'''Maintainer:''' [[Maintainer]] [wiki:rjollos] [[BR]]
'''Contributors:''' [[BR]]