Eric Niebler <[EMAIL PROTECTED]> writes:

> Rene Rivera wrote:
>> Eric Niebler wrote:
>> 
>>> I hate to flog this dead horse, but I'm still not overjoyed with
>>> what we have for variable lists in the CSS. In particular, I think
>>> it makes Doxygen-generated reference docs ugly and take up more
>>> vertical space than necessary.
>> I prefer the vertical space, it makes the text easier to read.
>
>
> IMO, it's wasteful and decreases the amount of information that can be 
> displayed at once. Personal preference, I guess.
>
>
>>> I found an XSL parameter which formats variablelists as tables, and
>>> I generated xpressive's docs with it. I also hacked our XSL
>>> transforms and boostbook.css to support it.
>>>
>>> This is before the change:
>>>   http://tinyurl.com/ho2a3
>>>
>>> This is after the change:
>>>   http://tinyurl.com/fh43h
>>>
>>> Look at the Parameters/Requires/Throws/Returns at the bottom to see
>>> the difference. I was motivated by the fop stylesheets which
>>> produces PDFs with beautiful table-like layouts for variable lists.
>> Are the "Requires", "Returns", "Throws" not a variable list, since
>> they don't show as a DL in the first one?
>
>
> By default, our html.xsl throws out the DL formatting on returns, 
> requires, throws, etc. I don't know why. Doug?
>
>
>> One of the problems with tabular layout I noticed, from looking at
>> all the docs, is that it creates inconsistent tab points as your
>> example shows. From my experience tabular layouts only work when you
>> have strict control of the horizontal tab points and hence can make
>> them look consistent. Otherwise the effect is of a lower quality
>> page, and harder to read as it makes one jump around left to right
>> to follow the tabs.
>
>
> Wow, I couldn't disagree more. For me, the different column widths 
> visually separate the parameters variable list from the 
> returns/requires/throws variable list. This is exactly what the fop/PDF 
> transforms do by default, and I think the result is very intuitive and 
> easy to read.

This is just by chance.  If the columns happened to come out close to
the same size you wouldn't be able to tell that it was two tables.
IMO your formatting looks better, but both are still too fractured.

The definition list would be a whole lot better if the definition text
were moved closer to the terms.  See 

  http://boost-consulting.com/mplbook/metafunctions.html#details

As for Effects and Returns clauses, I think 

  
http://www.boost.org/libs/iterator/doc/iterator_facade.html#iterator-facade-operations

came out pretty nicely.

-- 
Dave Abrahams
Boost Consulting
www.boost-consulting.com



-------------------------------------------------------
This SF.Net email is sponsored by xPML, a groundbreaking scripting language
that extends applications into web and mobile media. Attend the live webcast
and join the prime developer group breaking into this new coding territory!
http://sel.as-us.falkag.net/sel?cmd=lnk&kid=110944&bid=241720&dat=121642
_______________________________________________
Boost-docs mailing list
[email protected]
Unsubscribe and other administrative requests: 
https://lists.sourceforge.net/lists/listinfo/boost-docs

Reply via email to