Commit 5d65bec7 authored by Sybille Peters's avatar Sybille Peters 🙋 Committed by Christian Kuhn
Browse files

[TASK] Improve sysext metadata

The title and description texts as well as the README.rst for
system extensions are unified and some texts updated to
reflect changes.

Since the description and README.rst are also displayed on
Packagist, the text should be chosen so that it helps
people not familiar with TYPO3 know what the package is
about (e.g. by preceding the description with "TYPO3 CMS").

Descriptive texts for extensions are in these files:

- composer.json
- ext_emconf.php
- README.rst

The information is displayed in the Extension Manager (ext_emconf.php),
on extensions.typo3.org, on Packagist (composer.json and README.rst)
and on GitHub (README.rst).

We reuse the same text blocks in the following manner:

1. Extension title - used in ext_emconf.php:title and composer.json:
   description
2. Extension description (short) - used in ext_emconf.php:description
   and composer.json:description
3. Title and extension description (long) - used in README.rst. In
   most cases, the short description is reused, in some cases it is
   augmented with more information.

In composer.json, the description consists of: '<title> - <description>'

Also,

- In the title all words are capitalized (common name)
- The title always starts with "TYPO3 CMS"
- The description ends with a period.

Resolves: #96059
Releases: master
Change-Id: I57388ff96c5fcf9a8e64cd86ed8427f70d7ef23d
Reviewed-on: https://review.typo3.org/c/Packages/TYPO3.CMS/+/72288

Tested-by: core-ci's avatarcore-ci <typo3@b13.com>
Tested-by: Stefan Bürk's avatarStefan Bürk <stefan@buerk.tech>
Tested-by: Christian Kuhn's avatarChristian Kuhn <lolli@schwarzbu.ch>
Reviewed-by: Stefan Bürk's avatarStefan Bürk <stefan@buerk.tech>
Reviewed-by: Christian Kuhn's avatarChristian Kuhn <lolli@schwarzbu.ch>
parent 9d5ff89a
......@@ -2,12 +2,12 @@
`Contributing <https://docs.typo3.org/m/typo3/guide-contributionworkflow/master/en-us/Index.html>`__ \|
`Help & Support <https://typo3.org/help>`__ \|
========================================
TYPO3 Admin Panel (typo3/cms-adminpanel)
========================================
============================================
TYPO3 CMS Admin Panel (typo3/cms-adminpanel)
============================================
The TYPO3 admin panel provides a panel with additional functionality in
the frontend (Debugging, Caching, Preview...)
Panel with additional functionality in the frontend (Debugging, Caching,
Preview...).
:Repository: https://github.com/typo3/typo3
:Issues: https://forge.typo3.org/
......
{
"name": "typo3/cms-adminpanel",
"type": "typo3-cms-framework",
"description": "The TYPO3 admin panel provides a panel with additional functionality in the frontend (Debugging, Caching, Preview...)",
"description": "TYPO3 CMS Admin Panel - Panel with additional functionality in the frontend (Debugging, Caching, Preview...).",
"homepage": "https://typo3.org",
"license": ["GPL-2.0-or-later"],
"authors": [{
......
<?php
$EM_CONF[$_EXTKEY] = [
'title' => 'TYPO3 Admin Panel',
'description' => 'The TYPO3 admin panel provides a panel with additional functionality in the frontend (Debugging, Caching, Preview...)',
'title' => 'TYPO3 CMS Admin Panel',
'description' => 'Panel with additional functionality in the frontend (Debugging, Caching, Preview...).',
'category' => 'fe',
'state' => 'stable',
'clearCacheOnLoad' => 1,
......
\|
`Contributing <https://docs.typo3.org/m/typo3/guide-contributionworkflow/master/en-us/Index.html>`__ \|
`Help & Support <https://typo3.org/help>`__ \|
=====================================
TYPO3 CMS Backend (typo3/cms-backend)
=====================================
:Repository: https://github.com/typo3/typo3
:Issues: https://forge.typo3.org/
:Documentation: https://docs.typo3.org
{
"name": "typo3/cms-backend",
"type": "typo3-cms-framework",
"description": "Classes for the TYPO3 backend.",
"description": "TYPO3 CMS backend",
"homepage": "https://typo3.org",
"license": ["GPL-2.0-or-later"],
"authors": [{
......
<?php
$EM_CONF[$_EXTKEY] = [
'title' => 'TYPO3 Backend',
'description' => 'Classes for the TYPO3 backend.',
'title' => 'TYPO3 CMS Backend',
'description' => '',
'category' => 'be',
'state' => 'stable',
'clearCacheOnLoad' => 0,
......
\|
`Contributing <https://docs.typo3.org/m/typo3/guide-contributionworkflow/master/en-us/Index.html>`__ \|
`Help & Support <https://typo3.org/help>`__ \|
===============================
TYPO3 CMS Log (typo3/cms-belog)
===============================
View log (sys_log table) in the TYPO3 backend module System>Log and
Web>Info/Log.
The TYPO3 backend module System > Log provides a system wide overview and
Web>Info/Log shows logs related to specific pages.
:Repository: https://github.com/typo3/typo3
:Issues: https://forge.typo3.org/
:Documentation: https://docs.typo3.org
{
"name": "typo3/cms-belog",
"type": "typo3-cms-framework",
"description": "Displays backend log, both per page and system wide. Available as the module Tools>Log (system wide overview) and Web>Info/Log (page relative overview).",
"description": "TYPO3 CMS Log - View log (sys_log table) in the TYPO3 backend module System>Log and Web>Info/Log.",
"homepage": "https://typo3.org",
"license": ["GPL-2.0-or-later"],
"authors": [{
......
<?php
$EM_CONF[$_EXTKEY] = [
'title' => 'Tools>Log',
'description' => 'Displays backend log, both per page and system wide. Available as the module Tools>Log (system wide overview) and Web>Info/Log (page relative overview).',
'title' => 'TYPO3 CMS Log',
'description' => 'View log (sys_log table) in the TYPO3 backend module System>Log and Web>Info/Log.',
'category' => 'module',
'state' => 'stable',
'clearCacheOnLoad' => 0,
......
\|
`Contributing <https://docs.typo3.org/m/typo3/guide-contributionworkflow/master/en-us/Index.html>`__ \|
`Help & Support <https://typo3.org/help>`__ \|
=========================================
TYPO3 CMS Backend User (typo3/cms-beuser)
=========================================
TYPO3 backend module (System/Backend Users) for managing backend users and
groups.
Allows you to add / delete / modify backend users and groups, configure and
compare the settings of backend users and verify their permissions. Also, it is
possible to see who is online.
:Repository: https://github.com/typo3/typo3
:Issues: https://forge.typo3.org/
:Documentation: https://docs.typo3.org
{
"name": "typo3/cms-beuser",
"type": "typo3-cms-framework",
"description": "Backend user administration and overview. Allows you to compare the settings of users and verify their permissions and see who is online.",
"description": "TYPO3 CMS Backend User - TYPO3 backend module (System/Backend Users) for managing backend users and groups.",
"homepage": "https://typo3.org",
"license": ["GPL-2.0-or-later"],
"authors": [{
......
<?php
$EM_CONF[$_EXTKEY] = [
'title' => 'Backend User Administration',
'description' => 'Backend user administration and overview. Allows you to compare the settings of users and verify their permissions and see who is online.',
'title' => 'TYPO3 CMS Backend User',
'description' => 'TYPO3 backend module (System/Backend Users) for managing backend users and groups.',
'category' => 'module',
'author' => 'TYPO3 Core Team',
'author_email' => 'typo3cms@typo3.org',
......
\|
`Contributing <https://docs.typo3.org/m/typo3/guide-contributionworkflow/master/en-us/Index.html>`__ \|
`Help & Support <https://typo3.org/help>`__ \|
===============================
TYPO3 CMS Core (typo3/cms-core)
===============================
:Repository: https://github.com/typo3/typo3
:Issues: https://forge.typo3.org/
:Documentation: https://docs.typo3.org
{
"name": "typo3/cms-core",
"type": "typo3-cms-framework",
"description": "The core library of TYPO3.",
"description": "TYPO3 CMS Core",
"homepage": "https://typo3.org",
"license": ["GPL-2.0-or-later"],
"authors": [{
......
<?php
$EM_CONF[$_EXTKEY] = [
'title' => 'TYPO3 Core',
'description' => 'The core library of TYPO3.',
'title' => 'TYPO3 CMS Core',
'description' => '',
'category' => 'be',
'state' => 'stable',
'clearCacheOnLoad' => 0,
......
......@@ -2,9 +2,11 @@
`Contributing <https://docs.typo3.org/m/typo3/guide-contributionworkflow/master/en-us/Index.html>`__ \|
`Help & Support <https://typo3.org/help>`__ \|
===============================
Dashboard (typo3/cms-dashboard)
===============================
=========================================
TYPO3 CMS Dashboard (typo3/cms-dashboard)
=========================================
TYPO3 backend module for configurable dashboards with widgets.
:Repository: https://github.com/typo3/typo3
:Issues: https://forge.typo3.org/
......
{
"name": "typo3/cms-dashboard",
"type": "typo3-cms-framework",
"description": "Dashboard for TYPO3.",
"description": "TYPO3 CMS Dashboard - TYPO3 backend module for configurable dashboards with widgets.",
"homepage": "https://typo3.org",
"license": ["GPL-2.0-or-later"],
"authors": [{
......
<?php
$EM_CONF[$_EXTKEY] = [
'title' => 'Dashboard',
'description' => 'Add dashboard to TYPO3',
'title' => 'TYPO3 CMS Dashboard',
'description' => 'TYPO3 backend module for configurable dashboards with widgets.',
'category' => 'be',
'author' => 'TYPO3 Core Team',
'author_email' => 'typo3cms@typo3.org',
......
\|
`Contributing <https://docs.typo3.org/m/typo3/guide-contributionworkflow/master/en-us/Index.html>`__ \|
`Help & Support <https://typo3.org/help>`__ \|
=====================================
TYPO3 CMS Extbase (typo3/cms-extbase)
=====================================
Extension framework to create TYPO3 frontend plugins and TYPO3 backend modules.
:Repository: https://github.com/typo3/typo3
:Issues: https://forge.typo3.org/
:Documentation: https://docs.typo3.org
{
"name": "typo3/cms-extbase",
"type": "typo3-cms-framework",
"description": "A framework to build extensions for TYPO3 CMS.",
"description": "TYPO3 CMS Extbase - Extension framework to create TYPO3 frontend plugins and TYPO3 backend modules.",
"homepage": "https://typo3.org",
"license": ["GPL-2.0-or-later"],
"authors": [{
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment