PHP :: Doc Bug #18990 :: [chm] general layout comment

[chm] general layout comment

Submitted:

2002-08-20 13:00 UTC

Modified:

2002-12-28 09:10 UTC

Votes:	1
Avg. Score:	1.0 ± 0.0
Reproduced:	0 of 1 (0.0%)

From:

marcus at synchromedia dot co dot uk

Assigned:

goba (profile)

Status:

Closed

Package:

Documentation problem

PHP Version:

4CVS-2002-08-20

OS:

windows

Private report:

CVE-ID:

None

View Developer Edit

[2002-08-20 13:00 UTC] marcus at synchromedia dot co dot uk

[chm date: 2002-08-14]...
Just a note about the layout of the high skin.
I find having the function name and description together in the same part of the top bar quite confusing. I keep expecting the function definition to appear just under the bar. Perhaps at the top of the body, or in a separate bar below the description would be better. Either way, I find having it looking like just a second line of the description is misleading.

Patches

Pull Requests

Add a Pull Request

History

AllCommentsChangesGit/SVN commitsRelated reports

[2002-10-31 11:41 UTC] iliaa@php.net

Is still still an issue in the 10th edition of the chm documentation avaliable from http://weblabor.hu/php-doc-chm/ ?

[2002-11-04 10:49 UTC] vlcc69jfbo001 at sneakemail dot com

(Changed email address)
Sort of - my confusion was merely that the usage and 
purpose are presented as one block of text which made it 
hard to pick out either usage or purpose quickly.

Surely a function's purpose is a more important thing than 
its usage, and hence should be shown first and be clearly 
separated?

I prefer the layout in the "Header Nostalgia" skin, though 
it suffers a similar problem.

Really excellent docs, BTW.

[2002-11-07 11:24 UTC] goba@php.net

The CHM is designed to be extensible in design, as we probably never be able to come up with one design which fits everybody. Therefore you can create your own skins. If you prefer the headernostalgia, then you are in a good situation, as you can edit the CSS file right there. The purpose's style is defined in the #funcPurpose style, the usage is defined in the #funcUsage style. We also have .funcreturntype, .funcparamtype and .funcparamname styles, so you can apply a different style to every element of a function usage line...

[2002-11-07 11:25 UTC] goba@php.net

Anyway, I'll add some documentation on this to the next release...

[2002-12-28 09:10 UTC] goba@php.net

I have updated the HeaderNostalgia skin, so now it has special formatting for function parts. If you have any problems with it's display, you are able to create your own one. If you would like to modify the high skin for your pleasure, grab the files of the skin from here:

http://cvs.php.net/co.php/phpdoc/htmlhelp/suppfiles/html/_style_hi.css?p=1
http://cvs.php.net/co.php/phpdoc/htmlhelp/suppfiles/html/_style_hi.js?p=1

Save it under a folder named "MyHigh" under skins, and mofidy as you need. Then change to this skin, and use it ;)

	php.net \| support \| documentation \| report a bug \| advanced search \| search howto \| statistics \| random bug \| login
go to bug id or search bugs for


Copyright © 2001-2024 The PHP Group All rights reserved.	Last updated: Wed Aug 14 08:01:27 2024 UTC