Merge branch '2-add-documentation' into 'master'

Resolve "add documentation"

Closes #2

See merge request t3o/election!5

.gitignore

+/Documentation-GENERATED-temp

CHANGELOG

-0.2.5 First productive Release
\ No newline at end of file
+# Changelog
+
+| Version | Release    | Type  | Description                             |
+| ------- | ---------- | ----- | --------------------------------------- |
+| 0.1.0   | 15.03.2019 | Major | Alpha version                           |
+| 0.2.5   | 19.03.2019 | Major | Beta version / first productive release |
+| 0.2.6   |            | Minor | Beta version / TER release              |

CONTRIBUTING.md

 # Contribution 
 
+## Information about contributing to this extenstion
+
 Your contribution is welcome. Feel free to create issues. You can also create a 
 merge request. Please note, that we only review merge request
+
+
+### Create Issues
+
+* If you find something missing or something is wrong in this extension,
+  you are welcome to write an issue at https://git-t3o.typo3.org/t3o/election/issues/new  that is describing the problem.
+* If you can, please try to fix the problem yourself and create a merge reuest in this project (you need request group access first)
+* For every change, it is necessary to create an issue first.
+
+
+### Get help
+
+* If you need help with contributing to this extension or If you want to get a maintainer of the extension, please contact: stefan.busemann@typo3.org
+
+
+### requirments for merge requests
+
 * if the coding guidelines are fullfilled
 * acceptance criterias are described
 * unit tests are running
 
-If you want to get a maintainer of the extension, please contact:
-stefan.busemann@typo3.org
\ No newline at end of file
+

Classes/Controller/AbstractProtectedBeController.php

@@ -16,7 +16,6 @@ namespace TYPO3\Election\Controller;
 
 use Doctrine\Common\Util\Debug;
 use TYPO3\CMS\Core\Messaging\AbstractMessage;
-use TYPO3\CMS\Extbase\Utility\DebuggerUtility;
 use TYPO3\CMS\Extbase\Utility\LocalizationUtility;
 
 /**
@@ -71,7 +70,6 @@ abstract class AbstractProtectedBeController extends AbstractBeController
             $this->request->setOriginalRequestMappingResults($this->arguments->getValidationResults());
             $this->forward($referringRequest->getControllerActionName(), $referringRequest->getControllerName(), $referringRequest->getControllerExtensionName(), $referringRequest->getArguments());
         }
-        DebuggerUtility::var_dump($this->request['nominee.image']);
         $message = 'An error occurred while trying to call ' . get_class($this) . '->' . $this->actionMethodName . '().' . PHP_EOL;
         return $message;
 

Classes/Controller/BeDashboardController.php

@@ -14,7 +14,6 @@ namespace TYPO3\Election\Controller;
  * The TYPO3 project - inspiring people to share!
  */
 use TYPO3\CMS\Core\Messaging\AbstractMessage;
-use TYPO3\CMS\Extbase\Utility\DebuggerUtility;
 use TYPO3\CMS\Extbase\Utility\LocalizationUtility;
 use TYPO3\Election\Domain\Repository\ElectionCircularRepository;
 use TYPO3\Election\Domain\Repository\ElectorImportRepository;

Documentation/ChangeLog/Index.rst

+.. include:: ../Includes.txt
+
+
+.. _changelog:
+
+=========
+ChangeLog
+=========
+
+.. t3-field-list-table::
+ :header-rows: 1
+
+ - :Version:
+      Version
+   :Date:
+      Release Date
+   :Changes:
+      Release Description
+
+ - :Version:
+      0.2.5
+   :Date:
+      2019-05-29
+   :Changes:
+
+      * [FEATURE] Add custom controller error message
+      * [FEATURE] Improve list styling
+      * [TASK] Add URLs to nominees
+      * [BUGFIX] Correct some typos
+      * [BUGFIX] Remove obsolete charakters
+      * [BUGFIX] Show result status of an election
+      * [BUGFIX] Rename method to isGroupConfigComplete
+      * [BUGFIX] Add fallback configuration
+      * [BUGFIX] Use doctrine for plugin detection
+
+ - :Version:
+      0.1.0
+   :Date:
+      2019-03-15
+   :Changes:
+
+      * Initial Release

Documentation/Configuration/Index.rst

+.. include:: ../Includes.txt
+
+
+.. _configuration:
+
+=============
+Configuration
+=============
+
+Target group: **Administrators**
+
+How to configure the extension.
+
+Configuration Module
+====================
+
+Once the extension is installed, a new backend module gets visible. Most probably at bottom of your backend.
+
+.. figure:: ../Images/AdministratorManual/BE-Module.png
+   :width: 400px
+   :alt: Backend Module
+
+At the first call, you will receive a warning for an empty configuration.
+
+.. figure:: ../Images/AdministratorManual/NewConfiguration.png
+   :width: 5008px
+   :alt: Backend Module
+
+Click at the button "create a new configuration"
+
+
+.. figure:: ../Images/AdministratorManual/Configuration.png
+   :width: 5008px
+   :alt: Backend Module
+
+- **Administration backend user group**: Choose a backend user group, which is allowed to edit the configuration
+- **Election manager backend user group**: Choose a backend user group, which is allowed to edit the election
+- **Poll manager backend user group**: Choose a backend user group, which is allowed to edit polls
+- **Plugin PID**: Page ID of the election plugin
+- **Number of mails to send at once**: Set number of mails, which will send out in one request. In a normal environment 100 Mails should be possible
+- **Email address of the sender**: Valid email, which is used to send out the mails.
+- **Name of the sender**: Name of the sender, which is displayed in the mail
+- **Debug mode (will send all invitations to the configured test mail, but creates only dummy tokens)**: Enables the debug mode
+- **Debug test e-mail**: Mail which is used in debug mode.
+
+When you are ready, please choose "save and close" to proceed.
+
+Page Plugin
+===========
+
+Choose now the page module and the election plugin, to the page, you added to the configuration
+
+Edit Configuration
+==================
+
+.. figure:: ../Images/AdministratorManual/EditConfig.png
+   :width: 5008px
+   :alt: Backend Module
+
+If you want to edit an existing configuration (and you are member of the administration group), you can use the tool icon to edit the configuration.
+
+Next step
+=========
+
+:ref:`Use the extension <user>`.
+
+

Documentation/Developer/Index.rst

+.. include:: ../Includes.txt
+
+
+.. _developer:
+
+================
+Developer Corner
+================
+
+- Use your own templates: This is an option, what we plan to support in future. Due to the special setup, you are not able to
+overwrite templates
+-  Reset configuration: If you into a missconfiguraion, please empty table tx_election_domain_model_configuration or delete the record with the
+highest uid. A configuration record is written, each time the configuration is changed. The sytem uses always the configuration
+record with highest uid.
+
+Next step
+=========
+
+:ref:`Known problems <knownproblems>`.
+