[TASK] Restructure documentation 25/25625/2
authorNicole Cordes <cordes@cps-it.de>
Thu, 21 Nov 2013 20:55:37 +0000 (21:55 +0100)
committerNicole Cordes <typo3@cordes.co>
Thu, 21 Nov 2013 21:39:35 +0000 (22:39 +0100)
Change-Id: I00112288f94b81d43e7feb947f4bc729ef436229
Reviewed-on: https://review.typo3.org/25625
Reviewed-by: Nicole Cordes
Tested-by: Nicole Cordes
16 files changed:
Documentation/AdministratorManual/ExtensionConfiguration/Index.rst [new file with mode: 0644]
Documentation/AdministratorManual/Index.rst
Documentation/AdministratorManual/Installation/Index.rst [new file with mode: 0644]
Documentation/AdministratorManual/PageTs/Index.rst [new file with mode: 0644]
Documentation/AdministratorManual/VarnishConfiguration/Index.rst [new file with mode: 0644]
Documentation/Images/Introduction/Overview.png [deleted file]
Documentation/Images/Introduction/Screenshots/IconInEditView.png [new file with mode: 0644]
Documentation/Images/Introduction/Screenshots/IconInWebView.png [new file with mode: 0644]
Documentation/Images/Introduction/Screenshots/Messages.png [new file with mode: 0644]
Documentation/Index.rst
Documentation/Introduction/Index.rst
Documentation/Introduction/Screenshots/Index.rst [new file with mode: 0644]
Documentation/Introduction/Support/Index.rst [new file with mode: 0644]
Documentation/Introduction/WhatDoesItDo/Index.rst [new file with mode: 0644]
Documentation/Requirements/Index.rst [new file with mode: 0644]
Documentation/Support/Index.rst [deleted file]

diff --git a/Documentation/AdministratorManual/ExtensionConfiguration/Index.rst b/Documentation/AdministratorManual/ExtensionConfiguration/Index.rst
new file mode 100644 (file)
index 0000000..288f8d6
--- /dev/null
@@ -0,0 +1,45 @@
+.. ==================================================
+.. FOR YOUR INFORMATION
+.. --------------------------------------------------
+.. -*- coding: utf-8 -*- with BOM.
+
+.. include:: ../Includes.txt
+
+Extension configuration
+-----------------------
+
+Varnish Server [basic.server]
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+Enter the IP address of your Varnish server. Use a comma seperated list for multiple server support.
+
+HTTP ban method [basic.httpMethod]
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+If you want to insert an own method which is sent to the Varnish server you can edit it here. Please note that this method has to be equal to the method used in your Varnish configuration file.
+
+HTTP protocol [basic.httpProtocol]
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+Set the version of the http protocol which should be used to contact the Varnish server.
+
+Strip slash [basic.stripSlash]
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+If you use realurl extension (or any other url rendering) with the "appendMissingSlash" configuration you can configure vcc to strip the last slash. This can be useful if you want to customize the BAN handling in your varnish configuration e.g. use regular expressions.
+
+Support index.php script [basic.enableIndexScript]
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+If you use realurl extension (or any other url rendering) this option enables the cache clearing for alternative
+index.php url. This might help your editor to see the latest version if they view the page within the backend.
+
+Maximum age of log entries [basic.maxLogAge]
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+For each action one or multiple log entries (depends on debug setting) are generated in an own table. To minimize the table size you can set a specific age (in days) for the entries.
+
+Debug mode [basic.debug]
+^^^^^^^^^^^^^^^^^^^^^^^^
+
+You can enable a detailed logging of the values generated for each action. These information are stored in an own database table as well as send to any devLog extension.
index b0856dc..b66a427 100644 (file)
 
 .. include:: ../Includes.txt
 
-.. _admin-manual:
-
 Administrator Manual
 ====================
 
-Varnish configuration
----------------------
-
-Please add the following configuration to your vcl_recv function in your Varnish configuration file ::
-
-    # Add BAN request
-    if (req.request == "BAN") {
-        if (req.http.X-Host) {
-            ban("req.http.host == " + req.http.X-Host + " && req.url ~ " + req.http.X-Url + "[/]?(\?|&|$)");
-            error 200 "OK";
-        } else {
-            error 400 "Bad Request";
-        }
-    }
-
-To secure your environment consider to include reset of some server information in vcl_deliver ::
-
-    remove resp.http.Age;
-    remove resp.http.Via;
-    remove resp.http.X-Powered-By;
-    remove resp.http.X-Varnish;
-
-**For a best practise configuration see file** *Documentation/default.vcl*
-
-
-
-Installation
-------------
-
-To install the extension you just need to enable it in the Extension Manager.
-
-Extension configuration
------------------------
-
-Varnish Server [basic.server]
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
-
-Enter the IP address of your Varnish server. Use a comma seperated list for multiple server support.
-
-HTTP ban method [basic.httpMethod]
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
-
-If you want to insert an own method which is sent to the Varnish server you can edit it here. Please note that this method has to be equal to the method used in your Varnish configuration file.
-
-HTTP protocol [basic.httpProtocol]
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
-
-Set the version of the http protocol which should be used to contact the Varnish server.
-
-Strip slash [basic.stripSlash]
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
-
-If you use realurl extension (or any other url rendering) with the "appendMissingSlash" configuration you can configure vcc to strip the last slash. This can be useful if you want to customize the BAN handling in your varnish configuration e.g. use regular expressions.
-
-Support index.php script [basic.enableIndexScript]
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
-
-If you use realurl extension (or any other url rendering) this option enables the cache clearing for alternative
-index.php url. This might help your editor to see the latest version if they view the page within the backend.
-
-Maximum age of log entries [basic.maxLogAge]
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
-
-For each action one or multiple log entries (depends on debug setting) are generated in an own table. To minimize the table size you can set a specific age (in days) for the entries.
-
-Debug mode [basic.debug]
-^^^^^^^^^^^^^^^^^^^^^^^^
-
-You can enable a detailed logging of the values generated for each action. These information are stored in an own database table as well as send to any devLog extension.
-
-TYPO3 PageTS configuration
---------------------------
-
-You can configure the Varnish Cache Controll extension to be compatible to any data record in the backend. You just need to adopt the PageTS configuration which comes pre defined for pages and content elements. ::
-
-    mod.vcc {
-        pages = 1
-        pages {
-            typolink {
-                parameter.field = uid
-            }
-        }
-
-        pages_language_overlay = 1
-        pages_language_overlay {
-            typolink {
-                parameter.field = pid
-                additionalParams = &L={field:sys_language_uid}
-                additionalParams.insertData = 1
-            }
-        }
-
-        tt_content = 1
-        tt_content {
-            typolink {
-                parameter.field = pid
-                additionalParams = &L={field:sys_language_uid}
-                additionalParams.insertData = 1
-            }
-        }
-    }
-
-Just add a configuration with the name of your database table and a configuration how to generate the link to any (detail) page.
\ No newline at end of file
+.. include:: VarnishConfiguration/Index.rst
+.. include:: Installation/Index.rst
+.. include:: ExtensionConfiguration/Index.rst
+.. include:: PageTs/Index.rst
diff --git a/Documentation/AdministratorManual/Installation/Index.rst b/Documentation/AdministratorManual/Installation/Index.rst
new file mode 100644 (file)
index 0000000..92297b1
--- /dev/null
@@ -0,0 +1,11 @@
+.. ==================================================
+.. FOR YOUR INFORMATION
+.. --------------------------------------------------
+.. -*- coding: utf-8 -*- with BOM.
+
+.. include:: ../Includes.txt
+
+Installation
+------------
+
+To install the extension you just need to enable it in the Extension Manager.
diff --git a/Documentation/AdministratorManual/PageTs/Index.rst b/Documentation/AdministratorManual/PageTs/Index.rst
new file mode 100644 (file)
index 0000000..fba2d59
--- /dev/null
@@ -0,0 +1,40 @@
+.. ==================================================
+.. FOR YOUR INFORMATION
+.. --------------------------------------------------
+.. -*- coding: utf-8 -*- with BOM.
+
+.. include:: ../Includes.txt
+
+TYPO3 PageTS configuration
+--------------------------
+
+You can configure the Varnish Cache Controll extension to be compatible to any data record in the backend. You just need to adopt the PageTS configuration which comes pre defined for pages and content elements. ::
+
+    mod.vcc {
+        pages = 1
+        pages {
+            typolink {
+                parameter.field = uid
+            }
+        }
+
+        pages_language_overlay = 1
+        pages_language_overlay {
+            typolink {
+                parameter.field = pid
+                additionalParams = &L={field:sys_language_uid}
+                additionalParams.insertData = 1
+            }
+        }
+
+        tt_content = 1
+        tt_content {
+            typolink {
+                parameter.field = pid
+                additionalParams = &L={field:sys_language_uid}
+                additionalParams.insertData = 1
+            }
+        }
+    }
+
+Just add a configuration with the name of your database table and a configuration how to generate the link to any (detail) page.
diff --git a/Documentation/AdministratorManual/VarnishConfiguration/Index.rst b/Documentation/AdministratorManual/VarnishConfiguration/Index.rst
new file mode 100644 (file)
index 0000000..cd6de99
--- /dev/null
@@ -0,0 +1,30 @@
+.. ==================================================
+.. FOR YOUR INFORMATION
+.. --------------------------------------------------
+.. -*- coding: utf-8 -*- with BOM.
+
+.. include:: ../Includes.txt
+
+Varnish configuration
+---------------------
+
+Please add the following configuration to your vcl_recv function in your Varnish configuration file ::
+
+    # Add BAN request
+    if (req.request == "BAN") {
+        if (req.http.X-Host) {
+            ban("req.http.host == " + req.http.X-Host + " && req.url ~ " + req.http.X-Url + "[/]?(\?|&|$)");
+            error 200 "OK";
+        } else {
+            error 400 "Bad Request";
+        }
+    }
+
+To secure your environment consider to include reset of some server information in vcl_deliver ::
+
+    remove resp.http.Age;
+    remove resp.http.Via;
+    remove resp.http.X-Powered-By;
+    remove resp.http.X-Varnish;
+
+**For a best practise configuration see** :download:`this default configuration <../default.vcl>`
diff --git a/Documentation/Images/Introduction/Overview.png b/Documentation/Images/Introduction/Overview.png
deleted file mode 100644 (file)
index 97e13b2..0000000
Binary files a/Documentation/Images/Introduction/Overview.png and /dev/null differ
diff --git a/Documentation/Images/Introduction/Screenshots/IconInEditView.png b/Documentation/Images/Introduction/Screenshots/IconInEditView.png
new file mode 100644 (file)
index 0000000..44b95dc
Binary files /dev/null and b/Documentation/Images/Introduction/Screenshots/IconInEditView.png differ
diff --git a/Documentation/Images/Introduction/Screenshots/IconInWebView.png b/Documentation/Images/Introduction/Screenshots/IconInWebView.png
new file mode 100644 (file)
index 0000000..c768fdd
Binary files /dev/null and b/Documentation/Images/Introduction/Screenshots/IconInWebView.png differ
diff --git a/Documentation/Images/Introduction/Screenshots/Messages.png b/Documentation/Images/Introduction/Screenshots/Messages.png
new file mode 100644 (file)
index 0000000..97e13b2
Binary files /dev/null and b/Documentation/Images/Introduction/Screenshots/Messages.png differ
index 9b1f0de..3d92ebd 100644 (file)
@@ -49,13 +49,12 @@ Varnish Cache Control
        a GNU/GPL CMS/Framework available from `www.typo3.org <http://www.typo3.org/>`_.
 
 
-       **Table of Contents**
+**Table of Contents**
 
 .. toctree::
-       :maxdepth: 5
-       :titlesonly:
+       :maxdepth: 2
        :glob:
 
        Introduction/Index
+       Requirements/Index
        AdministratorManual/Index
-       Support/Index
index cbc6fb1..4bd11ff 100644 (file)
@@ -5,25 +5,9 @@
 
 .. include:: ../Includes.txt
 
-
-What does it do?
-================
-
-The extension provides an api to be able to handle commands to control the Varnish Cache within TYPO3.
-
-Besides it adds an icon to clear the Varnish Cache by every backend user.
-
-Screenshots
-===========
-
-.. figure:: ../Images/Introduction/Overview.png
-       :width: 600px
-       :alt: Visible server status of cache clearing
-
-Requirements
+Introduction
 ============
 
-- Varnish server should be up and running
-- You should be familiar with the configuration language vcl of Varnish
-
-If you need an introduction or further information on the configuration of Varnish you can find a comprehensive documentation at https://www.varnish-software.com/book/
+.. include:: WhatDoesItDo/Index.rst
+.. include:: Screenshots/Index.rst
+.. include:: Support/Index.rst
\ No newline at end of file
diff --git a/Documentation/Introduction/Screenshots/Index.rst b/Documentation/Introduction/Screenshots/Index.rst
new file mode 100644 (file)
index 0000000..f8b547b
--- /dev/null
@@ -0,0 +1,27 @@
+.. ==================================================
+.. FOR YOUR INFORMATION
+.. --------------------------------------------------
+.. -*- coding: utf-8 -*- with BOM.
+
+.. include:: ../../Includes.txt
+
+Screenshots
+-----------
+
+.. figure:: ../Images/Introduction/Screenshots/IconInWebView.png
+       :width: 600px
+       :alt: Icon to clear the cache in button bar
+
+Clear the Varnish cache for every site with just one click.
+
+.. figure:: ../Images/Introduction/Screenshots/IconInEditView.png
+       :width: 600px
+       :alt: Add the icon to clear the cache to any data record type
+
+You can even clear the Varnish cache from within all data records.
+
+.. figure:: ../Images/Introduction/Screenshots/Messages.png
+       :width: 600px
+       :alt: Visible server status of cache clearing
+
+For every cache clear request to the Varnish server, you get a status information afterwards.
\ No newline at end of file
diff --git a/Documentation/Introduction/Support/Index.rst b/Documentation/Introduction/Support/Index.rst
new file mode 100644 (file)
index 0000000..9750d94
--- /dev/null
@@ -0,0 +1,21 @@
+.. ==================================================
+.. FOR YOUR INFORMATION
+.. --------------------------------------------------
+.. -*- coding: utf-8 -*- with BOM.
+
+.. include:: ../../Includes.txt
+
+Support
+-------
+
+forge.typo3.org
+^^^^^^^^^^^^^^^
+
+You can find further information about development and open issues of the Varnish Cache Control extension (vcc) on its
+projects site under http://forge.typo3.org/projects/extension-vcc .
+
+E-Mail
+^^^^^^
+
+If you have any open questions or if you need consulting for your projects we would like to help you.
+Feel free to contact us at cordes@cps-it.de if you need any kind of support.
\ No newline at end of file
diff --git a/Documentation/Introduction/WhatDoesItDo/Index.rst b/Documentation/Introduction/WhatDoesItDo/Index.rst
new file mode 100644 (file)
index 0000000..79d7e86
--- /dev/null
@@ -0,0 +1,13 @@
+.. ==================================================
+.. FOR YOUR INFORMATION
+.. --------------------------------------------------
+.. -*- coding: utf-8 -*- with BOM.
+
+.. include:: ../../Includes.txt
+
+What does it do?
+----------------
+
+The extension provides an api to be able to handle commands to control the Varnish Cache within TYPO3.
+
+Besides it adds an icon to clear the Varnish Cache by every backend user.
\ No newline at end of file
diff --git a/Documentation/Requirements/Index.rst b/Documentation/Requirements/Index.rst
new file mode 100644 (file)
index 0000000..8130380
--- /dev/null
@@ -0,0 +1,14 @@
+.. ==================================================
+.. FOR YOUR INFORMATION
+.. --------------------------------------------------
+.. -*- coding: utf-8 -*- with BOM.
+
+.. include:: ../Includes.txt
+
+Requirements
+============
+
+- Varnish server should be up and running
+- You should be familiar with the configuration language vcl of Varnish
+
+If you need an introduction or further information on the configuration of Varnish you can find a comprehensive documentation at https://www.varnish-software.com/book/
diff --git a/Documentation/Support/Index.rst b/Documentation/Support/Index.rst
deleted file mode 100644 (file)
index 025582e..0000000
+++ /dev/null
@@ -1,22 +0,0 @@
-.. ==================================================
-.. FOR YOUR INFORMATION
-.. --------------------------------------------------
-.. -*- coding: utf-8 -*- with BOM.
-
-.. include:: ../Includes.txt
-
-
-Support
-=======
-
-forge.typo3.org
-^^^^^^^^^^^^^^^
-
-You can find further information about development and open issues of the Varnish Cache Control extension (vcc) on its
-projects site under http://forge.typo3.org/projects/extension-vcc .
-
-E-Mail
-^^^^^^
-
-If you have any open questions or if you need consulting for your projects we would like to help you.
-Feel free to contact us at cordes@cps-it.de if you need any kind of support.
\ No newline at end of file