Merge pull request #54 from evoWeb/feature/enhance-documentation

Feature/enhance documentation

Author: garbast

Documentation/Includes.txt Documentation/Includes.rst.txtDocumentation/Includes.txt renamed to Documentation/Includes.rst.txt

@@ -1,53 +1,54 @@
-.. include:: Includes.txt
+.. include:: /Includes.rst.txt
 
 .. _start:
 
-=======================================
-sessionplaner: TYPO3Camp Session planer
-=======================================
+==========================
+TYPO3 event Session planer
+==========================
 
 :Extension key:
     sessionplaner
 
+:Package name:
+   evoweb/sessionplaner
+
 :Version:
     |release|
 
 :Language:
     en
 
-:Description:
-    TYPO3camp session planing inside TYPO3
-
-:Keywords:
-    forIntegrator
-
-:Copyright:
-    2013-2022
-
 :Author:
     evoWeb
 
 :License:
-    Open Content License available from http://www.opencontent.org/opl.shtml
+   This document is published under the
+   `Creative Commons BY-NC-SA 4.0 <https://creativecommons.org/licenses/by-nc-sa/4.0/>`__
+   license.
 
 :Rendered:
     |today|
 
+----
+
 The content of this document is related to TYPO3,
 a GNU/GPL CMS/Framework available from http://typo3.org
 
-.. only:: html
-
-   .. tip::
+----
 
-      :ref: `Sitemap`
-
-**Table of Contents**
+**Table of Contents:**
 
 .. toctree::
-   :maxdepth: 5
+   :maxdepth: 2
    :titlesonly:
-   :glob:
 
    Introduction/Index
    Installation/Index
+   Tutorial/Index
+
+.. Meta Menu
+
+.. toctree::
+   :hidden:
+
+   Sitemap

Documentation/Index.rst

@@ -1,4 +1,4 @@
-.. include:: ../Includes.txt
+.. include:: /Includes.rst.txt
 
 .. _installation:
 
@@ -8,7 +8,7 @@ Installation
 
 
 Download via Extension Manager
-------------------------------
+==============================
 
 In the TYPO3 Backend go to Admin Tools > Extensions. Change in the dropdown on
 the top left to 'Get Extensions', enter the extension key 'sessionplaner'
@@ -17,20 +17,11 @@ list install the extension by hitting the action for that.
 
 
 Download via Composer
----------------------
+=====================
 
-Add evoweb/sessionplaner to the require in your composer.json like in the
-following example and run 'composer install'.
+Execute the command below in the shell on project root level.
 
-::
+.. code-block:: shell
+   :caption: Enter on shell
 
-	{
-		"require": {
-			"typo3/cms-core": "^10.0",
-			"evoweb/sessionplaner": "*",
-		}
-	}
-
-
-Alternatively if you have an existing project with a configured composer.json you
-can add sessionplaner with the command by running 'composer require evoweb/sessionplaner'.
+   composer require evoweb/store-finder

Documentation/Installation/Index.rst

@@ -1,21 +1,22 @@
-.. include:: ../Includes.txt
+.. include:: /Includes.rst.txt
 
-.. _introduction:
+..  _introduction:
 
 ============
 Introduction
 ============
 
+..  _what-it-does:
 
 What does it do?
-----------------
+================
 
 In the backend a module assists the planing process by adding sessions
 in a grid of all possible time slots and available rooms. It helps keeping
 an overview of which slots are booked and which are free.
 
 .. figure:: ../Images/sessionplaner-backend.png
-   :alt: Example of the frontend rendering with sessionplaner
+   :alt: Example of the backend module of the sessionplaner
 
 
 In frontend the session plan is rendered in a table style. For example look

Documentation/Introduction/Index.rst

@@ -1,14 +1,11 @@
-:orphan:
+:template: sitemap.html
 
-.. include:: Includes.txt
+.. include:: /Includes.rst.txt
 
-.. only:: html
+..  _sitemap:
 
-   .. _Sitemap:
+=======
+Sitemap
+=======
 
-   Sitemap
-   =======
-
-   .. toctree::
-
-      Index
+.. The sitemap.html template will insert here the page tree automatically.

Documentation/Sitemap.rst

@@ -0,0 +1,48 @@
+.. include:: /Includes.rst.txt
+
+..  _tutorial:
+
+========
+Tutorial
+========
+
+Preparation for planing
+=======================
+
+To be able to plan sessions you need to add the following:
+
+* a folder for the planing data
+* for each day of the event you need to add a "Session Planer Day"
+    - the days need to get "Slots" added to it for each slot that is available on that day
+* for each room in which you are having sessions a "Session Planer Room"
+    - add the "Days" to the room on which that room is available
+    - the rooms need to get "Slots" added to it for each slot that is available in that room
+* edit each day and add the rooms that are available on that day
+* in the "Session Planer" module, you should now have a grid comparable the screenshot
+
+.. figure:: ../Images/sessionplaner-backend.png
+   :alt: Example of the backend module of the sessionplaner
+
+Configuring the frontend
+========================
+
+For the frontend you need at least one page with a plugin of type "Sessionplaner: Sessionplan".
+
+For more complex needs you need to play with the other modules:
+
+* "Sessionplaner: Session"
+* "Sessionplaner: Tag"
+* "Sessionplaner: Speakers"
+* "Sessionplaner: Suggest Sessions"
+
+Each plugin comes with it's own settings as plugin options and do not need to be configured in TypoScript.
+
+TypoScript is only needed to override the templates, partials or layouts. These can be configured with constants:
+
+* `plugin.tx_sessionplaner.view.templateRootPath`
+* `plugin.tx_sessionplaner.view.partialRootPath`
+* `plugin.tx_sessionplaner.view.layoutRootPath`
+
+There is one exemption from this and that is the "Suggest Sessions" plugin. The form for that is configured
+within the `plugin.tx_sessionplaner.settings.suggest` key. Take a deeper look into
+Configuration/TypoScript/setup.typoscript