[FEATURE] Rewrite documentation 56/50556/2
authorFrancois Suter <francois@typo3.org>
Wed, 9 Nov 2016 14:46:20 +0000 (15:46 +0100)
committerFrancois Suter <francois@typo3.org>
Wed, 9 Nov 2016 14:49:13 +0000 (15:49 +0100)
DevLog has changed completely, so documentation needs to be
rewritten (and in reST format).

Change-Id: I9d340ce2a015dbf982cf4dfae98fb7e856cb76b5
Resolves: #78504
Releases: 3.0
Reviewed-on: https://review.typo3.org/50556
Reviewed-by: Francois Suter <francois@typo3.org>
Tested-by: Francois Suter <francois@typo3.org>
21 files changed:
ChangeLog
Documentation/.gitignore [new file with mode: 0644]
Documentation/Developer/Index.rst [new file with mode: 0644]
Documentation/Images/BackendModule.png [new file with mode: 0644]
Documentation/Images/ConfigurationDatabaseWriter.png [new file with mode: 0644]
Documentation/Images/ConfigurationFileWriter.png [new file with mode: 0644]
Documentation/Images/ConfigurationGeneral.png [new file with mode: 0644]
Documentation/Images/UserBackendModule.png [new file with mode: 0644]
Documentation/Images/UserClearEntries.png [new file with mode: 0644]
Documentation/Images/UserEntryDetails.png [new file with mode: 0644]
Documentation/Images/UserGroupedRuns.png [new file with mode: 0644]
Documentation/Images/UserListView.png [new file with mode: 0644]
Documentation/Includes.txt [new file with mode: 0644]
Documentation/Index.rst [new file with mode: 0644]
Documentation/Installation/Index.rst [new file with mode: 0644]
Documentation/Introduction/Index.rst [new file with mode: 0644]
Documentation/Settings.yml [new file with mode: 0644]
Documentation/Targets.rst [new file with mode: 0644]
Documentation/User/Index.rst [new file with mode: 0644]
doc/manual.pdf [deleted file]
doc/manual.sxw [deleted file]

index c0cefbb..d518f5e 100755 (executable)
--- a/ChangeLog
+++ b/ChangeLog
@@ -1,3 +1,7 @@
+2016-11-09 Francois Suter <typo3@cobweb.ch>
+
+       * Rewrote documentation and moved it to reST, resolves #78504
+
 2016-11-01 Francois Suter <typo3@cobweb.ch>
 
        * Updated and cleaned up the language files, resolves #78528
diff --git a/Documentation/.gitignore b/Documentation/.gitignore
new file mode 100644 (file)
index 0000000..911525f
--- /dev/null
@@ -0,0 +1,24 @@
+#########################
+# Git
+# global ignore file
+########################
+# ignoring temporary files (left by e.g. vim)
+# ignoring by common IDE's used directories/files
+# dont ignore .rej and .orig as we want to see/clean files after conflict resolution
+#
+# for local exclude patterns please edit .git/info/exclude
+#
+*~
+*.bak
+*.idea
+*.project
+*.swp
+.buildpath
+.cache
+.project
+.session
+.settings
+.TemporaryItems
+.webprj
+nbproject
+_make
\ No newline at end of file
diff --git a/Documentation/Developer/Index.rst b/Documentation/Developer/Index.rst
new file mode 100644 (file)
index 0000000..dd7de43
--- /dev/null
@@ -0,0 +1,145 @@
+.. ==================================================
+.. FOR YOUR INFORMATION
+.. --------------------------------------------------
+.. -*- coding: utf-8 -*- with BOM.
+
+.. include:: ../Includes.txt
+
+
+.. _developer:
+
+Developer manual
+----------------
+
+
+.. _developer-logging-method:
+
+Using the logging method
+^^^^^^^^^^^^^^^^^^^^^^^^
+
+To log something simply call :code:`\TYPO3\CMS\Core\Utility\GeneralUtility::devLog()`.
+This method takes the following parameters:
+
++-----------+-----------------------------------------------------------------------+
+| $msg      | The message that you want to write to the log                         |
++-----------+-----------------------------------------------------------------------+
+| $extKey   | The key of the extension writing to the log                           |
++-----------+-----------------------------------------------------------------------+
+| $severity | Indication of the severity of the message. The following values are   |
+|           | expected:                                                             |
+|           |                                                                       |
+|           | - -1 for ok status                                                    |
+|           | - 0 for a purely informational message                                |
+|           | - 1 for a notice                                                      |
+|           | - 2 for a warning                                                     |
+|           | - 3 for a (fatal) error                                               |
+|           |                                                                       |
+|           | This parameter is optional and defaults to 0.                         |
++-----------+-----------------------------------------------------------------------+
+| $dataVar  | This variable can be any type of data that you wish and that you find |
+|           | useful for information or debugging purposes. The Database Writer     |
+|           | serializes it before storage in the database.                         |
+|           |                                                                       |
+|           | This parameter is optional and defaults to false.                     |
++-----------+-----------------------------------------------------------------------+
+
+.. warning::
+
+   If you store a lot of stuff in the :code:`$dataVar` or
+   if you call the "devLog" very frequently, you may end up with a
+   very large "tx\_devlog\_domain\_model|_entry" table in your database.
+   Check it out regularly and don't hesitate to use the :ref:`clean up features <user-backend-module-clear-entries>`
+   as the relevant :ref:`configuration options <installation-configuration-database-writer>`.
+
+
+.. _developer-logging-method-severity-levels:
+
+More about severity levels
+""""""""""""""""""""""""""
+
+It may not always be easy to choose a severity level. The descriptions
+below go into a bit more detail and will – hopefully – make the choice
+easier.
+
+OK (-1)
+  These events indicate that everything went fine, no
+  error occurred (at least up to that point where the event was
+  created). No action needs to be taken.
+
+Info (0)
+  These events are purely informational. They are
+  normally used for debugging purposes only and require no special
+  action.
+
+Notice (1)
+  Abnormal condition, but not blocking. Notices are
+  meant to raise attention. Processes have been completed, but things
+  are not running as smoothly as they could and the condition should be
+  investigated.
+
+Warning (2)
+  These events are used to notify significant
+  problems. Processes have been completed, but parts of them may be
+  missing, wrong or corrupted. Warnings should not be ignored and action
+  should definitely be taken.
+
+Error (3)
+  These events signal that something went fatally wrong.
+  Processes were not completed and action is definitely needed.
+  Alternately this level may be used to point to a failed event, but in
+  a process where failure can be expected, e.g. a login attempt with the
+  wrong password.
+
+
+.. _developer-extra-information:
+
+Extra information
+^^^^^^^^^^^^^^^^^
+
+The devlog extension stores information beyond the parameters passed to the
+:code:`\TYPO3\CMS\Core\Utility\GeneralUtility::devLog()` method. Some of it
+is automatically retrieved, like the id of the currently logged in BE user, if any.
+
+If the devlog call is made in the FE context, the page id will also automatically
+be retrieved from :code:`$GLOBALS['TSFE']->id. This variable is not defined in other contexts,
+in particular the BE. There is still a way to pass a page id to the devlog, if it makes sense,
+but you need to set it yourself in the global variable
+:code:`$GLOBALS['TYPO3_CONF_VARS']['SC_OPTIONS']['GLOBAL']['debugData']['pid']`.
+If defined, this variable will be taken into account by the devlog.
+
+All this work happens in the :class:`\\Devlog\\Devlog\\Utility\\Logger` class.
+
+
+.. _developer-custom-writers:
+
+Custom Writers
+^^^^^^^^^^^^^^
+
+The data passed in the :code:`\TYPO3\CMS\Core\Utility\GeneralUtility::devLog()`
+call is stored by classed called "Writers". The extension provides two Writers
+out of the box: one write to the database, the other to a file. It is pretty
+easy to develop custom Writers.
+
+First you want to create a new class which extends
+:class:`\\Devlog\\Devlog\\Writer\\AbstractWriter`, which itself implements
+:class:`\\Devlog\\Devlog\\Writer\\WriterInterface`. The interface
+defines a single method called :code:`write()` which should take care of
+storing each log entry wherever and however it wants.
+
+Once you hace created your writer, register it in your extension's
+:file:`ext_localconf.php` file with the following syntax:
+
+.. code-block:: php
+
+       $GLOBALS['TYPO3_CONF_VARS']['EXTCONF']['devlog']['writers']['foobar'] = \Foo\Bar\Writer\FooBarWriter::class;
+
+
+where :code:`foobar` should be a unique key for your Writer.
+
+.. note::
+
+   It is actually possible to overwrite the default Writers be registrer a different
+   class for keys :code:`db` (Database Writer) and :code:`file` (File Writer).
+
+   It would also be possible to disable a Writer, by unsetting its entry in the
+   :code:`$GLOBALS['TYPO3_CONF_VARS']['EXTCONF']['devlog']['writers']` array.
diff --git a/Documentation/Images/BackendModule.png b/Documentation/Images/BackendModule.png
new file mode 100644 (file)
index 0000000..9879843
Binary files /dev/null and b/Documentation/Images/BackendModule.png differ
diff --git a/Documentation/Images/ConfigurationDatabaseWriter.png b/Documentation/Images/ConfigurationDatabaseWriter.png
new file mode 100644 (file)
index 0000000..04ad277
Binary files /dev/null and b/Documentation/Images/ConfigurationDatabaseWriter.png differ
diff --git a/Documentation/Images/ConfigurationFileWriter.png b/Documentation/Images/ConfigurationFileWriter.png
new file mode 100644 (file)
index 0000000..dcd3c99
Binary files /dev/null and b/Documentation/Images/ConfigurationFileWriter.png differ
diff --git a/Documentation/Images/ConfigurationGeneral.png b/Documentation/Images/ConfigurationGeneral.png
new file mode 100644 (file)
index 0000000..8e3977a
Binary files /dev/null and b/Documentation/Images/ConfigurationGeneral.png differ
diff --git a/Documentation/Images/UserBackendModule.png b/Documentation/Images/UserBackendModule.png
new file mode 100644 (file)
index 0000000..3ce4fe3
Binary files /dev/null and b/Documentation/Images/UserBackendModule.png differ
diff --git a/Documentation/Images/UserClearEntries.png b/Documentation/Images/UserClearEntries.png
new file mode 100644 (file)
index 0000000..40549c5
Binary files /dev/null and b/Documentation/Images/UserClearEntries.png differ
diff --git a/Documentation/Images/UserEntryDetails.png b/Documentation/Images/UserEntryDetails.png
new file mode 100644 (file)
index 0000000..c4beb82
Binary files /dev/null and b/Documentation/Images/UserEntryDetails.png differ
diff --git a/Documentation/Images/UserGroupedRuns.png b/Documentation/Images/UserGroupedRuns.png
new file mode 100644 (file)
index 0000000..83fe4df
Binary files /dev/null and b/Documentation/Images/UserGroupedRuns.png differ
diff --git a/Documentation/Images/UserListView.png b/Documentation/Images/UserListView.png
new file mode 100644 (file)
index 0000000..8a8edd3
Binary files /dev/null and b/Documentation/Images/UserListView.png differ
diff --git a/Documentation/Includes.txt b/Documentation/Includes.txt
new file mode 100644 (file)
index 0000000..a111144
--- /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..ebbe340
--- /dev/null
@@ -0,0 +1,59 @@
+.. ==================================================
+.. FOR YOUR INFORMATION
+.. --------------------------------------------------
+.. -*- coding: utf-8 -*- with BOM.
+
+.. include:: Includes.txt
+
+
+.. _start:
+
+===============
+Developer's Log
+===============
+
+.. only:: html
+
+       :Language:
+                 en
+
+       :Version:
+               |release|
+
+       :Description:
+                 The Developer's Log extension provides development logging/debugging functionality for usage of GeneralUtility::devlog() and a BE module to browse the logs.
+
+       :Keywords:
+                 data import, fetch data, services
+
+       :Copyright:
+               2007-2016
+
+       :Author:
+                 François Suter (Cobweb)
+
+       :Email:
+                 typo3@cobweb.ch
+
+       :License:
+               This document is published under the Open Content License
+               available from http://www.opencontent.org/opl.shtml
+
+       :Rendered:
+               |today|
+
+
+The content of this document is related to TYPO3,
+a GNU/GPL CMS/Framework available from `www.typo3.org <http://www.typo3.org/>`_.
+
+
+.. toctree::
+   :maxdepth: 5
+   :titlesonly:
+   :glob:
+
+   Introduction/Index
+   Installation/Index
+   Developer/Index
+   User/Index
+   Targets
diff --git a/Documentation/Installation/Index.rst b/Documentation/Installation/Index.rst
new file mode 100644 (file)
index 0000000..93041bb
--- /dev/null
@@ -0,0 +1,123 @@
+.. ==================================================
+.. FOR YOUR INFORMATION
+.. --------------------------------------------------
+.. -*- coding: utf-8 -*- with BOM.
+
+.. include:: ../Includes.txt
+
+
+.. _installation:
+
+Installation
+------------
+
+Just install the extension via the Extension Manager or via Composer
+and you're done. There's nothing more to do, except tuning the
+configuration to your taste. The configuration is divided in three
+sections, detailed below.
+
+
+.. _installation-configuration-general:
+
+General configuration
+^^^^^^^^^^^^^^^^^^^^^
+
+.. figure:: ../Images/ConfigurationGeneral.png
+       :alt: The general configuration
+
+       Generation Configuration screen in the Extension Manager
+
+Autorefresh frequency
+  The backend module can refresh itself automatically, loading all
+  new entries that were logged since last module load. The frequency
+  is given in seconds.
+
+Number of entries per page
+  Number of entries displayed at one time in the backend module.
+
+Minimum level for logging
+  Log entries come with a severity that can have the following values: -1 for ok,
+  0 for an information, 1 for a notice, 2 for a warning and 3 for an error.
+  With this setting you can define from which level you want to start logging entries.
+  All entries with a severity below that setting will be ignored.
+
+Excluded keys
+  Every log entry (normally) comes with a key. This is generally an extension key or a class name.
+  This parameter allows you to define a (comma-separated) list of keys that you don't want to log.
+  This will help keep your log table smaller.
+
+  Leave this property empty to log entries whatever their key.
+
+Included keys
+  While "Excluded keys" is a black list, "Included keys" is a white list. As soon as
+  you define a (comma-separated) list of keys to include, **only** those entries
+  that match these keys will be logged. All others are ignored.
+
+  Leave this property empty to log entries whatever their key.
+
+  The "Included keys" property supersedes "Excluded keys".
+
+Restricted IP addresses
+  With this setting you can restrict logging to activate only when some
+  IP addresses are matched. This property takes a comma-separated list
+  of IP addresses. It can also take the special value :code:`devIPmask`
+  in which case it will reuse the value from :code:`[SYS][devIPmask]`.
+
+  Set this property to :code:`*` to log entries whatever the incoming IP address.
+  On the contrary, set it to an empty value to block everything.
+
+
+.. _installation-configuration-database-writer:
+
+Database Writer configuration
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+.. figure:: ../Images/ConfigurationDatabaseWriter.png
+       :alt: The database writer configuration
+
+       Database Writer Configuration screen in the Extension Manager
+
+
+Maximum number of rows
+  This parameter sets an absolute limit on the number of log entries that are stored in the database.
+  When that limit is reached, about 10% of the oldest entries are deleted to make room for new ones.
+  If you don't want any limit, set this parameter to zero.
+
+Optimize devlog table
+  The database table may see a lot of operations, both inserts and deletes.
+  After a time some overhead accumulates. By selecting this option,
+  an optimization is run every time entries are deleted, as per the “maximum number of rows” option above.
+
+  .. note::
+
+     This operation uses the “OPTIMIZE” SQL statement which is proprietary of MySQL and and is not compatible with DBAL.
+     If you use another database than MySQL you should not activate this option.
+
+Maximum size of extra data
+  Data of any kind can be passed along to the "devLog" call. The Database Writer serializes it before storage.
+  This so-called “extra data” can become quite large in some situations which could bog down the database server.
+  To prevent this from happening, this setting will limit the size of the extra data (once serialized).
+  The default value is 1 million (characters). Any data above this limit will be stripped and replaced
+  by an informational message.
+
+.. tip::
+
+   Another way to keep the database table under control is to use the
+   Scheduler's Table garbage collection task to remove all records
+   beyond a certain age.
+
+
+.. _installation-configuration-file-writer:
+
+File Writer configuration
+^^^^^^^^^^^^^^^^^^^^^^^^^
+
+.. figure:: ../Images/ConfigurationFileWriter.png
+       :alt: The file writer configuration
+
+       File Writer Configuration screen in the Extension Manager
+
+
+Path
+  The path to the file where the log entries should be written. If left empty,
+  the File Writer is disabled.
diff --git a/Documentation/Introduction/Index.rst b/Documentation/Introduction/Index.rst
new file mode 100644 (file)
index 0000000..5a07d74
--- /dev/null
@@ -0,0 +1,89 @@
+.. ==================================================
+.. FOR YOUR INFORMATION
+.. --------------------------------------------------
+.. -*- coding: utf-8 -*- with BOM.
+
+.. include:: ../Includes.txt
+
+
+.. _introduction:
+
+Introduction
+------------
+
+TYPO3 CMS provides a functionality for logging information for
+the purposes of development and debugging via static method
+:code:`\TYPO3\CMS\Core\Utility\GeneralUtility::devLog()`.
+However this method does not do anything by itself. It simply
+provides a hook for registering whatever logging method you wish.
+The Developer's Log provides such a method.
+
+Information can be stored in a database table or written to a file.
+Custom Writers can be developed to write to other destinations.
+Logs in the database can be browsed using a backend module.
+Not all Writers can store all the data provided in the
+:code:`\TYPO3\CMS\Core\Utility\GeneralUtility::devLog()` call.
+In particular, the File Writer cannot store the extra data.
+
+This extension provides the following features:
+
+- log entries are logged in log sessions – one log session per script run.
+  That makes it easy to separate log runs.
+
+- frontend logging includes the page id.
+
+- backend module can be opened in a separate window and set to refresh automatically.
+
+- many options for searching and filtering in the backend module
+
+- clear up logs selectively
+
+.. figure:: ../Images/BackendModule.png
+       :alt: The backend module
+
+       The backend module provided by the extension
+
+
+.. _credits:
+
+Credits
+^^^^^^^
+
+This extension was orignally developed by René Fritz and improved and
+enhanced by Francois Suter.
+
+Version 3.0 is a complete rewrite.
+
+
+.. _suport:
+
+Questions and support
+^^^^^^^^^^^^^^^^^^^^^
+
+If you have any questions about this extension, please ask them in the
+TYPO3 English mailing list, so that others can benefit from the
+answers. Please use the bug tracker on forge.typo3.org to report
+problem or suggest features
+(http://forge.typo3.org/projects/extension-devlog/issues).
+
+
+.. _happy-developer:
+
+Keeping the developer happy
+^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+Every encouragement keeps the developer ticking, so don't hesitate
+to send thanks or share your enthusiasm about the extension.
+
+If you appreciate this work and want to show some support, please
+check http://www.monpetitcoin.com/en/francois/support-me/.
+
+
+.. _participate:
+
+Participating
+^^^^^^^^^^^^^
+
+This tool should really be a community tool and as such contributions
+are very welcome. The code repository will be moved to GitHub in the
+near future. This will helpfully encourage contributions.
diff --git a/Documentation/Settings.yml b/Documentation/Settings.yml
new file mode 100644 (file)
index 0000000..c50f0fe
--- /dev/null
@@ -0,0 +1,36 @@
+# This is the project specific Settings.yml file.
+# Place Sphinx specific build information here.
+# Settings given here will replace the settings of 'conf.py'.
+
+---
+conf.py:
+  copyright: 2007-2016
+  project: Developer's Log
+  version: 3.0
+  release: 3.0.0
+  latex_documents:
+  - - Index
+    - devlog.tex
+    - Developer's Log
+    - Francois Suter
+    - manual
+  latex_elements:
+    papersize: a4paper
+    pointsize: 10pt
+    preamble: \usepackage{typo3}
+  intersphinx_mapping:
+    t3tca:
+    - http://docs.typo3.org/typo3cms/TCAReference/
+    - null
+    t3tsconfig:
+    - http://docs.typo3.org/typo3cms/TSconfigReference/
+    - null
+    t3api:
+    - http://docs.typo3.org/typo3cms/CoreApiReference/
+    - null
+  extensions:
+  - sphinx.ext.intersphinx
+  - t3sphinx.ext.t3extras
+  - t3sphinx.ext.t3tablerows
+  - t3sphinx.ext.targets
+...
diff --git a/Documentation/Targets.rst b/Documentation/Targets.rst
new file mode 100644 (file)
index 0000000..3d58aa6
--- /dev/null
@@ -0,0 +1,16 @@
+.. ==================================================
+.. FOR YOUR INFORMATION
+.. --------------------------------------------------
+.. -*- coding: utf-8 -*- with BOM.
+
+.. include:: Includes.txt
+
+
+
+.. _labels-for-crossreferencing:
+
+Index: Labels for Crossreferencing
+==================================
+
+.. ref-targets-list::
+
diff --git a/Documentation/User/Index.rst b/Documentation/User/Index.rst
new file mode 100644 (file)
index 0000000..d96831c
--- /dev/null
@@ -0,0 +1,118 @@
+.. ==================================================
+.. FOR YOUR INFORMATION
+.. --------------------------------------------------
+.. -*- coding: utf-8 -*- with BOM.
+
+.. include:: ../Includes.txt
+
+
+.. _user:
+
+User manual
+-----------
+
+Viewing log entries depends on the Writer that was used to store
+them. While the File Writer provides a quick text-based access,
+the Database Writer makes it possible to have a full backend module,
+complete with search and filtering.
+
+
+.. _user-log-files:
+
+Log files
+^^^^^^^^^
+
+This is as straightforward as it gets. Open the log file and you should
+see something like:
+
+.. code-block:: text
+
+       2016-11-04T16:23:02+01:00 [NOTICE] Empty data (SandboxController.php 47)
+       2016-11-04T16:23:02+01:00 [INFO] Logging object test (SandboxController.php 48)
+       2016-11-04T16:23:02+01:00 [OK] Logging test (SandboxController.php 49)
+       2016-11-04T16:23:02+01:00 [INFO] Logging test (SandboxController.php 50)
+       2016-11-04T16:23:02+01:00 [NOTICE] Logging test (SandboxController.php 51)
+       2016-11-04T16:23:02+01:00 [WARNING] Logging test (SandboxController.php 52)
+       2016-11-04T16:23:02+01:00 [ERROR] Logging test (SandboxController.php 53)
+
+
+.. _user-single-entry:
+
+Viewing a single entry
+^^^^^^^^^^^^^^^^^^^^^^
+
+The Database Write writes log entries in the page where the call happened or
+at the root of the TYPO3 CMS installation if the call didn't happen within the
+context of a page. Those records can be seen in the **WEB > List** module.
+Records are ordered with the most recent on top.
+
+.. figure:: ../Images/UserListView.png
+       :alt: The log entries in the WEB > List module
+
+       List of log entries in the WEB > List module
+
+
+To view the details of a single entry, click on the "Edit" icon.
+
+.. figure:: ../Images/UserEntryDetails.png
+       :alt: The details of a log entry
+
+       Viewing the details of a log entry (all fields are read-only)
+
+
+.. _user-backend-module:
+
+The backend module
+^^^^^^^^^^^^^^^^^^
+
+The backend module can be used to view all entries written to the database
+no matter on which page they are stored. Furthermore it provides a number
+of search, filtering and ordering features.
+
+.. figure:: ../Images/UserBackendModule.png
+       :alt: The backend module
+
+       The Developer's Log backend module with features highlighted
+
+
+Hitting the "Reload" button **(1)** will load all log entries that were
+written since you started viewing the backend module. The table is refreshed.
+Checking the "Automatic reload" checkbox will trigger the reload
+action at predefined intervals (as per the
+:ref:`extension configuration <installation-configuration-general>`).
+
+The "Group runs" option **(2)** changes the table display to visually
+separate log entries that belong to the same "run", i.e. the same
+execution of a request to TYPO3 CMS.
+
+.. figure:: ../Images/UserGroupedRuns.png
+       :alt: The entries list grouped by runs
+
+       The list of log entries grouped by runs
+
+
+The search bar **(3)** is a simple keyword search, but it acts on all columns,
+including the extra data. The various filters **(4)** each correspond to
+a given column and will filter data accordingly. All filters can be reset
+by clicking on the "Clear all filtes" button.
+
+Data can be sorted by clicking on any column header **(5)**. The extra data
+is collapsed by default and can be viewed by clicking on any downward-pointing
+arrow **(6)**. Clicking on the arrow in the header cell **(7)** expands extra
+data for all rows.
+
+
+.. _user-backend-module-clear-entries:
+
+Clearing log entries
+""""""""""""""""""""
+
+In the docheader stands a menu for clearing log entries. From there,
+you can choose to delete all entries or delete them for a given
+period of time or for a given key.
+
+.. figure:: ../Images/UserClearEntries.png
+       :alt: Clear entries menu
+
+       The menu for clearing log entries
+
diff --git a/doc/manual.pdf b/doc/manual.pdf
deleted file mode 100644 (file)
index 1661b7a..0000000
Binary files a/doc/manual.pdf and /dev/null differ
diff --git a/doc/manual.sxw b/doc/manual.sxw
deleted file mode 100644 (file)
index 855cace..0000000
Binary files a/doc/manual.sxw and /dev/null differ