[DOCS] Add documentation

Documentation/Changelog/Index.rst

@@ -0,0 +1,9 @@
+.. include:: ../Includes.txt
+
+.. _changelog:
+
+==========
+Change log
+==========
+
+...

Documentation/Configuration/Index.rst

@@ -0,0 +1,44 @@
+.. include:: ../Includes.txt
+
+.. _configuration:
+
+=============
+Configuration
+=============
+
+.. tip::
+
+   You must configure the extensions service_bw2 and maps2 to run this extension correctly.
+
+   `Service BW2 Documentation <https://docs.typo3.org/p/jweiland/service-bw2/master/en-us/>`_
+   `Maps2 Documentation <https://docs.typo3.org/p/jweiland/maps2/master/en-us/>`_
+
+Extension configuration
+=======================
+
+rootCategory
+.............
+
+In each project record you have the possibility to add one or more areas of activity.
+In huge installations it's better to define a root category here to NOT show all categories.
+
+TypoScript configuration
+========================
+
+Use the constant editor and select tx_pfprojects to set those settings.
+
+Configure page ids for pfprojects plugin
+........................................
+
+You can configure the maps2 detail view target page, project detail page and service_bw2 detail page using the constants.
+
+Default storage pid
+...................
+
+Don't want to store all records at the plugin page? No problem, you can configure a custom storage page id (or storage folder)
+using the storagePid setting.
+
+Page browser
+............
+
+You can configure itemsPerPage, if the page browser should be inserted above and/or below and the maximum number of pages.

Documentation/Editor/Index.rst

@@ -0,0 +1,17 @@
+.. include:: ../Includes.txt
+
+.. _for-editors:
+
+===========
+For Editors
+===========
+
+Add a new "Project" record and fill in all the information.
+
+Connection to ext:service_bw2
+=============================
+
+By default you can choose one organizer record from Service BW. Later you can open the chosen organizer in the frontend.
+
+If you don't want a organizer record from service_bw2, then you can click that checkbox above the service_bw2 list and
+write that information manually using a text field.

Documentation/Includes.txt

@@ -0,0 +1,17 @@
+.. This is 'Includes.txt'. It is included at the very top of each and
+   every ReST source file in THIS documentation project (= manual).
+
+.. role:: aspect (emphasis)
+.. role:: html(code)
+.. role:: js(code)
+.. role:: php(code)
+.. role:: sep (strong)
+.. role:: sql(code)
+.. role:: typoscript(code)
+.. role:: yaml(code)
+
+.. role:: ts(typoscript)
+   :class: typoscript
+
+.. default-role:: code
+.. highlight:: php

Documentation/Index.rst

@@ -0,0 +1,65 @@
+.. every .rst file should include Includes.txt
+.. use correct path!
+
+.. include:: Includes.txt
+
+.. Every manual should have a start label for cross-referencing to
+.. start page. Do not remove this!
+
+.. _start:
+
+=============================================================
+pfprojects
+=============================================================
+
+:Version:
+   |release|
+
+:Language:
+   en
+
+:Authors:
+   Pascal Rinker
+
+:Email:
+   projects@jweiland.net
+
+:License:
+   This extension documentation is published under the
+   `CC BY-NC-SA 4.0 <https://creativecommons.org/licenses/by-nc-sa/4.0/>`__ (Creative Commons)
+   license
+
+This extension shows a list of projects and can be connected with service_bw2.
+
+**TYPO3**
+
+The content of this document is related to TYPO3 CMS,
+a GNU/GPL CMS/Framework available from `typo3.org <https://typo3.org/>`_ .
+
+**Community Documentation**
+
+This documentation is community documentation for the TYPO3 extension {extension.name}
+
+It is maintained as part of this third party extension.
+
+If you find an error or something is missing, please:
+`Report a Problem <https://github.com/TYPO3-Documentation/TYPO3CMS-Example-ExtensionManual/issues/new>`__
+
+**Extension Manual**
+
+This documentation is for the TYPO3 extension <extkey>.
+
+**For Contributors**
+
+You are welcome to help improve this guide.
+Just click on "Edit me on GitHub" on the top right to submit your change request.
+
+.. toctree::
+   :maxdepth: 3
+
+   Introduction/Index
+   Editor/Index
+   Installation/Index
+   Configuration/Index
+   Changelog/Index
+   Sitemap

Documentation/Installation/Index.rst

@@ -0,0 +1,17 @@
+.. include:: ../Includes.txt
+
+.. _installation:
+
+============
+Installation
+============
+
+Using composer
+..............
+
+Use `composer require jweiland/pfprojects` inside your TYPO3 project to get the extension. Then activate it using the TYPO3 Extension Manager.
+
+Using TER
+.........
+
+Open the Extension Manager in the backend, select "Get Extensions", update the extension list and search for pfprojects. Then press "Import and install".

Documentation/Introduction/Index.rst

@@ -0,0 +1,12 @@
+.. include:: ../Includes.txt
+
+.. _introduction:
+
+============
+Introduction
+============
+
+This extension shows a list of projects and can be connected with service_bw2. One project contains
+information like title, project status, project start, contact person, address data, a service_bw2 organizer record,
+some images, a description, some files and links. They can be filtered in frontend by project status and ordered by
+some other aspects.

Documentation/Settings.cfg

@@ -0,0 +1,95 @@
+# #####
+#
+# Settings.cfg - A TYPO3 Documentation Project's Configuration File
+# Information about Settings.cfg:
+#   https://docs.typo3.org/m/typo3/docs-how-to-document/master/en-us/GeneralConventions/DirectoryFilenames.html#settings-cfg
+#
+# About Syntax:
+#   See https://docs.python.org/2/library/configparser.html
+#
+# Attention:
+#   Only " ;" can start an inline comment.
+#   This is: blank PLUS semicolon!
+#
+# #####
+
+[general]
+
+# .................................................................................
+# ...   (required) title (displayed in left sidebar (desktop) or top panel (mobile)
+# .................................................................................
+
+project     = pfprojects
+
+# .................................................................................
+# ...   (recommended) version, displayed next to title (desktop) and in <meta name="book-version"
+# .................................................................................
+
+release     = 4.0.0
+
+# .................................................................................
+# ...  (recommended) displayed in footer
+# .................................................................................
+
+copyright   = by jweiland.net
+
+[html_theme_options]
+
+# .................................................................................
+# ...  (recommended) to get the "Edit me on Github Button"
+# .................................................................................
+
+github_branch        = master
+github_repository    = jweiland-net/pfprojects
+
+# .................................................................................
+# ...  (recommended) Fill in values to get links in the "Related Links" section
+# .................................................................................
+
+# usually an email address
+project_contact      = projects@jweiland.net
+
+# URL of online discussions, you can leave this blank
+project_discussions  =
+
+# URL of webpage of your extension (if it has one)
+project_home         = https://jweiland.net
+
+# URL to Issues
+project_issues       = https://github.com/jweiland-net/pfprojects/issues
+
+# URL of repository
+project_repository   = https://github.com/jweiland-net/pfprojects
+
+
+[intersphinx_mapping]
+
+# .................................................................................
+# for cross-referencing across manuals (intersphinx) with :ref:
+#
+# You must uncomment all manuals you use in your cross-references
+#
+# Example usage:
+#   :ref:`t3contribute:start` will link to start page of Contribution Guide
+# .................................................................................
+
+h2document    = https://docs.typo3.org/m/typo3/docs-how-to-document/master/en-us/
+# t3coreapi     = https://docs.typo3.org/m/typo3/reference-coreapi/master/en-us/
+# t3editors     = https://docs.typo3.org/m/typo3/tutorial-editors/master/en-us/
+# t3extbasebook = https://docs.typo3.org/m/typo3/book-extbasefluid/master/en-us/Index.html
+t3install     = https://docs.typo3.org/m/typo3/guide-installation/master/en-us/
+# t3l10n        = https://docs.typo3.org/m/typo3/guide-frontendlocalization/master/en-us/
+# t3start       = https://docs.typo3.org/m/typo3/tutorial-getting-started/master/en-us/
+# t3sitepackage = https://docs.typo3.org/m/typo3/tutorial-sitepackage/master/en-us/
+# t3tca         = https://docs.typo3.org/m/typo3/reference-tca/master/en-us/
+# t3templating  = https://docs.typo3.org/m/typo3/tutorial-templating-with-fluid/master/en-us/
+# t3ts45        = https://docs.typo3.org/m/typo3/tutorial-typoscript-in-45-minutes/master/en-us/
+# t3tsconfig    = https://docs.typo3.org/m/typo3/reference-tsconfig/master/en-us/
+t3tsref       = https://docs.typo3.org/m/typo3/reference-typoscript/master/en-us/
+
+[extensions]
+
+# This is required for embedding YouTube videos
+
+any_name_youtube = sphinxcontrib.youtube
+

Documentation/Sitemap.rst

@@ -0,0 +1,9 @@
+:template: sitemap.html
+
+.. _sitemap:
+
+=======
+Sitemap
+=======
+
+.. template 'sitemap.html' will insert the toctree as a sitemap here below normal contents

ext_emconf.php

@@ -2,7 +2,7 @@
 
 $EM_CONF[$_EXTKEY] = [
     'title' => 'PF Projects',
-    'description' => 'This extension shows a list of all masterplan projects of Pforzheim',
+    'description' => 'This extension shows a list of projects and can be connected with service_bw2.',
     'category' => 'plugin',
     'author' => 'Stefan Froemken',
     'author_email' => 'projects@jweiland.net',