[FLOW3-general] Quick review to Quickstart

Christof Adams christof.adams at online.de
Sun Aug 7 18:52:25 CEST 2011


Hallo

thanks for your excellent work on the Quickstart Doc, short and very 
instructive, it helped me a lot.
Because i'am am still not familiar with git(thanks for the nice wizard), i'd 
like to make my remarks here on the list:

1) I know most people are today aware that modern computer systems are case-
sensitive but a short remark about this may help the one or other

2)Under "Test the Installation" in the "Tip"-paragraph 
it reads  ... gladly help you out if describe ....  although im am not an 
native english speaker i would write: ...help you out if you describe ....

3) Under "Database setup" in the code example for the Settings.yaml only the 
first two lines are indented by 2 spaces whereas in the original file the  
lines starting with "backendOptions" and "driver"-ff are also indented by two 
spaces (and have to, i suppose)

4) Under "showAction" the block

.. code-block:: html

<f:link.action action="show" arguments="{coffeeBean: coffeeBean}">…
</f:link.action>

is not rendered in the right way.I couldn't find the cause. perhaps its the 
extra hyphen at the end of 
.. code-block:: text
	Acme.Demo/Resources/Private/Templates/CoffeeBean/Show.html`

the three points in the f:link statement  can be overlooked. A bit of pseudo-
code would be perhaps more instructive. 

5) Under "editAction" the two code examples are not in boxes and the markup-
code shows in the rendered text. The error may be the second colon at the end 
of the first paragraph.

6) tastes differ, but the use of 'italics' creates sometimes problems with 
some fonts mattering the readability of a text.

  a) in normal text it is sometimes better to introduce an extra space to
      seperate an 'italics'-expression from the next word

  b) in the code examples rendered with "code-block:: html" the backslashes
      look to me allmost like '|'(Ascii 124) instead of '/' that may confuse 
      newbies

perhaps you can use another (italics)-font with a stronger angle for slashes 
and with a better spacing. 


Only to make good work better

Greets

Christof



More information about the FLOW3-general mailing list