Update documentation for ViewHelpers

jweiland-net · Aug 13, 2019 · 8031faa · 8031faa
1 parent 8d0b2b3
commit 8031faa
Show file tree

Hide file tree

Showing 8 changed files with 35 additions and 19 deletions.
diff --git a/Documentation/ChangeLog/Index.rst b/Documentation/ChangeLog/Index.rst
@@ -1,12 +1,15 @@
 .. include:: ../Includes.txt
 
-
 .. _changelog:
 
 =========
 ChangeLog
 =========
 
+**Version 3.2.0**
+
+- Added SplitFileRef ViewHelper to split file paths into pieces
+
 **Version 3.1.1**
 
 - Better support for solr from version 3.0 until 9.0

diff --git a/Documentation/Configuration/Index.rst b/Documentation/Configuration/Index.rst
@@ -1,6 +1,5 @@
 .. include:: ../Includes.txt
 
-
 .. _configuration:
 
 =============
@@ -12,7 +11,6 @@ Target group: **Developers, Integrators**
 jwtools2 initially does nothing after installation. Each feature has to be activated manually with
 Extensionmanager configuration (TYPO3 8.7) or with module Settings since TYPO3 9.5.
 
-
 Extension configuration
 =======================
 
@@ -100,7 +98,6 @@ If you activate ``typo3TransferTypoScriptCurrent`` we make use of a hook in TYPO
 This option will only work for cObj types CONTENT and RECORD.
 
 
-
 .. _reduceCategoriesToPageTree:
 
 reduceCategoriesToPageTree

diff --git a/Documentation/Index.rst b/Documentation/Index.rst
@@ -1,6 +1,5 @@
 .. include:: Includes.txt
 
-
 .. Every manual should have a start label for cross-referencing to
 .. start page. Do not remove this!
 
@@ -46,13 +45,11 @@ Extension Name
    The content of this document is related to TYPO3,
    a GNU/GPL CMS/Framework available from `www.typo3.org <https://typo3.org/>`__.
 
-
    **Table of Contents**
 
 .. toctree::
    :maxdepth: 3
 
-
    Introduction/Index
    Installation/Index
    Configuration/Index

diff --git a/Documentation/Installation/Index.rst b/Documentation/Installation/Index.rst
@@ -1,7 +1,5 @@
 .. include:: ../Includes.txt
 
-
-
 .. _installation:
 
 ============
@@ -20,7 +18,6 @@ The extension needs to be installed like any other extension of TYPO3 CMS:
 
 #. Install extension
 
-
 Next step
 =========
 

diff --git a/Documentation/Introduction/Index.rst b/Documentation/Introduction/Index.rst
@@ -1,13 +1,11 @@
 .. include:: ../Includes.txt
 
-
 .. _introduction:
 
 ============
 Introduction
 ============
 
-
 .. _what-it-does:
 
 What does it do?
@@ -17,7 +15,7 @@ Solr-Features
 -------------
 
 We deliver a task to update all of your configured Solr indexers. There is no need to create one Solr indexer task
-for each pagetree anymore.
+for each PageTree anymore.
 
 In our jwtools2 backend module you have the possibility to clear individual solr cores by indexer type.
 
@@ -29,8 +27,8 @@ Since version 3.0.0 we have a new task to execute your individual SQL-Query.
 TYPO3 Settings
 --------------
 
-There are some settings for TYPO3 you can activate in extensionmanager instead of writing pageTSconfig. As
-an example: One click to show page UID in pagetree.
+There are some settings for TYPO3 you can activate in ExtensionManager instead of writing PageTSConfig. As
+an example: One click to show page UID in PageTree.
 
 Commands
 --------
@@ -44,3 +42,29 @@ Database
 If you make use of ConnectionPool::getQueryBuilderForTable() in backend you will also retrieve deleted records. To
 prevent that we have created a BackendRestrictionContainer. You can use it on your own or you can use our
 method ``JWeiland\Jwtools2\Database::getQueryBuilderForTable()``
+
+ViewHelpers
+-----------
+
+Solr.IndexStatusViewHelper
+**************************
+
+With this ViewHelper you will get the Progress Status of a Solr Site in percent.
+
+Solr.MemoryStatusViewHelper
+***************************
+
+With this ViewHelper you will get the used Memory usage and available system RAM for selected Solr Site.
+
+Solr.NextRunViewHelper
+**********************
+
+Calculates next run of Solr Indexer in seconds.
+
+SplitFileRefViewHelper
+**********************
+
+With version 3.2.0 we have ported functionality of method GeneralUtility::split_fileref into its own
+ViewHelper. This is very useful, if you want your own preview image for videos for example. See an example here:
+`Add Preview image to your videos
+<https://jweiland.net/typo3/beispiele-anleitungen-faq/allgemeines/vorschaubild-fuer-videos-einbinden.html>`__
diff --git a/Documentation/KnownProblems/Index.rst b/Documentation/KnownProblems/Index.rst
@@ -1,6 +1,5 @@
 .. include:: ../Includes.txt
 
-
 .. _known-problems:
 
 ==============

diff --git a/Documentation/Settings.cfg b/Documentation/Settings.cfg
@@ -21,8 +21,8 @@
 ; you can use in 'conf.py'
 
 project     = jwtools2
-version     = 3.1
-release     = 3.1.1
+version     = 3.2
+release     = 3.2.0
 t3author    = Stefan Froemken
 copyright   = since 2019 by jweiland.net
 

diff --git a/Documentation/ToDoList/Index.rst b/Documentation/ToDoList/Index.rst
@@ -1,6 +1,5 @@
 .. include:: ../Includes.txt
 
-
 .. _todo:
 
 ==========