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


=================
EXT: mailformplus
=================

:Author:
      Kasper Skårhøj

:Created:
      2002-11-01T00:32:00

:Changed by:
      Kurt Kunig

:Changed:
      2007-06-08T13:03:12

:Author:
      Peter Luser

:Email:
      netdog@typoheads.com

:Info 3:


:Info 4:


**EXT: FE extends mailformplus listview**

Version 0.0.2

Extension Key:  **kk\_mailformpluslist**

Copyright 2007, Kurt Kunig, <kurt@kunig.de>

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.com

.. _generated:

((generated))
=============

.. _Table-of-Contents:

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

**`Introduction 1 <#0.1.Introduction|outline>`_**

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

`Screenshots 2 <#0.1.3.Screenshots|outline>`_

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

**`Administration 4 <#0.3.Administration|outline>`_**

`FAQ 4 <#0.3.1.FAQ|outline>`_

**`Configuration and usage of kk\_mailformpluslist 4 <#0.4.Configurati
on%20and%20usage%20of%20kk_mailformpluslist|outline>`_**

`Typoscript support or maintenance: 5
<#0.4.1.Typoscript%20support%20or%20maintenance:|outline>`_

`the HTML form: subtemplates for emails and errormessages 5 <#0.4.2.th
e%20HTML%20form:%20subtemplates%20for%20emails%20and%20errormessages%2
0|outline>`_

`Known problems 6 <#0.4.3.Known%20problems|outline>`_

**`Change-Log: 7 <#0.5.Change-Log:|outline>`_**

`New in version 0.0.1 7
<#0.5.1.New%20in%20version%200.0.1%20|outline>`_


.. _Introduction:

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

First of all:

**Many thanks to all the gentle colleagues in the net who supported
me!**


.. _What-does-it-do:

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

This extension should be installed on top of the th\_mailformplus-
extension for a FE-view of the transmitted messages based on
mailformplus forms.

- Displays a number of messages (parameter in the mailfomplus object =
  new mailformplus-DB field) in a FE table as a list view.

- Inserts a link to a new dedicated page (parameter in the mailfomplus
  object = new mailformplus-DB field) for displaying the complete
  content of the chosen message (UID). Therefore you have to tell the
  “list-page” the PID of the page where the plugin th\_mailformplus is
  in. This can be done by a seperate plugin-property called
  “sourcePagePID”.

- You've the possibility to tell the plugin the content of a special
  marker (###LINK2SHOW###) where the link to the single display will be
  in (e.g. In the last column of the list table of the design template
  for the (mail)form. You can put in something like this: “<img
  src=”fileadmin/images/icon.gif width=15px height=15px border=0 />” or
  a simple letter like “O” (that's also the default if the property is
  missing).The property for this is: “linkVars = ...”


.. _Screenshots:

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

Backend module:

|img-1|

Sorry for the German description.

maximum number of records to be shown in the list, zero (0) means:
without limits.

Pid of that page that contains the plugin with the single view object.

|img-2|

This is a part of the page content, where the list should be
displayed. Link to the mailformplus data for the above mentioned two
additional parameters.

|img-3|

You Should also include the mailformplus-example-template or your own
one where the subparts and markers are defined for the two different
display forms “list” and “single”:

“plugin.tx\_kkmailformpluslist\_pi1.template =
fileadmin/templates/mfplus\_contact\_form01.html”

Here is an example screenshot of the frontend result:

|img-4|

and a single view:

|img-5|


.. _Users-manual:

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


.. _Administration:

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

see configuration


.. _FAQ:

FAQ
^^^

\- none


.. _Configuration-and-usage-of-kk-mailformpluslist:

Configuration and usage of kk\_mailformpluslist
-----------------------------------------------

-

- Install the module with the Extension manager.

- Create page and insert a “plugin” element on the page where the
  “list”-form should be shown –pluginname: “Mailformplus List” with the
  type of display “LIST”.

- Create (sub-)page and insert a “plugin” element on the page where the
  “single”-form should be shown –pluginname: “Mailformplus List” with
  the type of display “SINGLE” (remember the Id).

- Put in the two data into the mailformplus element (sysFolder!?): Max
  number of records to be shown and the PID of the page for the single
  view.

- Include the new plugin in the template and also include the HTML-
  document for the Subparts and
  markers.“plugin.tx\_kkmailformpluslist\_pi1.template =
  fileadmin/templates/mfplus\_contact\_form01.html”

- This will be the content of the marker
  ###LINK2SHOW###:plugin.tx\_kkmailformpluslist\_pi1.linkVars = <img
  src="fileadmin/images/lupe.gif" alt="lupe" width="14px" height="14px"
  />###LINK2SHOW### = “<img src="fileadmin/images/lupe.gif" alt="lupe"
  width="14px" height="14px" />” e.g.


.. _Typoscript-support-or-maintenance:

Typoscript support or maintenance:
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

plugin.tx\_kkmailformpluslist\_pi1.

.. ### BEGIN~OF~TABLE ###


.. _template:

template
""""""""

.. container:: table-row

   a
         template
   
   b
         Path to the HTML template with the markers in
         
         (perhaps the same path resp. the same document like that one for
         th\_mailformplus!?)
         
         e.g. = fileadmin/templates/mailformplus\_contact.html



.. _linkVars:

linkVars
""""""""

.. container:: table-row

   a
         linkVars
   
   b
         The content of this variable will be written into the marker
         ###LINK2SHOW###
         
         e.g. look into the example below.



.. _sourcePagePID-optional:

sourcePagePID (optional)
""""""""""""""""""""""""

.. container:: table-row

   a
         sourcePagePID (optional)
   
   b
         Because of possible different mailfomplus-forms and -pages and their
         possible different number of Markers (###value\_name### etc.) you have
         to tell the extension what messages should be displayed in the page
         that belongs to this ext. Template (the template that corresponds to
         the page where you want to show the list)
         
         e.g. = 43
         
         Shows only messages sent with THAT page!
         
         Without this property all mails will be listed, doesn't matter if
         there is the same mailformplus-Design is used.


.. ###### END~OF~TABLE ######


.. _generated:

((generated))
"""""""""""""

.. _Example:

Example:
~~~~~~~~

plugin.tx\_kkmailformpluslist\_pi1 {

template = fileadmin/templates/mailformplus\_contact\_Kunig.html

linkVars = <img src="fileadmin/images/lupe.gif" alt="lupe"
width="14px" height="14px" />

sourcePagePID = 43

}


.. _the-HTML-form-subtemplates-for-emails-and-errormessages:

the HTML form: subtemplates for emails and errormessages
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

You can (have to) specify a “HTML-Template with formular fields in
it”.

This is a “normal” static HTML document including the formular fields.

You know this from the extension th\_mailformplus itself!

There are some additonal subparts to be definded:


.. _generated:

((generated))
"""""""""""""

.. _Example:

Example:
~~~~~~~~

::

   ... This is a part (end) of the mailformplus-template:
   
   <!-- ###TEMPLATE_ERROR### begin
   
     OPTIONAL – this section holds the error texts for the input fields.
           Only a primitive server side check is supported: you can specify fiels that have to be filled out.      If not, this error message is shown.
   -->
   
           <!-- ###ERROR_START### begin 
                   this is used for the global error marker ###ERROR### -->
           The following errors occured:
           <ul>
           <!-- ###ERROR_START### end -->
   ...
   
   <!-- ###TEMPLATE_ERROR### end -->
   
   
   
   
   
   <!-- This is the part for the additive extension "kk_mailfompluslist"
       ALL markers have to be written in uppercase letters just like this one: ###VALUE_DATUM###!
           Constant markers are: 
           ###VALUE_DATUM### for the sending date and time 
           ###LINK2SHOW###   the content will take a glass-icon for the link to the single, complete document
           ###GO_BACK###     contains the link back to the calling page (defined in the locallang.xml-key "back")
           All other markers will be the same like in the form above.
   -->
   <!-- ###MFP_LIST### begin -->
           <br />
           <table class="fine">
                   <tr>
                      <th align="left">Datum</th>
                           <th align="left" bgcolor="#fecec0">Absender</th>
                           <th align="left">Thema</th>
                           <th>&nbsp;</th>
                   </tr>
                   <!--  ###MFPLISTE### begin  -->
                      <td valign="top"><span class="mini">###VALUE_DATUM###</span></td>
                           <td valign="top"><span class="mini" bgcolor="#fecec0">###VALUE_NAME###</span></td>
                           <td valign="top"><span class="mini">###VALUE_SUBJECT###</span></td>
                           <td valign="top"><span class="mini">###LINK2SHOW###</span></td>
                   <!--  ###MFPLISTE### end -->
           </table>
   <!-- ###MFP_LIST### end -->
   
   
   <!-- ###MFP_SINGLE### begin -->
           <!-- ###MFPSINGLEVIEW### begin -->
           <br />
           <table class="fine" width="100%">
              <tr><td>###VALUE_DATUM###</td><td>von ###VALUE_NAME###</td></tr>
                   <tr><td>Telefonnummer</td><td>###VALUE_PHONE###</td></tr>
                   <tr><td>Thema</td><td>###VALUE_SUBJECT###</td></tr>
                   <tr><td colspan="2">Nachricht:</td></tr>
                   <tr><td colspan="2" style="white-space:pre;">###VALUE_TEXT###</td></tr>
           </table>
           <p align="right">###GO_BACK###</p>
           <!-- ###MFPSINGLEVIEW### end -->
   <!-- ###MFP_SINGLE### end -->
   
   


.. _Special-fields:

Special fields:
~~~~~~~~~~~~~~~

::

      
   ###VALUE_DATUM### 
   will display date and time of the sent email
   
   
   ###LINK2SHOW###   
   the content will take the content of the parameter “linkVars” of the plugin-template (s.a.) for the link to the single complete document.
   
   
   
   ###GO_BACK###     
   contains the link back to the calling page (defined in the locallang.xml-key "back")
   


.. _Known-problems:

Known problems
^^^^^^^^^^^^^^

- The field “Drop down” for “list” or single” is shown in each page-type
  not only in the Ctype “list” and this plugin!?

- Perhaps a lot!? This is my FIRST extension! Sorry for the
  inconveniences you've possibly had! Please send me an email with
  possible hints and failure corrections.


.. _Change-Log:

Change-Log:
-----------


.. _New-in-version-0-0-1:

New in version 0.0.1
^^^^^^^^^^^^^^^^^^^^

New property “sourcePagePID” for a page ext-SETUP-template. Shows only
messages sent with THAT page! This is the pid that's in the
mailformplus\_log table of the database.

|img-6| EXT FE kk\_mailformpluslist 7


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

.. |img-1| image:: img-1.png
.. :align: left
.. :border: 0
.. :height: 210
.. :id: Grafik1
.. :name: Grafik1
.. :width: 495

.. |img-2| image:: img-2.png
.. :align: left
.. :border: 0
.. :height: 242
.. :id: Grafik4
.. :name: Grafik4
.. :width: 476

.. |img-3| image:: img-3.png
.. :align: left
.. :border: 0
.. :height: 210
.. :id: Grafik5
.. :name: Grafik5
.. :width: 494

.. |img-4| image:: img-4.png
.. :align: left
.. :border: 0
.. :height: 451
.. :id: Grafik6
.. :name: Grafik6
.. :width: 589

.. |img-5| image:: img-5.png
.. :align: left
.. :border: 0
.. :height: 197
.. :id: Grafik7
.. :name: Grafik7
.. :width: 507

.. |img-6| image:: img-6.png
.. :align: left
.. :border: 0
.. :height: 32
.. :id: Graphic1
.. :name: Graphic1
.. :width: 102