[TASK] move changelog documentation

Cleanup and update documentation Resolves: #35
extcode · Apr 29, 2019 · a9621d0 · a9621d0
1 parent 221cba8
commit a9621d0
Show file tree

Hide file tree

Showing 22 changed files with 66 additions and 244 deletions.
diff --git a/ChangeLog b/ChangeLog
diff --git a/Documentation/AdministratorManual/Configuration/Index.rst b/Documentation/AdministratorManual/Configuration/Index.rst
@@ -1,7 +1,4 @@
-.. ==================================================
-.. FOR YOUR INFORMATION
-.. --------------------------------------------------
-.. -*- coding: utf-8 -*- with BOM.
+.. include:: ../../Includes.txt
 
 Configuration
 =============
diff --git a/Documentation/AdministratorManual/Index.rst b/Documentation/AdministratorManual/Index.rst
@@ -1,7 +1,4 @@
-.. ==================================================
-.. FOR YOUR INFORMATION
-.. --------------------------------------------------
-.. -*- coding: utf-8 -*- with BOM.
+.. include:: ../Includes.txt
 
 Administrator Manual
 ====================

diff --git a/Documentation/AdministratorManual/Installation/Index.rst b/Documentation/AdministratorManual/Installation/Index.rst
@@ -1,7 +1,4 @@
-.. ==================================================
-.. FOR YOUR INFORMATION
-.. --------------------------------------------------
-.. -*- coding: utf-8 -*- with BOM.
+.. include:: ../../Includes.txt
 
 Installation
 ============

diff --git a/Documentation/Changelog/2.0/Index.rst b/Documentation/Changelog/2.0/Index.rst
@@ -0,0 +1,6 @@
+.. include:: ../../Includes.txt
+
+2.0 Changes
+===========
+
+The version 2.0.0 is a release for TYPO3 v8.7 only and skipped for TYPO3 v9.5. `3.0 Changes <../3.0/Index.html>`_.
diff --git a/Documentation/Changelog/3.0/Index.rst b/Documentation/Changelog/3.0/Index.rst
@@ -0,0 +1,6 @@
+.. include:: ../../Includes.txt
+
+3.0 Changes
+===========
+
+This is the initial release of cart_events for TYPO3 v9.5. It is part of the cart extension.
diff --git a/Documentation/Changelog/Index.rst b/Documentation/Changelog/Index.rst
@@ -0,0 +1,11 @@
+.. include:: ../Includes.txt
+
+ChangeLog
+=========
+
+.. toctree::
+   :maxdepth: 5
+   :titlesonly:
+
+   3.0/Index
+   2.0/Index
diff --git a/Documentation/DeveloperManual/Index.rst b/Documentation/DeveloperManual/Index.rst
diff --git a/Documentation/EditorManual/Index.rst b/Documentation/EditorManual/Index.rst
diff --git a/Documentation/Images/contacts_logo.png b/Documentation/Images/contacts_logo.png
diff --git a/Documentation/Includes.txt b/Documentation/Includes.txt
@@ -1,18 +1,20 @@
-.. ==================================================
-.. FOR YOUR INFORMATION
-.. --------------------------------------------------
-.. -*- coding: utf-8 -*- with BOM.
+.. This is 'Includes.txt'. It is included at the very top of each and
+   every ReST source file in THIS documentation project (= manual).
 
-.. ==================================================
-.. DEFINE SOME TEXTROLES
-.. --------------------------------------------------
+.. role:: aspect (emphasis)
+.. role:: html(code)
+.. role:: js(code)
+.. role:: php(code)
+.. role:: typoscript(code)
+.. role:: typescript(code)
+.. role:: shell(code)
+.. role:: sql(code)
+.. role:: yaml(code)
 
-.. role::   typoscript(code)
+.. role:: ts(typoscript)
+   :class: typoscript
+.. role:: javascript(js)
+   :class: js
 
-.. role::   ts(typoscript)
-   :class:  typoscript
-
-.. role::   php(code)
-   :language: php
-
-.. highlight:: php
+.. default-role:: code
+.. highlight:: php
diff --git a/Documentation/Index.rst b/Documentation/Index.rst
@@ -1,8 +1,3 @@
-.. ==================================================
-.. FOR YOUR INFORMATION
-.. --------------------------------------------------
-.. -*- coding: utf-8 -*- with BOM.
-
 .. include:: Includes.txt
 
 .. _start:
@@ -29,7 +24,7 @@ EXT: Contacts
 
    :Description:
       Contacts is a TYPO3 extension for handling contacts (companies, persons).
-      People and companies can be related to each other.
+      Persons and companies can be related to each other.
       Both can have multiple addresses and other contact data.
 
    :Keywords:
@@ -58,7 +53,5 @@ EXT: Contacts
     :titlesonly:
 
     Introduction/Index
-    EditorManual/Index
-    DeveloperManual/Index
     AdministratorManual/Index
-    Misc/Index
+    Changelog/Index
diff --git a/Documentation/Introduction/Index.rst b/Documentation/Introduction/Index.rst
@@ -1,13 +1,10 @@
-.. ==================================================
-.. FOR YOUR INFORMATION
-.. --------------------------------------------------
-.. -*- coding: utf-8 -*- with BOM.
+.. include:: ../Includes.txt
 
 Introduction
 ------------
 
 Contacts is a TYPO3 extension for handling contacts (companies, persons).
-People and companies can be related to each other.
+Persons and companies can be related to each other.
 Both can have multiple addresses and other contact data.
 
 .. toctree::

diff --git a/Documentation/Introduction/NoteOfThanks/Index.rst b/Documentation/Introduction/NoteOfThanks/Index.rst
@@ -1,7 +1,4 @@
-.. ==================================================
-.. FOR YOUR INFORMATION
-.. --------------------------------------------------
-.. -*- coding: utf-8 -*- with BOM.
+.. include:: ../../Includes.txt
 
 Note of thanks
 ==============
diff --git a/Documentation/Introduction/Sponsoring/Index.rst b/Documentation/Introduction/Sponsoring/Index.rst
@@ -1,7 +1,4 @@
-.. ==================================================
-.. FOR YOUR INFORMATION
-.. --------------------------------------------------
-.. -*- coding: utf-8 -*- with BOM.
+.. include:: ../../Includes.txt
 
 Sponsoring
 ==========

diff --git a/Documentation/Introduction/Support/Index.rst b/Documentation/Introduction/Support/Index.rst
@@ -1,7 +1,4 @@
-.. ==================================================
-.. FOR YOUR INFORMATION
-.. --------------------------------------------------
-.. -*- coding: utf-8 -*- with BOM.
+.. include:: ../../Includes.txt
 
 Support
 =======

diff --git a/Documentation/Misc/Changelog/Index.rst b/Documentation/Misc/Changelog/Index.rst
diff --git a/Documentation/Misc/Index.rst b/Documentation/Misc/Index.rst
diff --git a/Documentation/Misc/Todos/Index.rst b/Documentation/Misc/Todos/Index.rst
diff --git a/Documentation/Settings.cfg b/Documentation/Settings.cfg
@@ -1,10 +1,10 @@
 [general]
 
 project     = Contacts
-version     = 1.0
-release     = 1.0.0-pre
+version     = 2.0
+release     = 2.0.0
 t3author    = Daniel Gohlke
-copyright   = 2015-2018
+copyright   = 2018-2021
 
 description =
 

diff --git a/Documentation/Settings.yml b/Documentation/Settings.yml
@@ -0,0 +1,10 @@
+# This is the project specific Settings.yml file.
+# Place Sphinx specific build information here.
+# Settings given here will replace the settings of 'conf.py'.
+
+---
+conf.py:
+  copyright: 2018-2021
+  project: Contacts
+  version: 2.0
+  release: 2.0.0
diff --git a/README.md b/README.md
@@ -4,14 +4,12 @@
 [![Codacy Badge](https://api.codacy.com/project/badge/Grade/0e71b0ff657e475f8b4af581e13ce3b8)](https://www.codacy.com/app/extcode/contacts?utm_source=github.com&amp;utm_medium=referral&amp;utm_content=extcode/contacts&amp;utm_campaign=Badge_Grade)
 
 Contacts is a TYPO3 extension for handling contacts (companies, persons).
-People and companies can be related to each other.
-Both can have multiple addresses and other contact data.
 
 ## 1. Features
 
--
--
--
+- Persons and companies can be related to each other.
+- Both can have multiple addresses and other contact data.
+- Addresses can hold geolocation data to display them in maps.
 
 ## 2. Installation / Upgrade