[DOCS] Update documentation (#23)

Documentation/Changelog/Index.rst

@@ -0,0 +1,24 @@
+.. include:: /Includes.rst.txt
+
+.. _changelog:
+
+=========
+Changelog
+=========
+
+.. important::
+
+   We list only the important changes here
+   (specifically breaking changes).
+   For more changes, please see the respective release notes and commit messages
+   in the GitHub repository: https://github.com/sypets/page_callouts
+
+
+3.x.x
+=====
+
+.. toctree::
+   :glob:
+   :titlesonly:
+
+   Entries/4.x/*

README.rst → Documentation/ForDevelopers/Index.rst

@@ -1,18 +1,9 @@
-Why this extension?
-===================
-
-Informational, warning and error messages are displayed as "callouts"
-in the page module for various reasons, for example:
-
-*  info message if page is of type folder
-*  warning message if there are elements with an invalid colpos
-   ("unused elements")
-*  a page was defined as a shortcut, but has a missing target
+.. include:: /Includes.rst.txt
 
-However, it is not easily possible for extensions to add callouts of
-their own.
 
-This extension provides a hook to add additional messages.
+==============
+For Developers
+==============
 
 How it works
 ============

Documentation/Includes.rst.txt

@@ -0,0 +1,34 @@
+.. ==================================================
+.. FOR YOUR INFORMATION
+.. --------------------------------------------------
+.. -*- coding: utf-8 -*- with BOM.
+
+.. This is 'Includes.rst.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:: bash(code)
+.. role:: html(code)
+.. role:: js(code)
+.. role:: php(code)
+.. role:: rst(code)
+.. role:: sep(strong)
+.. role:: sql(code)
+.. role:: ts(code)
+  :class: typoscript
+
+.. role:: tsconfig(code)
+  :class: typoscript
+
+.. role:: typoscript(code)
+.. role:: xml(code)
+  :class: html
+
+.. role:: yaml(code)
+
+.. highlight:: php

Documentation/Index.rst

@@ -0,0 +1,57 @@
+.. include:: /Includes.rst.txt
+
+.. _start:
+
+=================
+Broken Link Fixer
+=================
+
+:Extension key:
+      page_callouts
+
+:Version:
+      |release|
+
+:Language:
+      en
+
+:Author:
+      Sybille Peters
+
+:License:
+      Open Content License available from `www.opencontent.org/opl.shtml
+      <http://www.opencontent.org/opl.shtml>`_
+
+----
+
+This is a TYPO3 extension which adds some features to the page module. It
+was originally intended to be used along with EXT:brofix, but the features
+are also available in combination with other extension.
+
+page_callouts makes the following available:
+
+1. Hooking into the page layout module in order to show additional informational
+   messages (used by brofix)
+
+2. Show a close button in the page layout module in case it was called from
+   another module with the parameter "returnUrl" - in this case we should return
+   to this module via the returnUrl on close. This will also be used by brofix.
+
+----
+
+The content of this document is related to TYPO3, a GNU/GPL CMS/Framework
+available from `www.typo3.org <https://www.typo3.org/>`_
+
+----
+
+
+.. toctree::
+   :maxdepth: 1
+   :titlesonly:
+
+   Introduction/Index
+   Installation/Index
+   ForDevelopers/Index
+   Changelog/Index
+   Sitemap
+

Documentation/Installation/Index.rst

@@ -0,0 +1,7 @@
+.. include:: /Includes.rst.txt
+
+============
+Installation
+============
+
+Install the same as any other extension.

Documentation/Introduction/Index.rst

@@ -0,0 +1,22 @@
+.. include:: /Includes.rst.txt
+
+.. _introduction:
+
+============
+Introduction
+============
+
+
+.. _what-does-it-do:
+
+What does it do?
+================
+
+page_callouts makes the following available:
+
+1. Hooking into the page layout module in order to show additional informational
+   messages (used by brofix)
+
+2. Show a close button in the page layout module in case it was called from
+   another module with the parameter "returnUrl" - in this case we should return
+   to this module via the returnUrl on close. This will also be used by brofix.

Documentation/Sitemap.rst

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

README.md

@@ -0,0 +1,21 @@
+[![TYPO3 11](https://img.shields.io/badge/TYPO3-11-orange.svg)](https://get.typo3.org/version/11)
+[![TYPO3 12](https://img.shields.io/badge/TYPO3-12-orange.svg)](https://get.typo3.org/version/12)
+[![CI Status](https://github.com/sypets/page_callouts/workflows/CI/badge.svg)](https://github.com/sypets/page_callouts/actions)
+[![Downloads](https://img.shields.io/packagist/dt/sypets/page_callouts)](https://packagist.org/packages/sypets/page_callouts)
+
+# TYPO3 extension `page_callouts`
+
+page_callouts makes the following available:
+
+1. Hooking into the page layout module in order to show additional informational
+   messages (used by brofix)
+
+2. Show a close button in the page layout module in case it was called from
+   another module with the parameter "returnUrl" - in this case we should return
+   to this module via the returnUrl on close. This will also be used by brofix.
+
+|                  | URL                                                       |
+|------------------|-----------------------------------------------------------|
+| **Repository:**  | https://github.com/page_callouts/brofix                   |
+| **Read online:** | https://docs.typo3.org/p/sypets/page_callouts/main/en-us/ |
+| **TER:**         | https://extensions.typo3.org/extension/page_callouts      |