.. You may want to use the usual include line. Uncomment and adjust the path. 
.. include:: ../Includes.txt


=====================
EXT: comments\_report
=====================

:Author:
      Dmitry Dulepov

:Created:
      2008-08-11T11:31:02

:Changed by:
      Dmitry Dulepov

:Changed:
      2009-04-21T10:37:32

:Author:
      Netcreators BV

:Email:
      extensions@netcreators.com

:Info 3:


:Info 4:


|img-1| |img-2| EXT: comments\_report


.. _EXT-comments-report:

EXT: comments\_report
=====================

Extension Key:  **comments\_report**

Copyright 2007-2009, Netcreators BV, <extensions@netcreators.com>

This document is published under the Open Content License

available from http://www.opencontent.org/opl.shtml

The content of this document is related to TYPO3

\- a GNU/GPL CMS/Framework available from www.typo3.org

.. _Table-of-Contents:

Table of Contents
-----------------

`EXT: comments\_report 1 <#1.EXT:%20comments_report|outline>`_

**`Introduction 3 <#1.1.Introduction|outline>`_**

`What does it do? 3 <#1.1.1.What%20does%20it%20do_|outline>`_

`Screenshots 3 <#1.1.2.Screenshots|outline>`_

**`Users manual 4 <#1.2.Users%20manual|outline>`_**

**`Administration 5 <#1.3.Administration|outline>`_**

`Configuring extension 5 <#1.3.1.Configuring%20extension|outline>`_

`Creating the report page 5
<#1.3.2.Creating%20the%20report%20page|outline>`_

`Activating the report link 5
<#1.3.3.Activating%20the%20report%20link|outline>`_

`Customizing reporting link and form 5
<#1.3.4.Customizing%20reporting%20link%20and%20form|outline>`_

**`Configuration 6 <#1.4.Configuration|outline>`_**

**`ChangeLog 7 <#1.5.ChangeLog|outline>`_**


.. _Introduction:

Introduction
------------


.. _What-does-it-do:

What does it do?
^^^^^^^^^^^^^^^^

This extension adds a link to report bad comment to every comment
produced by the comments extension. When web site visitor wants to
report the comment as bad, he/she click the link. Next he/she is
transferred to the page where he is presented with form. Visitor fills
the form and submits it. The e-mail is sent to the web site owner to
the configured e-mail address with a link to comment, comment text,
user name/e-mail and comment notes.

This extension was created by Dmitry Dulepov for Netcreators.


.. _Screenshots:

Screenshots
^^^^^^^^^^^

A sample comment with a default reporting link:

|img-3| The default template for comments extension with the reporting
marker:

|img-4|


.. _Users-manual:

Users manual
------------

There is nothing for user to configure in this extension. It should be
installed and configured by web site administrator or web site
developer.


.. _Administration:

Administration
--------------

This section describes how web site administrator/developer can add
reporting capabilities to the comments extension using the
comments\_report extension. In future we will use “administrator” to
refer to the person who configures the extension.


.. _Configuring-extension:

Configuring extension
^^^^^^^^^^^^^^^^^^^^^

The extension is configured only through TypoScript.

Firsts, extension's TypoScript template should be added to the main
TypoScript template of the web site.

Next, administration should use the Constant Editor in the
Web>Template module to set configuration settings. All of them are
explained in the constant editor. Administrator can set the following:

- Source e-mail (“From”)

- Destination e-mail (“To”)

- Captcha mode (none, sr\_freecap or captcha extensions)

- List of required fields (from,frommail,text)

- E-mail template file

- Report page id (required!)


.. _Creating-the-report-page:

Creating the report page
^^^^^^^^^^^^^^^^^^^^^^^^

The administrator should create a new page where reporting form is
placed. When such form is created, administrator inserts a plugin
named “Comments: report bad comment” to the page. There are no plugin
options because all configuration is done through TypoScript.


.. _Activating-the-report-link:

Activating the report link
^^^^^^^^^^^^^^^^^^^^^^^^^^

When reporting page is ready, the template for the comments extension
should be modified. A new marker ( :code:`###TX\_COMMENTSREPORT###` )
should be added to the template. This marker will provide a complete
link. By default it is a simple :code:`a` tag with a :code:`Report
this comment` text inside the tag.


.. _Customizing-reporting-link-and-form:

Customizing reporting link and form
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

Reporting link and form can be customized. The extension provides a
very flexible template with lots of markers. The default template is
located in the extension's :code:`res/` subdirectory.


.. _Configuration:

Configuration
-------------

See “Configuring extension” in the “Administration” section of this
manual.


.. _ChangeLog:

ChangeLog
---------

See the file named ChangeLog in the extension's directory.

|img-5| 7


.. ######CUTTER_MARK_IMAGES######

.. |img-1| image:: img-1.png
.. :align: left

.. |img-2| image:: img-2.png
.. :border: 0
.. :height: 23
.. :id: Grafik2
.. :name: Grafik2
.. :width: 86

.. |img-3| image:: img-3.png
.. :align: left
.. :border: 1
.. :height: 161
.. :id: graphics2
.. :name: graphics2
.. :width: 588

.. |img-4| image:: img-4.png
.. :align: left
.. :border: 1
.. :height: 325
.. :id: graphics3
.. :name: graphics3
.. :width: 309

.. |img-5| image:: img-5.png
.. :align: left
.. :border: 0
.. :height: 34
.. :id: graphics1
.. :name: graphics1
.. :width: 216