[DOCS]: Add first documentation

Documentation/Changelog/Index.rst

@@ -0,0 +1,12 @@
+.. include:: ../Includes.txt
+
+.. _changelog:
+
+==========
+Change log
+==========
+
+Version 1.0.0
+-------------
+
+Use this chapter to inform users of your extension about changes you made with each released version.

Documentation/Configuration/Index.rst

@@ -0,0 +1,50 @@
+.. include:: ../Includes.txt
+
+.. _configuration:
+
+=============
+Configuration
+=============
+
+How is the extension configured?
+Aim to provide simple instructions detailing how the extension is configured.
+Always assume that the user has no prior experience of using the extension.
+
+Try and provide a typical use case for your extension
+and detail each of the steps required to get the extension running.
+
+Typical Example
+===============
+
+- Does the integrator need to include a static template?
+- For example add a code snippet with comments
+
+Minimal example of TypoScript:
+
+- Code-blocks have support for syntax highlighting
+- Use any supported language
+
+.. code-block:: typoscript
+
+   plugin.tx_myextension.settings {
+      # configure basic email settings
+      email {
+         subject = Some subject
+         from = [email protected]
+      }
+   }
+
+.. _configuration-typoscript:
+
+TypoScript Reference
+====================
+
+Possible subsections: Reference of TypoScript options.
+The construct below show the recommended structure for TypoScript properties listing and description.
+
+When detailing data types or standard TypoScript features,
+don't hesitate to cross-link to the TypoScript Reference as shown below.
+
+See :ref:`h2document:how-to-document-hyperlinks` for information about how to use cross-references.
+
+See the :file:`Settings.cfg` file for the declaration of cross-linking keys.

Documentation/Developer/Index.rst

@@ -0,0 +1,38 @@
+.. include:: ../Includes.txt
+
+.. _developer:
+
+================
+Developer Corner
+================
+
+Use this section to provide examples of code or detail any information that would be deemed relevant to a developer.
+
+For example explain how a certain feature was implemented.
+
+
+.. _developer-api:
+
+API
+===
+
+How to use the API...
+
+.. code-block:: php
+
+   $stuff = \TYPO3\CMS\Core\Utility\GeneralUtility::makeInstance(
+      '\\Foo\\Bar\\Utility\\Stuff'
+   );
+   $stuff->do();
+
+or in some other language:
+
+.. code-block:: javascript
+   :linenos:
+   :emphasize-lines: 2-4
+
+   $(document).ready(
+      function () {
+         doStuff();
+      }
+   );

Documentation/Editor/Index.rst

@@ -0,0 +1,50 @@
+.. include:: ../Includes.txt
+
+.. _for-editors:
+
+===========
+For Editors
+===========
+
+How to use the extension from the perspective of an editor.
+
+Think of common tasks that an editor is likely to perform:
+
+- How do they complete them?
+- What problems are they likely to encounter?
+- What access do they require?
+- What configuration options are available to them?
+
+One example could be adding a frontend plugin to a page and then configuring it.
+
+Language should be non-technical, aim to avoid using acronyms where possible.
+
+Be mindful that editors typically don't have administrative access to the installation.
+
+.. tip::
+
+   Take a break from time to time.
+
+Admonitions should be used to warn the users about potential pitfalls.
+Attract their attention to important elements,
+or add some notes for for information (further reading, for example).
+
+Do not overuse admonitions like notes, important, etc.!
+
+Provide screenshots as needed for making things clear.
+When creating screenshots, try using the Official Introduction Package.
+
+.. figure:: ../Images/UserManual/BackendView.png
+   :class: with-shadow
+   :alt: Backend view
+
+   Default Backend view (caption of the image)
+
+Do not use huge full-screen images, unless it is necessary and serves a good purpose.
+
+.. _editor-faq:
+
+FAQ
+===
+
+Possible subsection: FAQ

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,67 @@
+.. 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:
+
+=============================================================
+SKom-Sitepackage
+=============================================================
+
+:Version:
+   |9.3.0|
+
+:Language:
+   en
+
+:Authors:
+   Sven Kalbhenn
+
+:Email:
+   [email protected]
+
+: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
+
+Basic TYPO3 sitepackage based on bootstrap_package.
+
+**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 SKom-Sitepackage
+
+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/Starraider/skom_sitepackage/issues/new>`__
+
+**Extension Manual**
+
+This documentation is for the TYPO3 extension skom_sitepackage.
+
+**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
+   Developer/Index
+   KnownProblems/Index
+   Changelog/Index
+   Sitemap

Documentation/Installation/Index.rst

@@ -0,0 +1,41 @@
+.. include:: ../Includes.txt
+
+.. _installation:
+
+============
+Installation
+============
+
+Installation Type
+=================
+
+Composer
+""""""""
+
+You can install skom_sitepackage with following shell command:
+
+.. code-block:: bash
+
+   composer req skom/skom-sitepackage
+
+Extensionmanager
+""""""""""""""""
+
+If you want to install skom_sitepackage traditionally with Extensionmanager, follow these steps:
+
+#. Visit ExtensionManager
+
+#. Switch over to `Get Extensions`
+
+#. Search for `skom_sitepackage`
+
+#. Install extension
+
+DEV Version (GIT)
+"""""""""""""""""
+
+You can install the latest DEV Version with following GIT command:
+
+.. code-block:: bash
+
+   git clone https://github.com/Starraider/skom_sitepackage.git

Documentation/Introduction/Index.rst

@@ -0,0 +1,62 @@
+.. include:: ../Includes.txt
+
+.. _introduction:
+
+============
+Introduction
+============
+
+.. _what-it-does:
+
+What does it do?
+================
+
+This extension some additional configurations and functions to the extension bootstrap_package.
+
+*  Language menu in the navbar
+*  Adds Klaro cookie banner
+*  A lot of templates and configuration for tx_news:
+
+   *  List-View
+
+      *  Image left
+      *  Image right
+      *  Image top
+      *  No Image
+      *  Card left
+      *  Card right
+
+   *  Detail-View:
+
+      *  Configuration for Lightbox Images
+      *  Galery left
+      *  Galery right
+      *  Galery bottom
+      *  Floating Galery left
+      *  Floating Galery right
+
+*  Adds some templates for the container extension:
+
+   *  section-container
+   *  2-col container
+   *  2-col-left container
+   *  2-col-right container
+   *  3-col container
+   *  4-col container
+
+.. _screenshots:
+
+Screenshots
+===========
+
+This chapter should help people understand how the extension works.
+Remove it if it is not relevant.
+
+.. figure:: ../Images/IntroductionPackage.png
+   :class: with-shadow
+   :alt: Introduction Package
+   :width: 300px
+
+   Introduction Package after installation (caption of the image).
+
+How the Frontend of the Introduction Package looks like after installation (legend of the image).

Documentation/KnownProblems/Index.rst

@@ -0,0 +1,9 @@
+.. include:: ../Includes.txt
+
+.. _known-problems:
+
+==============
+Known Problems
+==============
+
+Use this section for informing about any type of of problem.