.. include:: ../Includes.txt

.. _administrators:

For administrators
==================

.. _installation:

Installation
------------

#. Import from TER.
#. Include the static template.


.. _configuration:

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

Use the Constant Editor to set some default values or TypoScript, if the plugin is inserted directly in the TypoScript Setup.

Properties
^^^^^^^^^^

.. container:: ts-properties

    =========================== =================================== =================
    Property                    Title                               Type
    =========================== =================================== =================
    outputType_                 View                                string
    webmaster_                  Name of webmaster contact           string
    pidList_                    Storage PIDs                        list
    recursive_                  Use recursion with pidList          boolean
    hideSingle_                 Hide single list field              boolean
    formLayout_                 Form layout                         string
    layoutRootPath_             Path to layouts                     string
    partialRootPath_            Path to partials                    string
    templateRootPath_           Path to templates                   string
    =========================== =================================== =================


.. _outputType:

outputType
^^^^^^^^^^
.. container:: table-row

    Property
        outputType

    Data type
        string

    Description
        Selects the view. Allowed values:

        - *form* Shows the subscription form.
        - *list* Shows a list of all available mailing lists including descriptions.

    Default
        form


.. _webmaster:

webmaster
^^^^^^^^^
.. container:: table-row

    Property
        webmaster

    Data type
        string

    Description
        Name of webmaster contact.
        Used in error message if the request mail to the list server can not be send. Linked automatically if this is an email address.

        :typoscript:`plugin.tx_ghlistsubscribe_pi1.webmaster = webmaster@example.com`

    Default
        webmaster


.. _pidList:

pidList
^^^^^^^
.. container:: table-row

    Property
        pidList

    Data type
        string

    Description
        Comma separated list of page ids containing the mailin list records.
        Defaults to current page if empty. Can be overriden in the plugin's flexform.

    Default
        empty


.. _recursive:

recursive
^^^^^^^^^
.. container:: table-row

    Property
        recursive

    Data type
        boolean

    Description
        Use recursion with pidList_.
        Can be overriden in the plugin's flexform.

    Default
        0


.. _hideSingle:

hideSingle
^^^^^^^^^^
.. container:: table-row

    Property
        hideSingle

    Data type
        boolean

    Description
        Hide list selection field if there is only one list.
        Can be overriden in the plugin's flexform.

    Default
        1


.. _formLayout:

formLayout
^^^^^^^^^^
.. container:: table-row

    Property
        formLayout

    Data type
        string

    Description
        Layout for the form view. Allowed values:

        - *default* Standard form with labels and all fields available
        - *small* Minimized form without labels and name field

        Can be overriden in the plugin's flexform.

    Default
        default


.. _layoutRootPath:

layoutRootPath
^^^^^^^^^^^^^^
.. container:: table-row

    Property
        layoutRootPath

    Data type
        file path

    Description
        Sets a specific layout path. Files in this directory override files of the same name in the extension's layout directory.

    Default
        EXT:gh_listsubscribe/Resources/Private/Layouts


.. _partialRootPath:

partialRootPath
^^^^^^^^^^^^^^^
.. container:: table-row

    Property
        partialRootPath

    Data type
        file path

    Description
        Sets a specific partial path. Files in this directory override files of the same name in the extension's partial directory.

    Default
        EXT:gh_listsubscribe/Resources/Private/Partials


.. _templateRootPath:

templateRootPath
^^^^^^^^^^^^^^^^
.. container:: table-row

    Property
        templateRootPath

    Data type
        file path

    Description
        Sets a specific template path. Files in this directory override files of the same name in the extension's template directory.

        .. warning::

            With TYPO3 CMS 6.2, the FLUIDTEMPLATE object has no templateRootPaths property.Therefore this property is mapped to the template.file property.

            For templateRootPath to work correctly with TYPO3 CMS 6.2, you have to copy all files from the extension's template directory to the new location even if you do not intend to edit all of them.

    Default
        EXT:gh_listsubscribe/Resources/Private/Templates