Re: Small modification suggestion to new PHPDoc

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; } 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. 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; } 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. Cheers, On Sat, Aug 23, 2008 at 2:52 PM, Hannes Magnusson <hannes.magnusson@gmail.com> wrote: > On Sat, Aug 23, 2008 at 19:13, Guilherme Blanco > <guilhermeblanco@gmail.com> wrote: >> Hi Bjori, >> >> >> Pierre pointed me to message you. >> I checked the new PHP Doc layout and I want to suggest 2 small modifications. >> >> 1- Code examples >> They are too similar to documentation, so I suggest a way to >> differenciate them from paragraphs. >> The change is simple and could be tested with firebug before apply. >> >> .example-contents { >> background-color: #fff; >> border: 1px solid #e2e2e2; >> padding: 5px 10px; >> } >> >> This will modify all examples to have a white background with smooth >> border color and internal padding to increase visual experience. > > Committed, thanks! > There is still one minor annoying bug in PhD that generates two <pre> > blocks in some cases, screwing up few examples.. I'll try to look into > that > >> 2- Differenciate sections >> At the first glance, it's difficult to differenciate between section, >> sub-section, etc. >> Please try to find a combination of color/size/style that differenciates it. >> If you prefer, I can give you a final patch to fix this too. > > I completely agree. Each .refsect1 should probably be "boxed in" somehow.. > If you have a patch for it, awesome, if not.. I'll try to get AOE > media to come up with something for us ;) > > -Hannes > -- Guilherme Blanco - Web Developer CBC - Certified Bindows Consultant Cell Phone: +55 (16) 9166-6902 MSN: guilhermeblanco@hotmail.com URL: http://blog.bisna.com Rio de Janeiro - RJ/Brazil