Displaying notes better
| From: | Cece) Szabolcs | Date: | Tue, 19 Aug 2003 22:48:21 +0000 |
| Subject: | Displaying notes better | ||
| Groups: | php.doc | ||
| Request: | Send a blank email to phpdoc+get-969355975@lists.php.net to get a copy of this message | ||
Hello!
I played a bit on my phpweb mirror with notes displaying part.
The output of the function clean_note() a bit ugly, breaks
the identation of inserted codes, and isn't XHTML compatible.
And the code behind needs a little rework too, it's getting
too complicated after a lot of patches. I modified that clean_note()
function to use highlight_php(). With that the output preserves
identation, gets colors. I played with "urls to links" preg_replace
function to be more accurate (it needs more work, i know).
These reworks can be checked at http://hu2.php.net/manual/en/ pages.
Good examples :)
http://hu2.php.net/manual/en/ref.classobj.php
http://hu2.php.net/manual/en/ref.cpdf.php
http://hu2.php.net/manual/en/ref.filesystem.php
I talked about that with Goba. He suggests, that note-formatting
steps can be done at the level of update-user-notes of php-master-web.
With that we can save resources on phpweb's manual pages displaying
level.
To summarize benefits of that modofications:
- better looking user notes
- getting closer to XHTML Strict compilance on manual pages
- saving resource
So, let's discuss about that a bit!
Cece