Documentation Updates
Documentation Updates
Posted over 3 years ago by jwage
Enhancements
Over the past few days I have rolled out some changes to the documentation which are mostly aesthetic. Overall the changes make the documentation much richer and easier to read.
Some of the changes made to the documentation are listed below:
- Added next and previous links to navigate between chapters
- Adding syntax highlight to YAML examples
- Added syntax highlighting to SQL/DQL examples
- Enhanced PHP syntax highlighting colors
- Added styled caption boxes for notes, tips, sidebars and cautions
- Other miscellaneous styling enhancements
Why?
Why are we making these enhancements? This is in preparation for a new version of the manual which will be the first piece of documentation on Doctrine available in print! We will release more information about when this will be available soon.
Comments (5) [ add comment ]
Markup Problem Posted by Ree about over 3 years ago.
It's all fine except that in the 'all on one page' version of the manual there's a markup problem. At certain point all the text gets monospaced up to the end of the document which makes it unreadable.
@Ree Posted by jwage about over 3 years ago.
@Ree Thanks, this is fixed now!
Yellow Text Posted by Ree about over 3 years ago.
Should have mentioned it in my previous comment - the "normal" text is yellow in IE7. That's actually the main problem :).
Print? :) Posted by Blackpulp about over 3 years ago.
Really? An actual book? Can't wait!
One more markup problem Posted by naag about over 3 years ago.
The documentation is one of the best things about Doctrine :-) Still I would like to point out one more markup problem: chapter 11.9.10 "Exists Expressions", Listing .46 seems to be garbled. There are some hex color codes in the DQL query.
Thanks for all the work :-)