Task #69346
closed
Forms: Optimize documentation
100%
Description
The documentation of sysext forms needs some love:
Split the huge pages in several documents. Right now on one page we've got tons of information. You have to scroll forever. All navigation elements are far away.DRY: try to remove all the "duplicate content". Instead use references and check for exceptions."Complete" the documentation. There are some missing information, e.g. regarding some default values etc.Quite often "acceskey" is spelled incorrectly.Document default value for breakOnError.Document default value for inclusive which is part of the "between" validator.Better documentation for "strict" which is part of the "inarray" validator.Document CHECKBOXGROUP.-> not needed, since it's a container elementDocument RADIOGROUP.-> not needed, since it's a container elementDocument CONTENT.-> not needed since it's just a technical thingyDocument HEADER.Document TEXTBLOCK.Update cheat sheets.-> nope, removing them and provide nice tables with refsTicket #68646 needs documentation.Ticket #42404 needs documentation.
Updated by Björn Jacob about 9 years ago
- Subject changed from sysextforms: Optimize documentation to sysext forms: Optimize documentation
Updated by Björn Jacob about 9 years ago
- Subject changed from sysext forms: Optimize documentation to Forms: Optimize documentation
- Description updated (diff)
Updated by Björn Jacob about 9 years ago
- Description updated (diff)
- % Done changed from 0 to 30
Updated by Björn Jacob about 9 years ago
- Description updated (diff)
- Assignee set to Ralf Zimmermann
@Ralf: Could you please provide some more insights about the following objects? I'm thinking of available attributes and maybe an example for CONTENT.
- CHECKBOXGROUP
- CONTENT
- HEADER
- RADIOGROUP
- TEXTBLOCK
Updated by Björn Jacob about 9 years ago
- Assignee changed from Ralf Zimmermann to Björn Jacob
Updated by Björn Jacob about 9 years ago
- Description updated (diff)
- % Done changed from 30 to 40
Updated by Björn Jacob about 9 years ago
- Description updated (diff)
- % Done changed from 40 to 60
Updated by Björn Jacob about 9 years ago
- Description updated (diff)
- % Done changed from 60 to 80
Updated by Mathias Schreiber almost 9 years ago
- Status changed from In Progress to Needs Feedback
done?
Updated by Björn Jacob almost 9 years ago
- Target version changed from 7 LTS to 6.2.16
Nope. I want to push my changes to this issue. My plan is as follows:
- Use this ticket for pushing a quite big structural change on the documentation for 6.2. A lot of stuff had to be corrected also for 6.2.
- As soon as this one is merged I'm creating a new issue for bringing this patch to 7 LTS (needs some adoption).
- Afterwards I'll push a patch for #70087 which documents all the new functions for 7 LTS.
Updated by Björn Jacob almost 9 years ago
- Status changed from Needs Feedback to In Progress
Updated by Gerrit Code Review almost 9 years ago
- Status changed from In Progress to Under Review
Patch set 1 for branch TYPO3_6-2 of project Packages/TYPO3.CMS has been pushed to the review server.
It is available at https://review.typo3.org/44945
Updated by Gerrit Code Review almost 9 years ago
Patch set 2 for branch TYPO3_6-2 of project Packages/TYPO3.CMS has been pushed to the review server.
It is available at https://review.typo3.org/44945
Updated by Gerrit Code Review almost 9 years ago
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/45034
Updated by Gerrit Code Review almost 9 years ago
Patch set 3 for branch TYPO3_6-2 of project Packages/TYPO3.CMS has been pushed to the review server.
It is available at https://review.typo3.org/44945
Updated by Gerrit Code Review almost 9 years ago
Patch set 4 for branch TYPO3_6-2 of project Packages/TYPO3.CMS has been pushed to the review server.
It is available at https://review.typo3.org/44945
Updated by Gerrit Code Review almost 9 years ago
Patch set 5 for branch TYPO3_6-2 of project Packages/TYPO3.CMS has been pushed to the review server.
It is available at https://review.typo3.org/44945
Updated by Björn Jacob almost 9 years ago
- Target version deleted (
6.2.16) - TYPO3 Version changed from 7 to 8
Updated by Gerrit Code Review almost 9 years ago
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/46176
Updated by Gerrit Code Review almost 9 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/46176
Updated by Gerrit Code Review almost 9 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/46176
Updated by Gerrit Code Review almost 9 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/46176
Updated by Björn Jacob over 8 years ago
- Status changed from Under Review to Resolved
- % Done changed from 0 to 100
Applied in changeset 0f8cf7a6bdfcc934cbe99b26e75e457757e4d2fc.
Updated by Gerrit Code Review over 8 years ago
- Status changed from Resolved to Under Review
Patch set 1 for branch TYPO3_7-6 of project Packages/TYPO3.CMS has been pushed to the review server.
It is available at https://review.typo3.org/47036
Updated by Björn Jacob over 8 years ago
- Status changed from Under Review to Resolved
Applied in changeset 6e855aa751ed5299143dac4cde4031c52a99e97f.
Updated by Gerrit Code Review over 8 years ago
- Status changed from Resolved to Under Review
Patch set 1 for branch TYPO3_7-6 of project Packages/TYPO3.CMS has been pushed to the review server.
It is available at https://review.typo3.org/47053
Updated by Gerrit Code Review over 8 years ago
Patch set 2 for branch TYPO3_7-6 of project Packages/TYPO3.CMS has been pushed to the review server.
It is available at https://review.typo3.org/47053
Updated by Björn Jacob over 8 years ago
- Status changed from Under Review to Resolved
Applied in changeset 2289b54c414a7fc6e28779582c48a33d98b40838.
Updated by Gerrit Code Review over 8 years ago
- Status changed from Resolved to Under Review
Patch set 1 for branch TYPO3_6-2 of project Packages/TYPO3.CMS has been pushed to the review server.
It is available at https://review.typo3.org/47060
Updated by Björn Jacob over 8 years ago
- Status changed from Under Review to Resolved
Applied in changeset 5ecde7cc80d6471a7111cdb00d9d3d9f5f64fe6f.
Updated by