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

= Add comments to wiki pages

{{{#!box info
**Notice:** This plugin does not necessarily meet coding standards or functions correctly in all use cases.
}}} 

== Description

This macro allows for easily adding comments to a wiki page, in a standard format. Each comment is added in the following form:

{{{
==== Comment by <user> on <date> ====
<comment-body>

}}}

The comment body supports normal Trac WikiFormatting.

Comments are added after the first line that starts with {{{[[AddComment]]}}}.

The macro supports previewing and adheres to the TracPermissions scheme, only allowing comments to be added if the user has write access to the page.

Since changeset [21] the macro can fulfil the role of an append only Wiki page. By passing the argument `appendonly` to the macro, comments can be appended to the page even when the user does not have permission to modify the page. This is potentially unsafe, but can be useful.

Note that this macro differs from the [t:WikiFormatting#Comments standard wiki #comment feature].

== Bugs/Feature Requests

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

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

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

== Download

Download the version as per your Trac installation:
 * Trac 0.11 and 0.12: [source:addcommentmacro/0.11]
 * Trac 0.10: [source:addcommentmacro/0.10]

Download all versions as a [export:addcommentmacro zip file].

The plugin is also available on [pypi:TracAddCommentMacro PyPi].

== Source

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

== Installation

'''Dependencies''': You need to install MacroPostPlugin first, or else the 'Preview' and 'Submit' buttons won't work:

{{{#!sh
$> easy_install https://trac-hacks.org/svn/macropostplugin/0.11
...
$> easy_install https://trac-hacks.org/svn/addcommentmacro/0.11
...
Done.
}}}

Add the following to your `trac.ini` file:
{{{#!ini
[components]
macropost.web_ui.macropostmodule = enabled
addcomment.* = enabled
}}}

Alternatively, use the WebAdmin interface to enable both plugins.

== Recent Changes

[[ChangeLog(/addcommentmacro,3)]]

== Author/Contributors

'''Author:''' [wiki:athomas athomas] [[BR]]
'''Maintainer:''' [[Maintainer]] [[BR]]
'''Contributors:''' [wiki:eblot eblot] (ported Trac to trunk), [wiki:osimons osimons] (0.11 version)