[FEATURE] Move documentation to reStructuredText
authorChristian Futterlieb <christian@futterlieb.ch>
Mon, 23 Jun 2014 14:00:44 +0000 (16:00 +0200)
committerChristian Futterlieb <christian@futterlieb.ch>
Mon, 23 Jun 2014 14:00:44 +0000 (16:00 +0200)
Resolves: #59807
Release: master

Documentation/Administration/Index.rst [new file with mode: 0644]
Documentation/Configuration/DomainRecord/Index.rst [new file with mode: 0644]
Documentation/Configuration/ExtensionManager/Index.rst [new file with mode: 0644]
Documentation/Configuration/Index.rst [new file with mode: 0644]
Documentation/Includes.txt [new file with mode: 0644]
Documentation/Index.rst [new file with mode: 0644]
Documentation/Introduction/Index.rst [new file with mode: 0644]
Documentation/KnownProblems/Index.rst [new file with mode: 0644]

diff --git a/Documentation/Administration/Index.rst b/Documentation/Administration/Index.rst
new file mode 100644 (file)
index 0000000..c76d839
--- /dev/null
@@ -0,0 +1,121 @@
+.. ==================================================
+.. FOR YOUR INFORMATION
+.. --------------------------------------------------
+.. -*- coding: utf-8 -*- with BOM.
+
+.. include:: ../Includes.txt
+
+.. highlight:: typoscript
+
+
+==============================
+Administration
+==============================
+
+Installation
+==============================
+* Import and install the extension via extension manager
+
+Once installed the extension is already active. By default the 404 Page is a
+simple pure HTML template, that includes a title and a message with almost
+no styles.
+
+**Important:** If your default website language is not english, configure
+your default language code in the extension manager.
+
+Suggestions
+^^^^^^^^^^^
+
+* Optional you can make use of the third-party extension
+  `static_info_tables <http://typo3.org/extensions/repository/view/static_info_tables/current/>`_.
+* If you have a multilingual environment and
+  `realurl <http://typo3.org/extensions/repository/view/realurl/current/>`_
+  installed, also install extension
+  `realurl_force404lang <http://typo3.org/extensions/repository/view/realurl_force404lang/current/>`_
+  to make automatic language guessing work.
+  
+Available markers
+==============================
+
+In template files or in fetched pages, several markers will be replaced before
+outputting:
+
+
+
+.. ### BEGIN~OF~TABLE ###
+
+.. container:: table-row
+
+   Marker
+         ###TITLE###
+   
+   Data type
+         -
+   
+   Description
+         'page_title' from locallang_404.xml
+         
+
+.. container:: table-row
+
+   Marker
+         ###MESSAGE###
+   
+   Data type
+         -
+   
+   Description
+         'page_message' from locallang_404.xml
+         
+
+.. container:: table-row
+
+   Marker
+         ###REASON_TITLE###
+   
+   Data type
+         -
+   
+   Description
+         'reason_title' from locallang_404.xml
+         
+
+.. container:: table-row
+
+   Marker
+         ###REASON###
+   
+   Data type
+         -
+   
+   Description
+         From TYPO3 (autofilled)
+         
+
+.. container:: table-row
+
+   Marker
+         ###CURRENT_URL_TITLE###
+   
+   Data type
+         -
+   
+   Description
+         'current_url_title' from locallang_404.xml
+         
+
+.. container:: table-row
+
+   Marker
+         ###CURRENT_URL###
+   
+   Data type
+         -
+   
+   Description
+         From TYPO3 (autofilled)
+
+
+
+.. ###### END~OF~TABLE ######
+
diff --git a/Documentation/Configuration/DomainRecord/Index.rst b/Documentation/Configuration/DomainRecord/Index.rst
new file mode 100644 (file)
index 0000000..fbefb34
--- /dev/null
@@ -0,0 +1,72 @@
+.. ==================================================
+.. FOR YOUR INFORMATION
+.. --------------------------------------------------
+.. -*- coding: utf-8 -*- with BOM.
+
+
+.. include:: ../../Includes.txt
+
+.. highlight:: typoscript
+
+==============================
+Domain record configuration
+==============================
+
+This configuration is almost the same like in extension manager.
+Here are only the additional options or those which do not mean the
+same as in Extension Manager configuration.
+
+
+.. ### BEGIN~OF~TABLE ###
+
+.. container:: table-row
+
+   Property
+         Enable 404 handling configuration for this domain record
+   
+   Data type
+         boolean
+   
+   Description
+         It enables the possibility of a per-domain configuration. The default
+         setting (0) prevents, that every domain must be configured, when
+         per-domain config is enabled in the extension manager
+   
+   Default
+         0
+
+.. container:: table-row
+
+   Property
+         HTTP Forbidden header
+   
+   Data type
+         options
+   
+   Description
+         This option differs a little from extension manager config. There is
+         one additional option None to prevent sending headers even if a
+         special header is configured in extension manager. Default means
+         'act as configured in extension manager'.
+         
+         **Available options:**
+         
+         None (suppress config from extension manager)
+         
+         Default (as configured in extension manager)
+         
+         HTTP/1.1 400 Bad Request
+         
+         HTTP/1.1 401 Unauthorized
+         
+         HTTP/1.1 402 Payment Required
+         
+         HTTP/1.1 403 Forbidden
+   
+   Default
+         Default
+
+
+.. ###### END~OF~TABLE ######
+
+
diff --git a/Documentation/Configuration/ExtensionManager/Index.rst b/Documentation/Configuration/ExtensionManager/Index.rst
new file mode 100644 (file)
index 0000000..f59adef
--- /dev/null
@@ -0,0 +1,262 @@
+.. ==================================================
+.. FOR YOUR INFORMATION
+.. --------------------------------------------------
+.. -*- coding: utf-8 -*- with BOM.
+
+
+.. include:: ../../Includes.txt
+
+.. highlight:: typoscript
+
+================================
+Extension Manager configuration
+================================
+
+Go to the Extension Manager, find the extension pagenotfoundhandling and click
+on the extension name to open the configuration interface.
+
+.. ### BEGIN~OF~TABLE ###
+
+.. container:: table-row
+
+   Property
+         default404Page
+   
+   Data type
+         int
+   
+   Description
+         An uid of a page out of the page tree that will be displayed as
+         content of the 404 page. '0' disables this feature. See
+         3.1.3 Available Markers for details on marker substitution
+   
+   Default
+         0
+
+
+.. container:: table-row
+
+   Property
+         defaultTemplateFile
+   
+   Data type
+         string
+   
+   Description
+         This template will be used if no default404Page is configured.
+         See 3.1.3 Available Markers for details on marker substitution
+   
+   Default
+         EXT:pagenotfoundhandling/Resources/Private/Templates/default.html
+
+
+.. container:: table-row
+
+   Property
+         additional404GetParams
+   
+   Data type
+         string
+   
+   Description
+         These will be appended to the URL when fetching default404Page.
+         The marker::
+         
+           ###CURRENT_URL###
+         
+         is replaced within this string.
+   
+   Default
+         -
+
+.. container:: table-row
+
+   Property
+         default403Page
+   
+   Data type
+         int
+   
+   Description
+         Behaves like default404Page, but activates a separate handling for
+         requests on protected pages. Leave empty to disable this feature.
+   
+   Default
+         -
+
+.. container:: table-row
+
+   Property
+         default403TemplateFile
+   
+   Data type
+         string
+   
+   Description
+         Behaves like defaultTemplateFile, but activates a separate handling
+         for requests on protected pages. Leave empty to disable this feature.
+   
+   Default
+         -
+
+.. container:: table-row
+
+   Property
+         additional403GetParams
+   
+   Data type
+         string
+   
+   Description
+         These will be appended to the URL when fetching
+         default404Page/default403Page in case of access restriction error.
+         The marker::
+         
+           ###CURRENT_URL###
+         
+         is replaced within this string.
+   
+   Default
+         -
+
+.. container:: table-row
+
+   Property
+         default403Header
+   
+   Data type
+         options
+   
+   Description
+         Sent when a pages is not found because of access restrictions. Set to Default to prevent sending special headers.
+         
+         **Available options:**
+
+         Default (Do not send special headers)
+         
+         HTTP/1.1 400 Bad Request
+         
+         HTTP/1.1 401 Unauthorized
+         
+         HTTP/1.1 402 Payment Required
+         
+         HTTP/1.1 403 Forbidden
+   
+   Default
+           HTTP/1.1 403 Forbidden
+
+.. container:: table-row
+
+   Property
+         disableDomainConfig
+   
+   Data type
+         boolean
+   
+   Description
+         Domain dependent configurations will be ignored. The TCA of
+         sys_domains will not be extended.
+   
+   Default
+         0
+
+.. container:: table-row
+
+   Property
+         languageParam
+   
+   Data type
+         string
+   
+   Description
+         The _GET variable that holds the language uid. In most cases this will
+         be "L", which is the TYPO3 default.
+   
+   Default
+         L
+
+.. container:: table-row
+
+   Property
+         ignoreLanguage
+   
+   Data type
+         boolean
+   
+   Description
+         The language parameter in the request URL ($_GET['L']) will be
+         ignored, default language will be used. See option 'defaultLanguageKey'
+         also.
+   
+   Default
+         0
+
+.. container:: table-row
+
+   Property
+         defaultLanguageKey
+   
+   Data type
+         boolean
+   
+   Description
+         This tells the extension which language is your default language.
+         You can use values like 'de' for german, 'dk' for danish, etc..
+         Use this only if your default language is not english (TYPO3 default).
+         At the moment the extension only supports german and english, to use
+         your own language, see the option 'locallangFile' blow.
+   
+   Default
+         default
+
+.. container:: table-row
+
+   Property
+         forceLanguage
+   
+   Data type
+         int
+   
+   Description
+         This language is one from sys_language (the pid is shown in the
+         selector box). So, if you have no language records in your setup,
+         the selector box will be empty. If this option is used $_GET['L']
+         will be ignored.
+   
+   Default
+         -
+
+.. container:: table-row
+
+   Property
+         passthroughContentTypeHeader
+   
+   Data type
+         boolean
+   
+   Description
+         When a 404 page is defined, the HTTP header 'Content-Type' will be
+         captured and sent when delivering the 404 page
+   
+   Default
+         0
+
+.. container:: table-row
+
+   Property
+         additionalHeaders
+   
+   Data type
+         string
+   
+   Description
+         Send additional HTTP headers with the 404/403 page response.
+         Multiple headers are separated with '|'
+   
+   Default
+         -
+
+
+.. ###### END~OF~TABLE ######
+
+
diff --git a/Documentation/Configuration/Index.rst b/Documentation/Configuration/Index.rst
new file mode 100644 (file)
index 0000000..8708bc4
--- /dev/null
@@ -0,0 +1,26 @@
+.. ==================================================
+.. FOR YOUR INFORMATION
+.. --------------------------------------------------
+.. -*- coding: utf-8 -*- with BOM.
+
+.. include:: ../Includes.txt
+
+
+==============================
+Configuration
+==============================
+
+When no page has been found by TYPO3, there is no typoscript template available.
+Because of this the configuration of pagenotfoundhandling has to be done either
+in Extension Manager and/or within a domain record. This means:
+**There is no typoscript setup**.
+
+
+.. toctree::
+   :maxdepth: 5
+   :titlesonly:
+   :glob:
+
+   ExtensionManager/Index
+   DomainRecord/Index
+
diff --git a/Documentation/Includes.txt b/Documentation/Includes.txt
new file mode 100644 (file)
index 0000000..8ef89a7
--- /dev/null
@@ -0,0 +1,21 @@
+.. ==================================================
+.. 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 TEXT ROLES
+.. --------------------------------------------------
+
+.. role::   typoscript(code)
+
+.. role::   ts(typoscript)
+   :class:  typoscript
+
+.. role::   php(code)
+
+.. highlight:: php
diff --git a/Documentation/Index.rst b/Documentation/Index.rst
new file mode 100644 (file)
index 0000000..3ff093b
--- /dev/null
@@ -0,0 +1,63 @@
+.. ==================================================
+.. FOR YOUR INFORMATION
+.. --------------------------------------------------
+.. -*- coding: utf-8 -*- with BOM.
+
+.. include:: Includes.txt
+
+============================
+404 Page not found handling
+============================
+
+
+:Classification:
+      pagenotfoundhandling
+
+:Version:
+      2.0.0
+
+:Language:
+      en
+
+:Description:
+      This is the manual of the TYPO3 extension pagenotfoundhandling
+
+:Copyright:
+      2014
+
+:License:
+      This document is published under the Open Content License
+      available from http://www.opencontent.org/opl.shtml
+
+:Keywords:
+      404, 403, page not found handling, page unavailable handling, pageNotFound_handling 
+
+:Author:
+      Christian Futterlieb, `Agentur am Wasser | Maeder & Partner AG <http://web.agenturamwasser.ch>`_
+
+:Email:
+      development@agenturamwasser.ch
+      
+:Rendered:
+      |today|
+
+
+The content of this document is related to TYPO3, a GNU/GPL CMS/Framework
+available from `typo3.org <http://typo3.org/>`_.
+
+The extension pagenotfoundhandling is hosted on `TYPO3 forge
+<http://forge.typo3.org/projects/extension-pagenotfoundhandling>`_ and available through
+`TYPO3 Extension Repository (TER) <http://typo3.org/extensions/repository/view/pagenotfoundhandling>`_.
+
+**Table of Contents**
+
+.. toctree::
+   :maxdepth: 5
+   :titlesonly:
+   :glob:
+
+   Introduction/Index
+   Administration/Index
+   Configuration/Index
+   KnownProblems/Index
+
diff --git a/Documentation/Introduction/Index.rst b/Documentation/Introduction/Index.rst
new file mode 100644 (file)
index 0000000..221b9ed
--- /dev/null
@@ -0,0 +1,28 @@
+.. ==================================================
+.. FOR YOUR INFORMATION
+.. --------------------------------------------------
+.. -*- coding: utf-8 -*- with BOM.
+
+.. include:: ../Includes.txt
+
+==============================
+Introduction
+==============================
+
+
+Features
+==============================
+
+* Manage 404/403 errors thrown by TYPO3
+* Display user-defined contents in 404/403 case
+* Ready-to-use for simple TYPO3 installations, but it is configurable for many different use cases
+* Supports multi-domain systems
+* Supports multi-language systems
+
+
+Credits
+==============================
+
+Thanks to the `Agentur am Wasser <http://web.agenturamwasser.ch/>`_, our
+company, for giving us the possibility to realize this extension and share it
+with the TYPO3 community.
\ No newline at end of file
diff --git a/Documentation/KnownProblems/Index.rst b/Documentation/KnownProblems/Index.rst
new file mode 100644 (file)
index 0000000..2143c1a
--- /dev/null
@@ -0,0 +1,46 @@
+.. ==================================================
+.. FOR YOUR INFORMATION
+.. --------------------------------------------------
+.. -*- coding: utf-8 -*- with BOM.
+
+.. include:: ../Includes.txt
+
+==============================
+Known problems
+==============================
+
+
+With solution(s)
+==============================
+
+Extension realurl
+^^^^^^^^^^^^^^^^^
+
+At the moment the automatic language guessing does not work when the language
+parameter is translated with realurl.
+
+**Solution:**
+Install extension `realurl_force404lang <http://typo3.org/extensions/repository/view/realurl_force404lang/current/>`_
+if you have a multilingual environment with realurl.
+Make sure, you install realurl_force404lang **after** pagenotfoundhandling.
+Then - in extension manager configuration of realurl_force404lang - set the
+value of basic.pageNotFound_handling empty.
+
+
+Extension aeurltool
+^^^^^^^^^^^^^^^^^^^
+
+The extension aeurltool has a page not found handling too.
+
+**Solution:**
+To avoid conflicting 404 configurations, disable 'Use 404-Errorpage' in the
+backend module of aeurltool.
+
+Without solution(s)
+==============================
+
+Extension cooluri
+^^^^^^^^^^^^^^^^^
+
+With cooluri enabled, the extension does not work at all. Cooluri has its own
+404 handling and won't report back to TypoScriptFrontendController
\ No newline at end of file