Re: [Boost-docs] [stylesheet] forced upcasing of titles

Subject: Re: [Boost-docs] [stylesheet] forced upcasing of titles
From: Eric Niebler (eric_at_[hidden])
Date: 2008-04-01 17:02:07

Rene Rivera wrote:
> David Abrahams wrote:
>> It worries me that C++ identifiers appearing in section titles come out
>> as ALL_CAPS with the new documentation stylesheet.  This one is fairly
>> innocuous
>> (http://boost.org/doc/libs/1_35_0/libs/python/doc/building.html#include-issues)
>> but other cases could easily be really confusing.
>>
>> Is the stylistic advantage of small-caps section titles worth the
>> potential confusion?
> 
> Good question. I think the small-caps are useful overall. But I can see 
> how it would be confusing in this case. Would a compromise of not 
> showing the #include part of the heading as small-caps work? It would 
> generically be showing any "pre" or "tt" within a header as-is.

I'll second Dave's call to nix the uppercasing of titles. I put 
identifiers in titles. C++ respects case. So should Boost's docs.

-- 
Eric Niebler
Boost Consulting
www.boost-consulting.com