Welcome to The Cookbook

Thanks for this good application and good framework regarding the doc effort. Do you plane to implement a history/changes feature?

Cheers.

great work guys, i hope to be using it a lot, both reading and writing.

> and <h5> are very small for easily searching, bigger fontsize would improve quicksearch, especially when using "All in one page", which is already my favourite. What do i need a searchfunction for on the website when my browser has a nice one with CTRL+F :)

Very nice work indeed!!

But regarding "Use <pre> for code blocks" - how about the <code> tag instead?

Fits the "Use as plain and semantic HTML as you can" better :-)

Maybe is it possible to replace the <pre> in a DB dump?

I don't think this is the right place to discuss styling/tagging etc. issues here.

No, su6z3r0

Look at http://bakery.cakephp.org/articles/view/what-s-up-docs

> If you notice an issue with the application, log a ticket at http://trac.cakephp.org.

> If you notice an issue with the documentation, make a suggestion via the 'book.

<pre> are in the doc not in the code. So this comment is in the right place here.

JakeCake

you are right! RTFM me :-)

But doesn't this spoil the whole comment thing? I mean in a few months no-one wants to dig through hundreds (hopefully :-)) of comments about tagging and styling issues which actually belong to this application and not cake itself.

No problem, su6z3r0. But what do you expect we comment here? We are speaking about the documentation strategy, not cakephp itself as you say. The <pre> are spread in all the documentation, so this root node is the right place to debate about it. The problem is not that we spoil, it's that we don't have any answer nor the possibility to replace <pre> by <code> in the database and adapt the CSS.

So, if help needed, Cookbook admins, I agree to give a little help on that and more. But maybe we are wrong with this issue. That's possible, just say it.

Chaps.

This is the wrong place to debate the way John has asked for content to be entered. In any event please look at the rendered souce (what a pre becomes) and you'll see that as well as code replacing pre not being appropriate, if you put code in a pre it gets marked up appropriately.

This is going to be great! I can't wait to get involved.

I've spent a little time with navigating around here are some of the things from a UI standpoint that I think needs some tweaking...

After browsing around a bit I think it will make for a easier navigation experience if we:

1. Repeat the chapter/section number notation in the red h2 headers... i.e. "1.3.1 Audience" instead of just "Audience" so that you can visually note where you are in the structure.

2. We need to figure out how to highlight the page you are currently viewing in the sidebar nav. I think just a simple background color on the list item may do the trick.

3. Currently, it looks like the top level list chapter numbers are not correct?

4. In the sidebar lists, an indented left margin denotes a subsection of the item above it (and rightly so, as we have all grown up with that type of structure). So thats great, but when a sub list item has sub items of its own, the triangle icon jacks up this structure visually and makes the whole thing harder to digest. For example, go to: http://book.cakephp.org/view/260/requiresecure Now, 5.2 looks like a sub item of 5.1 due to the left margin increase caused by the arrow icon. I think the easiest thing to do would be to give all list items an icon... the arrow if there are sub lists, and a similarly designed bullet or other symbol if there are not. This will help equalize the left margin spacing issue.

I've mocked up what I'm talking about here: http://files.cdnm.com/cakephp/UI-Ideas-01.png

I am happy to help with css on this if needed. Please let me know.

The "See Comments" link under the h2 section title title should also link down to the comments div. When you click it on a page (like this one) with a lot of content, it isn't obvious that you've "toggled" the display of the comments div... I would even consider tossing the toggle effect, leave the comments visible all the time and just make "See Comments" a link to an anchor so you jump down to the comments area... otherwise new users may miss out on a section's comments all together.

It might also be nice to have a little header above the comments area to separate it visually from the rest of the page's content.

What are the chances of getting some extra output formats of the cookbook manuals? It's be great to have an option for all-in-one-page HTML version, PDF etc...

I do a lot of development without internet access and having downloaded copies of manuals (like PHP and MySQL) is a great help. I currently rely on a saved copy of the tempdocs.cakephp site and it'd be great if I could easily export this site too.

Thanks

Dave

daibach: there's a link in the sidebar that says "All in one page". Click on that and you'll get everything in one page. :)

@jonathansnook : i noticed that the option of all-in-one-page was gone for a day or so, now its back again.

Oh aye!, blimey don't know how I missed that, sure I remember seeing it now.

Really helpful now, plus it's nice to see an overall look of everything so far.

Eventually it'd still be nice to have a different all-in-one-page option that has things rearranged or hidden. Like the contents list being at the top of the content instead of in the right column and the links hidden (like comments and edit). But this'll do for now :)

Hi!

Cookbook is really great idea!

I would like to suggest adding also polish version. There is a constant growing CakePHP community in Poland and I'm sure there are many people who would like to participate in this project.

There should be an option to hide the comment/edit links when a user is just browsing and/or isn't logged in - or possibly hide them and show them onmouseover.

How can we translate the Cookbook menus, like "Table of contents", "See all comments", "Suggest a new section here"... ? There is no link for that.

In addition, how do you manage the new content added in English version for other languages? You rewrite the section in English and we re-translate all content?

Hope this comment is understandable...

I am new to CakePHP, so I was just starting with the 15 min Blog Tutorial that you have given.

I read it for 2 days, but today it is giving an error when I try to open the linked page.

Please check this problem...

I have noticed some possible improvements to the css.

When printing pages, the links to view comments or add a section could be hidden.

When I printed the Models section the menu took up 5 pages...

The code examples are printed twice, once for the formatted code with line numbers (the line numbers show up but the indentation doesn't) and once in the plain code (this prints correctly). I vote for only showing the plain code as printing in black and white makes the colouration and line numbers simply detract from he readability of the code.

In the screen stylesheet, the vertical margins and padding used for the plain text version of code examples are different from those used for the the formatted version. The result is that the total height of the example code changes when you mouse over a code example. Making the juggling the values so the total height of the example stayed the same as you mouse-over would make the change more 'seamless' and less tiring on the eyes.

To all the contributors to this manual: These comments are just details, you are doing an excellent job. The manual is clear and easy to use. Bravo. What more do you need?