[TASK] Support TYPO3 9 LTS (Related to #62)

Updated documentation
jonathanheilmann · Dec 10, 2018 · db64202 · db64202
1 parent cab2717
commit db64202
Show file tree

Hide file tree

Showing 10 changed files with 105 additions and 14 deletions.
diff --git a/Documentation/Administration/GlobalAjax/Index.rst b/Documentation/Administration/GlobalAjax/Index.rst
@@ -6,6 +6,8 @@ Global Ajax
 
 Available since version 0.3.0:
 
+Global ajax is deprecated and will be removed in EXT:jh_magnificpopup version 3.0.0.
+
 With the global ajax option enabled (plugin.tx_jhmagnificpopup.type.ajax.enableglobal) and eID for method ajax enabled (plugin.tx_jhmagnificpopup.useEidForAjaxMethod), it's possible to open every content-link in a Magnific Popup lightbox.
 
 To enable the lightbox for a content-link add class "mfp-ajax-link".

diff --git a/Documentation/BreakingChanges/Index.rst b/Documentation/BreakingChanges/Index.rst
@@ -10,6 +10,7 @@ Breaking changes
    :titlesonly:
    :glob:
 
+   Version2000000/Index
    Version1000000/Index
    Version060/Index
    Version050/Index

diff --git a/Documentation/BreakingChanges/Version2000000/Index.rst b/Documentation/BreakingChanges/Version2000000/Index.rst
@@ -0,0 +1,33 @@
+.. include:: ../../Includes.txt
+
+
+Version 2.0.0
+^^^^^^^^^^^^^
+
+Dropped support of dedicated styling extensions
+"""""""""""""""""""""""""""""""""""""""""""""""
+As supporting multiple styling extensions like css_styled_content, fluid_styled_content and bootstrap_package and their
+dedicated versions, support of these extensions has been dropped.
+Instead of that EXT:jh_magnificpopup provides it's own styles to solve this.
+If you adapted the old extensions templates, please read next passage "Compatibility mode".
+
+
+Compatibility mode
+""""""""""""""""""
+As the templates has been reworked, there may be some breaking changes with your custom template adaptions.
+To make your life easier, there is a compatibility mode, which will activate the old processing of data before passing
+them to the template. Also the old paths will be used.
+
+To enable compatibility mode set `plugin.tx_jhmagnificpopup.compatibilityMode` in Constant Editor category
+`PLUGIN.TX_JHMAGNIFICPOPUP`
+
+eID
+"""
+Usage of eID (ajax hooks) is marked as deprecated and will be removed in EXT:jh_magnificpopup version 3.0.0 as usage is
+not as simple and popular as expected.
+If you still require support, please contact me.
+
+type ajax
+"""""""""
+Connected to deprecation of eID, type ajax is marked as deprecated, too. In default mode, the plugin falls back to type
+inline, within compatibility mode, type ajax is available and the extension uses the deprecated classes.
diff --git a/Documentation/Changelog/Index.rst b/Documentation/Changelog/Index.rst
@@ -15,6 +15,12 @@ ChangeLog
    :Changes:
          Changes
 
+ - :Version:
+         2.0.0
+
+   :Changes:
+        \* [TASK]          #62   Support TYPO3 9 LTS
+
  - :Version:
          1.1.0
 

diff --git a/Documentation/ConfigurationOfLightbox/TyposcriptConstantsMagnificpopup/Index.rst b/Documentation/ConfigurationOfLightbox/TyposcriptConstantsMagnificpopup/Index.rst
@@ -115,10 +115,9 @@ TypoScript Constants – magnificpopup
 .. container:: table-row
 
    Property
-         support
+         image
 
    Data type
-         arpe
          array
 
    Description

diff --git a/Documentation/ConfigurationOfPlugin/TyposcriptConstantsMagnificpopup/Index.rst b/Documentation/ConfigurationOfPlugin/TyposcriptConstantsMagnificpopup/Index.rst
@@ -30,12 +30,58 @@ TypoScript Constants – magnificpopup
          boolean
 
    Description
-         Since version 0.3.0: Activate to use eID for Magnific Popup type ajax instead of pageNum
+        | Since version 0.3.0: Activate to use eID for Magnific Popup type ajax instead of pageNum
+        | Deprecated and will be removed in EXT:jh_magnificpopup version 3.0.0.
 
    Default
          0
 
 
+.. container:: table-row
+
+   Property
+         compatibilityMode
+
+   Data type
+         boolean
+
+   Description
+         Stay compatible to templates/partials from extension version 1.x
+
+   Default
+         0
+
+
+.. container:: table-row
+
+   Property
+         commonCss
+
+   Data type
+         string
+
+   Description
+         Since version 2.0.0: Path to common css (empty to include no css)
+
+   Default
+         EXT:jh_magnificpopup/Resources/Public/css/common.css
+
+
+.. container:: table-row
+
+   Property
+         jhStImg
+
+   Data type
+         string
+
+   Description
+         Path to jh-st-img
+
+   Default
+         EXT:jh_magnificpopup/Resources/Public/Vendor/jh-st-img/jhstimg.js
+
+
 .. container:: table-row
 
    Property

diff --git a/...tation/ConfigurationOfPlugin/TyposcriptConstantsMagnificpopuptypeajax/Index.rst b/...tation/ConfigurationOfPlugin/TyposcriptConstantsMagnificpopuptypeajax/Index.rst
@@ -4,6 +4,8 @@
 TypoScript Constants – magnificpopup.type.ajax
 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 
+Type ajax is deprecated and will be removed in EXT:jh_magnificpopup version 3.0.0.
+
 This constants-array is used for Display type “Content-Reference” and
 “Inline-Content” with Method “ajax”. Some important constants may be
 overwritten inside the plugin-setup by flexform-settings.

diff --git a/Documentation/Development/AjaxHook/Index.rst b/Documentation/Development/AjaxHook/Index.rst
@@ -4,7 +4,9 @@
 Ajax Hook
 ^^^^^^^^^
 
-(Available since version 0.3.0)
+Available since version 0.3.0
+
+Ajax hooks are deprecated and will be removed in EXT:jh_magnificpopup version 3.0.0.
 
 Use this hook if you want to add your own type to be opend as ajax lightbox.
 

diff --git a/Documentation/Settings.cfg b/Documentation/Settings.cfg
@@ -19,8 +19,8 @@
 ; you can use in 'conf.py'
 
 project     = Magnific Popup
-version     = 1.1
-release     = 1.1.0
+version     = 2.0
+release     = 2.0.0
 t3author    = Jonathan Heilmann
 copyright   = 2013-2018, Jonathan Heilmann, <[email protected]>
 

diff --git a/Documentation/UsersManual/Plugin/Index.rst b/Documentation/UsersManual/Plugin/Index.rst
@@ -31,22 +31,22 @@ Select "Display type" (Link, Inline-Content or Content-Reference) and "Link type
 
    :Description:
          | Available if Link type is "Text":
-         | The text that is displayed to the user
+         | The text displayed to the user
 
  - :Field:
          Link image
 
    :Description:
          | Available if Link type is "Image":
-         | The image that is displayed to the user
+         | The image displayed to the user
 
  - :Field:
          Link target
 
    :Description:
          The Link target ( `http://www.you-domain.tld <http://www.you-
          domain.tld/>`_ ). This could be a website, a youtube-movie or
-         everything else.
+         anything else.
 
 
 .. ###### END~OF~TABLE ######
@@ -69,20 +69,20 @@ Select "Display type" (Link, Inline-Content or Content-Reference) and "Link type
 
    :Description:
          | Available if Link type is "Text":
-         | The text that is displayed to the user
+         | The text displayed to the user
 
  - :Field:
          Link image
 
    :Description:
          | Available if Link type is "Image":
-         | The image that is displayed to the user
+         | The image displayed to the user
 
  - :Field:
          Method
 
    :Description:
-         Select the way the content is loaded.Inline renders the content when
+         Select the way the content is loaded. Inline renders the content when
          opening the page with the link, ajax loads the content when the user
          opens the link.
 
@@ -113,14 +113,14 @@ Select "Display type" (Link, Inline-Content or Content-Reference) and "Link type
 
    :Description:
          | Available if Link type is "Text":
-         | The text that is displayed to the user
+         | The text displayed to the user
 
  - :Field:
          Link image
 
    :Description:
          | Available if Link type is "Image":
-         | The image that is displayed to the user
+         | The image displayed to the user
 
  - :Field:
          Method