Project

General

Profile

Actions

Task #96059

closed

Fine-tune description of system extensions in composer.json

Added by Sybille Peters almost 3 years ago. Updated about 2 years ago.

Status:
Closed
Priority:
Should have
Category:
Documentation
Target version:
-
Start date:
2021-11-23
Due date:
% Done:

100%

Estimated time:
TYPO3 Version:
12
PHP Version:
Tags:
microcopy, documenation, text
Complexity:
Sprint Focus:

Description

1. Improve descriptions in composer.json ("description:")
2. Use same texts in ext_emconf.php
3. Use same texts in README.rst
3. Later, use text for system extensions page, see https://github.com/TYPO3-Documentation/DocsTypo3Org-Homepage/pull/182

(possibly we can also use a short form in composer.json and ext_emconf.php and a longer variant in README.rst)

Already talked about this on Slack.

In any case, I think it should be consistent. I looked at the other packages. You can have
  1. a description, what the package does, e.g. "Simple template engine" or "Provides a way to profile code". Or a longer description, e.g. "Provides an object-oriented API to strings and deals with bytes, UTF-8 code points and grapheme clusters in a unified way"
  2. the (short) name of the package and a description what it does, e.g. "PHPStan - PHP Static Analysis Tool"
Actions #1

Updated by Sybille Peters almost 3 years ago

Current list:

adminpanel : "The TYPO3 admin panel provides a panel with additional functionality in the frontend (Debugging, Caching, Preview...)"

backend : "Classes for the TYPO3 backend."

not just classes ...

belog : "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)."

beuser : "Backend user administration and overview. Allows you to compare the settings of users and verify their permissions and see who is online."

core : "The core library of TYPO3."

Not just a library ...

dashboard : "Dashboard for TYPO3."

extbase : "A framework to build extensions for TYPO3 CMS."

extensionmanager : "TYPO3 Extension Manager"

felogin : "A template-based plugin to log in Website Users in the Frontend"

filelist : "Listing of files in the directory"

filemetadata : "Add advanced metadata to File."

fluid : "Fluid is a next-generation templating engine which makes the life of extension authors a lot easier!"

Should "which makes the life of extension authors a lot easier!" be in there?

Also, it was already pointed out, that there is a Fluid package and the TYPO3 sysext is also name Fluid (and the latter uses the former). Perhaps call it "Fluid Integration", similar to rte_ckeditor.

fluid_styled_content : "A set of common content elements based on Fluid for Frontend output."

Untrue, does not supply the content elements, they are already supplied by other extensions.

form ** : "Form Library, Plugin and Editor"

frontend : "Classes for the frontend of TYPO3."

Not just classes ...

impexp : "Import and Export of records from TYPO3 in a custom serialized format (.T3D) for data exchange with other TYPO3 systems."

indexed_search : "Indexed Search Engine for TYPO3 pages, PDF-files, Word-files, HTML and text files. Provides a backend module for statistics of the indexer and a frontend plugin."

info : "Shows various infos"

very vague - can we improve?

install : "The Install Tool mounted as the module Tools>Install in TYPO3."

"mounted"?

Also, incorrect. Is not called Tools>Install.

linkvalidator : "The LinkValidator checks the links in your website for validity. It can validate all kinds of links: internal, external and file links. The Scheduler is supported to run LinkValidator via cron job, including the option to send status mails, if broken links were detected."

lowlevel : "Enables the 'Config' and 'DB Check' modules for technical analysis of the system. This includes raw database search, checking relations, counting pages and records etc."

opendocs : "Shows opened documents by the user."

recordlist : "List of database-records"

very vague. Also, this contains more, e.g. various "LinkHandlers". And an AbstractLinkBrowserController.

recycler : "The recycler offers the possibility to restore deleted records or remove them from the database permanently. These actions can be applied to a single record, multiple records, and recursively to child records (ex. restoring a page can restore all content elements on that page). Filtering by page and by table provides a quick overview of deleted records before taking action on them."

redirects : "Custom redirects in TYPO3."

reports : "The reports module groups several system reports."

rte_ckeditor : "Integration of CKEditor as Rich Text Editor."

scheduler : "The TYPO3 Scheduler lets you register tasks to happen at a specific time"

seo : "SEO features for TYPO3."

setup : "Allows users to edit a limited set of options for their user profile, eg. preferred language and their name and email address."

sys_note : "Records with messages which can be placed on any page and contain instructions or other information related to a page or section."

t3editor : "JavaScript-driven editor with syntax highlighting and code completion. Based on CodeMirror."

tstemplate : "Framework for management of TypoScript template records for the CMS frontend."

viewpage : "Shows the frontend webpage inside the backend frameset."

workspaces : "Adds workspaces functionality with custom stages to TYPO3."

Actions #2

Updated by Sybille Peters almost 3 years ago

  • Description updated (diff)
Actions #3

Updated by Sybille Peters almost 3 years ago

  • Description updated (diff)
Actions #4

Updated by Sybille Peters almost 3 years ago

  • Description updated (diff)
Actions #5

Updated by Sybille Peters almost 3 years ago

  • Description updated (diff)
Actions #6

Updated by Gerrit Code Review almost 3 years ago

  • Status changed from New to Under Review

Patch set 1 for branch master of project Packages/TYPO3.CMS has been pushed to the review server.
It is available at https://review.typo3.org/c/Packages/TYPO3.CMS/+/72288

Actions #7

Updated by Gerrit Code Review almost 3 years ago

Patch set 2 for branch master of project Packages/TYPO3.CMS has been pushed to the review server.
It is available at https://review.typo3.org/c/Packages/TYPO3.CMS/+/72288

Actions #8

Updated by Gerrit Code Review almost 3 years ago

Patch set 3 for branch master of project Packages/TYPO3.CMS has been pushed to the review server.
It is available at https://review.typo3.org/c/Packages/TYPO3.CMS/+/72288

Actions #9

Updated by Gerrit Code Review almost 3 years ago

Patch set 4 for branch master of project Packages/TYPO3.CMS has been pushed to the review server.
It is available at https://review.typo3.org/c/Packages/TYPO3.CMS/+/72288

Actions #10

Updated by Gerrit Code Review almost 3 years ago

Patch set 5 for branch master of project Packages/TYPO3.CMS has been pushed to the review server.
It is available at https://review.typo3.org/c/Packages/TYPO3.CMS/+/72288

Actions #11

Updated by Gerrit Code Review almost 3 years ago

Patch set 6 for branch master of project Packages/TYPO3.CMS has been pushed to the review server.
It is available at https://review.typo3.org/c/Packages/TYPO3.CMS/+/72288

Actions #12

Updated by Gerrit Code Review almost 3 years ago

Patch set 7 for branch master of project Packages/TYPO3.CMS has been pushed to the review server.
It is available at https://review.typo3.org/c/Packages/TYPO3.CMS/+/72288

Actions #13

Updated by Gerrit Code Review almost 3 years ago

Patch set 8 for branch master of project Packages/TYPO3.CMS has been pushed to the review server.
It is available at https://review.typo3.org/c/Packages/TYPO3.CMS/+/72288

Actions #14

Updated by Gerrit Code Review almost 3 years ago

Patch set 9 for branch master of project Packages/TYPO3.CMS has been pushed to the review server.
It is available at https://review.typo3.org/c/Packages/TYPO3.CMS/+/72288

Actions #15

Updated by Gerrit Code Review almost 3 years ago

Patch set 10 for branch master of project Packages/TYPO3.CMS has been pushed to the review server.
It is available at https://review.typo3.org/c/Packages/TYPO3.CMS/+/72288

Actions #16

Updated by Sybille Peters almost 3 years ago

  • Status changed from Under Review to Resolved
  • % Done changed from 0 to 100
Actions #17

Updated by Benni Mack about 2 years ago

  • Status changed from Resolved to Closed
Actions

Also available in: Atom PDF