add Documentation fixes

franzholz · Dec 1, 2023 · a23b87c · a23b87c
1 parent 80ddbc0
commit a23b87c
Show file tree

Hide file tree

Showing 18 changed files with 139 additions and 306 deletions.
diff --git a/ChangeLog b/ChangeLog
@@ -1,4 +1,7 @@
 
+2023-12-01 Franz Holzinger  <[email protected]>
+    * add Documentation fixes
+
 2023-11-22 Franz Holzinger  <[email protected]>
     * remove Classes/Hooks/CmsBackend.php, because this has been replaced already by the PageContentPreviewRenderingListener.
 

diff --git a/Classes/Middleware/FrontendHooks.php b/Classes/Middleware/FrontendHooks.php
@@ -31,7 +31,7 @@
 class FrontendHooks implements MiddlewareInterface
 {
     /**
-     * Hook to store the current basket
+     * Hook to initialize the current captcha
      *
      * @param ServerRequestInterface $request
      * @param RequestHandlerInterface $handler

diff --git a/Documentation/Administrator/Index.rst b/Documentation/Administrator/Index.rst
@@ -1,4 +1,4 @@
-.. include:: ../Includes.txt
+.. include:: ../Includes.rst.txt
 
 
 .. _admin-manual:
@@ -19,7 +19,7 @@ Prerequisites
 
 Some of the TypoScript settings do not function via the constants field, but must be entered in the 
 setup field. Only those settings which can be found using the Constants Editor or in the file 
-:file:`Configuration/TypoScript/Default/constants.txt` are valid constants. You must 
+:file:`Configuration/TypoScript/Default/constants.typoscript` are valid constants. You must 
 include the “Message Board Setup” into your “include static from extensions” of your TYPO3 template 
 setup. The “Message Board CSS styles“ are not required. They provide default CSS styles for the forum.
 
@@ -63,7 +63,8 @@ Other configuration
   This other option is for all the rest...
 
 
-.. figure:: ../Images/AdministratorManual/ExtensionManager.png
+.. figure:: /Images/AdministratorManual/ExtensionManager.png
+   :width: 700px
    :alt: Extension Manager
 
    Extension Manager
@@ -144,8 +145,9 @@ Example Setup
 You must alternatively use :code:`plugin.tt_board_tree` for the tree type forum. :code:`plugin.tt_board_list` is only used for the list type forum.
 
 
-.. figure:: ../Images/AdministratorManual/PrivacyPolicy.png
-   :alt: Privacy Policy
+.. figure:: /Images/AdministratorManual/PrivacyPolicy.png
+    :width: 700px
+    :alt: Privacy Policy
 
    Override the language texts for the Privacy Policy
 

diff --git a/Documentation/ChangeLog/Index.rst b/Documentation/ChangeLog/Index.rst
@@ -1,4 +1,4 @@
-.. include:: ../Includes.txt
+.. include:: ../Includes.rst.txt
 
 
 .. _changelog:

diff --git a/Documentation/Configuration/Index.rst b/Documentation/Configuration/Index.rst
@@ -1,4 +1,4 @@
-.. include:: ../Includes.txt
+.. include:: ../Includes.rst.txt
 
 
 .. _configuration:

diff --git a/Documentation/Developer/Index.rst b/Documentation/Developer/Index.rst
@@ -1,4 +1,4 @@
-.. include:: ../Includes.txt
+.. include:: ../Includes.rst.txt
 
 
 .. _developer:

diff --git a/Documentation/Includes.rst.txt b/Documentation/Includes.rst.txt
@@ -0,0 +1,34 @@
+..  More information about this file:
+    https://docs.typo3.org/m/typo3/docs-how-to-document/main/en-us/GeneralConventions/FileStructure.html#includes-rst-txt
+
+..  ----------
+..  text roles
+..  ----------
+
+..  role:: aspect(emphasis)
+..  role:: bash(code)
+..  role:: html(code)
+..  role:: js(code)
+..  role:: php(code)
+..  role:: rst(code)
+..  role:: sep(strong)
+..  role:: sql(code)
+
+..  role:: tsconfig(code)
+    :class: typoscript
+
+..  role:: typoscript(code)
+..  role:: xml(code)
+    :class: html
+
+..  role:: yaml(code)
+
+..  default-role:: code
+
+..  ---------
+..  highlight
+..  ---------
+
+..  By default, code blocks use PHP syntax highlighting
+
+..  highlight:: php
diff --git a/Documentation/Includes.txt b/Documentation/Includes.txt
diff --git a/Documentation/Index.rst b/Documentation/Index.rst
@@ -1,4 +1,9 @@
-.. include:: Includes.txt
+.. ==================================================
+.. FOR YOUR INFORMATION
+.. --------------------------------------------------
+.. -*- coding: utf-8 -*- with BOM.
+
+.. include:: Includes.rst.txt
 
 
 .. _start:
@@ -7,41 +12,43 @@
 Message board, twin mode
 =============================================================
 
-.. only:: html
+:Extension key:
+   tt_board
+
+:Package name:
+   jambagecom/tt-board
 
-	:Classification:
-		tt_board
+:Version:
+   |release|
 
-	:Version:
-		|release|
+:Language:
+   en
 
-	:Language:
-		en
+:Description:
+   Simple threaded (tree) or list message board (forum).
 
-	:Description:
-		Manual covering TYPO3 extension tt_board
+:Keywords:
+   translation pack
 
-	:Keywords:
-		forum,message,board
+:Copyright:
+   2006
 
-	:Copyright:
-		2019
+:Author:
+   Franz Holzinger
 
-	:Author:
-		Franz Holzinger
+:Email:
+   [email protected]
 
-	:Email:
-		[email protected]
+:License:
+   This document is published under the
+   `Open Content License <https://www.openhub.net/licenses/opl>`__.
 
-	:License:
-		This document is published under the Open Publication License
-		available from http://www.opencontent.org/openpub/
+   The content of this document is related to TYPO3,
+   a GNU/GPL CMS/Framework available from `www.typo3.org <https://www.typo3.org/>`_.
 
-	:Rendered:
-		|today|
+:Rendered:
+   |today|
 
-	The content of this document is related to TYPO3,
-	a GNU/GPL CMS/Framework available from `www.typo3.org <https://typo3.org/>`__.
 
 
 	**Table of Contents**

diff --git a/Documentation/Introduction/Index.rst b/Documentation/Introduction/Index.rst
@@ -1,4 +1,4 @@
-.. include:: ../Includes.txt
+.. include:: ../Includes.rst.txt
 
 
 .. _introduction:
@@ -36,15 +36,15 @@ Screenshots
 
 List type forum:
 ^^^^^^^^^^^^^^^^
-.. figure:: ../Images/Introduction/ListType.png
+.. figure:: /Images/Introduction/ListType.png
    :width: 500px
    :alt: list type forum
 
    The forum topics and entries are listed in a table format.
 
 Tree type forum:
 ^^^^^^^^^^^^^^^^
-.. figure:: ../Images/Introduction/TreeType.png
+.. figure:: /Images/Introduction/TreeType.png
    :width: 500px
    :alt: tree type forum
 

diff --git a/Documentation/KnownProblems/Index.rst b/Documentation/KnownProblems/Index.rst
@@ -1,4 +1,4 @@
-.. include:: ../Includes.txt
+.. include:: ../Includes.rst.txt
 
 
 .. _known-problems:

diff --git a/Documentation/Links.rst b/Documentation/Links.rst
@@ -1,4 +1,4 @@
-.. include:: Includes.txt
+.. include:: Includes.rst.txt
 
 
 .. _links:

diff --git a/Documentation/Localization.de_DE.tmpl/Index.rst b/Documentation/Localization.de_DE.tmpl/Index.rst
diff --git a/Documentation/Localization.de_DE.tmpl/README b/Documentation/Localization.de_DE.tmpl/README