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

Also available in: Atom PDF