Task #36651

Update "CGL on one page" PDF and link it

Added by Bastian Waidelich over 9 years ago. Updated about 9 years ago.

Status:
Resolved
Priority:
Should have
Category:
- Documentation -
Start date:
2012-04-27
Due date:
% Done:

100%

Estimated time:
Sprint:
PHP Version:
Has patch:
No
Complexity:

Description

We once had a nice PDF containing the most important CGL on one page (see attachment). This has been removed with the relaunch of flow3.typo3.org apparently.
We should update the PDF and link it in the CGL section of the documentation on flow3.typo3.org

Some of the required changes:

  • remove encoding declaration
  • adjust license header
  • remove obsolete class annotations (@pacakge, @version, @license)
  • Replace \F3 with \TYPO3\FLOW3
  • Add trailing backslash to "ArrayObject" in var annotation
  • Add empty space between description and var annotations
  • Remove @author annotations

Files

FLOW3_CGL_on_one_page-v9-1.pdf (42.2 KB) FLOW3_CGL_on_one_page-v9-1.pdf Bastian Waidelich, 2012-04-27 11:31
FLOW3_Coding_Guidelines_on_one_page.pdf (38 KB) FLOW3_Coding_Guidelines_on_one_page.pdf Karsten Dambekalns, 2012-05-21 18:15
#1

Updated by Bastian Waidelich over 9 years ago

BTW: Karsten, I assign this to you as you have the ODT file (according to Robert). Happy Birthday ;)

#2

Updated by Karsten Dambekalns over 9 years ago

  • Status changed from New to Accepted
  • Target version set to 1.1

The source file is in the (which is it now?) git repository :) I'll take care!

#3

Updated by Aske Ertmann over 9 years ago

  • The links at the bottom doesn't work anymore
#4

Updated by Karsten Dambekalns about 9 years ago

  • remove encoding declaration (was already gone)
  • adjust license header
  • remove obsolete class annotations (@package, @version, @license) (only license was left)
  • Replace \F3 with \TYPO3\FLOW3 (no F3 anywhere to be found)
  • Add trailing backslash to "ArrayObject" in var annotation
  • Add empty space between description and var annotations
  • Remove @author annotations

See a PDF of the result attached. If that is fine, I'll submit a change.

#5

Updated by Karsten Dambekalns about 9 years ago

  • Target version changed from 1.1 to 1.1 RC1
#6

Updated by Karsten Dambekalns about 9 years ago

  • Project changed from 1883 to TYPO3.Flow
#7

Updated by Karsten Dambekalns about 9 years ago

  • Category set to - Documentation -
  • Has patch set to No
#8

Updated by Gerrit Code Review about 9 years ago

  • Status changed from Accepted to Under Review

Patch set 1 for branch master has been pushed to the review server.
It is available at http://review.typo3.org/12252

#9

Updated by Gerrit Code Review about 9 years ago

Patch set 2 for branch master has been pushed to the review server.
It is available at http://review.typo3.org/12252

#10

Updated by Gerrit Code Review about 9 years ago

Patch set 1 for branch FLOW3-1.1 has been pushed to the review server.
It is available at http://review.typo3.org/12342

#11

Updated by Karsten Dambekalns about 9 years ago

  • Status changed from Under Review to Resolved
  • % Done changed from 50 to 100
#12

Updated by Karsten Dambekalns about 9 years ago

  • Status changed from Resolved to Accepted
  • % Done changed from 100 to 90

Still needs to be put online.

#13

Updated by Gerrit Code Review about 9 years ago

  • Status changed from Accepted to Under Review

Patch set 1 for branch master has been pushed to the review server.
It is available at http://review.typo3.org/12353

#14

Updated by Gerrit Code Review about 9 years ago

Patch set 2 for branch master has been pushed to the review server.
It is available at http://review.typo3.org/12353

#15

Updated by Gerrit Code Review about 9 years ago

Patch set 1 for branch FLOW3-1.1 has been pushed to the review server.
It is available at http://review.typo3.org/12355

#16

Updated by Karsten Dambekalns about 9 years ago

  • Status changed from Under Review to Resolved
  • % Done changed from 90 to 100

Also available in: Atom PDF