[FLOW3-core] "Getting Startet" - Documentation - Some incorrect/missing parts which makes it hard to follow

Alexander Kappler kappler at kss-online.com
Fri Mar 23 23:45:59 CET 2012


Hi @all,
I'm just starting with the FLOW3 framework and was curious about learning how it works. The best part for me is, that I can use it for TYPO3 extensions as well as for project without TYPO3.
Therefore I started with the Quickstart and afterwards with the "Part II: Getting Started" of your documentation. 
I had some really hard times, especially with setting up a local testserver on my computer (Win7 x64). Well I know that this is not the best developing machine (Linux would be better, I know), but still a lot of people developing on a Windows PC... 

Therefore my first point is: 
Please please add a "Tip" or something for Windows-User that they need at least WinVista (because of the support of symlinks) AND that they have to change the local user rights for creating symlincs from "administrator only" to "everyone" (this might rise security issues, I don't know, but it was the only way for me to get FLOW3 working. :-/ )

2.) I messed it sometimes up, because I entered the code in the wrong file. Therefor it would be great if you could attach a caption to each code-snipped  with the complete path and filename

3.) In section "viewer" of the  "Part II: Getting Started":
- The document refers to the blog-object: ... in this edit form you added object="{blog}" to the <f:form> tag.... but in the code-snipped it is object="{post}"

4.) In section "validation" of the  "Part II: Getting Started":
- The code for the postControler changes and explanation to displaying the error msg: "Could not create the new Post" is missing. Therefore an system-error message appears. 
- The look and behavior of the more verbose error messages is totally different. Both messages are one text block without any HTML symantic code. That's what is generated by the code: <div class="error">title: The length of this text must be between 1 and 100 characters.author: The length of this text must be between 1 and 50 characters.</div> So that the related  template-file code-snipped has to be adapted to look like the picture, or at least similar. 
- One really interesting part and - in my opinion - important part are some lines how to adapt  the verbose messages. From where does the english message come? How can I change the message to another language or provide my own text? (1-2 sentences would be enough and maybe a reference to the full documentation where it is explained in detail)

5.) In section "routing" of the  "Part II: Getting Started":
 - there are some " ..code-block::none"  Is there something missing? (See section object route parts)
 - And a wrong link to the manual: http://flow3.typo3.org/documentation/guide/partii/partiii/routing.html
       should be: http://flow3.typo3.org/documentation/guide/partiii/routing.html

Hopefully I could contribute a little bit to the development of FLOW3 and how to get started. 
You did (and do) a great job on this!

Thing is, for the moment, I wouldn't use FLOW3 for a customer project  cuz "a lot" of the docu is missing and/or has to be checked and there are not many howto-sources with examples available to learn it even faster.

I'm sure, if you work as hard on the docu as on the FLOW3-System FLOW3 will become a new rising star on the sky! 

I'm not a pro in programming, but if I can help with reviewing the docu I'll help as much as I can.

Best,
Alex




More information about the FLOW3-team-core mailing list