João Abecasis wrote:
Joel de Guzman wrote:
Hi,
I did a small tweak to quickbook and am about to commit, unless
there are objections.
In cases when you don't care about the heading level (1 to 6), you can
use the Generic Heading:
[h Heading]
The Generic Heading assumes the level, plus one, of the innermost
section where it is placed. For example, if it is placed in the
outermost section, then, it assumes h2.
Why do I need it? In the fusion docs, I am chunking the html files
at level 3 (to mimic the mpl docs layout). If I have a section lower
than level 3, it will be written in a separate file. I use headings
when I want to inhibit chunking. Yet, I do not really want to care
which heading (h1, h2..h6) to use. And many times, I shuffle
content a lot from one place to another.
Comments? Objections? Suggestions?
No objections from here. I like the direction of this and the syntax is
straightforward.
But then, this gets me thinking, why don't h1 through h6 automatically
translate to the-current-section-level plus 1-to-6? Then the new [h
Heading] would be a shorthand for [h1 Heading]. Is there a reason why
one would ever want to hardcode hN in the docs?
Good idea! Make it relative, instead of absolute. I have one reason
against it however: backward compatibility. I do have some docs with
hard coded hNs. Those were the ones that were quick-ported from the
good old days of QuickDoc. Well, we have version checking anyway,
so we can apply it only to 1.3 and above. And it's always easy to
grep those hNs.
There's another (minor) reason against it: syntax. The original
syntax was taken from HTML, which behavior is absolute; not
relative. Might there be some confusion? No?
Regards,
--
Joel de Guzman
http://www.boost-consulting.com
http://spirit.sf.net
-------------------------------------------------------
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
