David Greene wrote:
Now that I've started to use Quickbook for a major project, I am
liking it more and more. Of course, with that comes visions of
an even greater tool. :)
Great!
There are many ideas in the works, but it's taking a long time for some
of them to emerge. I'll take my share of responsibility here....
I've already run into a number of situations where I'd like to have
some missing functionality. Here are a few items:
- Chapters, _a_la_ LaTeX
- Subsections, _a_la_ LaTeX
I'm not sure what you're after, I'm not all that familiar with LaTeX.
FWIW, you can nest [sections] in QuickBook.
- Inclusion of .qbk files
This is already possible:
[include file.qbk]
And, somewhat related, there's also [xinclude] that adds a xml:xinclude
tag to direct the XSLT processor to grab some external xml file. This is
used to merge doxygen-generated docs into QuickBook.
- A way to specify HTML page breaks (i.e. put everything after this on
a new page). These may or may not specify page breaks for other
outputs. Perhaps multiple break types would be useful.
There are no explicit page breaks in QuickBook. I think you can get
something similar with sections. This is more the domain of DocBook, I'm
not sure what are (y)our options here.
- Superscript/subscript support
It seems we're missing this one...
- Footnote/bibliography/reference support (can fake it, but it's
awkward)
Eric added footnotes some time ago:
[footnote footnote_text]
No bibliography/references.
- A way to reference code snippits directly from source files. This
seems complicated but would be really useful to keep
documentation/code examples up-to-date with actual implmentations.
Perhaps some special marker comment in the code could be referenced
to import into a .qbk. Kind of like a literate programming system
but without the awful code mangling it implies. I've read about
systems like this called "Elucidative Programming:"
http://www.cs.auc.dk/~odin/thesis/
I haven't looked at the link for now, but something along those lines
was discussed some time ago, but there is no implementation as of yet...
Part of the idea was to add scripting support and to allow for the
manipulation of code snippets inside QuickBook as well as to extract
them from separate source files.
If these features exist and I missed them in the documentation, let me
know.
The ones that are available are documented in the CVS docs (because they
may only be available in CVS too). You can find the latest docs here,
<http://tinyurl.com/nntot>
I don't know how much of this is doable given the abilities of BoostBook
but I wanted to give some feedback to make a great tool even better.
Thanks for your feedback!
Regards,
João
-------------------------------------------------------
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
