[TASK] Cleanup documentation
authorChristian Futterlieb <christian@futterlieb.ch>
Thu, 16 Jun 2016 21:59:20 +0000 (23:59 +0200)
committerChristian Futterlieb <christian@futterlieb.ch>
Thu, 16 Jun 2016 22:23:22 +0000 (00:23 +0200)
* Add references and reference links
* Add inline code
* Remove whitespaces

Documentation/Administration/Index.rst
Documentation/Configuration/DomainRecord/Index.rst
Documentation/Configuration/ExtensionManager/Index.rst
Documentation/Configuration/Index.rst
Documentation/Index.rst
Documentation/Introduction/Index.rst
Documentation/KnownProblems/Index.rst

index e943990..e975bfe 100644 (file)
@@ -5,16 +5,18 @@
 
 .. include:: ../Includes.txt
 
-.. highlight:: typoscript
-
+.. _section-administration:
 
 ==============================
 Administration
 ==============================
 
+.. _section-installation:
+
 Installation
 ==============================
-* Import and install the extension via extension manager
+
+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
@@ -29,6 +31,7 @@ Suggestions
 * Optional you can make use of the third-party extension
   `static_info_tables <http://typo3.org/extensions/repository/view/static_info_tables/current/>`_.
 
+.. _section-available-markers:
 
 Available markers
 ==============================
@@ -44,74 +47,54 @@ outputting:
 
    Marker
          ###TITLE###
-   
-   Data type
-         -
-   
+
    Description
-         'page_title' from locallang_404.xml
-         
+         ``page_title`` from locallang_404.xml
+
 
 .. container:: table-row
 
    Marker
          ###MESSAGE###
-   
-   Data type
-         -
-   
+
    Description
-         'page_message' from locallang_404.xml
-         
+         ``page_message`` from locallang_404.xml
+
 
 .. container:: table-row
 
    Marker
          ###REASON_TITLE###
-   
-   Data type
-         -
-   
+
    Description
-         'reason_title' from locallang_404.xml
-         
+         ``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
+         ``current_url_title`` from locallang_404.xml
          
 
 .. container:: table-row
 
    Marker
          ###CURRENT_URL###
-   
-   Data type
-         -
-   
+
    Description
          From TYPO3 (autofilled)
 
 
-
 .. ###### END~OF~TABLE ######
-
index fbefb34..5ab0ee1 100644 (file)
@@ -3,18 +3,17 @@
 .. --------------------------------------------------
 .. -*- coding: utf-8 -*- with BOM.
 
-
 .. include:: ../../Includes.txt
 
-.. highlight:: typoscript
+.. _section-domain-record-configuration:
 
-==============================
+===========================
 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.
+This configuration is almost the same as in
+:ref:`section-extension-manager-configuration`. The described options either
+differ from Extension Manager configuration or are only available here.
 
 
 .. ### BEGIN~OF~TABLE ###
@@ -23,15 +22,15 @@ same as in Extension Manager configuration.
 
    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
 
@@ -39,34 +38,27 @@ same as in Extension Manager configuration.
 
    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
-   
+
+         * 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 ######
-
-
index 9b484be..bb73ddd 100644 (file)
@@ -6,30 +6,43 @@
 
 .. include:: ../../Includes.txt
 
-.. highlight:: typoscript
+.. _section-extension-manager-configuration:
 
-================================
+===============================
 Extension Manager configuration
-================================
+===============================
 
 Go to the Extension Manager, find the extension pagenotfoundhandling and click
 on the extension name to open the configuration interface.
 
+The available options are structured in four groups:
+
+* :ref:`section-basic-options`
+* :ref:`section-advanced-options`
+* :ref:`section-language-options`
+* :ref:`section-http-options`
+
+
+.. _section-basic-options:
+
+Basic options
+=============
+
 .. ### 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
-   
+         content of the 404 page. '0' disables this feature. See section
+         :ref:`section-available-markers` for details on marker substitution
+
    Default
          0
 
@@ -38,34 +51,31 @@ on the extension name to open the configuration interface.
 
    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
-   
+         This template will be used if no ``default404Page`` is configured.
+         See section :ref:`section-available-markers` for details on marker
+         substitution
+
    Default
-         EXT:pagenotfoundhandling/Resources/Private/Templates/default.html
+         `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.
-   
+         These will be appended to the URL when fetching ``default404Page``.
+         The marker ``###CURRENT_URL###`` is replaced within this string.
+
    Default
          -
 
@@ -73,14 +83,14 @@ on the extension name to open the configuration interface.
 
    Property
          default403Page
-   
+
    Data type
          int
-   
+
    Description
-         Behaves like default404Page, but activates a separate handling for
+         Behaves like ``default404Page``, but activates a separate handling for
          requests on protected pages. Leave empty to disable this feature.
-   
+
    Default
          -
 
@@ -88,14 +98,14 @@ on the extension name to open the configuration interface.
 
    Property
          default403TemplateFile
-   
+
    Data type
          string
-   
+
    Description
-         Behaves like defaultTemplateFile, but activates a separate handling
+         Behaves like ``defaultTemplateFile``, but activates a separate handling
          for requests on protected pages. Leave empty to disable this feature.
-   
+
    Default
          -
 
@@ -103,75 +113,80 @@ on the extension name to open the configuration interface.
 
    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.
-   
+         ``default404Page``/``default403Page`` in case of access restriction
+         error. The marker ``###CURRENT_URL###`` is replaced within this string.
+
    Default
          -
 
+.. ###### END~OF~TABLE ######
+
+.. _section-advanced-options:
+
+Advanced options
+================
+
+.. ### BEGIN~OF~TABLE ###
+
+.. container:: table-row
+
 .. container:: table-row
 
    Property
-         default403Header
-   
+         absoluteReferencePrefix
+
    Data type
-         options
-   
+         string
+
    Description
-         Sent when a pages is not found because of access restrictions. Set to Default to prevent sending special headers.
-         
-         **Available options:**
+         If your TYPO3 installation runs in a subdir of the DOCUMENT_ROOT,
+         add the relative path from DOCUMENT_ROOT to the installation here
 
-         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.
-   
+         sys_domain will not be extended.
+
    Default
          0
 
+.. ###### END~OF~TABLE ######
+
+.. _section-language-options:
+
+Language options
+================
+
+.. ### BEGIN~OF~TABLE ###
+
 .. container:: table-row
 
    Property
          languageParam
-   
+
    Data type
          string
-   
+
    Description
-         The _GET variable that holds the language uid. In most cases this will
+         The GET variable that holds the language uid. In most cases this will
          be "L", which is the TYPO3 default.
-   
+
    Default
          L
 
@@ -179,15 +194,15 @@ on the extension name to open the configuration interface.
 
    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.
-   
+         The language parameter in the request URL (:php:`$_GET['L']`) will be
+         ignored, default language will be used. See also option
+         ``defaultLanguageKey``.
+
    Default
          0
 
@@ -195,17 +210,17 @@ on the extension name to open the configuration interface.
 
    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.
-   
+         your own language, see the option ``locallangFile`` below.
+
    Default
          default
 
@@ -213,31 +228,76 @@ on the extension name to open the configuration interface.
 
    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']
+         the selector box will be empty. If this option is used :php:`$_GET['L']`
          will be ignored.
-   
+
    Default
          -
 
 .. container:: table-row
 
    Property
+         locallangFile
+
+   Data type
+         string
+
+   Description
+         This language xml file will be included and used for marker
+         substitution. See section :ref:`section-available-markers` for details.
+
+   Default
+         -
+
+.. ###### END~OF~TABLE ######
+
+.. _section-http-options:
+
+HTTP options
+============
+
+.. ### BEGIN~OF~TABLE ###
+
+   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
          passthroughContentTypeHeader
-   
+
    Data type
          boolean
-   
+
    Description
-         When a 404 page is defined, the HTTP header 'Content-Type' will be
+         When a 404 page is defined, the HTTP header ``Content-Type`` will be
          captured and sent when delivering the 404 page
-   
+
    Default
          0
 
@@ -245,15 +305,18 @@ on the extension name to open the configuration interface.
 
    Property
          sendXForwardedForHeader
-   
+
    Data type
          boolean
-   
+
    Description
-         Send the REMOTE_ADDR in the 'X-Forwarded-For' HTTP header when 
-         fetching the 404 page. Be sure to correctly configure
-         [TYPO3_CONF_VARS][SYS][reverseProxyIP] when using this feature.
-   
+         Send the ``REMOTE_ADDR`` in the ``X-Forwarded-For`` HTTP header when
+         fetching the 404 page.
+
+         Be sure to configure
+         :php:`$GLOBALS['TYPO3_CONF_VARS']['SYS']['reverseProxyIP']` correctly
+         when using this feature.
+
    Default
          0
 
@@ -261,29 +324,14 @@ on the extension name to open the configuration interface.
 
    Property
          additionalHeaders
-   
+
    Data type
          string
-   
+
    Description
          Send additional HTTP headers with the 404/403 page response.
          Multiple headers are separated with '|'
-   
-   Default
-         -
-
-.. container:: table-row
 
-   Property
-         absoluteReferencePrefix
-   
-   Data type
-         string
-   
-   Description
-         If your TYPO3 installation runs in a subdir of the DOCUMENT_ROOT,
-         add the relative path from DOCUMENT_ROOT to the installation here
-   
    Default
          -
 
@@ -291,26 +339,24 @@ on the extension name to open the configuration interface.
 
    Property
          digestAuthentication
-   
+
    Data type
          string
-   
+
    Description
          If the 404/403 page is access restricted with HTTP digest
          authentication, you can configure the username and password here.
-         
-         Format: "username:password"
-         
+
+         Format: ``username:password`` (colon-separated username and password)
+
          HTTP digest authentication requires cURL to be installed and enabled in
-         $GLOBALS['TYPO3_CONF_VARS']['SYS']['curlUse']
-         
-         Note: this is NOT required for HTTP basic authentication (this type of
+         :php:`$GLOBALS['TYPO3_CONF_VARS']['SYS']['curlUse']`
+
+         **Note**: this is NOT required for HTTP basic authentication (this type of
          authentication works out-of-the box)!
-   
+
    Default
          -
 
 
 .. ###### END~OF~TABLE ######
-
-
index 8708bc4..87a1c7e 100644 (file)
@@ -5,6 +5,7 @@
 
 .. include:: ../Includes.txt
 
+.. _section-configuration:
 
 ==============================
 Configuration
@@ -23,4 +24,3 @@ in Extension Manager and/or within a domain record. This means:
 
    ExtensionManager/Index
    DomainRecord/Index
-
index f90595c..74296a9 100644 (file)
       This is the manual of the TYPO3 extension pagenotfoundhandling
 
 :Copyright:
-      2014
+      2014-2016
 
 :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 
+      404, 403, page not found handling, page unavailable handling, pageNotFound_handling
 
 :Author:
-      Christian Futterlieb, `Agentur am Wasser | Maeder & Partner AG <http://web.agenturamwasser.ch>`_
+      Christian Futterlieb, `Agentur am Wasser | Maeder & Partner AG <https://web.agenturamwasser.ch>`_
 
 :Email:
       development@agenturamwasser.ch
-      
+
 :Rendered:
       |today|
 
@@ -60,4 +60,3 @@ The extension pagenotfoundhandling is hosted on `TYPO3 forge
    Administration/Index
    Configuration/Index
    KnownProblems/Index
-
index 221b9ed..d88254a 100644 (file)
@@ -5,10 +5,13 @@
 
 .. include:: ../Includes.txt
 
+.. _section-introduction:
+
 ==============================
 Introduction
 ==============================
 
+.. _section-features:
 
 Features
 ==============================
@@ -19,10 +22,11 @@ Features
 * Supports multi-domain systems
 * Supports multi-language systems
 
+.. _section-credits:
 
 Credits
 ==============================
 
-Thanks to the `Agentur am Wasser <http://web.agenturamwasser.ch/>`_, our
+Thanks to the `Agentur am Wasser <https://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
+with the TYPO3 community.
index 50cddee..7ac542c 100644 (file)
@@ -5,9 +5,11 @@
 
 .. include:: ../Includes.txt
 
-==============================
+.. _section-known-problems:
+
+==============
 Known problems
-==============================
+==============
 
 
 With solution