.. ==================================================
.. FOR YOUR INFORMATION
.. --------------------------------------------------
.. -*- coding: utf-8 -*- with BOM.

.. include:: ../Includes.txt

.. _admin-manual:

====================
Administrator Manual
====================

Remeber to include the static template.

.. figure:: ../Images/static-template.png
   :alt: Static Template

If this extension is used with TYPO3 6.x please enable bootstrap

.. figure:: ../Images/ext-config-bootstrap.png
   :alt: Static Template

Basic Configuration
===================

Properties
----------

.. contents::
	:local:
	:depth: 1


.. _plugin-tx-ricosmcc-templateRootPath:

templateRootPaths.0
^^^^^^^^^^^^^^^^^^^

:typoscript:`module.tx_ricosmcc.view.templateRootPath =` :ref:`t3tsref:data-type-string`
:code:`EXT:rico_smcc/Resources/Private/Backend/Templates/`

Path to Template


.. _plugin-tx-ricosmcc-layoutRootPath:

layoutRootPath.0
^^^^^^^^^^^^^^^^

:typoscript:`module.tx_ricosmcc.view.layoutRootPath =` :ref:`t3tsref:data-type-string`
:code:`EXT:rico_smcc/Resources/Private/Backend/Partials/`

Path to Layout

.. _plugin-tx-ricosmcc-partialRootPath:

partialRootPath.0
^^^^^^^^^^^^^^^^^

:typoscript:`module.tx_ricosmcc.view.partialRootPath =` :ref:`t3tsref:data-type-string`
:code:`EXT:rico_smcc/Resources/Private/Backend/Layouts/`

Path to Partial

.. _plugin-tx-ricosmcc-storagePid:

storagePid
^^^^^^^^^^

:typoscript:`module.tx_ricosmcc.persistence.storagePid =` :ref:`t3tsref:data-type-integer`

PID where the crawls will be saved

.. _plugin-tx-ricosmcc-crawlUrl:

crawlUrl
^^^^^^^^

:typoscript:`module.tx_ricosmcc.persistence.crawlUrl =` :ref:`t3tsref:data-type-string`

Frontend URL which will be used to crawl the site

.. _configuration-extensionmanager:

Extension Configuration
=======================

You have to setup the api data in the configuration section


.. figure:: ../Images/extmanager.png
   :alt: ExtManager

Properties
----------

.. only:: html

	.. contents::
		:local:
		:depth: 1


.. _plugin-tx-ricosmcc-apiSharedSecret:

apiSharedSecret
^^^^^^^^^^^^^^^

:typoscript:`settings.apiSharedSecret =` :ref:`t3tsref:data-type-string`

API Shared Secret (to be obtained from the Searchmetrics Suite interface "My API", to be stored)

.. _plugin-tx-ricosmcc-apiKey:

apiKey
^^^^^^

:typoscript:`settings.apiKey =` :ref:`t3tsref:data-type-string`

API Key (to be obtained from the Searchmetrics Suite interface "My API", to be stored)

.. _plugin-tx-ricosmcc-projectID:

projectID
^^^^^^^^^

:typoscript:`settings.projectID =` :ref:`t3tsref:data-type-Integer`

Project ID (to be obtained from the Searchmetrics Suite)

.. _plugin-tx-ricosmcc-bootstrapUsage:

bootstrapUsage
^^^^^^^^^^^^^^

:typoscript:`settings.bootstrap =` :ref:`t3tsref:data-type-Boolean`

Use own Bootstrap Lib for Output

.. _plugin-tx-ricosmcc-bootstrapUrl:

bootstrapUrl
^^^^^^^^^^^^

:typoscript:`settings.bootstrapUrl =` :ref:`t3tsref:data-type-String`
:code:`https://maxcdn.bootstrapcdn.com/bootstrap/3.3.6/css/bootstrap.min.css`

Path to the Bootstrap Lib

.. _plugin-tx-ricosmcc-debugMode:

debugMode
^^^^^^^^^

:typoscript:`settings.debug =` :ref:`t3tsref:data-type-Boolean`

Enable debug mode.
The debug mode will overwrite the postVars with staticPostVars.
This makes it easier to debug the ajax requests