Project

General

Profile

Actions
Copy link

Task #69346

closed

Forms: Optimize documentation

Added by Björn Jacob over 8 years ago. Updated over 5 years ago.

Status:
Closed
Priority:
Should have
Assignee:
Björn Jacob
Category:
Form Framework
Target version:
-
Start date:
2015-09-24
Due date:
% Done:

100%

Estimated time:
(Total: 0.00 h)
TYPO3 Version:
8
PHP Version:
Tags:
Complexity:
Sprint Focus:

Description

The documentation of sysext forms needs some love:

  1. 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.
  2. DRY: try to remove all the "duplicate content". Instead use references and check for exceptions.
  3. "Complete" the documentation. There are some missing information, e.g. regarding some default values etc.
  4. Quite often "acceskey" is spelled incorrectly.
  5. Document default value for breakOnError.
  6. Document default value for inclusive which is part of the "between" validator.
  7. Better documentation for "strict" which is part of the "inarray" validator.
  8. Document CHECKBOXGROUP. -> not needed, since it's a container element
  9. Document RADIOGROUP. -> not needed, since it's a container element
  10. Document CONTENT. -> not needed since it's just a technical thingy
  11. Document HEADER.
  12. Document TEXTBLOCK.
  13. Update cheat sheets. -> nope, removing them and provide nice tables with refs
  14. Ticket #68646 needs documentation.
  15. Ticket #42404 needs documentation.

Subtasks 1 (0 open — 1 closed)

Task #70087: EXT:form - Update documentation - only newer features from version 7 upwardsClosedBjörn Jacob2015-09-24

Actions
Actions
Copy link
 #1

Updated by Björn Jacob over 8 years ago

  • Subject changed from sysextforms: Optimize documentation to sysext forms: Optimize documentation
Actions
Copy link
 #2

Updated by Björn Jacob over 8 years ago

  • Status changed from New to In Progress
Actions
Copy link
 #3

Updated by Björn Jacob over 8 years ago

  • Description updated (diff)
Actions
Copy link
 #4

Updated by Björn Jacob over 8 years ago

  • Subject changed from sysext forms: Optimize documentation to Forms: Optimize documentation
  • Description updated (diff)
Actions
Copy link
 #5

Updated by Björn Jacob over 8 years ago

  • Description updated (diff)
Actions
Copy link
 #6

Updated by Björn Jacob over 8 years ago

  • Description updated (diff)
  • % Done changed from 0 to 30
Actions
Copy link
 #7

Updated by Björn Jacob over 8 years ago

  • Description updated (diff)
Actions
Copy link
 #8

Updated by Björn Jacob over 8 years ago

  • Description updated (diff)
Actions
Copy link
 #9

Updated by Björn Jacob over 8 years ago

  • Description updated (diff)
Actions
Copy link
 #10

Updated by Björn Jacob over 8 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
Actions
Copy link
 #11

Updated by Björn Jacob over 8 years ago

  • Assignee changed from Ralf Zimmermann to Björn Jacob
Actions
Copy link
 #12

Updated by Björn Jacob over 8 years ago

  • Description updated (diff)
  • % Done changed from 30 to 40
Actions
Copy link
 #13

Updated by Björn Jacob over 8 years ago

  • Description updated (diff)
Actions
Copy link
 #14

Updated by Björn Jacob over 8 years ago

  • Description updated (diff)
  • % Done changed from 40 to 60
Actions
Copy link
 #15

Updated by Björn Jacob over 8 years ago

  • Target version set to 7 LTS
Actions
Copy link
 #16

Updated by Björn Jacob over 8 years ago

  • Description updated (diff)
  • % Done changed from 60 to 80
Actions
Copy link
 #17

Updated by Björn Jacob over 8 years ago

  • Description updated (diff)
Actions
Copy link
 #18

Updated by Björn Jacob over 8 years ago

  • Description updated (diff)
Actions
Copy link
 #19

Updated by Björn Jacob over 8 years ago

  • % Done changed from 80 to 100
Actions
Copy link
 #20

Updated by Mathias Schreiber over 8 years ago

  • Status changed from In Progress to Needs Feedback

done?

Actions
Copy link
 #21

Updated by Björn Jacob over 8 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.
Actions
Copy link
 #22

Updated by Björn Jacob over 8 years ago

  • Status changed from Needs Feedback to In Progress
Actions
Copy link
 #23

Updated by Gerrit Code Review over 8 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

Actions
Copy link
 #24

Updated by Gerrit Code Review over 8 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

Actions
Copy link
 #25

Updated by Gerrit Code Review over 8 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

Actions
Copy link
 #26

Updated by Gerrit Code Review over 8 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

Actions
Copy link
 #27

Updated by Gerrit Code Review about 8 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

Actions
Copy link
 #28

Updated by Gerrit Code Review about 8 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

Actions
Copy link
 #29

Updated by Björn Jacob about 8 years ago

  • Target version deleted (6.2.16)
  • TYPO3 Version changed from 7 to 8
Actions
Copy link
 #30

Updated by Gerrit Code Review about 8 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

Actions
Copy link
 #31

Updated by Gerrit Code Review about 8 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

Actions
Copy link
 #32

Updated by Gerrit Code Review about 8 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

Actions
Copy link
 #33

Updated by Gerrit Code Review about 8 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

Actions
Copy link
 #34

Updated by Björn Jacob about 8 years ago

  • Status changed from Under Review to Resolved
  • % Done changed from 0 to 100
Actions
Copy link
 #35

Updated by Gerrit Code Review about 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

Actions
Copy link
 #36

Updated by Björn Jacob about 8 years ago

  • Status changed from Under Review to Resolved
Actions
Copy link
 #37

Updated by Gerrit Code Review about 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

Actions
Copy link
 #38

Updated by Gerrit Code Review about 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

Actions
Copy link
 #39

Updated by Björn Jacob about 8 years ago

  • Status changed from Under Review to Resolved
Actions
Copy link
 #40

Updated by Gerrit Code Review about 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

Actions
Copy link
 #41

Updated by Björn Jacob about 8 years ago

  • Status changed from Under Review to Resolved
Actions
Copy link
 #42

Updated by Benni Mack over 5 years ago

  • Status changed from Resolved to Closed
Actions
Copy link

Also available in: Atom PDF