Joel de Guzman wrote:
Hi,
Did some maintenance and cleanup to the quickbook code.
Most significantly, 1) the actions are placed in a separate
cpp file and 2) the phrase markups are separated from the
block markups.
The effect of 1 is (hopefully) faster compile times, and
for developers, faster incremental development (when a tweak
is made, the whole application need not be recompiled).
Faster compile-times are *always* welcome in Spirit-land ;-)
The effect of 2 is that I was able to reuse the phrase markup
grammar in the doc-info header. This means that, where
appropriate (e.g. purpose, license), you can now use phrase
markups. For example, instead of hard-coding xml in the
license, you can now write it as:
[license
Distributed under the Boost Software License, Version 1.0.
(See accompanying file LICENSE_1_0.txt or copy at
[EMAIL PROTECTED]://www.boost.org/LICENSE_1_0.txt])
]
Fantastic!!
Same with purpose (e.g.):
[purpose /WikiWiki/ style documentation tool]
rendering WikiWiki in italics.
Caveat: 2, BTW, is not backwards compatible. I shall deal with this
later (as soon as I get some more free time to do Qbk coding) through
a version switch. For current Qbk files, this:
[license
Distributed under the Boost Software License, Version 1.0.
(See accompanying file LICENSE_1_0.txt or copy at
<ulink url="http://www.boost.org/LICENSE_1_0.txt";>
http://www.boost.org/LICENSE_1_0.txt
</ulink>)
]
will not work as expected. For example, '<' will be rendered as "<".
I can see the importance of backward compatibility for users that have
invested in quickbook. However, *total compatibility* should not be our
first priority, right now. Keeping the syntax clean is.
I wonder if it's worth the effort to start offering version switches at
this point. Somehow it seems too early.
Regards,
João
-------------------------------------------------------
SF.Net email is Sponsored by the Better Software Conference & EXPO
September 19-22, 2005 * San Francisco, CA * Development Lifecycle Practices
Agile & Plan-Driven Development * Managing Projects & Teams * Testing & QA
Security * Process Improvement & Measurement * http://www.sqe.com/bsce5sf
_______________________________________________
Boost-docs mailing list
[email protected]
Unsubscribe and other administrative requests:
https://lists.sourceforge.net/lists/listinfo/boost-docs
