diff --git a/Documentation/ExtensionArchitecture/FileStructure/ComposerJson.rst b/Documentation/ExtensionArchitecture/FileStructure/ComposerJson.rst index c02098b1ec..004955acb7 100644 --- a/Documentation/ExtensionArchitecture/FileStructure/ComposerJson.rst +++ b/Documentation/ExtensionArchitecture/FileStructure/ComposerJson.rst @@ -75,6 +75,7 @@ This is a minimal :file:`composer.json ` for a TYPO3 ex * The vendor name is `MyVendor`. * The :ref:`extension key ` is `my_extension`. +* The extension title is `My Extension` and the description is `An example extension`. Subsequently: @@ -127,6 +128,8 @@ Extended composer.json Properties ========== +.. _ext-composer-json-property-name: + name ---- @@ -141,12 +144,22 @@ uppercase / lowercase spelling, for example: The PHP namespace :php:`JohnDoe\SomeExtension` may be `johndoe/some-extension` in :file:`composer.json `. +.. _ext-composer-json-property-description: + description ----------- +.. versionchanged:: 14.0 + Extension titles were previously taken from file :file:`ext_emconf.php` but + in Composer mode the :file:`ext_emconf.php` file is no longer necessary. The + description field in :file:`composer.json` is exploded to get the extension + title (in front of "-") and the extension description (after "-"). + (*required*) -Description of your extension (1 line). +This field contains the extension title and the description of your extension +(1 line). The title is separated from the description by a dash "-". If there is no +dash, the title will be the entire description. .. _ext-composer-json-property-type: diff --git a/Documentation/ExtensionArchitecture/FileStructure/_ComposerJson/_ExtendedComposer.json b/Documentation/ExtensionArchitecture/FileStructure/_ComposerJson/_ExtendedComposer.json index 9d57e8bd7a..d816717d14 100644 --- a/Documentation/ExtensionArchitecture/FileStructure/_ComposerJson/_ExtendedComposer.json +++ b/Documentation/ExtensionArchitecture/FileStructure/_ComposerJson/_ExtendedComposer.json @@ -1,7 +1,7 @@ { "name": "my-vendor/my-extension", "type": "typo3-cms-extension", - "description": "An example extension", + "description": "My Extension - An example extension", "license": "GPL-2.0-or-later", "require": { "php": "^8.1", diff --git a/Documentation/ExtensionArchitecture/FileStructure/_ComposerJson/_MinimalComposer.json b/Documentation/ExtensionArchitecture/FileStructure/_ComposerJson/_MinimalComposer.json index 4ba22fa504..dff5a4bb95 100644 --- a/Documentation/ExtensionArchitecture/FileStructure/_ComposerJson/_MinimalComposer.json +++ b/Documentation/ExtensionArchitecture/FileStructure/_ComposerJson/_MinimalComposer.json @@ -1,7 +1,7 @@ { "name": "my-vendor/my-extension", "type": "typo3-cms-extension", - "description": "An example extension", + "description": "My Extension - An example extension", "license": "GPL-2.0-or-later", "require": { "typo3/cms-core": "^12.4 || ^13.4"