Re: Small modification suggestion to new PHPDoc
| From: | Hannes Magnusson | Date: | Sat, 23 Aug 2008 20:56:57 +0000 |
| Subject: | Re: Small modification suggestion to new PHPDoc | ||
| References: | 1 2 3 4 | Groups: | php.webmaster |
| Request: | Send a blank email to php-webmaster+get-2515@lists.php.net to get a copy of this message | ||
On Sat, Aug 23, 2008 at 22:23, Guilherme Blanco
<guilhermeblanco@gmail.com> wrote:
> Hi,
>
>
> I missed to comment about some things.
>
> 1- There're wrong paths in content.css:
>
> #main-column .adv-block input {
> background:url(../images/../img/block_sprites.gif) 0 -77px no-repeat;
>
> This path does not exist.
> Another one:
>
> .add-note {
> background:url(../images/../img/block_sprites.gif) 100% 6px no-repeat;
these two are on me. I had been wondering why the image on right to
"view this translation in.." wasn't working :P
> 2- Image not uploaded
> Inside content.css you have:
>
> #contributed-notes .note {
> background:url(../images/note-corners-back.gif) 0 100% repeat-x #FFFFFF;
Hmmh. I don't have any such image from Kian..
Kian: did you forget to send this one or is it simply unintentional leftovers?
> On Sat, Aug 23, 2008 at 5:08 PM, Guilherme Blanco
> <guilhermeblanco@gmail.com> wrote:
>> Hi Hannes,
>>
>> I have fixed my suggestion (it was pointing to wrong style. I
>> inspected with firebug a single example without output result... so I
>> pointed to wrong node) and also included the complete patch to improve
>> readability of sections in php doc. I added scope and a visual style
>> of refsect2, which made me a very clear look and easy to follow
>> organization.
>> Another patch was with blockquotes inside documentation, which was
>> wrong indented and with extra bottom space.
>> Here is the complete changes I did:
>>
>> .example-contents .phpcode {
>> background-color: #fff;
>> border: 1px solid #e2e2e2;
>> padding: 5px 10px;
>> }
>>
>> .sect1 { padding-left: 0px; }
>> .sect2 { padding-left: 20px; }
>> .sect3 { padding-left: 40px; }
>> .sect4 { padding-left: 60px; }
>>
>> .sect1 H2.title {
>> font-weight: bold;
>> margin-bottom: 10px;
>> }
>>
>> .sect2 H3.title {
>> background-color: #e2e2e2;
>> border: 1px solid #b2b2b2;
>> padding: 5px 10px;
>> margin: 20px 0px 10px -20px;
>> }
>>
>> .sect3 H4.title {
>> font-weight: bold;
>> margin-bottom: 10px 0px -20px;
>> }
>>
>> .content BLOCKQUOTE {
>> margin: 10px 0px;
>> padding-bottom: 0px;
>> }
Looks good.
Shouldn't .refsectN also use the same styles as the .sectN? (.sectN is
used for "articles", .refsectN for functions)
If I apply the same styles to .refsectN the "Examples" header becomes
awkward, and the "Notes" too.. they should probably be fixed though..
>> There's a layout issue that should be addressed... that's probably the
>> one you mentioned.
>> When you place output of example, it doubles the <pre> tag.
>> I think (I removed to see if it's ok) as long as the first one is
>> addressed, everything will be fine.
Yeah, the double <pre> tags are a rendering bug in PhD (the in-house
DocBook rendering app we use).
There is already an open bug report on that, just haven't had the time
to look into it yet :]
>> Pierre also suggested me to improve navigation menu (header and left).
>> The header is easy to increase link visibility... simply add a
>> font-weight: bold and they will be much more visible. Fix to that is
>> very easy:
>>
>> #top-navigation A {
>> font-weight: bold;
>> }
Although it does make it more visible it looks weird, makes it look
like a fixed-width typewriting font.. :P
>> I am unable to think in a good and easy solution to enhance visual
>> experience of left menu. If you have suggestions, I can try something.
I'm sure AOE media can come up with something... right Kian? :)
-Hannes