diff --git a/.editorconfig b/.editorconfig index 96bbc0c1..c42c878e 100644 --- a/.editorconfig +++ b/.editorconfig @@ -1,5 +1,5 @@ -# EditorConfig is awesome: http://EditorConfig.org +# EditorConfig is awesome: https://EditorConfig.org # # Use as master: https://github.com/TYPO3-Documentation/T3DocTeam/blob/master/.editorconfig diff --git a/Documentation/.editorconfig b/Documentation/.editorconfig index e080df0c..3ae573dd 100644 --- a/Documentation/.editorconfig +++ b/Documentation/.editorconfig @@ -1,4 +1,4 @@ -# EditorConfig is awesome: http://EditorConfig.org +# EditorConfig is awesome: https://EditorConfig.org # top-most EditorConfig file? false = no! root = false diff --git a/Documentation/Composer/Index.rst b/Documentation/Composer/Index.rst deleted file mode 100644 index 234a2448..00000000 --- a/Documentation/Composer/Index.rst +++ /dev/null @@ -1,149 +0,0 @@ -.. include:: ../Includes.txt -.. highlight:: bash - -.. _composer-working-with: - -===================== -Working With Composer -===================== - -This chapter includes a number of helpful commands and best practices for -using TYPO3 with Composer. - -Run Composer Locally -==================== - -You should not run `composer` on your live webspace. You should always run -`composer` on your local or a dedicated deployment machine, so you can test -if everything worked -fine. After running your tests, you can deploy the :file:`vendor` and -:file:`public` folder to your web server. - -To avoid conflicts between your local and your server's PHP version, you -can define your server's PHP version in your :file:`composer.json` file -(e.g. ``{"platform": {"php": "7.2"}}``), so `composer` will always check -the correct dependencies. - -Update Packages -=============== - -After updating any packages, you always should commit your -:file:`composer.lock` to your version control system and your co-workers -should run `composer install` after checking out the updates. - -Update all Packages -------------------- - -Run `composer update` without any other attributes, to update all -packages. Composer will always try to install the newest packages that -match the defined version constraints. - -.. note:: - - Be careful with that. This command may cause negative effects if you - do not have proper version constraints in your :file:`composer.json`. - You always should prefer to update your packages separately. - -Update Single Packages ----------------------- - -When you want to update single packages, you can call `composer update` -with the package name. You should always add -``--with-all-dependencies`` attribute to also update the required third -party packages. - -Update TYPO3 Core -~~~~~~~~~~~~~~~~~ - - -Update all system extensions:: - - composer update typo3/cms-* --with-all-dependencies - -Update Extensions Like "news" -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - -:: - - composer update georgringer/news --with-all-dependencies - -Use Dev Requirements -==================== - -Add packages with ``--dev`` attribute to add packages only to your local -development environment. This is very useful for packages, you do not -need or do not want to have on your live server, e.g. PHPUnit or -Testing-Frameworks: - -:: - - composer require typo3/testing-framework:^2.0 --dev - -During your deployment routine, you should run ``composer install`` with -attribute ``--no-dev``. So the dev requirements are not installed. - -:: - - composer install --no-dev - - -.. _composer-remove-extension: - -Remove Extensions -================= - -You can use the composer command `remove` to uninstall extensions or -other composer packages. - -:: - - composer remove georgringer/news - -Don't forget to commit your updated :file:`composer.lock` to your version -control system. - -.. note:: - - Please be sure to disable extensions in TYPO3's Extension Manager, before removing them with `composer`. - Or ensure to regenerate your :file:`typo3conf/PackageStates.php` file automatically, after removing the packages. You could use the - `extension "typo3_console" `__ for that - - - -Check for Available Updates -=========================== - -Run `composer outdated` to see a list of available updates. - -Run `composer outdated -D` to see a list of available updates for directly required packages. - -Useful Packages and Bundles -=========================== - -Simplify "Subtree Split" Installations --------------------------------------- - -Instead of explicitly requiring each core extension, you can require -`typo3/minimal `__, which -brings the minimal required set of system extensions. - -TYPO3 CMS Base Distribution ---------------------------- - -Primarily, `typo3/cms-base-distribution `__ -is not meant to be used with `composer require`, but to really quickly start new composer based TYPO3 projects. - -Nevertheless, it's very good to have heard about it. If you're interested in more information, you should check -the packages `README `__. - -.. _secure-web: - -Secure Web ----------- - -`helhum/typo3-secure-web `__ -follows the very interesting concept to split the traditional web root directory into -two parts: the "public" one for all the resources, that must be directly accessible via -HTTP (images, styles, etc.) - and the "private" folder, where all the PHP will be located. - -This helps to make your TYPO3 installations even more secure! diff --git a/Documentation/ExtensionInstallation/Index.rst b/Documentation/ExtensionInstallation/Index.rst deleted file mode 100644 index 14950bc9..00000000 --- a/Documentation/ExtensionInstallation/Index.rst +++ /dev/null @@ -1,331 +0,0 @@ -.. include:: ../Includes.txt - - -.. _extension-installation: - -====================== -Extension Installation -====================== - -.. tip:: - - If you have installed TYPO3 with Composer, you should also - :ref:`install extensions with Composer `. - -In the context of the TYPO3 extension manager ("EM"), the words "install" and "uninstall" differ from their mainstream -meaning. To avoid mixing these terms up with the other EM verbs, here is a clarification: - -Import - Downloading an extension from TER and copying it to :file:`typo3conf/ext/`. - -Install - Activating the already imported extension inside the extension manager and performing database changes mandated by the extension. - -Uninstall - Deactivating an extension, but leaving it on the disk. - -Remove - Deleting extension files permanently from disk. - -.. _install-extension-without-composer: - -Install an Extension Without Composer -===================================== - -In the backend: - -.. rst-class:: bignums - -1. Got to :guilabel:`"ADMIN TOOLS" > "Extensions"` -2. In the Docheader, select :guilabel:`"Get Extensions"` - - .. figure:: ../Images/em_extensions.png - :class: with-shadow - :alt: Select "Get Extensions" in Extension Manager - - Select "Get Extensions" in Extension Manager - -3. Click :guilabel:`"Update now"` - - The button is on the top right. - - - .. figure:: ../Images/em_extensions_get.png - :class: with-shadow - :alt: Search for the extension and install - - Search for the extension and install - - -4. Enter the name of the extension in the search field -5. Click on :guilabel:`"Go"` -6. Click on the Action icon on the left for the extension: - - :guilabel:`"Import and Install"` - - Now the extension is installed, but not activated. To activate: - -7. Choose :guilabel:`"Installed Extensions"` in the Docheader -8. Click on the icon with a :guilabel:`"+"` sign for your extension - in the :guilabel:`"A/D"` column. - -.. _uninstall_extension_without_composer: - -Uninstall an Extension Without Composer -======================================= - -If you installed TYPO3 via composer you should uninstall Extensions via composer. - -Check Dependencies ------------------- - -First find out, which other extensions and functions of your TYPO3 installation are dependent on the extension you -want to uninstall. You can find out about the dependencies by checking the -`Extension Repository `__. Look for the extension -you want to uninstall and the others you have installed. Read in each extensions manual the sections 'Dependencies' and -'Reverse dependencies'. - -Contemplate, whether you made referrals to the extension in any setup, config or other TypoScript section. Check if you -included a plugin from the extension in your web site. Think of the results of removing them and finally do it. - -If you are working locally or on a test server you might as well try to uninstall the extension. The Extension Manager -warns you about dependencies that are written in an extensions :file:`ext_emconf.php` constraints section. Note however -that you depend on the extensions developers faithfully noting all dependencies in this config file. - -If you get an exception and can't even access the Extension Manager anymore because of it, you can uninstall / install -extensions manually with :file:`PackageStates.php` as a last resort, see :ref:`uninstall-extension-manually` - -.. tip:: - Be sure not to uninstall extensions by trial and error on production systems, expecially not under time pressure. - -.. _uninstall-extension-backend: - -Uninstall / Deactivate Extension via TYPO3 Backend --------------------------------------------------- - -.. figure:: ../Images/em-uninstall-extension.png - :class: with-shadow - :alt: Select "Deactivate" in Extension Manager - -Log into the TYPO3 Backend and open the Extension Manager ('Ext Manager'). From the menu choose 'Install extensions'. -You get an overview about installed extensions. - -On the left side you see an icon, which shows the status of each extension, and what you can do: - -* Extension Install Icon with plus sign: The extension is not installed. (Click once to install) -* Extension Uninstall Icon with minus sign: The extension is installed and running. (Click once to uninstall) - -Next to the extension you want to uninstall click on Extension UnInstall Icon. After some seconds the icon changes to -the grey Extension Install Icon. - - -.. _remove-extension-backend: - -Remove an Extension via the TYPO3 Backend --------------------------------------------------- - -.. figure:: ../Images/em-remove-extension.png - :class: with-shadow - :alt: Select "Remove" in Extension Manager - -After successfully uninstalling an extension via the Extension Manager you can permanently remove the extension by -clicking on the waste-basket symbol "Remove" beside the extensions entry in the Extension Manager. - -.. _uninstall-extension-manually: - -Uninstalling an Extension Manually ----------------------------------- - -At times an extension causes a problem and the TYPO3 Backend can not be opened anymore due to it. In such a case the -extension can be uninstalled manually. This is not common practise but a last resort. - -Since LTS8 this can be done by removing the extensions configuration from the file :file:`PackageStates.php` - -.. rst-class:: bignums - -#. Open the file :file:`typo3conf/PackageStates.php` -#. Search for your ext_key in the array. - - .. code-block:: php - - 'ext_key' => [ - 'packagePath' => 'typo3conf/ext/ext_key/', - ], - ... - -#. Remove the entry. - -It is no longer possible to remove an extension by setting :php:`'state' => 'inactive'` as was possible in LTS 6 and 7. - -In LTS 6 and 7 this can be done by editing the file :file:`PackageStates.php` - -.. rst-class:: bignums - -#. Open the file :file:`typo3conf/PackageStates.php` -#. Search for your ext_key in the array. - - .. code-block:: php - - 'ext_key' => [ - 'composerName' => '...', - 'state' => 'active', - 'packagePath' => '.../', - 'suggestions' => [], - ], - ... - -#. Change :php:`'state' => 'active'` to :php:`'state' => 'inactive'` - - -.. _remove-extension-manually: - -Removing an Extension Manually ------------------------------- -Removing an extension manually is not common practice and should only be done as a last resort. You should only remove -an extension that you uninstalled successfully. Make a backup first. Then you can permanently -remove an extension by removing its folder at :file:`typo3conf/ext/[extensionname]`. The corresponding database tables -can be removed in the :guilabel:`Install Tool -> Important Actions -> Database analyzer -> Compare current database -with specification`. - -.. _install-extension-with-composer: - -Install an Extension With Composer -================================== - - -On the command line: - -.. rst-class:: bignums - -1. Find out the Composer package name and extension key of the extension: - - * :ref:`find-out-composer-package-name` - * :ref:`find-out-extension-key` - -2. Use `composer require` - - .. code-block:: shell - - composer require - - For example: - - .. code-block:: shell - - composer require georgringer/news - - This will add the extension requirement to your :file:`composer.json` - and install the extension. - - The extension will - not yet - be active. You must activate it with: - -3. Activate - - .. code-block:: shell - - ./vendor/bin/typo3 extension:activate - - For example: - - .. code-block:: shell - - ./vendor/bin/typo3 extension:activate news - - -Remove Extensions With Composer -=============================== - - -see :ref:`composer-remove-extension` - -.. _find-out-composer-package-name: - -Find out Composer Package Name for an Extension -=============================================== - -For example go to the `Extension Repository `__, -and search for the extension. - -You should see the Composer command under :guilabel:`"Composer support"`, -for example `for the extension news `__. - -Here, the package name is `georgringer/news`. - -.. figure:: ../Images/ter_news.png - :class: with-shadow - :alt: Detail view for extension "news" - - Detail view for extension "news" - -Often the package name will be vendor + slash + extension key. -However, if the extension key contains an underscore, it is replaced -with a slash in the package name. Example for -`Extension Builder `__: - -* **extension key**: extension_builder -* **Composer package name**: friendsoftypo3/extension-builder - -.. _composer-extension-dependencies: - -Extension Dependencies -====================== - -This section is about finding out about extension dependencies for Composer installation. - -When you install an extension, another extension may automatically have been installed -as was the case for the :ref:`installation of the Introduction Package `: -The Introduction Package depends on the Bootstrap Package and this extension was installed -as well. - -This is relevant, because after the installation, both need to be activated. - -You can see the dependencies on https://packagist.org (for example for the -`Introduction Package `__) -or in the composer.json file of the extension, for example: - -:file:`public/typo3conf/ext/introduction/composer.json`: - -.. this is json but results in warnings if lex "json" is used - -.. code-block:: none - - "require": { - "typo3/cms-core": "^9.5", - "typo3/cms-impexp": "^9.5", - "typo3/cms-form": "^9.5", - "typo3/cms-indexed-search": "^9.5", - "typo3/cms-felogin": "^9.5", - "bk2k/bootstrap-package": "^10.0" - }, - -Here, the package name is bk2k/bootstrap-package, but the extension key is bootstrap_package, -as is explained in :ref:`find-out-composer-package-name`. - - -Additional Information -====================== - -The following is independant of whether you install with Composer or without. - - -.. _find-out-extension-key: - -Find out the Extension Key for an Extension -------------------------------------------- - -Again, go to the `Extension Repository `__, -and search for the extension. - -.. figure:: ../Images/ter_news.png - :class: with-shadow - :alt: Detail view for extension "news" - - Detail view for extension "news" - -The extension key is listed on the top. For the -`extension news `__, -the extension key is `news`. - -You can also see the extension key in your file system in the directory -:file:`public/typo3conf/ext/`. The directory name of the extension is the -same as the extension key. diff --git a/Documentation/HistoricalInformation/BreakingChangesExtbase6.rst b/Documentation/HistoricalInformation/BreakingChangesExtbase6.rst deleted file mode 100644 index b2dbdbd8..00000000 --- a/Documentation/HistoricalInformation/BreakingChangesExtbase6.rst +++ /dev/null @@ -1,315 +0,0 @@ -.. include:: /Includes.txt - -.. _breakingChangesExtbase6: - -========================================================== -Breaking Changes in Extbase and Fluid in Version 1.1 - 6.2 -========================================================== - -Breaking Changes in Extbase and Fluid -===================================== - -This is a list of the most important changes. It does not include all -changes. - -For a more complete list please refer to the `Extbase Changelog for 6.2 -and -below `__ -and the `Fluid Changelog for 6.2 and -below `__ - -We try to keep breaking changes to a minimum. Nevertheless, there will -be some changes that might break your existing extensions, especially if -you interacted with classes/methods that are not part of the public API. - -Version Matrix --------------- - -This page handles Extbase 1.0.2 to 6.2 and some of the related Fluid -changes. The version span corresponds to TYPO3 versions 6.2 and older. -Later Extbase and Fluid versions (since TYPO3 version 4.7) have the same -version numbers as the TYPO3 version (at least for the first 2 digits, -e.g. 6.2). - -============== =============== ============= -Version Matrix -TYPO3 Version Extbase Version Fluid Version -6.2.x (latest) 6.2.0 6.2.0 -6.1.x (latest) 6.1.0 6.1.0 -6.0.x (latest) 6.0.0 6.0.0 -4.7.x (latest) 4.7.7 4.7.7 -4.6.x (latest) 1.4.6 1.4.2 -4.5.x (latest) 1.3.4 1.3.1 -4.4.x (latest) 1.2.1 1.2.1 -4.3.x (latest) 1.1.0 1.1.1 -\ -============== =============== ============= - -From Extbase 6.1 to Extbase 6.2 -------------------------------- - -Extbase -^^^^^^^ - -- **Recursive object validation**: Validation of object structures in - extbase is now done recursively. If a tree of objects is created by - the new property mapper, not only the top level object is validated, - but all objects. -- **Allow empty validation**: In order to make a property required you - now need to add the NotEmptyValidator to your property. The return - value of validators is now optional. -- **TypoScript Templates in the Backend**: In the Backend the - TypoScript Templates are not read from the first found root page more - for building the configuration. ATM the new way needs to be - discussed. -- **AbstractController::addFlashMessage()**: a convenience API for - adding FlashMessages in controller actions has been added as *public - function addFlashMessage()*. You might run into PHP fatal errors, if - your extension has implemented a function with the same name but a - different visibility (e.g. "protected"). The solution is to either - change the visibility of your function to "public" or remove your - function in favour of the one from extbase. - -Fluid -^^^^^ - -- **Image view helper does not render title tag by default**: In - previous versions of fluid the image view helper always rendered the - title attribute. If not set, the value of the required alt attribute - was set as title. This fallback was removed with version 6.2. If not - specifically set, title is not rendered anymore. -- **BooleanNode::convertToBoolean()**: Negative integer values are now - (correctly) recognized as "TRUE" boolean value. This might break in - condition in IfViewHelper which performs checks with negative values. - -From Extbase 6.0 to Extbase 6.1 -------------------------------- - -.. _extbase-1: - -Extbase -^^^^^^^ - -- **Introduce explicit saving of modified domain objects**: Modified - objects now need to be passed through their repository update method - in order to be scheduled for saving by the persistence managers - persistAll method. -- **Enable rewritten PropertyMapper as default**: After solving the - missing security features and bugfixes the rewritten PropertyMapper - is now ready to be used in production environments. -- **Remove support for TCA setting 'foreign_selector'**: After this - setting triggers the DataMapper to resolve the n:m relation on its - own and therefore no access to the additional fields in the - intermediate table is possible, the support for this setting was - removed. Now usage of e.g. FAL features is possible. -- **Remove forced STI settings from extbase configuration**: The - tx_extbase_type setting for fe_users and fe_groups was introduced as - a demonstration of Single Table Inheritance handled in extbase. The - forced setting brings more problems then doing good in real live - scenarios though. So the typoscript is dropped, but TCA and sql kept - for backwards compatibility reasons. Since 6.1 all fe_users and - fe_groups are therefore returned if you don't set the TypoScript - setting on your own. - -.. _fluid-1: - -Fluid -^^^^^ - -- **Allow Fluid arrays only in ViewHelper arguments**: This change - greatly enhances the JavaScript compatibility of Fluid. - -Fluid Arrays are a subset of the JavaScript object syntax, making it -hard to work with them in mixed HTML/JavaScript documents. For example -before this change, the following JavaScript Object was parsed by Fluid: - -:: - - var uris = { - endPoint1: '{f:uri.action(.)}', - endPoint2: '{f:uri.action(.)}', - }; - -Before this change, the above snippet resulted in the following -template, as the generated array was casted to a string: - -:: - - var uris = 'Array' - -With this change, Fluid only parses arrays which are used inside -ViewHelper arguments, such that an array inside normal text is not -converted anymore. This change is only breaking in very rare cases where -one relied on the inner contents of the ViewHelper being an array, f.e. -if one used the debug ViewHelper as follows: - -:: - - {key1: 'value1', key2: 'value2'} - -or if anybody wrote custom ViewHelpers which use this convention. -ViewHelpers which were written like this should be re-written to take -the array as ViewHelper argument: - -:: - - - -From Extbase 4.7 to Extbase 6.0 -------------------------------- - -.. _extbase-2: - -Extbase -^^^^^^^ - -- **FrontendUser->isOnline**: The property isOnline of FrontendUser - with its getter and setter was removed, because there is no TCA - definition for column is_online. - -Thus the property was not getting filled with data from database in -mappping process. - -.. _fluid-2: - -Fluid -^^^^^ - -- **Naming of Fluid Templates**: As of version 6.0 all Fluid template - filenames must begin with an uppercase letter. So if your action is - called sendEmail the corresponding Fluid template needs to be named - SendEmail.html. Lowercase Fluid template filenames were deprecated - for a long time and finally removed in 6.0. -- **Removed RenderFlashMessagesViewHelper**: The Fluid ViewHelper - RenderFlashMessagesViewHelper was removed after being deprecated for - some versions. Please use FlashMessagesViewHelper instead. - -From Extbase 1.4 to Extbase 4.7 -------------------------------- - -.. _extbase-3: - -Extbase -^^^^^^^ - -- A registered slot now gets the signal's information (classname::name) - by default set as last parameter in the arguments array. You can - avoid this by setting passSignalInformation to FALSE in your - connect()-call. - -From Extbase 1.3.x to Extbase 1.4.0 ------------------------------------ - -.. _extbase-4: - -Extbase -^^^^^^^ - -- The **Property Mapper** of FLOW3 has been reworked and backported to - Extbase. The new property mapper is very `configurable and - extensible `__ - [not available anymore]. Because this is a breaking change, the new - behavior is **disabled** by default. You can activate it for your new - Extensions with - *plugin.tx_[yourExtensionName].features.rewrittenPropertyMapper = 1* -- The **Validation API** has also changed, but this is only a breaking - change if you do NOT subclass **AbstractValidator**, but implement - **ValidatorInterface** yourself. In this case, you need to adjust - your custom validator to support the new API. -- The action resolving mechanism has been adjusted slightly and an - exception is thrown when a controller/action is requested that is not - configured to be supported by the current plugin. With the option - *plugin.tx_[yourExtensionName].mvc.throwPageNotFoundExceptionIfActionCantBeResolved - = 1* you can force Extbase to display the TYPO3 404 page not found - page instead. - -With Extbase 1.4.1 there will be a new option -*mvc.callDefaultActionIfActionCantBeResolved* that can be set in order -to **disable** the exception and fall back to the default -controller/action if an invalid action was requested. - -.. _fluid-3: - -Fluid -^^^^^ - -- **AbstractViewHelper::arguments** are no longer an object but an - array. If you used *$this->arguments->hasArgument()* in your custom - ViewHelpers, you'll have to replace this with $this->hasArgument(). -- With Fluid 1.4 you can use *{_all}* inside your template to access - all variables available right now. This is only a breaking change if - you used a variable \_all inside your own templates. -- Fluid templates, layouts and partials are now **compiled** with the - first rendering. This increases performance and decreases memory - consumption extensively. This should not be a breaking change as the - cache is automatically regenerated whenever the Fluid file changes. - -If you still want to disable Fluid compilation for debugging purposes, -you can do so by disabling the cache with -*$GLOBALS['TYPO3_CONF_VARS']['SYS']['caching']['cacheConfigurations']['fluid_template']['backend'] -= 't3lib_cache_backend_NullBackend';* - -From Extbase 1.2.x to Extbase 1.3.0 ------------------------------------ - -- We now have **Dependency Injection** in Extbase. This should work - seamlessly in most cases. However, if you used your own Dependency - Injection approach within your extension, you might have to adjust - the code slightly. -- **Tx_Extbase_Dispatcher** is now **deprecated**. The new entry point - for Extbase extensions is *Tx_Extbase_Core_Bootstrap* (analogical to - \\F3\FLOW3\Core\Bootstrap in FLOW3). Nevertheless, in order to stay - backwards compatible Tx_Extbase_Dispatcher will stay in Extbase until - version 1.5.0. -- **Tx_Extbase_Persistence_QueryInterface::execute()** now returns an - object of type **QueryResultInterface** instead of an array. The - QueryResult implements the interfaces **Countable**, **Iterator** and - **ArrayAccess** and should therefore behave like an array (you can - use it in loops and use the count() function on it). - -Due to a bug in PHP you can't use the *array_\** functions on the -QueryResult though. That applies to the *current()* function too, which -people used to return the first result. Instead you should use the -method *getFirst()* on the QueryResult. See -`QueryResult `__. - -- The **ConfigurationManager** has been reworked. As it was not part of - the Public API this should not be a breaking change to you. Anyways, - if you were referring to the ConfigurationManager in your extensions, - you most probably have to adjust your code. -- **Flashmessages** are now stored in the improved - *t3lib_FlashMessageQueue* internally. The API is still the same, but - a side-effect is, that the message queue is now handled **globally** - per request. This probably won't affect a lot of users though as - Flashmessages are usually only outputted as result of some user - input. -- The **UriBuilder** now uses the current cObject instead of creating a - new instance in the constructor. This is a breaking change if you - instantiated the UriBuilder in your code and passed in a cObject. - Please use the Extbase ObjectManager or inject the - ConfigurationManager manually. -- the *link.external* now adds by default HTTP:// in front of links, if - missing. This is a breaking change if you have links to HARD Coded - Pages on the same Server and your uri was like - "/some/other/stuff.html" without Domainname. Fix it by adding - defaultScheme= *to your command.* - -From Extbase 1.0.2 to Extbase 1.2.0 ------------------------------------ - -- *$query->execute()* now returns a **plain array** of row-arrays - instead of an *RowIterator*. This is a breaking change if you use - your own Query object in combination with - *$querySettings->getRawQueryResult = TRUE*. -- It's now possible to edit **localized domain models** in the FE. - Changes will be stored to the correct database row. This changes the - behavior of mapping the uid to DomainObjects. The uid is now the - "real" uid of the localized database tuple instead of the - sys_language_parent. This may influence the $_GET parameters of - cached pages as the uid is often part of the URI. -- Fluid template filenames are expected to be **UpperCamelCased** from - now on. For a grace period (until version 1.5.0) there is still a - fallback mechanism, so that your old template filenames will still - work. But you should rename your templates from "myaction.html" to - "MyAction.html" to make sure, that it still works in upcoming - versions of Fluid! diff --git a/Documentation/HistoricalInformation/Index.rst b/Documentation/HistoricalInformation/Index.rst deleted file mode 100644 index 03ec5492..00000000 --- a/Documentation/HistoricalInformation/Index.rst +++ /dev/null @@ -1,17 +0,0 @@ -.. include:: ../Includes.txt - -.. _historical-information: - -====================== -Historical Information -====================== - -In this chapter we keep historical information that might be of interest -when updating very old TYPO3 versions. - - -.. toctree:: - :titlesonly: - - BreakingChangesExtbase6 - diff --git a/Documentation/Images/AutomaticScreenshots/AdminTools/AdminToolsUpgradeOverview.png b/Documentation/Images/AutomaticScreenshots/AdminTools/AdminToolsUpgradeOverview.png new file mode 100644 index 00000000..f7adbbf1 Binary files /dev/null and b/Documentation/Images/AutomaticScreenshots/AdminTools/AdminToolsUpgradeOverview.png differ diff --git a/Documentation/Images/AutomaticScreenshots/AdminTools/AdminToolsUpgradeOverview.rst.txt b/Documentation/Images/AutomaticScreenshots/AdminTools/AdminToolsUpgradeOverview.rst.txt new file mode 100644 index 00000000..0194da41 --- /dev/null +++ b/Documentation/Images/AutomaticScreenshots/AdminTools/AdminToolsUpgradeOverview.rst.txt @@ -0,0 +1,6 @@ +.. Automatic screenshot: Remove this line if you want to manually change this file + +.. figure:: /Images/AutomaticScreenshots/AdminTools/AdminToolsUpgradeOverview.png + :class: with-shadow + + The "Upgrade" section of the Admin Tool. \ No newline at end of file diff --git a/Documentation/Images/AutomaticScreenshots/AdminTools/ClearAllCache.png b/Documentation/Images/AutomaticScreenshots/AdminTools/ClearAllCache.png new file mode 100644 index 00000000..a2f393fa Binary files /dev/null and b/Documentation/Images/AutomaticScreenshots/AdminTools/ClearAllCache.png differ diff --git a/Documentation/Images/AutomaticScreenshots/AdminTools/ClearAllCache.rst.txt b/Documentation/Images/AutomaticScreenshots/AdminTools/ClearAllCache.rst.txt new file mode 100644 index 00000000..ab0a527f --- /dev/null +++ b/Documentation/Images/AutomaticScreenshots/AdminTools/ClearAllCache.rst.txt @@ -0,0 +1,7 @@ +.. Automatic screenshot: Remove this line if you want to manually change this file + +.. figure:: /Images/AutomaticScreenshots/AdminTools/ClearAllCache.png + :alt: Flush Caches + :class: with-shadow + + The option "Flush" in the Admin Tool. \ No newline at end of file diff --git a/Documentation/Images/AutomaticScreenshots/AdminTools/DatabaseAnalyzer.png b/Documentation/Images/AutomaticScreenshots/AdminTools/DatabaseAnalyzer.png new file mode 100644 index 00000000..b14ac8f1 Binary files /dev/null and b/Documentation/Images/AutomaticScreenshots/AdminTools/DatabaseAnalyzer.png differ diff --git a/Documentation/Images/AutomaticScreenshots/AdminTools/DatabaseAnalyzer.rst.txt b/Documentation/Images/AutomaticScreenshots/AdminTools/DatabaseAnalyzer.rst.txt new file mode 100644 index 00000000..2f2d84ee --- /dev/null +++ b/Documentation/Images/AutomaticScreenshots/AdminTools/DatabaseAnalyzer.rst.txt @@ -0,0 +1,5 @@ +.. Automatic screenshot: Remove this line if you want to manually change this file + +.. figure:: /Images/AutomaticScreenshots/AdminTools/DatabaseAnalyzer.png + :alt: The Database Analyzer before analyzing the database + :class: with-shadow \ No newline at end of file diff --git a/Documentation/Images/AutomaticScreenshots/AdminTools/DatabaseAnalyzerDatabaseAnalyzed.png b/Documentation/Images/AutomaticScreenshots/AdminTools/DatabaseAnalyzerDatabaseAnalyzed.png new file mode 100644 index 00000000..0de92c40 Binary files /dev/null and b/Documentation/Images/AutomaticScreenshots/AdminTools/DatabaseAnalyzerDatabaseAnalyzed.png differ diff --git a/Documentation/Images/AutomaticScreenshots/AdminTools/DatabaseAnalyzerDatabaseAnalyzed.rst.txt b/Documentation/Images/AutomaticScreenshots/AdminTools/DatabaseAnalyzerDatabaseAnalyzed.rst.txt new file mode 100644 index 00000000..f46f33a7 --- /dev/null +++ b/Documentation/Images/AutomaticScreenshots/AdminTools/DatabaseAnalyzerDatabaseAnalyzed.rst.txt @@ -0,0 +1,7 @@ +.. Automatic screenshot: Remove this line if you want to manually change this file + +.. figure:: /Images/AutomaticScreenshots/AdminTools/DatabaseAnalyzerDatabaseAnalyzed.png + :alt: Database analyzer + :class: with-shadow + + The Database Analyzer with no updates to do \ No newline at end of file diff --git a/Documentation/Images/AutomaticScreenshots/AdminTools/InstallLanguagePacks.png b/Documentation/Images/AutomaticScreenshots/AdminTools/InstallLanguagePacks.png new file mode 100644 index 00000000..2e82b13e Binary files /dev/null and b/Documentation/Images/AutomaticScreenshots/AdminTools/InstallLanguagePacks.png differ diff --git a/Documentation/Images/AutomaticScreenshots/AdminTools/InstallLanguagePacks.rst.txt b/Documentation/Images/AutomaticScreenshots/AdminTools/InstallLanguagePacks.rst.txt new file mode 100644 index 00000000..fece2b0b --- /dev/null +++ b/Documentation/Images/AutomaticScreenshots/AdminTools/InstallLanguagePacks.rst.txt @@ -0,0 +1,7 @@ +.. Automatic screenshot: Remove this line if you want to manually change this file + +.. figure:: /Images/AutomaticScreenshots/AdminTools/InstallLanguagePacks.png + :alt: Manage language packs + :class: with-shadow + + The option "Manage language packs" in the Install Tool \ No newline at end of file diff --git a/Documentation/Images/AutomaticScreenshots/AdminTools/RemoveTemporaryAssets.png b/Documentation/Images/AutomaticScreenshots/AdminTools/RemoveTemporaryAssets.png new file mode 100644 index 00000000..afd5b0bf Binary files /dev/null and b/Documentation/Images/AutomaticScreenshots/AdminTools/RemoveTemporaryAssets.png differ diff --git a/Documentation/Images/AutomaticScreenshots/AdminTools/RemoveTemporaryAssets.rst.txt b/Documentation/Images/AutomaticScreenshots/AdminTools/RemoveTemporaryAssets.rst.txt new file mode 100644 index 00000000..5db26efd --- /dev/null +++ b/Documentation/Images/AutomaticScreenshots/AdminTools/RemoveTemporaryAssets.rst.txt @@ -0,0 +1,7 @@ +.. Automatic screenshot: Remove this line if you want to manually change this file + +.. figure:: /Images/AutomaticScreenshots/AdminTools/RemoveTemporaryAssets.png + :alt: Remove temporary assets + :class: with-shadow + + The option "Remove temporary assets" in the Install Tool. \ No newline at end of file diff --git a/Documentation/Images/AutomaticScreenshots/AdminTools/ResetUserPreferences.png b/Documentation/Images/AutomaticScreenshots/AdminTools/ResetUserPreferences.png new file mode 100644 index 00000000..c1cbe916 Binary files /dev/null and b/Documentation/Images/AutomaticScreenshots/AdminTools/ResetUserPreferences.png differ diff --git a/Documentation/Images/AutomaticScreenshots/AdminTools/ResetUserPreferences.rst.txt b/Documentation/Images/AutomaticScreenshots/AdminTools/ResetUserPreferences.rst.txt new file mode 100644 index 00000000..ec215c9b --- /dev/null +++ b/Documentation/Images/AutomaticScreenshots/AdminTools/ResetUserPreferences.rst.txt @@ -0,0 +1,7 @@ +.. Automatic screenshot: Remove this line if you want to manually change this file + +.. figure:: /Images/AutomaticScreenshots/AdminTools/ResetUserPreferences.png + :alt: Reset User Preferences + :class: with-shadow + + The option "Reset Backend User Preferences" in the Install Tool \ No newline at end of file diff --git a/Documentation/Images/AutomaticScreenshots/ImportExport/CheckExport.png b/Documentation/Images/AutomaticScreenshots/ImportExport/CheckExport.png new file mode 100644 index 00000000..e029e1a4 Binary files /dev/null and b/Documentation/Images/AutomaticScreenshots/ImportExport/CheckExport.png differ diff --git a/Documentation/Images/AutomaticScreenshots/ImportExport/CheckExport.rst.txt b/Documentation/Images/AutomaticScreenshots/ImportExport/CheckExport.rst.txt new file mode 100644 index 00000000..36887345 --- /dev/null +++ b/Documentation/Images/AutomaticScreenshots/ImportExport/CheckExport.rst.txt @@ -0,0 +1,7 @@ +.. Automatic screenshot: Remove this line if you want to manually change this file + +.. figure:: /Images/AutomaticScreenshots/ImportExport/CheckExport.png + :alt: Check the exported data + :class: with-shadow + + Check the exported data \ No newline at end of file diff --git a/Documentation/Images/AutomaticScreenshots/ImportExport/ContextMenuExport.png b/Documentation/Images/AutomaticScreenshots/ImportExport/ContextMenuExport.png new file mode 100644 index 00000000..ab5cc41c Binary files /dev/null and b/Documentation/Images/AutomaticScreenshots/ImportExport/ContextMenuExport.png differ diff --git a/Documentation/Images/AutomaticScreenshots/ImportExport/ContextMenuExport.rst.txt b/Documentation/Images/AutomaticScreenshots/ImportExport/ContextMenuExport.rst.txt new file mode 100644 index 00000000..a5bb84b3 --- /dev/null +++ b/Documentation/Images/AutomaticScreenshots/ImportExport/ContextMenuExport.rst.txt @@ -0,0 +1,7 @@ +.. Automatic screenshot: Remove this line if you want to manually change this file + +.. figure:: /Images/AutomaticScreenshots/ImportExport/ContextMenuExport.png + :alt: Select Then select "Export" + :class: with-shadow + + Select Then select "Export" \ No newline at end of file diff --git a/Documentation/Images/AutomaticScreenshots/ImportExport/ContextMenuMore.png b/Documentation/Images/AutomaticScreenshots/ImportExport/ContextMenuMore.png new file mode 100644 index 00000000..237c4f3d Binary files /dev/null and b/Documentation/Images/AutomaticScreenshots/ImportExport/ContextMenuMore.png differ diff --git a/Documentation/Images/AutomaticScreenshots/ImportExport/ContextMenuMore.rst.txt b/Documentation/Images/AutomaticScreenshots/ImportExport/ContextMenuMore.rst.txt new file mode 100644 index 00000000..070313c0 --- /dev/null +++ b/Documentation/Images/AutomaticScreenshots/ImportExport/ContextMenuMore.rst.txt @@ -0,0 +1,7 @@ +.. Automatic screenshot: Remove this line if you want to manually change this file + +.. figure:: /Images/AutomaticScreenshots/ImportExport/ContextMenuMore.png + :alt: Select "More options..." from the context menu of the page tree + :class: with-shadow + + Select "More options..." from the context menu of the page tree \ No newline at end of file diff --git a/Documentation/Images/AutomaticScreenshots/ImportExport/DownloadExport.png b/Documentation/Images/AutomaticScreenshots/ImportExport/DownloadExport.png new file mode 100644 index 00000000..0167b8f6 Binary files /dev/null and b/Documentation/Images/AutomaticScreenshots/ImportExport/DownloadExport.png differ diff --git a/Documentation/Images/AutomaticScreenshots/ImportExport/DownloadExport.rst.txt b/Documentation/Images/AutomaticScreenshots/ImportExport/DownloadExport.rst.txt new file mode 100644 index 00000000..18b6bb65 --- /dev/null +++ b/Documentation/Images/AutomaticScreenshots/ImportExport/DownloadExport.rst.txt @@ -0,0 +1,7 @@ +.. Automatic screenshot: Remove this line if you want to manually change this file + +.. figure:: /Images/AutomaticScreenshots/ImportExport/DownloadExport.png + :alt: Download the export data + :class: with-shadow + + Download the export data \ No newline at end of file diff --git a/Documentation/Images/AutomaticScreenshots/ImportExport/ExportDialog.png b/Documentation/Images/AutomaticScreenshots/ImportExport/ExportDialog.png new file mode 100644 index 00000000..158d1255 Binary files /dev/null and b/Documentation/Images/AutomaticScreenshots/ImportExport/ExportDialog.png differ diff --git a/Documentation/Images/AutomaticScreenshots/ImportExport/ExportDialog.rst.txt b/Documentation/Images/AutomaticScreenshots/ImportExport/ExportDialog.rst.txt new file mode 100644 index 00000000..3d1ef0fa --- /dev/null +++ b/Documentation/Images/AutomaticScreenshots/ImportExport/ExportDialog.rst.txt @@ -0,0 +1,7 @@ +.. Automatic screenshot: Remove this line if you want to manually change this file + +.. figure:: /Images/AutomaticScreenshots/ImportExport/ExportDialog.png + :alt: Select the tables to be exported + :class: with-shadow + + Select the tables to be exported \ No newline at end of file diff --git a/Documentation/Images/AutomaticScreenshots/ImportExport/ExportDialogInfiniteLevels.png b/Documentation/Images/AutomaticScreenshots/ImportExport/ExportDialogInfiniteLevels.png new file mode 100644 index 00000000..34aab14c Binary files /dev/null and b/Documentation/Images/AutomaticScreenshots/ImportExport/ExportDialogInfiniteLevels.png differ diff --git a/Documentation/Images/AutomaticScreenshots/ImportExport/ExportDialogInfiniteLevels.rst.txt b/Documentation/Images/AutomaticScreenshots/ImportExport/ExportDialogInfiniteLevels.rst.txt new file mode 100644 index 00000000..7d496145 --- /dev/null +++ b/Documentation/Images/AutomaticScreenshots/ImportExport/ExportDialogInfiniteLevels.rst.txt @@ -0,0 +1,7 @@ +.. Automatic screenshot: Remove this line if you want to manually change this file + +.. figure:: /Images/AutomaticScreenshots/ImportExport/ExportDialogInfiniteLevels.png + :alt: Select the page levels to be exported + :class: with-shadow + + Select the page levels to be exported \ No newline at end of file diff --git a/Documentation/Images/AutomaticScreenshots/ImportExport/UploadImport.png b/Documentation/Images/AutomaticScreenshots/ImportExport/UploadImport.png new file mode 100644 index 00000000..6b176a68 Binary files /dev/null and b/Documentation/Images/AutomaticScreenshots/ImportExport/UploadImport.png differ diff --git a/Documentation/Images/AutomaticScreenshots/ImportExport/UploadImport.rst.txt b/Documentation/Images/AutomaticScreenshots/ImportExport/UploadImport.rst.txt new file mode 100644 index 00000000..3d406d9b --- /dev/null +++ b/Documentation/Images/AutomaticScreenshots/ImportExport/UploadImport.rst.txt @@ -0,0 +1,7 @@ +.. Automatic screenshot: Remove this line if you want to manually change this file + +.. figure:: /Images/AutomaticScreenshots/ImportExport/UploadImport.png + :alt: Upload the export data + :class: with-shadow + + Upload the export data \ No newline at end of file diff --git a/Documentation/Images/AutomaticScreenshots/Upgrade/UpgradeAnalysis.png b/Documentation/Images/AutomaticScreenshots/Upgrade/UpgradeAnalysis.png new file mode 100644 index 00000000..465492c1 Binary files /dev/null and b/Documentation/Images/AutomaticScreenshots/Upgrade/UpgradeAnalysis.png differ diff --git a/Documentation/Images/AutomaticScreenshots/Upgrade/UpgradeAnalysis.rst.txt b/Documentation/Images/AutomaticScreenshots/Upgrade/UpgradeAnalysis.rst.txt new file mode 100644 index 00000000..3b3730bb --- /dev/null +++ b/Documentation/Images/AutomaticScreenshots/Upgrade/UpgradeAnalysis.rst.txt @@ -0,0 +1,7 @@ +.. Automatic screenshot: Remove this line if you want to manually change this file + +.. figure:: /Images/AutomaticScreenshots/Upgrade/UpgradeAnalysis.png + :alt: Upgrade Analysis + :class: with-shadow + + The "Upgrade Analysis" in the Install Tool \ No newline at end of file diff --git a/Documentation/Images/AutomaticScreenshots/Upgrade/UpgradeWizard.png b/Documentation/Images/AutomaticScreenshots/Upgrade/UpgradeWizard.png new file mode 100644 index 00000000..b34e1459 Binary files /dev/null and b/Documentation/Images/AutomaticScreenshots/Upgrade/UpgradeWizard.png differ diff --git a/Documentation/Images/AutomaticScreenshots/Upgrade/UpgradeWizard.rst.txt b/Documentation/Images/AutomaticScreenshots/Upgrade/UpgradeWizard.rst.txt new file mode 100644 index 00000000..c9f7de87 --- /dev/null +++ b/Documentation/Images/AutomaticScreenshots/Upgrade/UpgradeWizard.rst.txt @@ -0,0 +1,7 @@ +.. Automatic screenshot: Remove this line if you want to manually change this file + +.. figure:: /Images/AutomaticScreenshots/Upgrade/UpgradeWizard.png + :alt: Upgrade wizard + :class: with-shadow + + The "Upgrade Wizard" in the Install Tool. \ No newline at end of file diff --git a/Documentation/Images/AutomaticScreenshots/Upgrade/UpgradeWizardExecute.png b/Documentation/Images/AutomaticScreenshots/Upgrade/UpgradeWizardExecute.png new file mode 100644 index 00000000..906b0062 Binary files /dev/null and b/Documentation/Images/AutomaticScreenshots/Upgrade/UpgradeWizardExecute.png differ diff --git a/Documentation/Images/AutomaticScreenshots/Upgrade/UpgradeWizardExecute.rst.txt b/Documentation/Images/AutomaticScreenshots/Upgrade/UpgradeWizardExecute.rst.txt new file mode 100644 index 00000000..92e72808 --- /dev/null +++ b/Documentation/Images/AutomaticScreenshots/Upgrade/UpgradeWizardExecute.rst.txt @@ -0,0 +1,5 @@ +.. Automatic screenshot: Remove this line if you want to manually change this file + +.. figure:: /Images/AutomaticScreenshots/Upgrade/UpgradeWizardExecute.png + :alt: Choose "No, do not execute" + :class: with-shadow \ No newline at end of file diff --git a/Documentation/Images/composer-ter-abandoned.png b/Documentation/Images/ExternalScreenshots/ComposerTerAbandoned.png similarity index 100% rename from Documentation/Images/composer-ter-abandoned.png rename to Documentation/Images/ExternalScreenshots/ComposerTerAbandoned.png diff --git a/Documentation/Images/ExternalScreenshots/ComposerTerAbandoned.rst.txt b/Documentation/Images/ExternalScreenshots/ComposerTerAbandoned.rst.txt new file mode 100644 index 00000000..9f8bb99e --- /dev/null +++ b/Documentation/Images/ExternalScreenshots/ComposerTerAbandoned.rst.txt @@ -0,0 +1 @@ +.. image:: ../Images/ExternalScreenshots/ComposerTerAbandoned.png diff --git a/Documentation/Images/github-composer-file.png b/Documentation/Images/ExternalScreenshots/GithubComposerFile.png similarity index 100% rename from Documentation/Images/github-composer-file.png rename to Documentation/Images/ExternalScreenshots/GithubComposerFile.png diff --git a/Documentation/Images/ExternalScreenshots/GithubComposerFile.rst.txt b/Documentation/Images/ExternalScreenshots/GithubComposerFile.rst.txt new file mode 100644 index 00000000..e7dbaacd --- /dev/null +++ b/Documentation/Images/ExternalScreenshots/GithubComposerFile.rst.txt @@ -0,0 +1,2 @@ +.. image:: ../Images/ExternalScreenshots/GithubComposerFile.png + :scale: 80 % diff --git a/Documentation/Images/github-composer-name.png b/Documentation/Images/ExternalScreenshots/GithubComposerName.png similarity index 100% rename from Documentation/Images/github-composer-name.png rename to Documentation/Images/ExternalScreenshots/GithubComposerName.png diff --git a/Documentation/Images/ExternalScreenshots/GithubComposerName.rst.txt b/Documentation/Images/ExternalScreenshots/GithubComposerName.rst.txt new file mode 100644 index 00000000..541c0696 --- /dev/null +++ b/Documentation/Images/ExternalScreenshots/GithubComposerName.rst.txt @@ -0,0 +1,2 @@ +.. image:: ../Images/ExternalScreenshots/GithubComposerName.png + :scale: 80 % diff --git a/Documentation/Images/packagist-mask.png b/Documentation/Images/ExternalScreenshots/PackagistMask.png similarity index 100% rename from Documentation/Images/packagist-mask.png rename to Documentation/Images/ExternalScreenshots/PackagistMask.png diff --git a/Documentation/Images/ExternalScreenshots/PackagistMask.rst.txt b/Documentation/Images/ExternalScreenshots/PackagistMask.rst.txt new file mode 100644 index 00000000..f3545627 --- /dev/null +++ b/Documentation/Images/ExternalScreenshots/PackagistMask.rst.txt @@ -0,0 +1,2 @@ +.. image:: /Images/ExternalScreenshots/PackagistMask.png + :scale: 65 % diff --git a/Documentation/Images/satis-abandoned.png b/Documentation/Images/ExternalScreenshots/SatisAbandoned.png similarity index 100% rename from Documentation/Images/satis-abandoned.png rename to Documentation/Images/ExternalScreenshots/SatisAbandoned.png diff --git a/Documentation/Images/ExternalScreenshots/SatisAbandoned.rst.txt b/Documentation/Images/ExternalScreenshots/SatisAbandoned.rst.txt new file mode 100644 index 00000000..0bfdfb13 --- /dev/null +++ b/Documentation/Images/ExternalScreenshots/SatisAbandoned.rst.txt @@ -0,0 +1 @@ +.. image:: /Images/ExternalScreenshots/SatisAbandoned.png diff --git a/Documentation/Images/ter-code-link.png b/Documentation/Images/ExternalScreenshots/TerCodeLink.png similarity index 100% rename from Documentation/Images/ter-code-link.png rename to Documentation/Images/ExternalScreenshots/TerCodeLink.png diff --git a/Documentation/Images/ExternalScreenshots/TerCodeLink.rst.txt b/Documentation/Images/ExternalScreenshots/TerCodeLink.rst.txt new file mode 100644 index 00000000..4db0d108 --- /dev/null +++ b/Documentation/Images/ExternalScreenshots/TerCodeLink.rst.txt @@ -0,0 +1,2 @@ +.. image:: ../Images/ExternalScreenshots/TerCodeLink.png + :scale: 65 % diff --git a/Documentation/Images/ter-composer-command.png b/Documentation/Images/ExternalScreenshots/TerComposerCommand.png similarity index 100% rename from Documentation/Images/ter-composer-command.png rename to Documentation/Images/ExternalScreenshots/TerComposerCommand.png diff --git a/Documentation/Images/ExternalScreenshots/TerComposerCommand.rst.txt b/Documentation/Images/ExternalScreenshots/TerComposerCommand.rst.txt new file mode 100644 index 00000000..7b149476 --- /dev/null +++ b/Documentation/Images/ExternalScreenshots/TerComposerCommand.rst.txt @@ -0,0 +1,2 @@ +.. image:: /Images/ExternalScreenshots/TerComposerCommand.png + :scale: 65 % diff --git a/Documentation/Images/FirstInstall.png b/Documentation/Images/FirstInstall.png deleted file mode 100644 index 6dd3f0c4..00000000 Binary files a/Documentation/Images/FirstInstall.png and /dev/null differ diff --git a/Documentation/Images/ImpExUpload.png b/Documentation/Images/ImpExUpload.png deleted file mode 100644 index 6160a542..00000000 Binary files a/Documentation/Images/ImpExUpload.png and /dev/null differ diff --git a/Documentation/Images/ImpExpCheckExport.png b/Documentation/Images/ImpExpCheckExport.png deleted file mode 100644 index 21d92ff4..00000000 Binary files a/Documentation/Images/ImpExpCheckExport.png and /dev/null differ diff --git a/Documentation/Images/ImpExpContext.png b/Documentation/Images/ImpExpContext.png deleted file mode 100644 index 8bd9ea48..00000000 Binary files a/Documentation/Images/ImpExpContext.png and /dev/null differ diff --git a/Documentation/Images/ImpExpContext2.png b/Documentation/Images/ImpExpContext2.png deleted file mode 100644 index b64c31a3..00000000 Binary files a/Documentation/Images/ImpExpContext2.png and /dev/null differ diff --git a/Documentation/Images/ImpExpDialog.png b/Documentation/Images/ImpExpDialog.png deleted file mode 100644 index 6b75f8a8..00000000 Binary files a/Documentation/Images/ImpExpDialog.png and /dev/null differ diff --git a/Documentation/Images/ImpExpDialogInfinite.png b/Documentation/Images/ImpExpDialogInfinite.png deleted file mode 100644 index 3c7775e3..00000000 Binary files a/Documentation/Images/ImpExpDialogInfinite.png and /dev/null differ diff --git a/Documentation/Images/ImpExpDownload.png b/Documentation/Images/ImpExpDownload.png deleted file mode 100644 index 13f20bf2..00000000 Binary files a/Documentation/Images/ImpExpDownload.png and /dev/null differ diff --git a/Documentation/Images/Important-Actions-Clear-All-Cache.png b/Documentation/Images/Important-Actions-Clear-All-Cache.png deleted file mode 100644 index 8d5ea123..00000000 Binary files a/Documentation/Images/Important-Actions-Clear-All-Cache.png and /dev/null differ diff --git a/Documentation/Images/Important-Actions-Database-Analyzer-Database-Analyzed.png b/Documentation/Images/Important-Actions-Database-Analyzer-Database-Analyzed.png deleted file mode 100644 index bf881921..00000000 Binary files a/Documentation/Images/Important-Actions-Database-Analyzer-Database-Analyzed.png and /dev/null differ diff --git a/Documentation/Images/Important-Actions-Database-Analyzer.png b/Documentation/Images/Important-Actions-Database-Analyzer.png deleted file mode 100644 index 289ace99..00000000 Binary files a/Documentation/Images/Important-Actions-Database-Analyzer.png and /dev/null differ diff --git a/Documentation/Images/Install-Language-Packs.png b/Documentation/Images/Install-Language-Packs.png deleted file mode 100644 index 6c60202f..00000000 Binary files a/Documentation/Images/Install-Language-Packs.png and /dev/null differ diff --git a/Documentation/Images/IntroductionPackage.png b/Documentation/Images/IntroductionPackage.png deleted file mode 100644 index 93744a5d..00000000 Binary files a/Documentation/Images/IntroductionPackage.png and /dev/null differ diff --git a/Documentation/Images/Important-Actions-Database-Analyzer-Updates-Executed.png b/Documentation/Images/ManualScreenshots/DatabaseAnalyzerUpdatesExecuted.png similarity index 100% rename from Documentation/Images/Important-Actions-Database-Analyzer-Updates-Executed.png rename to Documentation/Images/ManualScreenshots/DatabaseAnalyzerUpdatesExecuted.png diff --git a/Documentation/Images/ManualScreenshots/DatabaseAnalyzerUpdatesExecuted.rst.txt b/Documentation/Images/ManualScreenshots/DatabaseAnalyzerUpdatesExecuted.rst.txt new file mode 100644 index 00000000..eba4a8f1 --- /dev/null +++ b/Documentation/Images/ManualScreenshots/DatabaseAnalyzerUpdatesExecuted.rst.txt @@ -0,0 +1,6 @@ + +.. figure:: /Images/ManualScreenshots/DatabaseAnalyzerUpdatesExecuted.png + :class: with-shadow + :alt: Database analyzer + + The Database Analyzer diff --git a/Documentation/Images/ImpExpV3.8.png b/Documentation/Images/ManualScreenshots/ImportExport/ImpExpV3.8.png similarity index 100% rename from Documentation/Images/ImpExpV3.8.png rename to Documentation/Images/ManualScreenshots/ImportExport/ImpExpV3.8.png diff --git a/Documentation/Images/ManualScreenshots/ImportExport/ImpExpV3.8.rst.txt b/Documentation/Images/ManualScreenshots/ImportExport/ImpExpV3.8.rst.txt new file mode 100644 index 00000000..ef0e5a54 --- /dev/null +++ b/Documentation/Images/ManualScreenshots/ImportExport/ImpExpV3.8.rst.txt @@ -0,0 +1,5 @@ +.. figure:: /Images/ManualScreenshots/ImportExport/ImpExpV3.8.png + :class: with-shadow + :alt: Export module of TYPO3 3.8.0 (year 2005) + + Export module of TYPO3 3.8.0 (year 2005) diff --git a/Documentation/Images/ImpExImport.png b/Documentation/Images/ManualScreenshots/ImportExport/ImportPreview.png similarity index 100% rename from Documentation/Images/ImpExImport.png rename to Documentation/Images/ManualScreenshots/ImportExport/ImportPreview.png diff --git a/Documentation/Images/ManualScreenshots/ImportExport/ImportPreview.rst.txt b/Documentation/Images/ManualScreenshots/ImportExport/ImportPreview.rst.txt new file mode 100644 index 00000000..00c10b59 --- /dev/null +++ b/Documentation/Images/ManualScreenshots/ImportExport/ImportPreview.rst.txt @@ -0,0 +1,5 @@ +.. figure:: /Images/ManualScreenshots/ImportExport/ImportPreview.png + :class: with-shadow + :alt: Preview the data + + Preview the data diff --git a/Documentation/Images/upgrade_wizard_install_taskcenter.png b/Documentation/Images/ManualScreenshots/UpgradeWizardExecute.png similarity index 100% rename from Documentation/Images/upgrade_wizard_install_taskcenter.png rename to Documentation/Images/ManualScreenshots/UpgradeWizardExecute.png diff --git a/Documentation/Images/ManualScreenshots/UpgradeWizardExecute.rst.txt b/Documentation/Images/ManualScreenshots/UpgradeWizardExecute.rst.txt new file mode 100644 index 00000000..1f5c08aa --- /dev/null +++ b/Documentation/Images/ManualScreenshots/UpgradeWizardExecute.rst.txt @@ -0,0 +1,2 @@ +.. image:: /Images/ManualScreenshots/UpgradeWizardExecute.png + :alt: Choose "No, do not execute" diff --git a/Documentation/Images/QuickInstall-1-System-Environment.png b/Documentation/Images/QuickInstall-1-System-Environment.png deleted file mode 100644 index 1f9f6d71..00000000 Binary files a/Documentation/Images/QuickInstall-1-System-Environment.png and /dev/null differ diff --git a/Documentation/Images/QuickInstall-2-Database-Connection.png b/Documentation/Images/QuickInstall-2-Database-Connection.png deleted file mode 100644 index 91d2f944..00000000 Binary files a/Documentation/Images/QuickInstall-2-Database-Connection.png and /dev/null differ diff --git a/Documentation/Images/QuickInstall-4-Admin-User-Sitename.png b/Documentation/Images/QuickInstall-4-Admin-User-Sitename.png deleted file mode 100644 index 22d601da..00000000 Binary files a/Documentation/Images/QuickInstall-4-Admin-User-Sitename.png and /dev/null differ diff --git a/Documentation/Images/QuickInstall-5-Last-Step.png b/Documentation/Images/QuickInstall-5-Last-Step.png deleted file mode 100644 index f9220d1e..00000000 Binary files a/Documentation/Images/QuickInstall-5-Last-Step.png and /dev/null differ diff --git a/Documentation/Images/Remove-Temporary-Assets.png b/Documentation/Images/Remove-Temporary-Assets.png deleted file mode 100644 index ee64874f..00000000 Binary files a/Documentation/Images/Remove-Temporary-Assets.png and /dev/null differ diff --git a/Documentation/Images/Reset-User-Preferences.png b/Documentation/Images/Reset-User-Preferences.png deleted file mode 100644 index a73f0938..00000000 Binary files a/Documentation/Images/Reset-User-Preferences.png and /dev/null differ diff --git a/Documentation/Images/Upgrade-Analysis.png b/Documentation/Images/Upgrade-Analysis.png deleted file mode 100644 index 7d3ab15e..00000000 Binary files a/Documentation/Images/Upgrade-Analysis.png and /dev/null differ diff --git a/Documentation/Images/Upgrade-Wizard.png b/Documentation/Images/Upgrade-Wizard.png deleted file mode 100644 index 2036ca35..00000000 Binary files a/Documentation/Images/Upgrade-Wizard.png and /dev/null differ diff --git a/Documentation/Images/admin-tools-maintenance-overview.png b/Documentation/Images/admin-tools-maintenance-overview.png deleted file mode 100644 index 1973feaa..00000000 Binary files a/Documentation/Images/admin-tools-maintenance-overview.png and /dev/null differ diff --git a/Documentation/Images/em-remove-extension.png b/Documentation/Images/em-remove-extension.png deleted file mode 100644 index 0a914724..00000000 Binary files a/Documentation/Images/em-remove-extension.png and /dev/null differ diff --git a/Documentation/Images/em-uninstall-extension.png b/Documentation/Images/em-uninstall-extension.png deleted file mode 100644 index dba55edb..00000000 Binary files a/Documentation/Images/em-uninstall-extension.png and /dev/null differ diff --git a/Documentation/Images/em_extensions.png b/Documentation/Images/em_extensions.png deleted file mode 100644 index 5139a7c8..00000000 Binary files a/Documentation/Images/em_extensions.png and /dev/null differ diff --git a/Documentation/Images/em_extensions_get.png b/Documentation/Images/em_extensions_get.png deleted file mode 100644 index 9f7a7b2b..00000000 Binary files a/Documentation/Images/em_extensions_get.png and /dev/null differ diff --git a/Documentation/Images/ext-on-packagist.png b/Documentation/Images/ext-on-packagist.png deleted file mode 100644 index 99385ca0..00000000 Binary files a/Documentation/Images/ext-on-packagist.png and /dev/null differ diff --git a/Documentation/Images/get_introduction_package.png b/Documentation/Images/get_introduction_package.png deleted file mode 100644 index 20fb4757..00000000 Binary files a/Documentation/Images/get_introduction_package.png and /dev/null differ diff --git a/Documentation/Images/startpage.png b/Documentation/Images/startpage.png deleted file mode 100644 index 08ecfbc3..00000000 Binary files a/Documentation/Images/startpage.png and /dev/null differ diff --git a/Documentation/Images/ter_news.png b/Documentation/Images/ter_news.png deleted file mode 100644 index 377b9cae..00000000 Binary files a/Documentation/Images/ter_news.png and /dev/null differ diff --git a/Documentation/In-depth/Distributions/Index.rst b/Documentation/In-depth/Distributions/Index.rst deleted file mode 100644 index f55ba536..00000000 --- a/Documentation/In-depth/Distributions/Index.rst +++ /dev/null @@ -1,57 +0,0 @@ -.. include:: ../../Includes.txt - - -.. _the-distributions: - -================= -The Distributions -================= - -Distributions were created to give new users easy access to a -preconfigured installation of TYPO3 that they could then use without the -need to set up and configure various parts of the CMS such as page -structure, content and templating. - -.. tip:: - - The following is only true, if you installed TYPO3 without Composer: - - When installing TYPO3 for the first time, you will be given the option to - access a set of "Preconfigured Distributions" once the installation is complete. - Upon selecting this option, you will be redirected to your installations "Extension Manger" - and given a list of Distributions to choose from. - - For an existing installation of TYPO3, distributions are already available and - can be accessed in the Extension Manager. - -.. note:: - - If you installed TYPO3 via Composer, all extensions and distributions - will need to be installed and managed via Composer. - - -.. _introduction-package: - -Introduction Package -==================== - -The Introduction Package is a complete, fully operational website. It it based on a -responsive design using bootstrap templates and contains example -content for testing and evaluation. This is ideal for new users who wish -to have a "look around" and get more familiar with the CMS. - -.. figure:: ../../Images/IntroductionPackage.png - :alt: Introduction Package - :class: with-shadow - - The Introduction Package provides a fully operational website based on bootstrap. - - -To install the introduction package, follow the instructions in :ref:`install-introduction-package`. - -.. important:: - - The steps for installing a distribution with Composer are the same as - installing an extension with Composer. See the section - :ref:`install-extension-with-composer` if you wish to install additional - extensions. You can also find more information in that section. diff --git a/Documentation/In-depth/Index.rst b/Documentation/In-depth/Index.rst deleted file mode 100644 index 06572a89..00000000 --- a/Documentation/In-depth/Index.rst +++ /dev/null @@ -1,22 +0,0 @@ -.. include:: ../Includes.txt - - -.. _in-depth-installation: - -====================== -Installation explained -====================== - - -.. toctree:: - :maxdepth: 5 - :titlesonly: - :glob: - - SystemRequirements/Index - WhichPackageAndFormat/Index - ThePackageInDetail/Index - TheInstallTool/Index - Distributions/Index - TranslatingTheBackend/Index - diff --git a/Documentation/In-depth/OpcodeCache/Index.rst b/Documentation/In-depth/OpcodeCache/Index.rst deleted file mode 100644 index e01bf87d..00000000 --- a/Documentation/In-depth/OpcodeCache/Index.rst +++ /dev/null @@ -1,158 +0,0 @@ -.. include:: /Includes.txt - -============ -Opcode Cache -============ - -Introduction -============ - -An opcode cache is a system to cache the result of the PHP code -compilation to bytecode. This allows to use the bytecode instead of -compiling on every request. Different opcode cache systems are -available, mostly depending on used PHP version. Currently usually -OPcache is used. - -Every opcode cache system has its own pitfalls, which we want to show -here, so you can configure your system as good as possible and to get -the message "This opcode cache should work correctly and has good -performance." in your TYPO3 installer. Opcode caching systems which -aren't listed here are not supported by TYPO3 CMS. - -In general, PHP opcode caches can lead to a massive performance -improvement of bigger PHP frameworks like TYPO3 CMS and can be seen as a -must-have in professional production environments. All existing opcode -cache solutions give a similar performance gain, the differences are -insignificant. But the performance gain between using one and not using -a opcode cache can be a factor of 3 in typical TYPO3 CMS installations. -A well configured PHP environment on decent hardware usually delivers a -full cached TYPO3 CMS frontend page in around 50 milliseconds or less. -Enabling an opcode cache reduces this to 18ms or less! This gain is not -so big for pages that are not delivered from cache, since the actual -calculation time and database stuff has a bigger share than the compile -time of PHP scripts. Still, opcode caches can lead to a massive -performance gain and can make the website and the TYPO3 CMS backend more -snappy. - -General opcode cache considerations -=================================== - -Using opcode cache in CLI -------------------------- - -The implementation of opcode cache system is done by using Shared -Memory. This means only the same user from same process have access to -it. The options apc.enable_cli or opcache.enable_cli do not give the -ability to change/reset the opcode cache of the webserver. So for -example package installation via CLI can lead to problems on the website -as the opcode cache does not correlate to the new settings. This issue -isn't easy fixable and an outstanding -`issue `__. - -(!) This issue applies to CLI scheduler tasks. - -(!) Using ApcBackend, WincacheBackend, XcacheBackend as caching backend -in your TYPO3 CMS installation will lead to the same problem. You can't -change the data from the website. - -Using PHP code on an NFS share ------------------------------- - -NFS Clients normally are using a transparent cache to the server, so they -don't need to gather directory or file data and content every time. This -leads to the issue that the server do not see every change on the NFS -Server by deployings or in caches. This issue affects not only PHP and -the opcode cache, you need to have this in mind if you use such multi -webserver installations. Disabling the NFS caching resolves this issue, -but slows down your server systems. If you use an opcode cache on such -an installation makes the issue more worse and clearing the opcode cache -may not only help as the NFS Client cache may again deliver outdated -file content. This tends to throw funny issues like "class already -declared" on PHP file changes (eg. after deployment). - -In general, it is often better to have all PHP code (typo3/, typo3conf/, -typo3temp/Cache) on local file systems deployed to the single servers, -than to share that on a network filesystem. While this strategy makes -deployment a bit harder, it usually improves performance and reduces -network load. - -Also using other systems without the NFS caching issue like DRBD helps. - -Opcode caches and PHP file changes ----------------------------------- - -In a perfect world, opcode caches are fully transparent. That means, if -PHP code is changed that is covered by an opcode cache, the opcode cache -detects this change and invalidates its cache entry of the file. This -works pretty well but it comes with overhead, since the opcode cache -needs to check change times on files on every request. If you need -maximum performance in production, disk load can be reduced by turning -those checks off. If PHP files are changed then, the opcode cache must -be explicitly hinted to invalidate its entries. Most opcode cache -systems default to stat file changes everytime, OPcache defaults to only -every 5 seconds, but this default behavior depends on your distribution. - -Opcode caches and symlinked pathes/files ----------------------------------------- - -Especially APC before 3.1.13 have the issue to detect that a file is the -same one if included with a path which includes a symlink. This may lead -to the issue that it tries to include same class twice which leads to -the fatal error "class already declared". Also APC tends to the issue -that it doesn't clear his cache if you change a file by changing a -symlink, even if the usual file change detections are turned on, and -delivers old opcache data. This seems to happen frequently for double -linked directories, for example if typo3/ is a link to typo3-src which -themself is a link to typo3-src-6.2.4 (this strategy is often used for -nice deployments since it allows to activate a full build by just -changing exactly one symlink). If then typo3/index.php is requested, APC -sometimes struggles to detect those link changes and throws funny -issues. This issue was also reported with older versions of -ZendOptimizerPlus. - -Opcode caches and amount of shared memory ------------------------------------------ - -To fully benefit from opcode caching, it is important to give the opcode -cache enough shared memory to work with. Typical base configurations -give 32MB or 64MB of RAM, and that is usually not enough for a single -TYPO3 CMS instance. If not enough memory is left, the opcode cache needs -to throw out scripts, so those need to be compiled again if requested. -All opcode caches have some diagnoses scripts to monitor the amount of -used memory. It is advisable to monitor the memory usage and tune the -according memory setting until it fits needs. - - -What do the messages mean in installer -====================================== - -See :ref:`troubleshooting Opcode Cache messages `. - - -OPcache -======= - -This opcode caching system comes mostly with your PHP 5.5 (or newer) -installation. It is derived from Zend Optimizer+ and maintained by the -PHP developers. - -Never set ---------- - -Do not set opcache.save_comments and opcache.load_comments to false. -Some internet pages mention this speeds up the website, but the code -information which will be removed with this options is needed by Extbase -and Fluid and therefore for TYPO3 CMS. - -Optimization ------------- - -On live systems you can set the option opcache.validate_timestamps to -false to gain a speedup. This prevents the cache from looking up every -opcache.revalidate_freq seconds if there is a changed PHP file. If you -update your system or an extension you should use the "clear opcode -cache" button in the install tool to clear the complete opcode cache so -the new files will be used. - -Please open an issue report if you experience issues with the -PhpCacheBackend and option opcache.validate_timestamps set to false. diff --git a/Documentation/In-depth/SystemRequirements/Index.rst b/Documentation/In-depth/SystemRequirements/Index.rst deleted file mode 100644 index 0569da64..00000000 --- a/Documentation/In-depth/SystemRequirements/Index.rst +++ /dev/null @@ -1,304 +0,0 @@ -.. include:: ../../Includes.txt - - -.. _system-requirements: - -=================== -System Requirements -=================== - -TYPO3 requires a web server, PHP and a database system. - -* TYPO3 requires a **web server** which can run PHP (Apache httpd, Nginx, - Microsoft IIS, Caddy Server). - If you use an Apache web server, some module (e.g. mod_rewrite) must be activated. - See :ref:`system-requirements-webserver` for details. - -* TYPO3 10 requires **PHP >= 7.2 <= 7.4** (Mac users: see warning at the end of this document). - For PHP, several PHP extensions are necessary, others recommended. You possibly want to - adjust the memory limit. See :ref:`system-requirements-php`. - -* TYPO3 can be used with many **database** systems (MariaDB >= 10.2 <= 10.3, - Microsoft SQL Server, MySQL 5.5+, PostgreSQL, SQLite). - See :ref:`system-requirements-database` on this page for details. - -* If you want TYPO3 to automatically carry out **image processing** – for example - scaling or cropping – you will need GraphicsMagick (version 1.3 or newer) or - ImageMagick (version 6 or - newer) installed on the server. (GraphicsMagick should be preferred.) - -For an overview see also `get.typo3.org -`_. - -Should you encounter problems, the ":ref:`troubleshooting`" chapter will help. - -.. _system-requirements-database: - -Database Environment -==================== - -TYPO3 works with database management systems in the above mentioned versions. -The InnoDB engine is required to be enabled in MySQL. - - -Required Database Privileges ----------------------------- - -The database user needs at least the following privileges on the TYPO3 -database: - -* SELECT, INSERT, UPDATE, DELETE - -* CREATE, DROP, INDEX, ALTER, CREATE TEMPORARY TABLES, LOCK TABLES - -It is recommended to also grant the following privileges: - -* CREATE VIEW, SHOW VIEW - -* EXECUTE, CREATE ROUTINE, ALTER ROUTINE - - -.. _system-requirements-webserver: - -Web Server Environment -====================== - -.. _system-requirements-apache: - -Apache ------- - -* Make sure `AllowOverride `__ - in the webserver configuration includes "Indexes" and "FileInfo" if you use Apache as - webserver and override the default configuration with :file:`.htaccess` (as done by default). - -* Enable Apache modules (see :ref:`enable-necessary-modules` in the Troubleshooting - section). The following modules are used by the default :file:`.htaccess`: - -mod_alias: - Block access to vcs directories - (strongly recommended for security reasons). - -mod_authz_core: - Block access to specific files and directories - (strongly recommended for security reasons). - -mod_autoindex: - Used for disabling directory listings - (strongly recommended for security reasons). - -mod_deflate: - Used for compression, better performance. - -mod_expires: - Adds HTTP headers for browser caching and better - performance - -mod_filter: - Used with mod_deflate. For Apache versions below - version 2.3.7 you don't need to enable `mod_filter`. - -mod_headers: - Used in combination with `mod_deflate`. - -mod_rewrite: - Enable human readable urls. - -mod_setenvif: - Also used with `mod_deflate`. - -.. important:: - - If the modules are not active, the corresponding directives in :file:`.htaccess` will - not be activated (due to the `` directives in the default :file:`.htaccess` file - `EXT:install/Resources/Private/FolderStructureTemplateFiles/root-htaccess `__ - for more clues about which modules are used for what purpose. Not all used modules - may have directives in the .htaccess file so do not necessarily expect :file:`.htaccess` - to contain a complete list of modules. - -* During the installation process (first install) the default :file:`.htaccess` file is - copied to the document root folder of the project, if the file does not exist already. - - -Microsoft Internet Information Services (IIS) ---------------------------------------------- - -* During the installation process (first install) the default IIS web config file is - copied to the document root folder of the project, if the file does not exist already. - -* Default IIS web config file with rewrite rules can be found in - :file:`EXT:install/Resources/Private/FolderStructureTemplateFiles/root-web-config` - -* Make sure that the `URL Rewrite plugin `__ is installed on your system. - -NGINX ------ - -* NGINX web server does not support any static file like htaccess in the document root by default. - The NGINX configuration has to be setup manually. - -Example Configuration: - -.. code-block:: nginx - - # Compressing resource files will save bandwidth and so improve loading speed especially for users - # with slower internet connections. TYPO3 can compress the .js and .css files for you. - # *) Set $GLOBALS['TYPO3_CONF_VARS']['BE']['compressionLevel'] = 9 for the Backend - # *) Set $GLOBALS['TYPO3_CONF_VARS']['FE']['compressionLevel'] = 9 together with the TypoScript properties - # config.compressJs and config.compressCss for GZIP compression of Frontend JS and CSS files. - location ~ \.js\.gzip$ { - add_header Content-Encoding gzip; - gzip off; - types { text/javascript gzip; } - } - location ~ \.css\.gzip$ { - add_header Content-Encoding gzip; - gzip off; - types { text/css gzip; } - } - - # TYPO3 - Rule for versioned static files, configured through: - # - $GLOBALS['TYPO3_CONF_VARS']['BE']['versionNumberInFilename'] - # - $GLOBALS['TYPO3_CONF_VARS']['FE']['versionNumberInFilename'] - if (!-e $request_filename) { - rewrite ^/(.+)\.(\d+)\.(php|js|css|png|jpg|gif|gzip)$ /$1.$3 last; - } - - # TYPO3 - Block access to composer files - location ~* composer\.(?:json|lock) { - deny all; - } - - # TYPO3 - Block access to flexform files - location ~* flexform[^.]*\.xml { - deny all; - } - - # TYPO3 - Block access to language files - location ~* locallang[^.]*\.(?:xml|xlf)$ { - deny all; - } - - # TYPO3 - Block access to static typoscript files - location ~* ext_conf_template\.txt|ext_typoscript_constants\.txt|ext_typoscript_setup\.txt { - deny all; - } - - # TYPO3 - Block access to miscellaneous protected files - location ~* /.*\.(?:bak|co?nf|cfg|ya?ml|ts|typoscript|tsconfig|dist|fla|in[ci]|log|sh|sql|sqlite)$ { - deny all; - } - - # TYPO3 - Block access to recycler and temporary directories - location ~ _(?:recycler|temp)_/ { - deny all; - } - - # TYPO3 - Block access to configuration files stored in fileadmin - location ~ fileadmin/(?:templates)/.*\.(?:txt|ts|typoscript)$ { - deny all; - } - - # TYPO3 - Block access to libraries, source and temporary compiled data - location ~ ^(?:vendor|typo3_src|typo3temp/var) { - deny all; - } - - # TYPO3 - Block access to protected extension directories - location ~ (?:typo3conf/ext|typo3/sysext|typo3/ext)/[^/]+/(?:Configuration|Resources/Private|Tests?|Documentation|docs?)/ { - deny all; - } - - location / { - try_files $uri $uri/ /index.php$is_args$args; - } - - # TYPO3 Backend URLs - location = /typo3 { - rewrite ^ /typo3/; - } - - location /typo3/ { - try_files $uri /typo3/index.php$is_args$args; - } - - - - location ~ [^/]\.php(/|$) { - fastcgi_split_path_info ^(.+?\.php)(/.*)$; - if (!-f $document_root$fastcgi_script_name) { - return 404; - } - fastcgi_buffer_size 32k; - fastcgi_buffers 8 16k; - fastcgi_connect_timeout 240s; - fastcgi_read_timeout 240s; - fastcgi_send_timeout 240s; - fastcgi_pass typo3:9000; - fastcgi_index index.php; - include fastcgi.conf; - } - - -.. _system-requirements-php: - -PHP Environment ---------------- - -* memory_limit set to at least 256M recommended - -* max_execution_time set to at least 30 (240 seconds recommended) - -* max_input_vars set to at least 1500 - - -PHP Required Extensions -~~~~~~~~~~~~~~~~~~~~~~~ - -Your PHP needs to support the following extensions. Install will check if these -are available. - -* These are usually part of the standard PHP package on most distributions and - are mandatory for a proper function: - - * PDO - * json - * pcre >= 8.38 (Mac users: see warning a the end of this document) - * session - * xml - * filter - * hash - * SPL - * standard - -* These are optional but highly recommended: - - * mbstring - -* These might have to be installed separately: - - * fileinfo - * gd - * zip - * zlib - * openssl - * intl - * mysqli (if you use MySQL, MariaDB as DBMS) - * postgresql (if you use PostgreSQL as DBMS) - * sqlsrv (if you use SQL Server as DBMS) - * sqlite (if you use SQLite as DBMS) - -.. warning:: - - With **PHP 7.3** in combination with **macOS** 10.13.6 (and probably also 10.14 - unconfirmed) - pcre causes problems with brew as well as native or MAMP installations. It is - recommended to use PHP 7.2. More information can be found here: - - * `Not working after upgrading to 7.3 `_ - * `Bug #77260 preg_match_all(): JIT compilation failed: no more memory `_ diff --git a/Documentation/In-depth/TheInstallTool/Index.rst b/Documentation/In-depth/TheInstallTool/Index.rst deleted file mode 100644 index bba0645c..00000000 --- a/Documentation/In-depth/TheInstallTool/Index.rst +++ /dev/null @@ -1,194 +0,0 @@ -.. include:: ../../Includes.txt - - -.. _the-install-tool-in-depth: - -======================= -TYPO3 System Management -======================= - -The TYPO3 Admin Tool area provides tools to help with the maintenance of your -installation: Upgrading, checking the system environment, configuring settings -from and solving problems. The standalone tool usage is not dependent on a -working Backend, and you access it using a single password. - -First go to your site and enter the admin tool via `/typo3/install.php`, e.g. https://www.example.com/typo3/install.php. - -.. hint:: - - If you see a message "The Install Tool is locked", create a new file named - "ENABLE_INSTALL_TOOL" in the folder :file:`public/typo3conf/`. Then reload - the page. - -.. note:: - - The Admin tool was called "Install Tool" in earlier versions, you will - likely still see that term in some places. - - -.. _important-actions: - -Maintenance -=========== - -The section provides basic information about your system and several functions -which you need for maintenance tasks. - -.. figure:: ../../Images/admin-tools-maintenance-overview.png - :class: with-shadow - :alt: Admin Tools: Maintenance Overview - - The "Maintenance" section of the Install Tool. - - -The **Flush TYPO3 and PHP Cache** functionality can empty all caches: Frontend, -Backend, language caches and the OPCode Cache. - -With **Analyze Database Structure** you can compare the current structure of -your database with the expected structure for the TYPO3 version you are using. -The next step allows you to update the structure of your database accordingly. - -**Remove Temporary Assets** allows you to clear temporary files and will -trigger regeneration when they are needed next. - -**Rebuild PHP Autoload Information** resets autoload information for all active -third party extensions. - -With **Clear persistent database tables** you can cleanup non-caching tables -like the history, log or backend sessions. Be aware that clearing backend -sessions will log out all active users. Clearing the history will remove all -history entries, you will not be able to use the content element history to -undo changes anymore. - -"Create administrative user" allows to create a new administrator (if wanted -with system maintenance role on top). The system maintainer role adds the -maintenance tools to the menu and allows easy access to the standalone admin -tool. - -If for some reason you or your editors have problems when editing in the TYPO3 -backend, clearing the backend user settings might help. In those preferences -various settings of a backend editor are stored, for example: which page tree -nodes are currently expanded. Click on "Reset backend user preferences" to -clear these settings and set them to their defaults. - -.. note:: - - Some technical background: User settings get saved in the database table - `be_users` in the `uc` (=User Configuration) field. When resetting the - backend user preferences this field is set to an empty string. - -Install new TYPO3 backend languages with the **Manage language packs** -functionality. You can update existing language packs (for example after -installing new extensions) or add new languages to the system. Afterwards, you -can choose between all installed languages in your user settings. - - -Settings -======== - -This area allows you to configure both TYPO3 extensions as well as the core. - -In **Extension Configuration** you can configure all enabled extensions that -provide custom configuration options. - -Via **Change Install Tool Password** you can set a new password for the -maintenance area. - -With **Manage system maintainers** you can add new system maintainers (admin -users with the additional role of **system maintainers**). System maintainers -have easier access to the maintenance tools of TYPO3. Be aware that this is -mainly a usability enhancement, blinding maintenance options for normal -administrators. As administrators still have elevated permissions you should -still be careful which users can be trusted with these rights. - -At **Configuration Presets** TYPO3 offers presets for common settings groups. -It allows for easier configuration of settings for debugging, image handling, -mail configuration and password hashing. - -TYPO3 provides **Feature Toggles** for certain features that have a major -impact on your system. You can enable or disable these features here. - -.. tip:: - - On new installation it is recommended to activate the following features for - TYPO3 9 LTS: - - - unifiedPageTranslationHandling - - TypoScript.strictSyntax - - simplifiedControllerActionDispatching - -**Configure Installation-Wide Options** (previously known as "All -Configuration") allows you to configure settings that impact how your complete -TYPO3 installation behaves. - -.. tip:: - - If you are new to TYPO3, take some time to read through all the options and - their explanation to get an impression of what TYPO3 offers. - - -The **Check for broken extensions** can be run to make sure that all -:file:`ext_tables` and :file:`ext_localconf` files contain valid PHP code, so -that they can be loaded without breaking the system. - -The **TCA Migrations** can be used to check whether the current TCA needs -migrations and displays applied migrations. - -The **Core update** can update the TYPO3 Core to the newest minor version. - -Apart from these functions, this section also contains options to change the -install tool password, to change the site name, to change the encryption key -and to create a Backend administrator user. Usually you do not need these -functions. - - -.. _upgrade-wizard: - -Upgrade -======= - -You don't need the upgrade section while *installing* TYPO3. These functions -will be explained in a later chapter about upgrading TYPO3. See -:ref:`upgrade`. - - -.. _system-environment: - -Environment -=========== - -The section contains a huge number of environment checks, which notify you of -(potential) problems in your installation. - -The **Environment Overview** provides a short system overview that you can also -access via Application Information in the top bar. - -The **Environment Status** runs checks on your server environment and reports -potentially wrong or missing settings. - -With **Directory Status** you can check whether all required files and folders -exist and are writable when necessary. It also shows the default file and -folder permissions TYPO3 will apply on creation of assets. - -**PHP Info** simply outputs the `phpinfo()`. - -**Test Mail Setup** allows you to test the mail setup of TYPO3 by sending a -test mail. - -.. tip:: - - If the test mail does not arrive, check the settings via "Settings" > - "Configuration Presets" > "Mail". - - -**Image Processing** checks various image rendering capabilities of your system -and displays hints if something goes wrong. - -.. tip:: - - If rendering fails you can copy the executed command and see if it works on - your favorite command line. If that works, the tool itself is working but - TYPO3 might have problems executing it. If the command does not work, you - might need to adjust the settings (via "Settings" > "Configuration Presets" - > "Image Handling"). - diff --git a/Documentation/In-depth/ThePackageInDetail/Index.rst b/Documentation/In-depth/ThePackageInDetail/Index.rst deleted file mode 100644 index da1cff19..00000000 --- a/Documentation/In-depth/ThePackageInDetail/Index.rst +++ /dev/null @@ -1,107 +0,0 @@ -.. include:: ../../Includes.txt - - -.. _the-distributions-in-detail: - -===================== -The Package in Detail -===================== - - -.. _typo3-folders-and-documents: - -TYPO3 Folders and Files on Root Level -===================================== - -The following files and folders are part of the TYPO3 package in a Composer -based installation. - -:file:`public/` - is the document root and public entry point. - -:file:`var/` - contains system files, like caches, logs, sessions... - -:file:`vendor/` - the Composer vendor directory contains third-party packages, libraries etc. - -The 'public' Folder -------------------- - -The following files and folders will be created in the public folder during the -installation of TYPO3: - -:file:`fileadmin/` - contains your site assets and files, local to the website. You can e.g. put - images, user uploads and other assets here. By default this folder is used to - store files, which have been uploaded in the TYPO3 Backend - (:file:`fileadmin/` is configured as the first default storage). - :file:`fileadmin/` must be writable for the web server user. Files in - :file:`fileadmin/` are for editors, you should not put any site configuration - files here. Exclude the :file:`fileadmin/` folder from your version control - to make sure not to mix development files and user files. - -:file:`typo3conf/` - contains configuration and extensions for the local site. - -:file:`typo3conf/ext/` - will hold the local extensions available for this installation, extensions - can be required via Composer. - -:file:`typo3conf/LocalConfiguration.php` - is the main configuration file of your installation and the one the - customized values of all the Install Tool options get written to. It has to - be writable and will be updated automatically by the Maintenance Tools and - the Extension Manager. You can edit this file manually, but make sure you - keep the PHP syntax working. - -:file:`typo3conf/PackageStates.php` - contains information about the extensions, which are activated in your - system. - -:file:`typo3conf/AdditionalConfiguration.php` - is an additional configuration file, which is executed on every request after - the :file:`LocalConfiguration.php` has been loaded. It can be used to - manipulate the configuration of - :code:`$GLOBALS['TYPO3_CONF_VARS']`. This file is not created - automatically; create it if you need it. - -:file:`index.php` - the main script for the website Frontend - - -.. _custom-folders: - -The `var` Folder ----------------- - -:file:`cache/` - is where file based caches will be stored. - -:file:`charset/` - contains charset conversion tables. - -:file:`labels/` - contains language labels for a translated TYPO3 backend. You can download - more languages via "Maintenance" > "Manage language labels" - -:file:`lock/` - is where file based locks are created. - -:file:`log/` - the default location for TYPO3 log files. Can be configured via the TYPO3 - logging framework. See `Logging Framework - `_. - -:file:`session/` - is where sessions are stored. - -:file:`transient/` - acts as transient storage during file operations for example. - - -Custom Folders? -=============== - -Yes, just add whatever you like. Why not? - diff --git a/Documentation/In-depth/TranslatingTheBackend/Index.rst b/Documentation/In-depth/TranslatingTheBackend/Index.rst deleted file mode 100644 index df111544..00000000 --- a/Documentation/In-depth/TranslatingTheBackend/Index.rst +++ /dev/null @@ -1,50 +0,0 @@ -.. include:: ../../Includes.txt - - -.. _translating-the-backend: - -======================= -Translating the Backend -======================= - -In order to use translations in the TYPO3 Backend, you first need to download -the translations and then select them for the Backend users. - - -.. _download-translations-for-the-backend: - -Download Translations for the Backend -===================================== - -Log in to the Backend and go to the Backend module "Maintenance". - -In the section "Manage Language Packs" click "Manage Languages". In the modal -window click "Add Language" to add a new language to TYPO3. - -After that click "Update all" to update the translations. This may take some -time. Some extensions do not have translatable texts and so also do not have -translations available. If for an extension you get an error message, wait -until the update has finished and then press "Update from repository" again. - -.. hint:: - - After installing new extensions, you'll have to update the language packs - again to get translations for the newly installed packages. - - -.. _change-the-language-for-a-backend-user: - -Change the Language for a Backend User -====================================== - -The Backend can be displayed in different languages for different users. Go to -the module "User settings". On the tab "Personal data" you can choose between -the languages, which you downloaded in the last step. Select the language, -which you want to use. Then click "Save Configuration" and after that reload -the Backend. - -When you are logged in as an administrator, you can also modify user settings -of *other* users: Go to the module "Backend Users" and switch to the Backend -user, which you want to edit. After that you can set user settings for this -user and adjust *his/her* language as well. - diff --git a/Documentation/In-depth/WhichPackageAndFormat/Index.rst b/Documentation/In-depth/WhichPackageAndFormat/Index.rst deleted file mode 100644 index fcd378ef..00000000 --- a/Documentation/In-depth/WhichPackageAndFormat/Index.rst +++ /dev/null @@ -1,42 +0,0 @@ -.. include:: ../../Includes.txt - -.. _which-package-and-which-file-format: - -========================= -With Composer or without? -========================= - -With Composer -============= - -The recommended way of installing TYPO3 is via the PHP package manager `Composer`. -For detailed instructions on how to install TYPO3 **with** Composer, visit the -:ref:`install-via-composer` section of this manual. - -When you install with Composer, you will install the core extensions and third -party extensions with the package manager Composer on the command line. You will -not be able to import extensions (e.g. from TER) in the TYPO3 backend via the browser! - -Without Composer -================ - -If you do not have access to Composer, you can install TYPO3 by downloading -and then extracting its source package on your web server. - -Directions for installing TYPO3 **without** Composer can be found in -:ref:`install-typo3-without-composer`. - -.. _which-file-format-to-use: - -Which File Format to Use ------------------------- - -.. tip:: - - This is only relevant if you install TYPO3 **without** Composer! - -The TYPO3 Source package is available as a :file:`.zip` or -:file:`.tar.gz` distribution. Their content is the same and you should -download the one that you will be able to extract directly on your -web server (Windows based systems are more likely to use the :file:`.zip` -file while Linux distributions tend to use the :file:`.tar.gz` file). diff --git a/Documentation/Includes.txt b/Documentation/Includes.rst.txt similarity index 94% rename from Documentation/Includes.txt rename to Documentation/Includes.rst.txt index b9e00d47..6396e5e2 100644 --- a/Documentation/Includes.txt +++ b/Documentation/Includes.rst.txt @@ -9,6 +9,7 @@ .. role:: typoscript(code) .. role:: yaml(code) .. role:: bash(code) +.. role:: shell(code) .. role:: ts(typoscript) :class: typoscript diff --git a/Documentation/Index.rst b/Documentation/Index.rst index 26479efd..90131dee 100644 --- a/Documentation/Index.rst +++ b/Documentation/Index.rst @@ -1,88 +1,98 @@ -.. include:: Includes.txt +.. include:: /Includes.rst.txt .. _start: +.. _upgrading: -============================== -Installation and Upgrade Guide -============================== +================= +Upgrading TYPO3 +================= -:Version: - |release| +.. container:: row m-0 p-0 -:Language: - en + .. container:: col-md-6 pl-0 pr-3 py-3 m-0 -:Copyright: - Since 2000 + .. container:: card px-0 h-100 -:Author: - `Documentation Team `__ & TYPO3 community (see :ref:`credits`) + .. rst-class:: card-header h3 -:License: - Open Publication License available from `www.opencontent.org/openpub/ - `_ + .. rubric:: :ref:`Minor upgrades ` + .. container:: card-body + Minor updates contain bugfixes and/or security updates. This section details + how to install minor updates using Composer. -The content of this document is related to TYPO3, -a GNU/GPL CMS/Framework available from `www.typo3.org -`_ + .. container:: col-md-6 pl-0 pr-3 py-3 m-0 + .. container:: card px-0 h-100 -**About this manual** + .. rst-class:: card-header h3 -This document describes the file structure of TYPO3 and takes you -step by step through the installation. It does not focus on -specific operating systems, but contains some hints on general -TYPO3 installation issues with regards to Apache, PHP and MySQL. + .. rubric:: :ref:`Major upgrades ` + .. container:: card-body + This chapter details how major updates are installed using Composer and + highlights what tasks need to be carried out before and after the core is updated. -**Official documentation** + .. container:: col-md-6 pl-0 pr-3 py-3 m-0 -This document is included as part of the official TYPO3 documentation. + .. container:: card px-0 h-100 + .. rst-class:: card-header h3 -If you find an error or something is missing, please: `Report a Problem -`__ + .. rubric:: :ref:`Upgrading extensions ` + .. container:: card-body -**Guide** + Just like TYPO3's core, extensions also need to be regularly updated. + This chapter details how to upgrade extensions using Composer. -This document is a Guide. Guides are designed to familiarize a reader -with a specific topic in order to provide a working knowledge of that -particular process. Readers should peruse the guide from cover to -cover in order to gain a practical overview of the process. Once -completed, the Guide becomes a practical reference tool to which a reader -can refer as needed. Guides offer advice on how best to achieve a -given task. + .. container:: col-md-6 pl-0 pr-3 py-3 m-0 -**For Contributors** + .. container:: card px-0 h-100 -You are welcome to help in improving this guide. Just click on -"Edit me on GitHub" on the top right to submit your change request. + .. rst-class:: card-header h3 -You can find out more about how to do this in :ref:`contribute`. + .. rubric:: :ref:`Legacy upgrade guide ` -:ref:`linktargets` -| `GitHub repository `__ -| `Issues `__ + .. container:: card-body + + Using TYPO3 without Composer? This chapter details how to upgrade TYPO3 manually. + + .. container:: col-md-6 pl-0 pr-3 py-3 m-0 + + .. container:: card px-0 h-100 + + .. rst-class:: card-header h3 + + .. rubric:: :ref:`Migrate a TYPO3 installation to Composer ` + + .. container:: card-body + + Information on how to migrate a legacy installation of TYPO3 to a Composer based installation. + + .. container:: col-md-6 pl-0 pr-3 py-3 m-0 + + .. container:: card px-0 h-100 + + .. rst-class:: card-header h3 + + .. rubric:: :ref:`Migrate content ` + + .. container:: card-body + + This chapter details how pages and content can be exported and then imported into another installation of TYPO3. .. toctree:: :hidden: - Introduction/Index - QuickInstall/Index - In-depth/Index - Composer/Index - ExtensionInstallation/Index - Upgrade/Index + Minor/Index + Major/Index + UpgradingExtensions/Index + Legacy/Index MigrateToComposer/Index MigrateContent/Index - ReleaseIntegrity/Index - Troubleshooting/Index - HistoricalInformation/Index - Sitemap/Index Linktargets diff --git a/Documentation/Introduction/Index.rst b/Documentation/Introduction/Index.rst deleted file mode 100644 index 01894ceb..00000000 --- a/Documentation/Introduction/Index.rst +++ /dev/null @@ -1,73 +0,0 @@ -.. include:: ../Includes.txt - - -.. _introduction: - -============ -Introduction -============ - -.. _about-this-document: - -About this Document -=================== - -This manual provides instructions on how to install and -also upgrade an existing TYPO3 CMS installation. - -The "Installation" section is aimed at beginners who want to set up -a new installation of TYPO3 CMS. The "Update" section targets -those who already have a running website and wish to upgrade it -to a newer version of TYPO3 CMS. - -It is recommended that you follow each of the steps in the "Quick Installation" -section in order to ensure that your installation is completed correctly. After -this point you may wish to take a closer a look at the "In-Depth Installation" section -to find out how to further configure and customize your installation of TYPO3. - - -.. _what-s-new: - -What's New -========== - -Updated the manual for TYPO3 CMS version 9.5. - - -.. _credits: - -Credits -======= - -This manual was originally written by Kasper Skårhøj and is now kept -up to date by the TYPO3 community. - -The chapter :ref:`migrate-to-composer` was added by Albrecht Köhnlein -(July 2018). Some of the information in that chapter was later moved -to :ref:`composer-working-with`. - -.. _feedback: -.. _contribute: - -Contribution -============ - - -If you find a bug in this manual, please be so kind as to check the -online version on https://docs.typo3.org/typo3cms/InstallationGuide/. -From there you can hit the "Edit me on GitHub" button in the top right corner -and submit a pull request via GitHub. Alternatively you can just file an issue -using the bug tracker: https://github.com/TYPO3-Documentation/TYPO3CMS-Guide-Installation/issues. - -Maintaining high quality documentation requires time and effort -and the TYPO3 Documentation Team always appreciates support. -If you want to support us, please contact us as described in -the next section. - -.. _contact-doc-team: - -Contact the Documentation Team -============================== - -For general questions about the documentation get in touch with -the `Documentation Team `__. diff --git a/Documentation/Legacy/Index.rst b/Documentation/Legacy/Index.rst new file mode 100644 index 00000000..40db0910 --- /dev/null +++ b/Documentation/Legacy/Index.rst @@ -0,0 +1,104 @@ +.. include:: /Includes.rst.txt + +.. _legacy: + +============== +Legacy Upgrade +============== + +Minor Upgrades - Using The Core Updater +======================================== + +The "Install Tool" in the section "Important Actions" provides a function to +update the TYPO3 Core. + +In the section "Important Actions" scroll down to "Core update" and click the +"Check for core updates" button. If the requirements are met, TYPO3 will +automatically install the new source code. + +.. note:: + + For the Core Updater to work, the following setup is required: + + * It only works in Unix-like systems (including macOS). + + * :file:`typo3_src` must be a symlink. + + * This symlink needs to be writable (and deletable) by the web-server user. + + * The document root needs to be writable. + + * One path above document root (:file:`../`) needs to be writable (creation + of new directories must be allowed). + + * The :program:`tar` command must be available (for extracting the Source + package). + + +.. _install-manually: + +Major Upgrades - Symlink The Core +================================= + +Go to https://typo3.org/download/ and download +the source package of the new TYPO3 version. + +Extract the package on your web server and, in your TYPO3 document root, +adjust the :file:`typo3_src` symlink. + +.. important:: + Make sure to upload the whole TYPO3 source directory including the + :file:`vendor` directory, otherwise you will miss important dependency + updates. + +Disabling the Core Updater +-------------------------- + +The Core Updater functionality can be turned off, in order to avoid users using it, +i.e. if you use your own update mechanism. + +This feature is already disabled when TYPO3 is installed via Composer. + +To disable the core updater, you can set this environment variable:: + + TYPO3_DISABLE_CORE_UPDATER=1 + +For example in Apache: + +.. code-block:: apacheconf + + SetEnv TYPO3_DISABLE_CORE_UPDATER 1 + +or for NGINX: + +.. code-block:: nginx + + server { + location ~ path/to/it { + include fastcgi_params; + fastcgi_param TYPO3_DISABLE_CORE_UPDATER "1"; + } + } + +This will remove the button and all related functionality in the Install +Tool. + +What's the Next Step? +===================== + +In case you performed a *minor update*, e.g. from TYPO3 9.5.0 to 9.5.1, database +updates are usually *not* necessary, though you still have to +:ref:`remove the temporary cache files `. After +that your update is finished. + +.. note:: + + Make sure to read the release notes of even the minor versions carefully. While + great care is taken to keep the minor updates as easy as possible, (especially + when releasing security updates) more steps might be necessary. + +In case of a *major update*, e.g. from TYPO3 8.7 to 9.5, go ahead with the next +step! + +Also check out any breaking changes listed in the `changelog +`_ for the new version. diff --git a/Documentation/Linktargets.rst b/Documentation/Linktargets.rst index e399ae42..fc06464d 100644 --- a/Documentation/Linktargets.rst +++ b/Documentation/Linktargets.rst @@ -1,4 +1,4 @@ -.. include:: Includes.txt +.. include:: /Includes.rst.txt .. highlight:: bash @@ -32,7 +32,7 @@ in the manual you are linking from, e.g.: [intersphinx_mapping] - t3install = https://docs.typo3.org/typo3cms/InstallationGuide/ + t3install = https://docs.typo3.org/m/typo3/guide-installation/master/en-us/ The directive `ref-targets-list` below creates an overview of the linktargets defined in this manual. @@ -49,6 +49,6 @@ Targets for Cross-Referencing .. only:: html .. ref-targets-list:: - - + + diff --git a/Documentation/Major/Index.rst b/Documentation/Major/Index.rst new file mode 100644 index 00000000..a80cc77b --- /dev/null +++ b/Documentation/Major/Index.rst @@ -0,0 +1,53 @@ +.. include:: /Includes.rst.txt +.. _major: + +============= +Major upgrade +============= + +.. container:: row m-0 p-0 + + .. container:: col-md-6 pl-0 pr-3 py-3 m-0 + + .. container:: card px-0 h-100 + + .. rst-class:: card-header h3 + + .. rubric:: :ref:`Pre-upgrade tasks ` + + .. container:: card-body + + Before upgrading TYPO3 to a major release, there are several tasks that can be performed + to help ensure a successful upgrade and help minimise any potential downtime. + + .. container:: col-md-6 pl-0 pr-3 py-3 m-0 + + .. container:: card px-0 h-100 + + .. rst-class:: card-header h3 + + .. rubric:: :ref:`Upgrade the core ` + + .. container:: card-body + + This chapter details how to perform a major upgrade using Composer. + + .. container:: col-md-6 pl-0 pr-3 py-3 m-0 + + .. container:: card px-0 h-100 + + .. rst-class:: card-header h3 + + .. rubric:: :ref:`Post-upgrade tasks ` + + .. container:: card-body + + Once TYPO3's core has been upgraded, there a few tasks that need to be actioned to complete the process. + +.. toctree:: + :hidden: + :titlesonly: + + PreupgradeTasks/Index + UpgradeCore.rst + PostupgradeTasks/Index diff --git a/Documentation/Upgrade/UpdateTranslations/Index.rst b/Documentation/Major/PostupgradeTasks/BackendTranslations.rst.txt similarity index 60% rename from Documentation/Upgrade/UpdateTranslations/Index.rst rename to Documentation/Major/PostupgradeTasks/BackendTranslations.rst.txt index 1f983bb3..b95fcee4 100644 --- a/Documentation/Upgrade/UpdateTranslations/Index.rst +++ b/Documentation/Major/PostupgradeTasks/BackendTranslations.rst.txt @@ -1,22 +1,13 @@ -.. include:: ../../Includes.txt - +.. include:: /Includes.rst.txt .. _update-translations: -=================== -Update Translations -=================== - In the Install tool, go to the module "Maintenance" -> "Manage languages" and update your translations. If you don't update your translations, new texts will only be displayed in English. The translations are available, once the `Translation Team`_ for your language has translated the texts. -.. figure:: ../../Images/Install-Language-Packs.png - :class: with-shadow - :alt: Manage language packs - - The option "Manage language packs" in the Install Tool. +.. include:: /Images/AutomaticScreenshots/AdminTools/InstallLanguagePacks.rst.txt .. _Translation Team: https://wiki.typo3.org/Translations#Translation_Teams diff --git a/Documentation/Major/PostupgradeTasks/ClearCaches.rst.txt b/Documentation/Major/PostupgradeTasks/ClearCaches.rst.txt new file mode 100644 index 00000000..3fde7eb3 --- /dev/null +++ b/Documentation/Major/PostupgradeTasks/ClearCaches.rst.txt @@ -0,0 +1,15 @@ +.. include:: /Includes.rst.txt + +.. _clear_caches: + +You should also clear all caches when upgrading. + +Go to "Maintenance" and click "Flush": + +.. include:: /Images/AutomaticScreenshots/AdminTools/ClearAllCache.rst.txt + +Additionally, after an upgrade to a new major version, you should also delete +the other temporary files, which TYPO3 saves in :file:`typo3temp/`. In the +Install Tool go to "Clean up" to do so. + +.. include:: /Images/AutomaticScreenshots/AdminTools/RemoveTemporaryAssets.rst.txt \ No newline at end of file diff --git a/Documentation/Upgrade/RunTheDatabaseAnalyzer/Index.rst b/Documentation/Major/PostupgradeTasks/DatabaseAnalyser.rst.txt similarity index 65% rename from Documentation/Upgrade/RunTheDatabaseAnalyzer/Index.rst rename to Documentation/Major/PostupgradeTasks/DatabaseAnalyser.rst.txt index 284a5b43..d5a81a28 100644 --- a/Documentation/Upgrade/RunTheDatabaseAnalyzer/Index.rst +++ b/Documentation/Major/PostupgradeTasks/DatabaseAnalyser.rst.txt @@ -1,11 +1,6 @@ -.. include:: ../../Includes.txt +.. include:: /Includes.rst.txt - -.. _run-the-database-analyzer: - -========================= -Run the Database Analyzer -========================= +.. _database_analyser: While in the previous step, tables and columns have been *changed or added* to allow running the upgrade wizards smoothly. The next step gives you the @@ -13,9 +8,7 @@ possibility to *remove* old and unneeded tables and columns from the database. Use the "Maintenance section" and click "Analyze Database". -.. figure:: ../../Images/Important-Actions-Database-Analyzer.png - :alt: The Database Analyzer before analyzing the database. - :class: with-shadow +.. include:: /Images/AutomaticScreenshots/AdminTools/DatabaseAnalyzer.rst.txt You will be able to execute queries to remove these tables and columns so that @@ -40,19 +33,11 @@ your database corresponds to the structure required for the new TYPO3 version. Select the upgrades you want and press "Execute": -.. figure:: ../../Images/Important-Actions-Database-Analyzer-Updates-Executed.png - :class: with-shadow - :alt: Database analyzer - - The Database Analyzer +.. include:: /Images/ManualScreenshots/DatabaseAnalyzerUpdatesExecuted.rst.txt When you then click "Compare current database with specification" again and you only see the message -.. figure:: ../../Images/Important-Actions-Database-Analyzer-Database-Analyzed.png - :class: with-shadow - :alt: Database analyzer - - The Database Analyzer with no updates to do. +.. include:: /Images/AutomaticScreenshots/AdminTools/DatabaseAnalyzerDatabaseAnalyzed.rst.txt -then all database updates have been applied. +then all database updates have been applied. \ No newline at end of file diff --git a/Documentation/Major/PostupgradeTasks/Index.rst b/Documentation/Major/PostupgradeTasks/Index.rst new file mode 100644 index 00000000..15f6cb8a --- /dev/null +++ b/Documentation/Major/PostupgradeTasks/Index.rst @@ -0,0 +1,42 @@ +.. include:: /Includes.rst.txt + +.. _index: + +================== +Post-upgrade tasks +================== + +.. _postupgradetasks: + +Run the upgrade wizard +====================== + +.. include:: UpgradeWizard.rst.txt + +.. _run_the_database_analyser: + +Run the database analyser +========================= + +.. include:: DatabaseAnalyser.rst.txt + +.. _clear_user_settings: + +Clear user settings +=================== + +.. include:: UserSettings.rst.txt + +.. _post_upgrade_clear_caches: + +Clear caches +============ + +.. include:: ClearCaches.rst.txt + +.. _update_backend_translation: + +Update backend translations +=========================== + +.. include:: BackendTranslations.rst.txt diff --git a/Documentation/Upgrade/UseTheUpgradeWizard/Index.rst b/Documentation/Major/PostupgradeTasks/UpgradeWizard.rst.txt similarity index 87% rename from Documentation/Upgrade/UseTheUpgradeWizard/Index.rst rename to Documentation/Major/PostupgradeTasks/UpgradeWizard.rst.txt index 35971ffa..51c62bcb 100644 --- a/Documentation/Upgrade/UseTheUpgradeWizard/Index.rst +++ b/Documentation/Major/PostupgradeTasks/UpgradeWizard.rst.txt @@ -1,20 +1,11 @@ -.. include:: ../../Includes.txt - +.. include:: /Includes.rst.txt .. _use-the-upgrade-wizard: -====================== -Use the Upgrade Wizard -====================== - -Enter the Install Tool at `https://example.com/typo3/install.php` on your +Enter the Install Tool at :samp:`https://example.org/typo3/install.php` on your TYPO3 site. -.. figure:: ../../Images/Upgrade-Wizard.png - :class: with-shadow - :alt: Upgrade wizard - - The Upgrade Wizard in the Install Tool. +.. include:: /Images/AutomaticScreenshots/Upgrade/UpgradeWizard.rst.txt TYPO3 provides an upgrade wizard for easy upgrading. Go to the :guilabel:`Upgrade` section and choose :guilabel:`Upgrade Wizard`. @@ -67,8 +58,7 @@ Apply the optional wizards too - just be sure to select the correct option (e.g. "No, do not execute"). This way, these wizards will also be removed from the list of wizards to execute and the upgrade will be marked as "done". -.. image:: ../../Images/upgrade_wizard_install_taskcenter.png - :alt: Choose "No, do not execute" +.. include:: /Images/ManualScreenshots/UpgradeWizardExecute.rst.txt After running through the upgrade wizards go to :guilabel:`Maintenance` > :guilabel:`Analyze Database Structure`. diff --git a/Documentation/Major/PostupgradeTasks/UserSettings.rst.txt b/Documentation/Major/PostupgradeTasks/UserSettings.rst.txt new file mode 100644 index 00000000..2a72c149 --- /dev/null +++ b/Documentation/Major/PostupgradeTasks/UserSettings.rst.txt @@ -0,0 +1,10 @@ +.. include:: /Includes.rst.txt + +.. _user_settings: + +You might consider clearing the Backend user preferences. This +can avoid problems, if something in the upgrade requires this. Go to +"Clean up", scroll to "Reset user preferences" and click "Reset backend +user preferences". + +.. include:: /Images/AutomaticScreenshots/AdminTools/ResetUserPreferences.rst.txt diff --git a/Documentation/Upgrade/Backup/Index.rst b/Documentation/Major/PreupgradeTasks/Backup.rst.txt similarity index 91% rename from Documentation/Upgrade/Backup/Index.rst rename to Documentation/Major/PreupgradeTasks/Backup.rst.txt index 3ce98b87..eaf522f1 100644 --- a/Documentation/Upgrade/Backup/Index.rst +++ b/Documentation/Major/PreupgradeTasks/Backup.rst.txt @@ -1,12 +1,7 @@ -.. include:: ../../Includes.txt - +.. include:: /Includes.rst.txt .. _backup: -====== -Backup -====== - Make a backup first! If things go wrong, you can at least go back to the old version. You need a backup of diff --git a/Documentation/Major/PreupgradeTasks/Changelog.rst.txt b/Documentation/Major/PreupgradeTasks/Changelog.rst.txt new file mode 100644 index 00000000..c94fbc84 --- /dev/null +++ b/Documentation/Major/PreupgradeTasks/Changelog.rst.txt @@ -0,0 +1,29 @@ +.. include:: /Includes.rst.txt + +In addition to the deprecations you may want to read the information about important +changes, new features and breaking changes for the release you are updating to. + +The ChangeLog is divided into four sections "Breaking Changes", "Features", "Deprecation" and +"Important". Before upgrading you should at least take a look at the sections "Breaking Changes" +and "Important" - changes described in those areas might affect your website. + +.. tip:: + + Breaking changes should be of no concern to you if you already handled the + deprecations before upgrading. + +The detailed information contains a section called "Affected Installations" which contains hints +whether or not your website is affected by the change. + +There are 3 different methods you can use to read the Changelogs: + +#. Look through the `ChangeLogs `_ + online. This has the advantage that code blocks will be formatted nicely with + syntax highlighting. +#. Read the Changelogs in the backend: :guilabel:`Upgrade > View Upgrade Documentation`. + This has the advantage that you can filter by tags and mark individual Changelogs + as done. This way, it is possible to use the list like a todo list. +#. Read the changelog in the :ref:`Extension Scanner ` + (as explained above). + +.. include:: /Images/AutomaticScreenshots/Upgrade/UpgradeAnalysis.rst.txt diff --git a/Documentation/Upgrade/ConvertGlobalExtensions/Index.rst b/Documentation/Major/PreupgradeTasks/ConvertGlobalExtensions.rst.txt similarity index 88% rename from Documentation/Upgrade/ConvertGlobalExtensions/Index.rst rename to Documentation/Major/PreupgradeTasks/ConvertGlobalExtensions.rst.txt index 8c31a57f..f3eacb5d 100644 --- a/Documentation/Upgrade/ConvertGlobalExtensions/Index.rst +++ b/Documentation/Major/PreupgradeTasks/ConvertGlobalExtensions.rst.txt @@ -1,11 +1,7 @@ -.. include:: ../../Includes.txt +.. include:: /Includes.rst.txt -.. _convert-global-extensions: - -========================= -Convert Global Extensions -========================= +.. _convert_global_extensions: If you use global extensions, convert them to local ones. diff --git a/Documentation/Major/PreupgradeTasks/Deprecations.rst.txt b/Documentation/Major/PreupgradeTasks/Deprecations.rst.txt new file mode 100644 index 00000000..48bc9129 --- /dev/null +++ b/Documentation/Major/PreupgradeTasks/Deprecations.rst.txt @@ -0,0 +1,38 @@ +.. include:: /Includes.rst.txt + +If you notice some API you are using is deprecated, you should look up the +corresponding `ChangeLog `_ +entry and see how to migrate your code corresponding to the documentation. + +Since TYPO3 v9 an :ref:`extension scanner ` is +included, that provides basic scanning of your extensions for deprecated code. +While it does not catch everything, it can be used as a base for an upgrade. You +can either access the extension scanner via the TYPO3 admin tools (in the +Backend: :guilabel:`Module "Upgrade" > "Scan Extension Files"`) +or as a standalone tool (https://github.com/tuurlijk/typo3scan). + +The extension scanner will show the corresponding changelog which contains +a description of how to migrate your code. See :ref:`check-the-changelog-and-news-md` +for more information about the Changelogs and how to read them. + +.. note:: + + TYPO3 aims at providing a reliable backwards compatibility between versions: + + * Minor versions are always backwards compatible - unless explicitly stated + otherwise (for example in case of security updates) + + * Major versions may contain breaking changes - normally these are + deprecated one major version in advance + + * Most breaking changes usually happen in the first Sprint Release + + If PHP classes, methods, constants, functions or parameters are to be + removed, they will be *marked as deprecated* first and not removed until the + next major release of TYPO3. For example: a method that gets deprecated in + version 9.4.0 will remain fully functional in all 9.x.x releases, but will + be removed in version 10. + + This strategy gives developers sufficient time to adjust their TYPO3 + extensions, assuming many agencies upgrade from one LTS release to the next + (usually 1.5 years). diff --git a/Documentation/Major/PreupgradeTasks/Index.rst b/Documentation/Major/PreupgradeTasks/Index.rst new file mode 100644 index 00000000..90499a0d --- /dev/null +++ b/Documentation/Major/PreupgradeTasks/Index.rst @@ -0,0 +1,68 @@ +.. include:: /Includes.rst.txt + +.. _preupgradetasks: + +================= +Pre-upgrade tasks +================= + +Before starting the upgrade check your system for compatibility with a newer +TYPO3 version. + +* Before you upgrade to the next major version, make sure you have run all + Upgrade Wizards of the the current TYPO3 major version. + +* Check for deprecations: Enable the deprecation log and let it log all + deprecations for a while. + +* Alternatively (or additionally) run the + :ref:`extension scanner ` and + :ref:`handle deprecations ` (below). + +* Check installed extensions for versions compatible to the target TYPO3 + version + +* Try the upgrade on a development system first or create a parallel instance + + +Check that all system requirements for upgrading are met: + +* See :ref:`system-requirements` + +.. _make_a_backup: + +Make A Backup +============= + +.. include:: Backup.rst.txt + +.. _update_reference_index: + +Update Reference Index +====================== + +.. include:: ReferenceIndex.rst.txt + +.. _check-the-changelog-and-news-md: + +Check the ChangeLog +=================== + +.. include:: Changelog.rst.txt + + +.. _handling-deprecations: +.. _deprecations: + +Resolve Deprecations +==================== + +.. include:: Deprecations.rst.txt + + +.. _convert_global_extensions: + +Convert Global Extensions +========================= + +.. include:: Deprecations.rst.txt diff --git a/Documentation/Upgrade/UpdateReferenceIndex/Index.rst b/Documentation/Major/PreupgradeTasks/ReferenceIndex.rst.txt similarity index 81% rename from Documentation/Upgrade/UpdateReferenceIndex/Index.rst rename to Documentation/Major/PreupgradeTasks/ReferenceIndex.rst.txt index 30c51686..211adee3 100644 --- a/Documentation/Upgrade/UpdateReferenceIndex/Index.rst +++ b/Documentation/Major/PreupgradeTasks/ReferenceIndex.rst.txt @@ -1,15 +1,10 @@ -.. include:: ../../Includes.txt +.. include:: /Includes.rst.txt .. highlight:: shell .. _reference-index: -=============== -Reference Index -=============== - - -With Command Line (Recommended) -=============================== +With command line (recommended) +------------------------------- .. sidebar:: Why CLI? @@ -29,8 +24,8 @@ In a non-composer installation execute:: Use `referenceindex:update 2> /dev/null` to suppress the progress output (e.g. when the command is executed by a cronjob). -Without Command Line -==================== +Without command line +-------------------- Still in your old TYPO3 version, go to the "System" > "DB check" module and use the "Check and update global reference index" function. diff --git a/Documentation/Major/UpgradeCore.rst b/Documentation/Major/UpgradeCore.rst new file mode 100644 index 00000000..77a56b89 --- /dev/null +++ b/Documentation/Major/UpgradeCore.rst @@ -0,0 +1,72 @@ +.. include:: /Includes.rst.txt + +.. Use syntax highlighting for shell commands by default on this page + +.. highlight:: shell + +.. _upgradecore: + +================ +Upgrade the core +================ + +Upgrading to a major release using composer +=========================================== + +This example details how to upgrade from one LTS release to another. In this example, +the installation is running TYPO3 version 10.4.22 and the new LTS release is version 11.5.0. + +Check which TYPO3 packages are currently installed +-------------------------------------------------- + +TYPO3's core contains a mix of required and optional packages. For example, `typo3/cms-backend` +is a required package. `typo3/cms-sys-note` is not a required package and does not need to installed +for TYPO3 to work correctly. + +Prior to upgrading, check which packages are currently installed and make a note of them. + +Running `composer info typo3/*` will output a list of all TYPO3 packages that are currently installed. + +Running Composer require +------------------------ + +To upgrade a Composer package, run `Composer require` with the package name and version number. + +For example, to upgrade `typo3/cms-backend` run `composer require typo3/cms-backend:~11.5`. + +When upgrading to a new major release, each of TYPO3's packages will need to be upgraded. + +Given that a typical installation of TYPO3 will consist of a number of packages, it is recommended that the `Composer Helper Tool `_ be used +to help generate the Composer upgrade command. + +Assuming that the packages below are installed locally, the following example would upgrade each of them to version `11.5`. + +.. code:: + + $ composer require "typo3/cms-adminpanel:^11.5" "typo3/cms-backend:^11.5" + "typo3/cms-belog:^11.5" "typo3/cms-beuser:^11.5" "typo3/cms-core:^11.5" "typo3/cms-dashboard:^11.5" + "typo3/cms-felogin:^11.5" "typo3/cms-filelist:^11.5" "typo3/cms-filemetadata:^11.5" + "typo3/cms-fluid:^11.5" "typo3/cms-form:^11.5" "typo3/cms-frontend:^11.5" "typo3/cms-info:^11.5" + "typo3/cms-install:^11.5" "typo3/cms-linkvalidator:^11.5" "typo3/cms-lowlevel:^11.5" + "typo3/cms-recordlist:^11.5" "typo3/cms-recycler:^11.5" "typo3/cms-rte-ckeditor:^11.5" + "typo3/cms-setup:^11.5" "typo3/cms-t3editor:^11.5" "typo3/cms-tstemplate:^11.5" "typo3/cms-viewpage:^11.5" + + +Monitoring changes to TYPO3's core +---------------------------------- + +The system extensions that are developed and exist within TYPO3's core +are likely to change over time. Some extensions are merged into others, new system extensions +are added and others abandoned. +These changes are published `here +`_ and can also be found by searching in the +`breaking changes `_ +for the extension by its key name. + + +.. _install-next-step: + +Next steps +========== + +Once the upgrade is complete, there are a set of tasks that need to actioned to complete the process. diff --git a/Documentation/MigrateContent/Index.rst b/Documentation/MigrateContent/Index.rst index d303804f..6ab56441 100644 --- a/Documentation/MigrateContent/Index.rst +++ b/Documentation/MigrateContent/Index.rst @@ -1,6 +1,6 @@ -.. include:: /Includes.txt +.. include:: /Includes.rst.txt -.. _migrate-content: +.. _migratecontent: =============== Migrate content @@ -31,6 +31,36 @@ On composer based installations it can be required via Export your data ================ +Via CLI command +---------------- + +Exporting a TYPO3 page tree without php time limit is possible via +:ref:`Symfony Console Commands (cli) `. + +.. code-block:: bash + :caption: Composer based installation + + vendor/bin/typo3 impexp:export [options] [--] [] + +.. note:: + If your TYPO3 installation is not based on composer you can run the command + with :bash:`typo3/sysext/core/bin/typo3 impexp:export` instead. + +and exports the entire TYPO3 page tree - or parts of it - to a data file of +format XML or T3D, which can be used for import into any TYPO3 instance. + +The export can be fine-tuned through the complete set of options also +available in the export view of the TYPO3 backend: +You can see the complete list of options by calling the help for the command: + +.. code-block:: bash + + vendor/bin/typo3 help impexp:export + + +Manual export from the TYPO3 backend +------------------------------------ + .. rst-class:: bignums 1. Go to the export module @@ -38,19 +68,11 @@ Export your data On the page tree left click on the page from where you want to start the export. Select :guilabel:`More options ...`: - .. figure:: /Images/ImpExpContext.png - :class: with-shadow - :alt: Select "More options..." from the context menu of the page tree - - Select "More options..." from the context menu of the page tree + .. include:: /Images/AutomaticScreenshots/ImportExport/ContextMenuMore.rst.txt Then select :guilabel:`Export` from the context menu. - .. figure:: /Images/ImpExpContext2.png - :class: with-shadow - :alt: Then select "Export" - - Select Then select "Export" + .. include:: /Images/AutomaticScreenshots/ImportExport/ContextMenuExport.rst.txt 2. Select the tables to be exported @@ -59,11 +81,7 @@ Export your data is also possible to include static relations to tables already present in the target installation. - .. figure:: /Images/ImpExpDialog.png - :class: with-shadow - :alt: Select the tables to be exported - - Select the tables to be exported + .. include:: /Images/AutomaticScreenshots/ImportExport/ExportDialog.rst.txt 3. Choose number of levels to be exported @@ -71,11 +89,7 @@ Export your data select 'Infinite' from the :guilabel:`Levels` select box and hit the :guilabel:`Update` Button at the end of the dialog. - .. figure:: /Images/ImpExpDialogInfinite.png - :class: with-shadow - :alt: Select the page levels to be exported - - Select the page levels to be exported + .. include:: /Images/AutomaticScreenshots/ImportExport/ExportDialogInfiniteLevels.rst.txt 4. Check the included records @@ -88,22 +102,14 @@ Export your data orange exclamation mark. Reasons for lost relations include records stored outside the page tree to be exported and excluded tables. - .. figure:: /Images/ImpExpCheckExport.png - :class: with-shadow - :alt: Check the exported data - - Check and adjust the exported data. + .. include:: /Images/AutomaticScreenshots/ImportExport/CheckExport.rst.txt 5. Save or export the data You can save the exported data to your server or download it in the tab :guilabel:`File & Preset`. - .. figure:: /Images/ImpExpDownload.png - :class: with-shadow - :alt: Download the export data - - Download the export data + .. include:: /Images/AutomaticScreenshots/ImportExport/DownloadExport.rst.txt Import your data ================ @@ -114,6 +120,36 @@ Import your data is up to date before starting the import. Otherwise the data related to non-existing tables will not get imported. + +Via CLI command +---------------- + +Importing a TYPO3 page tree without php time limit is possible via +:ref:`Symfony Console Commands (cli) `. + +.. code-block:: bash + :caption: Composer based installation + + vendor/bin/typo3 impexp:import [options] [--] [] + +.. note:: + If your TYPO3 installation is not based on composer you can run the command + with :shell:`typo3/sysext/core/bin/typo3 impexp:import` instead. + + +The import can be fine-tuned through the complete set of options also +available in the import view of the TYPO3 backend. You can see the complete +list of options by calling the help for the command: + + +.. code-block:: bash + + vendor/bin/typo3 help impexp:import + + +Manual import from the TYPO3 backend +------------------------------------ + .. rst-class:: bignums 1. Upload the export file @@ -124,11 +160,7 @@ Import your data the imported page should be as starting point for the import. If you want to import the data at root-level, choose the - .. figure:: /Images/ImpExUpload.png - :class: with-shadow - :alt: Upload the export data - - Upload the export data + .. include:: /Images/AutomaticScreenshots/ImportExport/UploadImport.rst.txt 2. Preview the data do be imported @@ -136,11 +168,7 @@ Import your data automatically. If you change some options you can reload this display with the :guilabel:`preview` button. - .. figure:: /Images/ImpExImport.png - :class: with-shadow - :alt: Preview the data - - Preview the data + .. include:: /Images/ManualScreenshots/ImportExport/ImportPreview.rst.txt 3. Import @@ -158,8 +186,4 @@ The following shows the export dialog of TYPO3 installation of version 3.8.0. It is often more feasible to use the Import / Export tool then to attempt to update very old TYPO3 installations. -.. figure:: /Images/ImpExpV3.8.png - :class: with-shadow - :alt: Export module of TYPO3 3.8.0 (year 2005) - - Export module of TYPO3 3.8.0 (year 2005) +.. include:: /Images/ManualScreenshots/ImportExport/ImpExpV3.8.rst.txt diff --git a/Documentation/MigrateToComposer/BestPractices.rst b/Documentation/MigrateToComposer/BestPractices.rst index 9968c6cf..1c9aadc1 100644 --- a/Documentation/MigrateToComposer/BestPractices.rst +++ b/Documentation/MigrateToComposer/BestPractices.rst @@ -1,4 +1,4 @@ -.. include:: ../Includes.txt +.. include:: /Includes.rst.txt .. highlight:: bash .. _mig-composer-best-practices: @@ -12,7 +12,7 @@ specific to migrating to Composer are still here. .. _mig-composer-clear-typo3conf-ext-folder: -Completely Clear `typo3conf/ext` Folder +Completely clear `typo3conf/ext` folder ======================================= In the "Migration Steps" chapter, this tutorial explained, how you can @@ -25,7 +25,7 @@ If you are searching for a solution to keep your :file:`typo3conf/ext` folder clean and unify the extension handling even for your project's individual extension, this section might be useful. -Define a Local Path Repository +Define a local path repository ------------------------------ Create a directory :file:`packages` in your project root folder and define @@ -40,7 +40,7 @@ this folder as a repository of type "path" in your :file:`composer.json`:: ] } -Include Your Individual Extensions From `packages` Folder +Include your individual extensions from `packages` folder --------------------------------------------------------- In the next step, you move all your individual extensions from @@ -62,7 +62,7 @@ number, but tell composer to use the latest ``dev`` state. :file:`composer.json` and can be removed from your project's :file:`composer.json`. -Exclude `typo3conf/ext` from Version Control System +Exclude `typo3conf/ext` from version control system --------------------------------------------------- To finish your cleanup of "typo3conf/ext", you should keep the line diff --git a/Documentation/MigrateToComposer/CoWorking.rst b/Documentation/MigrateToComposer/CoWorking.rst index c1621c0a..a144a474 100644 --- a/Documentation/MigrateToComposer/CoWorking.rst +++ b/Documentation/MigrateToComposer/CoWorking.rst @@ -1,4 +1,4 @@ -.. include:: ../Includes.txt +.. include:: /Includes.rst.txt .. highlight:: bash ========== diff --git a/Documentation/MigrateToComposer/Index.rst b/Documentation/MigrateToComposer/Index.rst index 170ef4ea..8de8ee26 100644 --- a/Documentation/MigrateToComposer/Index.rst +++ b/Documentation/MigrateToComposer/Index.rst @@ -1,10 +1,10 @@ -.. include:: ../Includes.txt +.. include:: /Includes.rst.txt -.. _migrate-to-composer: +.. _migratetocomposer: -================================= -Migrate TYPO3 Project to Composer -================================= +=================================== +Migrate a TYPO3 project to composer +=================================== Contributed `initially `__ diff --git a/Documentation/MigrateToComposer/MigrationSteps.rst b/Documentation/MigrateToComposer/MigrationSteps.rst index 3a6a6f47..4c910d35 100644 --- a/Documentation/MigrateToComposer/MigrationSteps.rst +++ b/Documentation/MigrateToComposer/MigrationSteps.rst @@ -1,11 +1,11 @@ -.. include:: ../Includes.txt +.. include:: /Includes.rst.txt .. highlight:: bash =============== -Migration Steps +Migration steps =============== -Delete Files +Delete files ============ Yes, that's true. You have to delete some files, because they will be created by @@ -21,7 +21,7 @@ Please keep only your sitepackage extension or any other extension, which was explicitly built for your current project and does not have an own Git repository. -Configure Composer +Configure composer ================== Create a file with name :file:`composer.json` in your project root, not inside @@ -29,7 +29,7 @@ your web root. You can use the :file:`composer.json` from typo3/cms-base-distribution as an example. Use the file from the branch which matches your current version, e.g. -`10.x `__. +`10.x `__. However, this may require extensions you don't need or omit extensions you do need, so be sure to update the required extensions as described in the next @@ -53,15 +53,16 @@ The :file:`composer.json` in the Base distribution includes a scripts section: .. code-block:: json - - "scripts":{ - "typo3-cms-scripts": [ - "typo3cms install:generatepackagestates", - "typo3cms install:fixfolderstructure" - ], - "post-autoload-dump": [ - "@typo3-cms-scripts" - ] + { + "scripts": { + "typo3-cms-scripts": [ + "typo3cms install:generatepackagestates", + "typo3cms install:fixfolderstructure" + ], + "post-autoload-dump": [ + "@typo3-cms-scripts" + ] + } } @@ -75,7 +76,7 @@ for generating the file :file:`typo3conf/PackageStates.php`. Look at the previous versions. -Add All Required Packages to Your Project +Add all required packages to your project ========================================= You can add all your required packages with the Composer command `composer @@ -105,7 +106,7 @@ You have to decide by yourself, which syntax fits best to your needs. .. _composer-migration-require-all: .. _composer-migration-require-subtree-packages: -Install the Core +Install the core ---------------- .. hint:: @@ -119,11 +120,11 @@ Install the system extensions:: composer require typo3/minimal:^9.5 composer require typo3/cms-scheduler:^9.5 - composer require ... + composer require ... Or in one line:: - composer require typo3/cms-minimal:^9.5 typo3/cms-scheduler:^9.5 ... + composer require typo3/cms-minimal:^9.5 typo3/cms-scheduler:^9.5 ... To find the correct package names, you can either take a look in the :file:`composer.json` of any system extension or follow the naming @@ -135,11 +136,11 @@ e.g. :file:`typo3/cms-fluid-styled-content`. To find out all TYPO3 Core packages, you can visit the TYPO3 Composer Helper website. https://get.typo3.org/misc/composer/helper - From this website, you can select TYPO3 Core Packages you need and generate + From this website, you can select TYPO3 Core Packages you need and generate the composer command to require them. - -Install Extensions from Packagist + +Install extensions from packagist --------------------------------- You already know the TER and always used it to install extensions? Fine. @@ -148,7 +149,7 @@ directly from `packagist.org `__. This works great, when to there. Many well known extensions are already available. You only need to known the package name. There are multiple ways to find it: -Notice on Extension's TER Page +Notice on extension's TER page ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ Extension maintainers optionally can link their TYPO3 extension in TER with the @@ -156,31 +157,31 @@ correct Composer key on `packagist.org `__. Some maintain search the extension in TER, you will see a message, which command and Composer key you can use to install this extension. -|TER Composer command| +.. include:: /Images/ExternalScreenshots/TerComposerCommand.rst.txt .. note:: The command `composer req` is short for `composer require`. Both commands exactly do the same and are interchangeable. -Check in TER Satis +Check in TER satis ~~~~~~~~~~~~~~~~~~ If you search the extension in https://composer.typo3.org/satis.html and it's linked to `packagist.org `__, they are marked as "abandoned" and you will see a message, which Composer key should be used to install this extension. -|satis abandoned note| +.. include:: /Images/ExternalScreenshots/SatisAbandoned.rst.txt -See Warning During `composer require` Command +See warning during `composer require` command ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ If you still install one of the abandoned extensions via its `typo3-ter` package key, you will also see a warning during the `composer require` command. -|composer abandoned note| +.. include:: /Images/ExternalScreenshots/ComposerTerAbandoned.rst.txt -Check Manually +Check manually ~~~~~~~~~~~~~~ This is the most exhausting way. But it will work, even if the extension maintainer @@ -191,33 +192,33 @@ does not provide additional information. #. Click button "Take a look into the code". - |TER screen shot| + .. include:: /Images/ExternalScreenshots/TerCodeLink.rst.txt #. Open file :file:`composer.json`. - |file list| + .. include:: /Images/ExternalScreenshots/GithubComposerFile.rst.txt #. Search for line with property `"name"`, it's value should be formatted like `vendor/package`. - |file content| + .. include:: /Images/ExternalScreenshots/GithubComposerName.rst.txt #. Check, if the package can be found on `packagist.org `__. - |packagist screen shot| + .. include:: /Images/ExternalScreenshots/PackagistMask.rst.txt **Example:** To install the mask extension in version 4.1.\*, type:: composer require mask/mask:~4.1.0 -Install Extension from TER +Install extension from TER -------------------------- If the extension is not available on packagist, the good news is: All TER extensions are available via Composer! That's, why we added -`https://composer.typo3.org/` as repository to our :file:`composer.json` +:samp:`https://composer.typo3.org/` as repository to our :file:`composer.json` some lines above. There are little naming conventions: * Vendor name is `typo3-ter`. @@ -238,10 +239,10 @@ https://composer.typo3.org/satis.html. .. note :: If you do not include any packages this way, you can remove the - repository block named `https://composer.typo3.org` from your + repository block named :samp:`https://composer.typo3.org` from your :file:`composer.json` to improve speed. -Install Extension from Version Control System (e.g. GitHub, Gitlab, ...) +Install extension from version control system (e.g. GitHub, Gitlab, ...) ------------------------------------------------------------------------ In some cases, you will have to install a TYPO3 extension, which is not @@ -280,17 +281,18 @@ additional lines added to the :file:`composer.json` from above: .. code-block:: json - "extra": { + { + "extra": { "typo3/cms": { - "cms-package-dir": "{$vendor-dir}/typo3/cms" + "cms-package-dir": "{$vendor-dir}/typo3/cms" } - } + } + } There is no harm in that, but it won't have any effect. -The Git repository must be a TYPO3 extension, with all the required -files (e.g. :file:`ext_emconf.php`) and must contain a valid +The Git repository must be a TYPO3 extension with a :file:`composer.json` itself. How this file should look in your extension, can be found on `composer.typo3.org `__ or `this blog post from Helmut Hummel `__. @@ -303,7 +305,7 @@ same way like the other examples:: .. _mig-composer-include-individual-extensions: -Include Individual Extensions like Site Packages +Include individual extensions like site packages ================================================ It's not necessary to move your project's site package to a dedicated @@ -370,7 +372,7 @@ To complete our example :file:`composer.json`, it would look like this: ] } } - + After adding paths to the autoload you should run `composer dumpautoload`. This command will re-generate the autoload info and should be run anytime you add new paths to the autoload portion in the :file:`composer.json`. .. note:: @@ -381,19 +383,6 @@ After adding paths to the autoload you should run `composer dumpautoload`. This :ref:`completely clear "typo3conf/ext" folder ` in the :ref:`Best practices ` section. -.. |TER composer command| image:: ../Images/ter-composer-command.png - :scale: 65 % -.. |TER screen shot| image:: ../Images/ter-code-link.png - :scale: 65 % -.. |file list| image:: ../Images/github-composer-file.png - :scale: 80 % -.. |file content| image:: ../Images/github-composer-name.png - :scale: 80 % -.. |packagist screen shot| image:: ../Images/packagist-mask.png - :scale: 65 % -.. |satis abandoned note| image:: ../Images/satis-abandoned.png -.. |composer abandoned note| image:: ../Images/composer-ter-abandoned.png - New file locations ================== diff --git a/Documentation/MigrateToComposer/Requirements.rst b/Documentation/MigrateToComposer/Requirements.rst index f03c6a32..992e03f4 100644 --- a/Documentation/MigrateToComposer/Requirements.rst +++ b/Documentation/MigrateToComposer/Requirements.rst @@ -1,4 +1,4 @@ -.. include:: ../Includes.txt +.. include:: /Includes.rst.txt .. highlight:: bash ============ @@ -60,7 +60,7 @@ If you do not have such a web root directory, you must refactor your project before continuing. Please be aware to tell your web server about the changed web root folder, if necessary. -Code Integrity +Code integrity ============== Your project must have the TYPO3 core and all installed extensions in diff --git a/Documentation/Minor/Index.rst b/Documentation/Minor/Index.rst new file mode 100644 index 00000000..119272f5 --- /dev/null +++ b/Documentation/Minor/Index.rst @@ -0,0 +1,45 @@ +.. include:: /Includes.rst.txt + +.. _minor: + +============= +Minor upgrade +============= + +What are minor upgrades +======================= + +Minor upgrades contain bugfixes and security updates. They never contain new features and do not break backwards compatibility. + +For example, upgrading from TYPO3 version `11.5.2` to `11.5.3` is a minor upgrade. + +Before upgrading +================ + +The :ref:`pre-upgrade tasks ` chapter contains a list of tasks that should be actioned prior to upgrading +to a major release. + +The only tasks that need to actioned for a minor upgrade are :ref:`making a backup ` and :ref:`updating the reference index `. + +Check if updates are available +=============================== + +There are two ways to check if a minor update is available for an installation of TYPO3. + +All supported versions of TYPO3 and their version numbers are published on `get.typo3.org `_. + +Alternatively, running `composer outdated "typo3/*"` will present a list of any packages that have updates. + +Execute the upgrade +=================== + +To execute the upgrade, run `composer update -W typo3/*`. + +This will upgrade all TYPO3 packages, the `-W` (`--with-all-dependencies`) signals that any dependencies should also be upgraded. + +Post upgrade +============ + +Once Composer has finished upgrading the installation of TYPO3, log in to the backend and clear all caches. + +:guilabel:`Admin Tools > Maintenance > Flush TYPO3 and PHP Cache` diff --git a/Documentation/QuickInstall/Composer/Index.rst b/Documentation/QuickInstall/Composer/Index.rst deleted file mode 100644 index 0cfa4707..00000000 --- a/Documentation/QuickInstall/Composer/Index.rst +++ /dev/null @@ -1,64 +0,0 @@ -.. include:: ../../Includes.txt -.. highlight:: shell - - -.. _install-via-composer: - -========================== -Install TYPO3 via composer -========================== - -The recommended way of installing TYPO3 is via Composer, as described on -this page. If you do not want to use Composer, follow the :ref:`package installation -guide `. - -You have more ways to install TYPO3 via composer: - -* Install regular via loading the needed packages. Use `Composer helper `_ to generate the composer command. -* Install the cms-base-distribution package. This is helpful when you are use ddev, because it configures your database and mailserver for Mailhog. - -To create a new TYPO3 project using the TYPO3 Base Distribution:: - - # Download the Base Distribution, the latest "sprint" release (10) - composer create-project typo3/cms-base-distribution YourNewProjectFolder - -To create a new TYPO3 project using the TYPO3 Base Distribution in a ddev environment:: - - # Download the Base Distribution, the latest "LTS" release (10) - ddev composer create "typo3/cms-base-distribution:^10" --prefer-dist - - -.. note:: - - **For Windows users:** To install TYPO3 via the `composer` command, it should be started as admin - or explicitly given the right to create symlinks (use for example a - powershell or git bash started with admin rights). - - -After `composer create project ...` executed, you should have the following folder structure: - -.. code-block:: none - - . - ├── .gitignore - ├── composer.json - ├── composer.lock - ├── LICENSE - ├── public - ├── README.md - ├── var - └── vendor - -Point the document root of your web server to the `public` folder. - - -Tutorial from the official TYPO3 YouTube channel -================================================ - -.. youtube:: M4imQOUKDe4 - -Next Steps -========== - -Continue with :ref:`the-install-tool`. - diff --git a/Documentation/QuickInstall/GetAndUnpack/Index.rst b/Documentation/QuickInstall/GetAndUnpack/Index.rst deleted file mode 100644 index 82c3a68e..00000000 --- a/Documentation/QuickInstall/GetAndUnpack/Index.rst +++ /dev/null @@ -1,111 +0,0 @@ -.. include:: ../../Includes.txt -.. highlight:: shell - -.. _get-and-unpack-the-typo3-package: -.. _install-typo3-without-composer: - -============================== -Install TYPO3 Without Composer -============================== - -.. attention:: - - The recommended way of installing TYPO3 is :ref:`via Composer `. - This page describes an alternative method of installing TYPO3 without Composer. - -.. _installation-unix: - -Installing on a Unix Server -=========================== - -#. Get the Source Package from `http://typo3.org/download/ - `_ and upload this package to your web server. - Put it one level above the document root. In this example, we will use the - :file:`.tar.gz` file format. (If you are not sure which package you should - choose, read the section ":ref:`which-package-and-which-file-format`" in the - in-depth part of the manual). Use the shell to execute the following - commands:: - - /var/www/site/public/$ cd .. - /var/www/site/$ wget --content-disposition https://get.typo3.org/10 - - -#. Unpack the :file:`typo3_src-10.0.x.tar.gz` file on your web server:: - - /var/www/site/$ tar xzf typo3_src-10.4.x.tar.gz - - - .. note:: - - Be aware that the `x` in the extracted folder will be replaced with the - latest bugfix version, e.g. typo3_src-10.4.1. - - .. tip:: - - You can also unpack the package on your local PC and *then* upload the - *unpacked* contents onto your web server. However, the package contains - several thousand files which will then need to uploaded one at a time. - This process is time intensive and not recommended. - - -#. Create these symlinks in your document root:: - - cd public - ln -s ../typo3_src-10.4.x typo3_src - ln -s typo3_src/index.php index.php - ln -s typo3_src/typo3 typo3 - - -You end up with the following structure of files:: - - typo3_src-10.4.x/ - public/typo3_src -> ../typo3_src-10.4.x/ - public/typo3 -> typo3_src/typo3/ - public/index.php -> typo3_src/index.php - - -The advantage of this setup is that all files from the TYPO3 Source package are -kept together in the :file:`typo3_src-10.0.x` folder and separated from other -files of your installation. This allows you to easily replace this folder when -a new patchlevel version of TYPO3 is released. - - -.. note:: - - This setup allows the administrator to use the "Core Updater" feature in the - Admin Tool / Maintenance area to update the TYPO3 installation. - - - -.. _installation-windows: - -Installing on a Windows Server -============================== - -#. Get the Source Package from `http://typo3.org/download/ - `_ and extract it on your local PC. Use FTP, - SFTP or similar to upload the contents of this package to your web server. - Put them one level above the document root. For this manual, we will use the - :file:`.zip` file. (If you are not sure which package you should choose, - read the section ":ref:`which-package-and-which-file-format`" in the - in-depth part of the manual). - - -#. Use the shell to create these symbolic links in your document root:: - - cd public - mklink /d typo3_src ..\typo3_src-10.4.x - mklink /d typo3 typo3_src\typo3 - mklink index.php typo3_src\index.php - - - You end up with the following structure of files:: - - typo3_src-10.4.x/ - public/typo3_src -> ../typo3_src-10.4.x/ - public/typo3 -> typo3_src/typo3/ - public/index.php -> typo3_src/index.php - - -After extraction and symlink creation continue with the steps in -:ref:`the-install-tool` diff --git a/Documentation/QuickInstall/Index.rst b/Documentation/QuickInstall/Index.rst deleted file mode 100644 index 8d461186..00000000 --- a/Documentation/QuickInstall/Index.rst +++ /dev/null @@ -1,64 +0,0 @@ -.. include:: ../Includes.txt - -.. _quick-installation: - -================ -Installing TYPO3 -================ - -For those already familiar with running web software, get started quickly with -this quick install guide. For a more detailed description, take a look at the -section :ref:`in-depth-installation`. - -The following instructions assume you are able to create symlinks on the target -machine (which needs elevated permissions on Windows machines). - -.. rst-class:: bignums-xxl - -1. Checkout out the system requirements - - Install required software, such as: - - * Web server (Apache, Nginx, IIS...) - * PHP ≥ 7.2 - * Database server (MySQL, PostgreSQL, MariaDB ...) - * ... more see :ref:`system-requirements` - - .. tip:: - Alternatively, you can use a container solution such as - `DDEV `__ which comes with preconfigured - configuration for TYPO3. - -2. Install the TYPO3 core - - This can be done either using the package manager Composer or by unpacking - a downloaded archive. Using Composer is the recommended way to install TYPO3. - - The installation steps are described in the subchapters: - - * :ref:`install-via-composer` - * **or** :ref:`install-typo3-without-composer` - -3. "Admin Tool" - - Once the source is installed, you must walk through the "Admin Tool" (formerly called - "Install Tool"). This is described in: - - * :ref:`the-install-tool` - -4. Install "Introduction Package" (optional) - - This is recommended if you wish to create a TYPO3 demo site. - - * :ref:`install-introduction-package` - - -.. toctree:: - :titlesonly: - :hidden: - - Composer/Index - GetAndUnpack/Index - TheInstallTool/Index - IntroductionPackage/Index - NextSteps/Index diff --git a/Documentation/QuickInstall/IntroductionPackage/Index.rst b/Documentation/QuickInstall/IntroductionPackage/Index.rst deleted file mode 100644 index 3f7d71c3..00000000 --- a/Documentation/QuickInstall/IntroductionPackage/Index.rst +++ /dev/null @@ -1,109 +0,0 @@ -.. include:: ../../Includes.txt - - -.. _install-introduction-package: - -============================ -Install Introduction Package -============================ - -.. hint:: - - The Introduction Package creates a demo website! If you do not want - that, skip this page and proceed to :ref:`install-next-steps`. - -If you are using TYPO3 for the first time you may want to -see a working example of the CMS before you start work on -your own project. - -The `Official Introduction Package -`__ showcases many of -TYPO3's capabilities and gives you the ability to try them first hand. -The Introduction Package utilizes the `bootstrap_package extension -`__ -to generate multiple responsive HTML templates that you can select and try -out. - -It also features examples of the different kinds page content that you -typically see on a website. Such as paragraphs of text, images, tables -and navigation menus. - -Find more information in :ref:`introduction-package`. - -.. _installing-introduction-package-with-composer: -.. _installing-distributions-wit-composer: - -If you installed TYPO3 with Composer -==================================== - -To install the Introduction Package or any other distribution on a Composer -based installation use: - -.. code-block:: shell - - composer require typo3/cms-introduction - - -Use the following commands to activate the extension(s) via the command line: - -.. code-block:: shell - - ./vendor/bin/typo3 extension:activate bootstrap_package - ./vendor/bin/typo3 extension:activate introduction - -In this case, the Introduction Package depends on the Bootstrap Package -(extension key: `bootstrap_package`), so both packages have to be activated. - -When done, proceed with :ref:`install-intro-first-steps`. - - -.. _installing-distributions: -.. _installing-distributions-without-composer: - -If you installed TYPO3 without Composer -======================================= - -You can select "Yes, download the list of distributions" in the last step of -the :ref:`the-install-tool` when you finish installing the CMS. - -In the backend: - -.. rst-class:: bignums-xxl - -#. Go to :guilabel:`ADMIN TOOLS > Extensions` - -#. Select :guilabel:`Get preconfigured distributions` in the select box. - -#. Install the Introduction Package - - The first distribution on the top left should be the official "Introduction Package". - Click on :guilabel:`Install` to install. - -.. image:: ../../Images/get_introduction_package.png - - -.. _install-intro-first-steps: - -First steps with the Introduction Package -========================================= - -The "Introduction Package" creates some pages. The top level page is named "Congratulations". - -.. rst-class:: bignums-xxl - -#. Click on "Congratulations" in the page tree. - - -#. View the page in the frontend: - - Click on the :guilabel:`"View webpage"` icon (with an eye) to view the page - in the frontend. - -.. image:: ../../Images/startpage.png - -.. tip:: - - Learn more about using the backend in the "Getting Started Tutorial's" :ref:`t3start:general-principles` - chapter. - - diff --git a/Documentation/QuickInstall/NextSteps/Index.rst b/Documentation/QuickInstall/NextSteps/Index.rst deleted file mode 100644 index c613fbf0..00000000 --- a/Documentation/QuickInstall/NextSteps/Index.rst +++ /dev/null @@ -1,18 +0,0 @@ -.. include:: ../../Includes.txt - - -.. _install-next-steps: - -========== -Next steps -========== - -After the basic installation procedure is complete, TYPO3 will be working and -the most appropriate settings will have been made for you. You will get -redirected to the Backend and can log in with your administrator account. - -If you want to make changes to your installation settings at a later date, use -the "Admin Tools" in the backend. You can find more information in the section -"In-Depth Installation", subsection ":ref:`the-install-tool-in-depth`". - - diff --git a/Documentation/QuickInstall/TheInstallTool/Index.rst b/Documentation/QuickInstall/TheInstallTool/Index.rst deleted file mode 100644 index 95a429a6..00000000 --- a/Documentation/QuickInstall/TheInstallTool/Index.rst +++ /dev/null @@ -1,107 +0,0 @@ -.. include:: ../../Includes.txt - - -.. _the-install-tool: - -================ -The Admin Tool -================ - -.. tip:: - - The "Admin Tool" was formerly called "Install Tool". - - -#. Hit the start page of your freshly created site with your browser and you - should see the "thank you for downloading"-message. - - .. figure:: ../../Images/FirstInstall.png - :class: with-shadow - :alt: Success message after download. - - Success message after download. - - -#. Create the file FIRST_INSTALL in your web root directory (`public` folder) - and reload the page. You will be redirected to the install tool. It will - guide you through the steps for installing TYPO3. The Install Tool is - located in 'typo3/install' in your installation which for example would be - `http://www.example.com/typo3/install.php - `_. - - -#. This is what you should see: - - .. figure:: ../../Images/QuickInstall-1-System-Environment.png - :alt: first step - :class: with-shadow - - Install Tool in 1-2-3 mode, first step. - - -#. In case you have problems in your Environment, you will get warnings or - hints in this screen. In this case, you should try to fix them; the - ":ref:`troubleshooting`" section might help you. - - -#. *Choose database connection.* In this step, you can choose the database - management system TYPO3 should run with. Via the GUI you can choose between - MySQL (compatible to MariaDB), PostGres or SQLite if available. SQLite - requires no further configuration and is a good choice for testing TYPO3, - but you should choose one of the others for running production grade web - sites. - - .. figure:: ../../Images/QuickInstall-2-Database-Connection.png - :alt: third step - :class: with-shadow - - Install Tool in 1-2-3 mode, second step. - - -#. *Choose Database.* If you did not select SQLite in the previous step, you - have to select an empty database for TYPO3 now (or create one if your user - is allowed to). - - -#. Enter a username and password for your first TYPO3 administrator account. - (For security reasons, it's best not to use the name *admin*.) This password - will also be used for the Install Tool. The "site name" will identify this - installation (in the page tree and browser title). - - .. figure:: ../../Images/QuickInstall-4-Admin-User-Sitename.png - :alt: forth step - :class: with-shadow - - Install Tool in 1-2-3 mode, forth step. - - -#. In the last step you can choose whether you want to start with an empty - TYPO3 or if you want to have a basis to start from. - - - .. figure:: ../../Images/QuickInstall-5-Last-Step.png - :alt: fifth step - :class: with-shadow - - Install Tool in 1-2-3 mode, fifth step. - - .. tip:: - - If you wish to install the "Introduction Package" in order to create a - demo site, choose: - - * With Composer: :guilabel:`"Take me straight to the backend"` - * Without Composer: :guilabel:`"Get preconfigured distributions"` - - Proceed with :ref:`install-introduction-package` - - -If you do not wish to install the "Introduction Package", choose -:guilabel:`"Take me straight to the backend"` or -:guilabel:`"Create empty starting page"` - -**The installation is now complete.** - -Find some more tips in :ref:`install-next-steps`. - - diff --git a/Documentation/ReleaseIntegrity/Index.rst b/Documentation/ReleaseIntegrity/Index.rst deleted file mode 100644 index 45431ace..00000000 --- a/Documentation/ReleaseIntegrity/Index.rst +++ /dev/null @@ -1,268 +0,0 @@ -.. include:: ../Includes.txt -.. highlight:: bash -.. highlight:: text - -======================= -TYPO3 Release Integrity -======================= - -TYPO3 Release Packages (the downloadable tarballs and zip files) as well as -Git tags are signed using PGP signatures during the automated release process. -Besides that, MD5 and SHA2-256 hashes are being generated for these files. - -Release package contents ------------------------- - -TYPO3 Release packages contain the following files: - -.. code-block:: bash - :caption: `TYPO3 CMS 7.6.4 contents`_ as an example - :name: release-package-contents - - typo3_src-7.6.4.tar.gz - typo3_src-7.6.4.tar.gz.sig - typo3_src-7.6.4.zip - typo3_src-7.6.4.zip.sig - RELEASE-7.6.4.txt - -* ``*.tar.gz`` and ``*.zip`` files are the actual release packages, containing - the source code of the TYPO3 CMS Core -* ``*.sig`` files contain accordant signatures for each release package file -* ``RELEASE.txt`` is the signed "delivery note" of the whole release - -.. _TYPO3 CMS 7.6.4 contents: https://sourceforge.net/projects/typo3/files/TYPO3%20Source%20and%20Dummy/TYPO3%207.6.4/ - - -Checking file hashes --------------------- - -File hashes are used to check that a downloaded file was transferred and stored -correctly on the local system. TYPO3 uses the cryptographic hash methods `MD5`_ -and `SHA2-256`_ which are created by accordant tools like ``md5sum`` or -``shasum``. - -The ``RELEASE.txt`` file contains these hash sums that have been created during -the release process. - -.. code-block:: text - :caption: `TYPO3 CMS 7.6.4 RELEASE.txt file`_ as an example - :name: release-file - - -----BEGIN PGP SIGNED MESSAGE----- - Hash: SHA256 - - ================================================================================================ - Release of TYPO3 CMS 7.6.4 - ================================================================================================ - - MD5 checksums: - 400d5f8808c1377034ddc35165ccbb18 typo3_src-7.6.4.tar.gz - d9b4ec13fdc935445f6e85c3e3c7fdc8 typo3_src-7.6.4.zip - - SHA256 checksums: - 6d65008f4a71036cc6c90648f3c4019422904ff7c7d3c0f84a1695d64b8f615b typo3_src-7.6.4.tar.gz - 04fe21245a0881ed3be1219092cc86bcba1d2fb28554e33d425814bfa5bc347e typo3_src-7.6.4.zip - - Further details on the signing and hashing process of TYPO3 releases: - https://docs.typo3.org/typo3cms/drafts/github/TYPO3Incubator/InfrastructureGuide/Releases/ - ================================================================================================ - - -----BEGIN PGP SIGNATURE----- - ... - -----END PGP SIGNATURE----- - - -To check values, either one of the the names tools, ``md5sum`` or ``shasum`` has -to be used to locally create these hash values which you then use to compare -them to the values published with the release. - -.. code-block:: bash - - ~$ md5sum typo3_src-*.tar.gz typo3_src-*.zip - 400d5f8808c1377034ddc35165ccbb18 typo3_src-7.6.4.tar.gz - d9b4ec13fdc935445f6e85c3e3c7fdc8 typo3_src-7.6.4.zip - -.. code-block:: bash - - ~$ shasum -a 256 typo3_src-*.tar.gz typo3_src-*.zip - 6d65008f4a71036cc6c90648f3c4019422904ff7c7d3c0f84a1695d64b8f615b typo3_src-7.6.4.tar.gz - 04fe21245a0881ed3be1219092cc86bcba1d2fb28554e33d425814bfa5bc347e typo3_src-7.6.4.zip - -.. _MD5: https://en.wikipedia.org/wiki/MD5 -.. _SHA2-256: https://en.wikipedia.org/wiki/SHA-2 -.. _TYPO3 CMS 7.6.4 RELEASE.txt file: http://prdownloads.sourceforge.net/typo3/RELEASE-7.6.4.txt?download - - -Checking file signatures ------------------------- - -TYPO3 uses `Pretty Good Privacy`_ to sign release packages and Git release tags. -To validate these signatures we suggest to use `The GNU Privacy Guard`_, however -any `OpenPGP`_-compliant tool should be working as well. - -The release packages are using a detached binary signature. This means that -the file ``typo3_src-7.6.4.tar.gz`` has an additional signature file -``typo3_src-7.6.4.tar.gz.sig`` which is the detached signature. The -``RELEASE.txt`` file that has been mentioned in the previous section -is signed as well - however it contains the signature inline in the same file. - -.. code-block:: bash - - gpg --verify RELEASE-7.6.4.txt - -.. code-block:: none - - gpg: Signature made Tue 23 Feb 2016 12:18:26 PM CET using RSA key ID 59BC94C4 - gpg: Can't check signature: public key not found - -The warning means that the public key ``59BC94C4`` is not yet available on the -local system and cannot be used to validate the signature. The public key can be -obtained by any key server - a popular one is `pgpkeys.mit.edu`_. - -.. code-block:: bash - - wget -qO- https://get.typo3.org/KEYS | gpg --import - -.. code-block:: none - - gpg: requesting key 59BC94C4 from hkp server pgpkeys.mit.edu - gpg: key 59BC94C4: public key "TYPO3 Release Team (RELEASE) " imported - gpg: key FA9613D1: public key "Benjamin Mack " imported - gpg: key 16490937: public key "Oliver Hader " imported - gpg: no ultimately trusted keys found - gpg: Total number processed: 3 - gpg: imported: 3 (RSA: 3) - -Once the public key has been imported, the previous command on verifying the -signature of the ``RELEASE.txt`` file can be repeated. - -.. code-block:: bash - - gpg --verify RELEASE-7.6.4.txt - -.. code-block:: none - - gpg: Signature made Tue 23 Feb 2016 12:18:26 PM CET using RSA key ID 59BC94C4 - gpg: Good signature from "TYPO3 Release Team (RELEASE) " - gpg: WARNING: This key is not certified with a trusted signature! - gpg: There is no indication that the signature belongs to the owner. - Primary key fingerprint: 7AF5 1AAA DED9 D002 4F89 B06B 9B9C B92E 59BC 94C4 - -The new warning is expected since everybody could have created the public key -and uploaded it to the key server. The vital aspect here is to validate the key -fingerprint ``7AF5 1AAA DED9 D002 4F89 B06B 9B9C B92E 59BC 94C4`` which is in -this case the correct one for TYPO3 CMS release packages. - -.. code-block:: bash - - gpg --fingerprint 59BC94C4 - -.. code-block:: none - - pub 4096R/59BC94C4 2016-02-21 [expires: 2021-02-22] - Key fingerprint = 7AF5 1AAA DED9 D002 4F89 B06B 9B9C B92E 59BC 94C4 - uid TYPO3 Release Team (RELEASE) - sub 4096R/0752FD79 2016-02-21 - -Verifying the release packages works almost similar with a detacted signature -which has to be downloaded as well. - -.. code-block:: bash - - gpg --verify typo3_src-7.6.4.tar.gz.sig typo3_src-7.6.4.tar.gz - -.. code-block:: none - - gpg: Signature made Tue 23 Feb 2016 12:18:24 PM CET using RSA key ID 59BC94C4 - gpg: Good signature from "TYPO3 Release Team (RELEASE) " - -.. _Pretty Good Privacy: https://en.wikipedia.org/wiki/Pretty_Good_Privacy -.. _The GNU Privacy Guard: http://www.gnupg.org/ -.. _OpenPGP: http://www.openpgp.org/ -.. _pgpkeys.mit.edu: https://pgpkeys.mit.edu/ - - -Checking tag signature ----------------------- - -Checking signatures on Git tags works similar to verifying the results using the -``gpg`` tool, but with using the ``git tag --verify`` command directly. - -.. code-block:: bash - - git tag --verify 7.6.4 - - -.. code-block:: none - - object bd0c7f6ca9cb3093bd647e85035e9f36bf1e9e86 - type commit - tag 7.6.4 - tagger TYPO3 Release Team 1456226245 +0100 - - Tagged version 7.6.4 - gpg: Signature made Tue 23 Feb 2016 12:17:25 PM CET using RSA key ID 59BC94C4 - gpg: Good signature from "TYPO3 Release Team (RELEASE) " - -The ``git show`` command on the name of the tag reveals more details. - -.. code-block:: bash - - git show 7.6.4 - -.. code-block:: none - - tag 7.6.4 - Tagger: TYPO3 Release Team - Date: Tue Feb 23 12:17:25 2016 +0100 - - Tagged version 7.6.4 - -----BEGIN PGP SIGNATURE----- - ... - -----END PGP SIGNATURE----- - - commit bd0c7f6ca9cb3093bd647e85035e9f36bf1e9e86 - Author: TYPO3 Release Team - Date: Tue Feb 23 12:16:38 2016 +0100 - - [RELEASE] Release of TYPO3 7.6.4 - - Change-Id: Ibc16ad8989398404e277236bed6ae5a0f7f6a29f - Reviewed-on: https://review.typo3.org/46839 - Reviewed-by: TYPO3 Release Team - Tested-by: TYPO3 Release Team - - -Public Keys ------------ - -.. note:: - - Through June 2017 TYPO3 releases have been cryptographically signed by - ``TYPO3 Release Team `` with a dedicated public key. - Since July 2017 releases are signed by individual members of the TYPO3 - Release Team directly, namely ``Benni Mack `` and - ``Oliver Hader ``. - -You can download the used public keys from `get.typo3.org.keys`_ - -* TYPO3 Release Team - + 4096 bit RSA key - + Key ID `0x9B9CB92E59BC94C4`_ - + Fingerprint ``7AF5 1AAA DED9 D002 4F89 B06B 9B9C B92E 59BC 94C4`` -* Benni Mack - + 4096 bit RSA key - + Key ID `0x3304BBDBFA9613D1`_ - + Fingerprint ``E7ED 29A7 0309 A0D1 AE34 DA73 3304 BBDB FA96 13D1`` -* Oliver Hader - + 4096 bit RSA key - + Key ID `0xC19FAFD699012A5A`_, subkey of `0xA36E4D1F16490937`_ - + Fingerprint ``0C4E 4936 2CFA CA0B BFCE 5D16 A36E 4D1F 1649 0937`` - -............................... - -.. _0x9B9CB92E59BC94C4: https://pgpkeys.mit.edu/pks/lookup?search=0x9B9CB92E59BC94C4 -.. _0x3304BBDBFA9613D1: https://pgpkeys.mit.edu/pks/lookup?search=0x3304BBDBFA9613D1 -.. _0xC19FAFD699012A5A: https://pgpkeys.mit.edu/pks/lookup?search=0xC19FAFD699012A5A -.. _0xA36E4D1F16490937: https://pgpkeys.mit.edu/pks/lookup?search=0xA36E4D1F16490937 -.. _get.typo3.org.keys: https://get.typo3.org/KEYS \ No newline at end of file diff --git a/Documentation/Settings.cfg b/Documentation/Settings.cfg index 8b94c38a..ec289ba4 100644 --- a/Documentation/Settings.cfg +++ b/Documentation/Settings.cfg @@ -24,7 +24,7 @@ ; endless list of all of the general simple settings ; you can use in 'conf.py' -project = Installation and Upgrade Guide +project = Upgrade Guide version = 11.0 (development) release = 11.0 (development) t3author = TYPO3 Documentation Team @@ -58,3 +58,6 @@ h2document = https://docs.typo3.org/m/typo3/docs-how-to-document/master/en-us t3core = https://docs.typo3.org/c/typo3/cms-core/master/en-us/ t3coreapi = https://docs.typo3.org/m/typo3/reference-coreapi/master/en-us/ t3start = https://docs.typo3.org/m/typo3/tutorial-getting-started/master/en-us/ + +; point to the manual of the current LTS where necessary +ltst3install = https://docs.typo3.org/m/typo3/guide-installation/10.4/en-us/ diff --git a/Documentation/Sitemap/Index.rst b/Documentation/Sitemap/Index.rst deleted file mode 100644 index b139600c..00000000 --- a/Documentation/Sitemap/Index.rst +++ /dev/null @@ -1,11 +0,0 @@ -:template: sitemap.html - -.. _Sitemap: - -======= -Sitemap -======= - -.. template 'sitemap.html' will insert the toctree as a sitemap here - below normal contents - diff --git a/Documentation/Troubleshooting/Index.rst b/Documentation/Troubleshooting/Index.rst deleted file mode 100644 index e5c215c1..00000000 --- a/Documentation/Troubleshooting/Index.rst +++ /dev/null @@ -1,354 +0,0 @@ -.. include:: ../Includes.txt - - -.. _troubleshooting: - -=============== -Troubleshooting -=============== - -The following sections contain hints to help you solve common problems. -Note that you should also check the section -:guilabel:`"ADMIN TOOLS > Environment > Environment Status"` in the -Install Tool or TYPO3 backend. TYPO3 will inform you about errors and -warnings in your installation. Follow the advice given there to fix those issues. -This helps to solve or prevent most issues. - -.. _troubleshooting_lost_password: - -Lost passwords -============== - -.. _troubleshooting_lost_password_admin: - -Resetting lost admin passwords ------------------------------- - -If the admin password got lost you can create a new admin user from the admin -tools section :guilabel:`Maintenance`. - -Directly from the TYPO3 backend the admin tools can only be accessed by admin users -with system maintainer rights. And such a user is lacking. - -However the admin tools can be accessed as :guilabel:`Install tool` by calling:: - - https://examle.com/typo3/install.php - -The install tool expects the install tool password. If you have also lost this -one see :ref:`troubleshooting_lost_password_install_tool`. - -Once in the admin tool go to :guilabel:`Maintenance > Create Administrative User` -and click on :guilabel:`Create Administrator`. In the following dialogue you -can enter a new username and password for the new administrator. - -Use this new administrator to log into the TYPO3 backend. In the module -:guilabel:`Backend Users` you can change the passwords of existing users, -including admins. - - -.. _troubleshooting_lost_password_install_tool: - -Resetting lost install tool passwords -------------------------------------- - -As long as you have writing access to the file -:file:`typo3conf/LocalConfiguration.php` you can reset -the install tool password. - -Just enter any desired password into the dialogue asking for your install tool -password. If it is not correct you will get a message like this one:: - - "Given password does not match the install tool login password. Calculated hash: - $argon2i$v=xyz" - -Copy this hash including the :php:`$argon2i` part and any trailing dots. Then -open the file :file:`typo3conf/LocalConfiguration.php` and replace the following -array entry:: - - 'BE' => [ - 'installToolPassword' => '$argon2i$v=xyz', - ], - -.. note:: - - If the new install tool password does not work, check if it gets overridden - later in the LocalConfiguration.php or in the AdditionalConfiguration.php - if one exists. If you can still not log into the install tool check if - there are errors in the logs when debugging is turned on. - - -Debug settings -============== - -During troubleshooting, in the :guilabel:`"Settings > Configuration Presets"` section of the Install -Tool, under "Debug settings", you should select the "Debug" preset. This is -especially helpful, if e.g. in the Frontend you only see a blank page. With -debug settings activated, the PHP error message will be displayed, which will -help you narrow down the problem. - -You may also have to enable this TypoScript setting: - -.. code-block:: typoscript - - config.contentObjectExceptionHandler = 0 - -.. seealso:: - - :ref:`t3coreapi:error-handling-configuration-examples-debug` - -.. important:: - - Do not permanently enable debug presets, but set it back to production ("Live") - after you have fixed the problem (or analyze the problem on a test system). - -If necessary, look in relevant logs for further clues: - -* Webserver log files for general problems (e.g. :file:`/var/log/apache2` on - Linux based system) -* TYPO3 Administration log in :guilabel:`SYSTEM > Log` (in the backend) -* TYPO3 logs writting by :ref:`Logging Framework ` in :file:`typo3temp/var/log` - -What gets written where depends on how you have configured the error handling and logging. - -.. _apache: - -Apache -====== - -Some settings may require adjustment for TYPO3 to operate -correctly. - - -.. _enable-necessary-modules: -.. _enable-mod_rewrite: - -Enable mod_rewrite ------------------- - -TYPO3 makes use of several Apache modules (see -:ref:`System Requirements ` for more information). - -If mod_rewrite is not enabled, the URL handling will not work -properly (specifically the mapping of the URLs TYPO3 uses internally -to "speaking URLs") and you might get 404 (page not found) errors. - -.. tip:: - - How Apache modules are enabled, depends on your system. Look in the - documentation for your operating system distribution. - -For example, the modules can be -enabled by editing your http.conf file, locating the required modules -and removing the preceding hash symbol:: - - #LoadModule expires_module modules/mod_expires.so - #LoadModule rewrite_module modules/mod_rewrite.so - -Or, just do - -.. code-block:: bash - - a2enmod rewrite expires - -As usual, after changing configuration, you must reload / restart the -Apache service. - -.. _adjust-threadstacksize-on-windows: - -Adjust ThreadStackSize on Windows ---------------------------------- - -If you are running TYPO3 on top of Windows, the extension manager might not -appear. Instead you might only see a blank screen in the right frame. - -This problem is caused by the value of ThreadStackSize, which on -Windows systems by default is set too low. To fix this, add the -following lines at the end of your httpd.conf file:: - - - ThreadStackSize 8388608 - - - -.. _php: - -PHP -=== - -.. _install-tool: - -Install Tool ------------- - -The "System Environment" section of the Install Tool provides detailed -information about any missing PHP modules and any other settings that -may not be configured correctly. - -For example, the PHP extensions openssl and fileinfo must be enabled. This can -be achieved by adding (or uncommenting) the following lines in the [PHP] -section of your php.ini file:: - - extension=fileinfo.so - extension=openssl.so - -On a Windows-based server, these are the extension files:: - - extension=php_fileinfo.dll - extension=php_openssl.dll - - -.. _php-caches-extension-classes-etc: - -PHP Caches, Extension Classes etc. ----------------------------------- - -There are some situations which can cause what appear to be totally -illogical problems after an upgrade: - -- If extensions override classes in which functions have changed. - Solution: Try disabling all extensions and then enable them one by - one until the error recurs. - -- If a PHP cache somehow fails to re-cache scripts: in particular, if a - change happened to a parent class overridden by a child class which was not updated. - Solution: Remove ALL cached PHP files (for PHP-Accelerator, remove :file:`/tmp/phpa_*`) - and restart Apache. - - -.. _php-troubleshooting_opcode: - -Opcode cache messages ---------------------- - -No PHP opcode cache loaded -~~~~~~~~~~~~~~~~~~~~~~~~~~ - -You do not have an opcode cache system installed or activated. If you -want better performance for your website, then you should use one. The -best choice is OPcache for PHP 5.5 onwards. - -This opcode cache is marked as malfunctioning by the TYPO3 CMS Team. -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - -This will be shown if an opcode cache system is found and activated, -which is known to have "too many" errors and won't be supported by TYPO3 -CMS (no bugfixes, security fixes or anything else). In current TYPO3 -versions only OPcache is supported - -This opcode cache may work correctly but has medium performance. -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - -This will be shown if an opcode cache system is found and activated, -which has some nitpicks. For example we cannot clear the cache for one -file (which we changed) but only can reset the complete cache itself. -This will happen with: - -- OPcache before 7.0.2 (Shouldn't be out in the wild.) -- APC before 3.1.1 and some mysterious configuration combinations. -- XCache -- ZendOptimizerPlus - -This opcode cache should work correctly and has good performance. -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - -Well it seems that all is ok and working. Maybe you can tweak something -more but this is out of our knowledge of your user scenario. - - -.. _mysql: - -MySQL -===== - - -.. _character-sets: - -Character Set -------------- - -TYPO3 uses UTF-8 encoding, you will need to ensure that your -instance of MySQL also uses UTF-8. When installing TYPO3 for -the first time, you can select UTF-8 encoding when you create -the database for the first time. For an existing database, you -will have to set each table and column to use UTF-8. - - -.. _typo3-specific: - -TYPO3 -===== - - -.. _cached-files-in-typo3temp: - -Cached Files in typo3temp/ --------------------------- - -Generally you should know that TYPO3 generates temporary "cached" -files and PHP scripts in :file:`/cache/` (usually either -`typo3temp/var/cache` or `var/cache`). You can remove the -whole :file:`/cache` directory at any time; the directory -structure and all the caches will be re-written on the next hit to the -system. - -A shortcut to remove these caches can be found in the Install Tool, -under "Important Actions". This might be useful in the event your -cache files become damaged and your system is not running correctly. The -Install Tool won't load any of these caches or any extension, so it -should be safe to use regardless of the corrupt state of the Caches. - -Amongst other caches, under :file:`/cache/code/core/` -you find files like these:: - - -rw-rw---- 1 www-data www-data 61555 2014-03-26 16:28 ext_localconf_8b0519db6112697cceedb50296df89b0ce04ff70.php - -rw-rw---- 1 www-data www-data 81995 2014-03-26 16:28 ext_tables_c3638687920118a92ab652cbf23a9ca69d4a6469.php - -These files simply contain all :file:`ext\_tables.php` and -:file:`ext\_localconf.php` files of the installed extensions -concatenated in the order they are loaded. Therefore including one of -these files would be the same as including potentially hundreds of PHP -files and should improve performance. - -Concerning these files you have to consider the following: - -#. Making changes to these files does not make sense, because they can - be removed and recreated from the "originals" at any time. You should - instead change the "originals". - -#. If you make changes to the original :file:`ext\_tables.php` or - :file:`ext\_localconf.php` files in your extensions, you will have - to clear the cached files away for your changes to take effect. - - -.. _possible-problems-with-the-cached-files: - -Possible Problems With the Cached Files ---------------------------------------- - -.. _changing-the-absolute-path-to-typo3: - -Changing the absolute path to TYPO3 -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - -If you change the path of the TYPO3 installation, you might get a lot -of errors like "Failed opening ..." or "Unable to access ...". The -problem is that absolute file paths are hard-coded inside the cached -files. - -Fix: Clean the cache using the Install Tool: Go to "Important Actions" -and use the "Clear all caches" function. Then hit the page again. - - -.. _changing-image-processing-settings: - -Changing Image Processing Settings -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - -When you change the settings for Image Processing (in normal mode), -you must take into account that old images may still be in the -:file:`typo3temp/` folder and that they prevent new files from being -generated! This is especially important to know, if you are trying to -set up image processing for the very first time. - -The problem is solved by clearing the files in the :file:`typo3temp/` -folder. Also make sure to clear the database table "cache\_pages". diff --git a/Documentation/Upgrade/ChangelogAndNewsmd/Index.rst b/Documentation/Upgrade/ChangelogAndNewsmd/Index.rst deleted file mode 100644 index 79a67cf2..00000000 --- a/Documentation/Upgrade/ChangelogAndNewsmd/Index.rst +++ /dev/null @@ -1,8 +0,0 @@ -:orphan: - - -=================== -Check the ChangeLog -=================== - -The content of this page was moved to :ref:`check-the-changelog-and-news-md`. diff --git a/Documentation/Upgrade/ClearCachesAndUserSettings/Index.rst b/Documentation/Upgrade/ClearCachesAndUserSettings/Index.rst deleted file mode 100644 index c8f179f7..00000000 --- a/Documentation/Upgrade/ClearCachesAndUserSettings/Index.rst +++ /dev/null @@ -1,19 +0,0 @@ -.. include:: ../../Includes.txt - - -.. _clear-caches-and-user-settings: - -=================== -Clear User Settings -=================== - -You might consider clearing the Backend user preferences. This -can avoid problems, if something in the upgrade requires this. Go to -"Clean up", scroll to "Reset user preferences" and click "Reset backend -user preferences". - -.. figure:: ../../Images/Reset-User-Preferences.png - :class: with-shadow - :alt: Reset User Preferences - - Reset user preferences in install tool. diff --git a/Documentation/Upgrade/Index.rst b/Documentation/Upgrade/Index.rst deleted file mode 100644 index 429b4a5d..00000000 --- a/Documentation/Upgrade/Index.rst +++ /dev/null @@ -1,39 +0,0 @@ -.. include:: ../Includes.txt - - -.. _upgrade: - -Upgrade -======= - -When a new version of TYPO3 is released, you should follow the -guideline in this chapter in order to do an upgrade. Also follow any -additional upgrade information carefully. You might e.g. want to skim -the `Release Notes on get.typo3.org `_ to -see if any features affect the way your site works. - -.. note:: - - **Think of active users** - - Think of users who might want to do any changes during your upgrading - and/or fallback. Inform them **before** you start! - -Basically these are the steps to be done to update your TYPO3 site: - -.. toctree:: - :maxdepth: 5 - :titlesonly: - :glob: - - Preparation/Index - Backup/Index - UpdateReferenceIndex/Index - InstallTheNewSource/Index - ConvertGlobalExtensions/Index - UseTheUpgradeWizard/Index - RunTheDatabaseAnalyzer/Index - ClearCachesAndUserSettings/Index - RemoveTemporaryCacheFiles/Index - UpdateExtensions/Index - UpdateTranslations/Index diff --git a/Documentation/Upgrade/InstallTheNewSource/Index.rst b/Documentation/Upgrade/InstallTheNewSource/Index.rst deleted file mode 100644 index ba627586..00000000 --- a/Documentation/Upgrade/InstallTheNewSource/Index.rst +++ /dev/null @@ -1,169 +0,0 @@ -.. include:: ../../Includes.txt - -.. Use syntax highlighting for shell commands by default - on this page - -.. highlight:: shell - -.. _install-the-new-source: - -====================== -Install the New Source -====================== - -.. note:: - - The recommended installation of TYPO3 is based on Composer. - - -Upgrading a Composer Based System -================================= - -.. caution:: - - TYPO3 v9 LTS has no support for the package `typo3/cms` anymore - instead - all TYPO3 system extensions are now single packages. When upgrading, remove - the `typo3/cms` package and require the single packages you need. - -Use Composer to update your system via for example:: - - composer require typo3/cms-backend:^9.5 typo3/cms-core:^9.5 \ - typo3/cms-extbase:^9.5 typo3/cms-extensionmanager:^9.5 \ - typo3/cms-filelist:^9.5 typo3/cms-fluid:^9.5 typo3/cms-frontend:^9.5 \ - typo3/cms-install:^9.5 typo3/cms-recordlist:^9.5 \ - --update-with-dependencies - -If you have extensions installed, you will have to find the corresponding newer -versions you want to install for your new major version and update them, too. - -Example:: - - composer require typo3/cms-backend:^9.5 typo3/cms-core:^9.5 \ - typo3/cms-extbase:^9.5 typo3/cms-extensionmanager:^9.5 \ - typo3/cms-filelist:^9.5 typo3/cms-fluid:^9.5 typo3/cms-frontend:^9.5 \ - typo3/cms-install:^9.5 typo3/cms-recordlist:^9.5 georgringer/news:^7.0 \ - --update-with-dependencies - -.. tip:: - - To make selecting the packages easier, you can use the TYPO3 `Composer Helper - `_ to find the packages you need. - -To find the matching extension versions you can go to `packagist.org -`_, search for your extension and take a look at the -requires section. - -.. tip:: - - The list of system extensions developed directly in the TYPO3 core repository - changes from time to time: Some extensions are merged into others, new system extensions - are added and others abandoned or released to the public and therefore maintained at a - different place. - If you want to know details, you can have a look at this `list - `_ or search in the - `breaking changes `_ - for the extension key (not the package name!). - -.. figure:: ../../Images/ext-on-packagist.png - :class: with-shadow - :alt: extension on packagist - - The "News" extension on packagist - - - -.. _install-next-step: -.. _install-core-updater: - -Using the Core Updater -====================== - -The Install Tool in the section "Important Actions" provides a function to -update the TYPO3 Core. - -In the section "Important Actions" scroll down to "Core update" and click the -"Check for core updates" button. If the requirements are met, TYPO3 will -automatically install the new source code. - -.. note:: - - For the Core Updater to work, the following setup is required: - - * It only works under Unix and MacOS. - - * :file:`typo3_src` must be a symlink. - - * This symlink needs to be writable (and deletable) by the web server user. - - * document root needs to be writable. - - * One path above document root (:file:`../`) needs to be writable (new - directories need to be allowed to be created). - - * The :program:`tar` command must be available for extracting the Source - package. - -Disabling the Core Updater --------------------------- - -The Core Updater functionality can be disabled, in order to avoid users using it, -i.e. if you use your own update mechanism. - -This feature is already disabled when TYPO3 is installed via Composer. - -To disable the core updater, you can set this environment variable:: - - TYPO3_DISABLE_CORE_UPDATER=1 - -For example in Apache: - -.. code-block:: apacheconf - - SetEnv TYPO3_DISABLE_CORE_UPDATER 1 - -or for nginx: - -.. code-block:: nginx - - server { - location ~ path/to/it { - include fastcgi_params; - fastcgi_param TYPO3_DISABLE_CORE_UPDATER "1"; - } - } - -This will disable the button and all related functionality in the Install -Tool. - - -.. _install-manually: - -Installing the Source Manually -============================== - -Go to `http://typo3.org/download/ `_ and download -the source package of the new TYPO3 version. - -Extract the package on your web server and - in your TYPO3 document root - -adjust the :file:`typo3_src` symlink. - - -What's the Next Step? -===================== - -In case you did a *minor update*, e.g. from TYPO3 9.5.0 to 9.5.1, database -updates are usually *not* necessary. All you still have to do is to -:ref:`remove the temporary cache files `. After -that your update is finished. - -.. note:: - - Make sure to read the release notes even of minor versions carefully. While - we take great care to keep the minor updates as easy as possible especially - when releasing security updates more steps might be necessary. - -In case of a *major update*, e.g. from TYPO3 8.7 to 9.5, go ahead with the next -step! - -Also check out the breaking changes listed in `Changelog -`_ for the new version. diff --git a/Documentation/Upgrade/Preparation/Index.rst b/Documentation/Upgrade/Preparation/Index.rst deleted file mode 100644 index 3cbfbdfc..00000000 --- a/Documentation/Upgrade/Preparation/Index.rst +++ /dev/null @@ -1,114 +0,0 @@ -.. include:: ../../Includes.txt - - -.. _preparation: -.. _beforeUpgrading: - -================ -Before upgrading -================ - -* You should use the latest version of a previous major version before you upgrade! - For example, upgrade to latest 9.5.x before you upgrade to version 10. - -Before starting the upgrade check your system for compatibility with a newer -TYPO3 version. - -* Before you upgrade to the next major version, make sure you have run all - Upgrade Wizards of the the current TYPO3 major version. - -* Check for deprecations: Enable the deprecation log and let it log all - deprecations for a while. - -* Alternatively (or additionally) run the - :ref:`extension scanner ` and - :ref:`handle deprecations ` (below). - -* Check installed extensions for versions compatible to the target TYPO3 - version - -* Try the upgrade on a development system first or create a parallel instance - - -Check that all system requirements for upgrading are met: - -* See :ref:`system-requirements` - -.. _handling-deprecations: - -Handling Deprecations -===================== - -If you notice some API you are using is deprecated, you should look up the -corresponding `ChangeLog `_ -entry and see how to migrate your code corresponding to the documentation. - -Since TYPO3 v9 an :ref:`extension scanner ` is -included, that provides basic scanning of your extensions for deprecated code. -While it does not catch everything, it can be used as a base for an upgrade. You -can either access the extension scanner via the TYPO3 admin tools (in the -Backend: :guilabel:`Module "Upgrade" > "Scan Extension Files"`) -or as a standalone tool (https://github.com/tuurlijk/typo3scan). - -The extension scanner will show the corresponding changelog which contains -a description of how to migrate your code. See :ref:`check-the-changelog-and-news-md` -for more information about the Changelogs and how to read them. - -.. note:: - - TYPO3 aims at providing a reliable backwards compatibility between versions: - - * Minor versions are always backwards compatible - unless explicitly stated - otherwise (for example in case of security updates) - - * Major versions may contain breaking changes - normally these are - deprecated one major version in advance - - * Most breaking changes usually happen in the first Sprint Release - - If PHP classes, methods, constants, functions or parameters are to be - removed, they will be *marked as deprecated* first and not removed until the - next major release of TYPO3. For example: a method that gets deprecated in - version 9.4.0 will remain fully functional in all 9.x.x releases, but will - be removed in version 10. - - This strategy gives developers sufficient time to adjust their TYPO3 - extensions, assuming many agencies upgrade from one LTS release to the next - (usually 1.5 years). - -.. _check-the-changelog-and-news-md: - -Check the ChangeLog -=================== - -In addition to the deprecations you may want to read the information about important -changes, new features and breaking changes for the release you are updating to. - -The ChangeLog is divided into four sections "Breaking Changes", "Features", "Deprecation" and -"Important". Before upgrading you should at least take a look at the sections "Breaking Changes" -and "Important" - changes described in those areas might affect your website. - -.. tip:: - - Breaking changes should be of no concern to you if you already handled the - deprecations before upgrading. - -The detailed information contains a section called "Affected Installations" which contains hints -whether or not your website is affected by the change. - -There are 3 different methods you can use to read the Changelogs: - -#. Look through the `ChangeLogs `_ - online. This has the advantage that code blocks will be formatted nicely with - syntax highlighting. -#. Read the Changelogs in the backend: :guilabel:`Upgrade > View Upgrade Documentation`. - This has the advantage that you can filter by tags and mark individual Changelogs - as done. This way, it is possible to use the list like a todo list. -#. Read the changelog in the :ref:`Extension Scanner ` - (as explained above). - -.. figure:: ../../Images/Upgrade-Analysis.png - :class: with-shadow - :alt: Uprade Analysis - - The "Upgrade Analysis" in the Install Tool diff --git a/Documentation/Upgrade/RemoveTemporaryCacheFiles/Index.rst b/Documentation/Upgrade/RemoveTemporaryCacheFiles/Index.rst deleted file mode 100644 index 244fb74d..00000000 --- a/Documentation/Upgrade/RemoveTemporaryCacheFiles/Index.rst +++ /dev/null @@ -1,28 +0,0 @@ -.. include:: ../../Includes.txt - - -.. _remove-temporary-cache-files: - -============ -Clear Caches -============ - -You should also clear all caches when upgrading. - -Go to "Maintenance" and click "Flush": - -.. figure:: ../../Images/Important-Actions-Clear-All-Cache.png - :class: with-shadow - :alt: Flush Caches - - The option "Flush" in the Install Tool. - -Additionally, after an upgrade to a new major version, you should also delete -the other temporary files, which TYPO3 saves in :file:`typo3temp/`. In the -Install Tool go to "Clean up" to do so. - -.. figure:: ../../Images/Remove-Temporary-Assets.png - :class: with-shadow - :alt: Remove temporary assets. - - The option "Remove temporary assets" in the Install Tool. diff --git a/Documentation/Upgrade/UpdateExtensions/Index.rst b/Documentation/Upgrade/UpdateExtensions/Index.rst deleted file mode 100644 index 21661b2d..00000000 --- a/Documentation/Upgrade/UpdateExtensions/Index.rst +++ /dev/null @@ -1,17 +0,0 @@ -.. include:: ../../Includes.txt - - -.. _update-extensions: - -============================================== -Update Extensions (non-Composer Installations) -============================================== - -In the Backend, go to the extension manager and update the extensions you use. -TYPO3 CMS stores a reference list of available extensions locally, so make sure -that the list is up-to-date by clicking the "Update now" button in the "Get -extensions" view. - -You can also take this opportunity to delete all unused extensions, thereby -making sure that there are no potential security "holes" in files stored on -your server. diff --git a/Documentation/UpgradingExtensions/Index.rst b/Documentation/UpgradingExtensions/Index.rst new file mode 100644 index 00000000..adbc8ae8 --- /dev/null +++ b/Documentation/UpgradingExtensions/Index.rst @@ -0,0 +1,28 @@ +.. include:: /Includes.rst.txt +.. _upgradingextensions: + +==================== +Upgrading extensions +==================== + +List extensions +--------------- + +Like TYPO3's core, extensions are also composer packages. The `composer info` command will list all +extensions that are currently installed including their name and current version number. + +Check for updates +----------------- + +To check if any extension upgrades are available, `composer outdated` can be used to display a list +of packages that have updates along with their new version number. + +Upgrade an extension (minor) +---------------------------- + +Minor upgrades of an extension can be done with the composer command `composer update vendor/packagename`. + +Upgrade an extension (major) +---------------------------- + +Major upgrades of an extension can be done with the composer command `composer require vendor/packagename:`. diff --git a/Documentation/screenshots.json b/Documentation/screenshots.json new file mode 100644 index 00000000..2322f760 --- /dev/null +++ b/Documentation/screenshots.json @@ -0,0 +1,335 @@ +{ + "suites": { + "Core": { + "screenshots": { + "AdminTool": [ + { + "action": "setScreenshotsImagePath", + "path": "Images/AutomaticScreenshots/AdminTools" + }, + { + "action": "setScreenshotsRstPath", + "path": "Images/AutomaticScreenshots/AdminTools" + }, + { + "action": "resizeWindow", + "width": 1232, + "height": 768 + }, + {"action": "switchToMainFrame"}, + {"action": "waitForElement", "element": "button#web"}, + {"action": "click", "link": "button#web"}, + {"action": "waitForElement", "element": "button#site"}, + {"action": "click", "link": "button#site"}, + {"action": "waitForElement", "element": "button#file"}, + {"action": "click", "link": "button#file"}, + {"action": "waitForElement", "element": "button#system"}, + {"action": "click", "link": "button#system"}, + {"action": "see", "text": "Maintenance"}, + {"action": "click", "link": "Maintenance"}, + {"action": "switchToContentFrame"}, + {"action": "fillField", "field": "input#confirmationPassword", "value": "password"}, + {"action": "click", "link": "Confirm"}, + {"comment": "********************************************************"}, + {"comment": "Maintenance Section of Admin Tool"}, + {"comment": "********************************************************"}, + {"action": "waitForText", "text": "Maintenance", "timeout": 5}, + { + "action": "resizeWindow", + "width": 1024, + "height": 512 + }, + {"action": "drawArrow", "selector": "button[data-require='TYPO3/CMS/Install/Module/Maintenance/Cache']", "position": "right-middle"}, + { + "action": "makeScreenshotOfElement", + "fileName": "ClearAllCache", + "altText": "Flush Caches", + "captionText": "The option \"Flush\" in the Admin Tool." + }, + {"action": "clearDrawings"}, + { + "action": "click", + "link": "Scan temporary files" + }, + { + "action": "waitForModalDialogInMainFrame" + }, + { + "action": "makeScreenshotOfElement", + "fileName": "RemoveTemporaryAssets", + "altText": "Remove temporary assets", + "captionText": "The option \"Remove temporary assets\" in the Install Tool." + }, + { + "action": "click", + "link": "button.t3js-modal-close" + }, + {"action": "switchToContentFrame"}, + { + "action": "wait", + "timeout": "1" + }, + {"action": "drawArrow", "selector": "button[data-require='TYPO3/CMS/Install/Module/Maintenance/DatabaseAnalyzer']", "position": "right-middle"}, + { + "action": "makeScreenshotOfElement", + "fileName": "DatabaseAnalyzer", + "altText": "The Database Analyzer before analyzing the database" + }, + {"action": "clearDrawings"}, + { + "action": "click", + "link": "Analyze database" + }, + { + "action": "waitForModalDialogInMainFrame" + }, + { + "action": "makeScreenshotOfElement", + "fileName": "DatabaseAnalyzerDatabaseAnalyzed", + "altText": "Database analyzer", + "captionText": "The Database Analyzer with no updates to do" + }, + { + "action": "click", + "link": "button.t3js-modal-close" + }, + {"action": "switchToContentFrame"}, + + { + "action": "wait", + "timeout": "1" + }, + {"action": "scrollModuleBodyTo", "toSelector": "button[data-require='TYPO3/CMS/Install/Module/Maintenance/LanguagePacks']"}, + {"action": "drawArrow", "selector": "button[data-require='TYPO3/CMS/Install/Module/Maintenance/LanguagePacks']", "position": "right-middle"}, + { + "action": "makeScreenshotOfElement", + "fileName": "InstallLanguagePacks", + "altText": "Manage language packs", + "captionText": "The option \"Manage language packs\" in the Install Tool" + }, + {"action": "clearDrawings"}, + {"action": "scrollModuleBodyTo", "toSelector": "button[data-require='TYPO3/CMS/Install/Module/Maintenance/ResetBackendUserUc']"}, + {"action": "drawArrow", "selector": "button[data-require='TYPO3/CMS/Install/Module/Maintenance/ResetBackendUserUc']", "position": "right-middle"}, + { + "action": "makeScreenshotOfElement", + "fileName": "ResetUserPreferences", + "altText": "Reset User Preferences", + "captionText": "The option \"Reset Backend User Preferences\" in the Install Tool" + }, + {"action": "clearDrawings"}, + { + "action": "resizeWindow", + "width": 1232, + "height": 768 + }, + + {"comment": "********************************************************"}, + {"comment": "Upgrade Section of Admin Tool"}, + {"comment": "********************************************************"}, + { + "action": "setScreenshotsImagePath", + "path": "Images/AutomaticScreenshots/Upgrade" + }, + { + "action": "setScreenshotsRstPath", + "path": "Images/AutomaticScreenshots/Upgrade" + }, + {"action": "switchToMainFrame"}, + {"action": "see", "text": "Upgrade"}, + {"action": "click", "link": "Upgrade"}, + { + "action": "makeScreenshotOfFullPage", + "fileName": "AdminToolsUpgradeOverview", + "captionText": "The \"Upgrade\" section of the Admin Tool." + }, + + { + "action": "resizeWindow", + "width": 1024, + "height": 512 + }, + {"action": "switchToContentFrame"}, + { + "action": "see", + "text": "View Upgrade Documentation" + }, + { + "action": "click", + "link": "View Upgrade Documentation" + }, + { + "action": "waitForModalDialogInMainFrame" + }, + { + "action": "click", + "link": "a[aria-controls='#version-0']" + }, + { + "action": "wait", + "timeout": "1" + }, + { + "action": "makeScreenshotOfElement", + "fileName": "UpgradeAnalysis", + "altText": "Upgrade Analysis", + "captionText": "The \"Upgrade Analysis\" in the Install Tool" + }, + { + "action": "click", + "link": "button.t3js-modal-close" + }, + {"action": "switchToContentFrame"}, + { + "action": "wait", + "timeout": "1" + }, + { + "action": "see", + "text": "Run Upgrade Wizard" + }, + { + "action": "click", + "link": "Run Upgrade Wizard" + }, + { + "action": "waitForModalDialogInMainFrame" + }, + { + "action": "makeScreenshotOfElement", + "fileName": "UpgradeWizard", + "altText": "Upgrade wizard", + "captionText": "The \"Upgrade Wizard\" in the Install Tool." + }, + { + "action": "click", + "link": "button.t3js-modal-close" + }, + {"action": "switchToMainFrame"} + ] + } + }, + "Introduction": { + "screenshots": { + "importexportcontext": [ + { + "action": "setScreenshotsImagePath", + "path": "Images/AutomaticScreenshots/ImportExport" + }, + { + "action": "setScreenshotsRstPath", + "path": "Images/AutomaticScreenshots/ImportExport" + }, + { + "action": "amOnPage", + "page": "/typo3/" + }, + {"action": "resizeWindow", "width": 1024,"height": 768}, + {"action": "see", "text": "List"}, + {"action": "click", "link": "List"}, + {"action": "openPageTreePath", "path": ["Congratulations", "Frontend User"]}, + {"action": "clickWithRightButton", "cssOrXPath": "//*[@id='typo3-pagetree-treeContainer']//*[text()='Frontend User']/.."}, + {"action": "waitForElement", "element": "#contentMenu0", "timeout": 1}, + {"action": "drawBox", "selector": "//*[@id='contentMenu0']//*[contains(text(), 'More options...')]"}, + { + "action": "makeScreenshotOfWindow", + "fileName": "ContextMenuMore", + "altText": "Select \"More options...\" from the context menu of the page tree", + "captionText": "Select \"More options...\" from the context menu of the page tree" + }, + {"action": "clearDrawings"}, + {"action": "click", "link": "//*[@id='contentMenu0']//*[contains(text(), 'More options...')]"}, + {"action": "waitForElement", "element": "#contentMenu1", "timeout": 1}, + { + "action": "makeScreenshotOfWindow", + "fileName": "ContextMenuExport", + "altText": "Select Then select \"Export\"", + "captionText": "Select Then select \"Export\"" + }, + {"action": "click", "link": "//*[@id='contentMenu1']//*[contains(text(), 'Export')]"} + ], + "importexport": [ + { + "action": "setScreenshotsImagePath", + "path": "Images/AutomaticScreenshots/ImportExport" + }, + { + "action": "setScreenshotsRstPath", + "path": "Images/AutomaticScreenshots/ImportExport" + }, + {"action": "resizeWindow", "width": 1024,"height": 768}, + { + "action": "amOnPage", + "page": "/typo3/record/importexport/export?token=x&id=0&tx_impexp[pagetree][id]=7&tx_impexp[pagetree][levels]=0&tx_impexp[pagetree][tables][]=_ALL" + }, + { + "action": "makeScreenshotOfWindow", + "fileName": "ExportDialog", + "altText": "Select the tables to be exported", + "captionText": "Select the tables to be exported" + }, + {"action": "selectOption", "select": "select[name='tx_impexp[pagetree][levels]']", "option": "999"}, + {"action": "click", "link": "Update"}, + { + "action": "makeScreenshotOfWindow", + "fileName": "ExportDialogInfiniteLevels", + "altText": "Select the page levels to be exported", + "captionText": "Select the page levels to be exported" + }, + { + "action": "amOnPage", + "page": "/typo3/record/importexport/export?token=x&id=0&tx_impexp[pagetree][id]=1&tx_impexp[pagetree][levels]=0&tx_impexp[pagetree][tables][]=_ALL" + }, + {"action": "scrollModuleBodyToTop"}, + { + "action": "makeScreenshotOfElement", + "selector": ".t3js-impexp-preview", + "fileName": "CheckExport", + "altText": "Check the exported data", + "captionText": "Check the exported data" + }, + {"action": "scrollModuleBodyToTop"}, + { + "action": "see", + "text": "File & Preset" + }, + { + "action": "click", + "link": "File & Preset" + }, + {"action": "fillField", "field": "input#impexp-filename", "value": "MyExport"}, + {"action": "drawBox", "selector": "input[name='tx_impexp[download_export]']"}, + {"action": "resizeWindow", "width": 1024,"height": 1024}, + {"action": "scrollModuleBodyToTop"}, + { + "action": "makeScreenshotOfElement", + "fileName": "DownloadExport", + "selector": ".t3js-module-body", + "altText": "Download the export data", + "captionText": "Download the export data" + } + ], + "import": [ + { + "action": "amOnPage", + "page": "/typo3/record/importexport/import?token=x" + }, + { + "action": "see", + "text": "Upload" + }, + { + "action": "click", + "link": "Upload" + }, + { + "action": "makeScreenshotOfElement", + "fileName": "UploadImport", + "selector": ".module-body", + "altText": "Upload the export data", + "captionText": "Upload the export data" + } + ] + } + } + } +}