Merge pull request #95 from sitegeist/documentationCleanup

Update Documentation

.gitattributes

@@ -1,3 +1,4 @@
+/Build/ export-ignore
 /.github export-ignore
 /.gitattributes export-ignore
 /.editorconfig export-ignore

.gitignore

@@ -1,4 +1,4 @@
 .Build
 composer.lock
-/Documentation-GENERATED-temp
+Documentation-GENERATED-temp
 var/

Build/Documentation/docker-compose.yml

@@ -0,0 +1,8 @@
+version: '3'
+services:
+ t3docmake:
+ image: t3docs/render-documentation:latest
+ command: makehtml
+ volumes:
+ - ../../:/PROJECT:ro
+ - ./Documentation-GENERATED-temp:/RESULT

Documentation/AdministratorManual/Index.rst → Documentation/Configuration/Index.rst

@@ -6,15 +6,12 @@
 .. include:: ../Includes.txt
 
 
-.. _admin-manual:
+.. _configuration:
 
-Administrator Manual
+Configuration
 ====================
 
-Installation
-------------
-
-.. figure:: ../Images/AdministratorManual/ConstantsEditor.png
+.. figure:: ../Images/Configuration/ConstantsEditor.png
  :width: 650px
  :alt: Constants Editor
 
@@ -30,19 +27,3 @@ Depending on the preferred image setup, these values can be adjusted to fit the
 The image sizes can be altered or modified without major consequences. You should however make sure that your configuration covers the area between 400 and 1000 pixels as this is the most common area of screen sizes. Also note that widths and pixel density descriptors must not be mixed!
 
 If you modify the sizes query, you should note that this applies to *all* content images by default, so this could have broad consequences to the download size of your website. The default value makes sure that the image can't get larger than the value configured in the backend. Long story short: You should know what you're doing.
-
-Updating from 1.x
------------------
-
-There are a few breaking changes which might require you to update your integration:
-
-- Support for TYPO3 8.7 is gone. Please use version 1.3 of the extension.
-- The ``picturefill`` attribute of ``<sms:image />`` and ``<sms:media />`` has been removed, so you need to remove it from your Fluid templates. Separate markup for picturefill.js is no longer required, so the extension now outputs standards-compliant markup at any time.
-- In addition to svg files, gif files are now excluded as well. You can change this by adjusting the ``ignoreFileExtensions`` parameter.
-- If ``lazyload`` is enabled, image tags will get a ``class="lazyload"`` automatically.
-
-There are also some changes under the hood you might want to consider:
-
-- The PHP namespace has switched from ``SMS\SmsResponsiveImages`` to ``Sitegeist\ResponsiveImages``, so if you extended one of the provided PHP classes, you need to adjust this.
-- The extension now uses ``.1579774724`` instead of ``.100`` to overwrite the image partial of fluid_styled_content. This means that there will be less interference with other extensions. However, if you need to overwrite the ``Image.html`` file again, you need to specify your partial after that value.
-- The demo plugin is gone, so if you were using it, it won't work anymore.

Documentation/Index.rst

@@ -59,6 +59,7 @@ SMS Responsive Images
  :titlesonly:
 
  Introduction/Index
- AdministratorManual/Index
- DeveloperManual/Index
+ Installation/Index
+ Configuration/Index
+ Usage/Index
  Links

Documentation/Installation/Index.rst

@@ -0,0 +1,69 @@
+.. ==================================================
+.. FOR YOUR INFORMATION
+.. --------------------------------------------------
+.. -*- coding: utf-8 -*- with BOM.
+
+.. include:: ../Includes.txt
+
+
+.. _installation:
+
+Installation
+====================
+
+Composer mode
+=============
+
+If your TYPO3 installation uses Composer, install the latest version of the
+extension through:
+
+.. code-block:: bash
+
+ composer require sitegeist/sms-responsive-images
+
+If you want to use a different version of the extension, you need to
+add a version constraint, for example:
+
+.. code-block:: bash
+
+ composer require sitegeist/sms-responsive-images:"^1.3"
+
+Legacy mode
+===========
+
+If you are working with a TYPO3 installation that does not use Composer, install
+the extension in the Extension Manager:
+
+- Navigate to :guilabel:`Admin Tools > Extensions > Get Extensions`.
+- Click on :guilabel:`Update now`
+- Search for `sms_responsive_images`
+- Click :guilabel:`Import and install` on the side of the extension entry
+
+and activate it:
+
+- Navigate to :guilabel:`Admin Tools > Extensions > Installed Extensions`
+- Search for `sms_responsive_images`
+- Activate the extension by clicking on the :guilabel:`Activate` button in the
+ :guilabel:`A/D` column
+
+.. seealso::
+
+ On pages ":doc:`Managing Extensions <t3start:Extensions/Management>`" and
+ ":doc:`Managing Extensions - Legacy Guide <t3start:Extensions/LegacyManagement>`"
+ both TYPO3 installation modes are explained in detail.
+
+Updating from 1.x
+-----------------
+
+There are a few breaking changes which might require you to update your integration:
+
+- Support for TYPO3 8.7 is gone. Please use version 1.3 of the extension.
+- The ``picturefill`` attribute of ``<sms:image />`` and ``<sms:media />`` has been removed, so you need to remove it from your Fluid templates. Separate markup for picturefill.js is no longer required, so the extension now outputs standards-compliant markup at any time.
+- In addition to svg files, gif files are now excluded as well. You can change this by adjusting the ``ignoreFileExtensions`` parameter.
+- If ``lazyload`` is enabled, image tags will get a ``class="lazyload"`` automatically.
+
+There are also some changes under the hood you might want to consider:
+
+- The PHP namespace has switched from ``SMS\SmsResponsiveImages`` to ``Sitegeist\ResponsiveImages``, so if you extended one of the provided PHP classes, you need to adjust this.
+- The extension now uses ``.1579774724`` instead of ``.100`` to overwrite the image partial of fluid_styled_content. This means that there will be less interference with other extensions. However, if you need to overwrite the ``Image.html`` file again, you need to specify your partial after that value.
+- The demo plugin is gone, so if you were using it, it won't work anymore.

Documentation/Links.rst

@@ -12,7 +12,7 @@ Links
 -----
 
 :TER:
- https://typo3.org/extensions/repository/view/sms_responsive_images
+ https://extensions.typo3.org/extension/sms_responsive_images
 
 :Bug Tracker:
  https://github.com/sitegeist/sms-responsive-images/issues

Documentation/Settings.cfg

@@ -0,0 +1,90 @@
+# #####
+#
+# Settings.cfg - A TYPO3 Documentation Project's Configuration File
+# Information about Settings.cfg:
+# https://docs.typo3.org/m/typo3/docs-how-to-document/master/en-us/GeneralConventions/DirectoryFilenames.html#settings-cfg
+#
+# About Syntax:
+# See https://docs.python.org/2/library/configparser.html
+#
+# Attention:
+# Only " ;" can start an inline comment.
+# This is: blank PLUS semicolon!
+#
+# #####
+
+[general]
+
+# .................................................................................
+# ... (required) title (displayed in left sidebar (desktop) or top panel (mobile)
+# .................................................................................
+
+project = SMS Responsive Images
+
+# .................................................................................
+# ... (recommended) version, displayed next to title (desktop) and in <meta name="book-version"
+# .................................................................................
+
+release = 2.0
+
+# .................................................................................
+# ... (recommended) displayed in footer
+# .................................................................................
+
+copyright = 2017
+
+[html_theme_options]
+
+# .................................................................................
+# ... (recommended) to get the "Edit me on Github Button"
+# .................................................................................
+
+github_branch = master
+github_repository = sitegeist/sms-responsive-images
+
+# .................................................................................
+# ... (recommended) Fill in values to get links in the "Related Links" section
+# .................................................................................
+
+# usually an email address
+project_contact = praetorius@sitegeist.de
+
+project_discussions =
+
+# URL of webpage of your extension (if it has one)
+project_home = https://extensions.typo3.org/extension/sms_responsive_images
+
+# URL to Issues
+project_issues = https://github.com/sitegeist/sms-responsive-images/issues
+
+# URL of repository
+project_repository = https://github.com/sitegeist/sms-responsive-images
+
+[notify]
+
+about_new_build = praetorius@sitegeist.de
+
+[intersphinx_mapping]
+
+# .................................................................................
+# for cross-referencing across manuals (intersphinx) with :ref:
+#
+# You must uncomment all manuals you use in your cross-references
+#
+# Example usage:
+# :ref:`t3contribute:start` will link to start page of Contribution Guide
+# .................................................................................
+
+# h2document = https://docs.typo3.org/m/typo3/docs-how-to-document/master/en-us/
+# t3coreapi = https://docs.typo3.org/m/typo3/reference-coreapi/master/en-us/
+t3editors = https://docs.typo3.org/m/typo3/tutorial-editors/master/en-us/
+# t3extbasebook = https://docs.typo3.org/m/typo3/book-extbasefluid/master/en-us/Index.html
+# t3install = https://docs.typo3.org/m/typo3/guide-installation/master/en-us/
+# t3l10n = https://docs.typo3.org/m/typo3/guide-frontendlocalization/master/en-us/
+t3start = https://docs.typo3.org/m/typo3/tutorial-getting-started/master/en-us/
+# t3sitepackage = https://docs.typo3.org/m/typo3/tutorial-sitepackage/master/en-us/
+# t3tca = https://docs.typo3.org/m/typo3/reference-tca/master/en-us/
+# t3templating = https://docs.typo3.org/m/typo3/tutorial-templating-with-fluid/master/en-us/
+# t3ts45 = https://docs.typo3.org/m/typo3/tutorial-typoscript-in-45-minutes/master/en-us/
+# t3tsconfig = https://docs.typo3.org/m/typo3/reference-tsconfig/master/en-us/
+t3tsref = https://docs.typo3.org/m/typo3/reference-typoscript/master/en-us/

Documentation/DeveloperManual/Index.rst → Documentation/Usage/Index.rst

@@ -6,9 +6,7 @@
 .. include:: ../Includes.txt
 
 
-.. _admin-manual:
-
-Developer Manual
+Usage
 ====================
 
 The extension provides two Fluid ViewHelpers which can generate various image markups. They extend the original ``<f:image />`` and ``<f:media />`` ViewHelpers, so they can also be used for non-responsive images.

README.md

@@ -23,7 +23,7 @@ This extension is available via packagist.
 
 Alternatively, you can install the extension from TYPO3 TER:
 
-[TYPO3 TER: sms_responsive_images](https://typo3.org/extensions/repository/view/sms_responsive_images)
+[TYPO3 TER: sms_responsive_images](https://extensions.typo3.org/extension/sms_responsive_images)
 
 For further instructions, please take a look at the full documentation.
 

composer.json

@@ -54,6 +54,7 @@
  "test": "phpunit -c .Build/vendor/typo3/testing-framework/Resources/Core/Build/UnitTests.xml Tests/",
  "prepare-release": [
  "rm -r .github .ecrc .editorconfig .gitattributes Tests"
- ]
+ ],
+ "render-documentation": "docker-compose -f Build/Documentation/docker-compose.yml run --rm t3docmake"
  }
 }

ext_emconf.php

@@ -9,7 +9,7 @@
  'state' => 'stable',
  'uploadfolder' => false,
  'clearCacheOnLoad' => false,
- 'version' => '2.1.1',
+ 'version' => '2.1.2',
  'constraints' => [
  'depends' => [
  'typo3' => '9.5.0-11.9.99',