I am working one some quickbook docs and they start out like this:
[library The Boost Algorithm Library [quickbook 1.5] [id algorithm] [dirname algorithm] [purpose Library of useful algorithms] [category algorithms] [authors [Clow, Marshall]] [copyright 2010 Marshall Clow] [source-mode c++] [license Distributed under the Boost Software License, Version 1.0. (See accompanying file LICENSE_1_0.txt or copy at [@http://www.boost.org/LICENSE_1_0.txt]) ] ]
Later (in the same file), I want to drop a link. So, I write:
[link algorithm.all.none_of_if none_of_if1]
(where all is a section, and none_of_if is a heading in that section) but this doesn't work! Some investigation shows that
[link the_boost_algorithm_library.all.none_of_if none_of_if2]
does work - even though the documentation says that the first element in the link is the document id, not the document title. Am I misunderstanding something? -- Marshall
On 29 December 2010 21:18, Marshall Clow <mclow.lists@gmail.com> wrote:
Later (in the same file), I want to drop a link. So, I write:
[link algorithm.all.none_of_if none_of_if1]
(where all is a section, and none_of_if is a heading in that section)
but this doesn't work! Some investigation shows that
[link the_boost_algorithm_library.all.none_of_if none_of_if2]
does work - even though the documentation says that the first element in the link is the document id, not the document title.
Am I misunderstanding something?
Is 'all' in an included file? There's a bug which messes up explicit ids when including files. I can't fix it without a version switch because it'll break a lot of existing documentation (I've already got the fix in place for quickbook 1.6). What you have to do is explicitly specify the id when including a file. So: [library The Boost Algorithm Library [quickbook 1.5] [id algorithm] ... ] [include:algorithm file.qbk] If you want to see a real example, I do this in both the unordered and hash documentation. Daniel
On Dec 29, 2010, at 1:28 PM, Daniel James wrote:
On 29 December 2010 21:18, Marshall Clow <mclow.lists@gmail.com> wrote:
Later (in the same file), I want to drop a link. So, I write:
[link algorithm.all.none_of_if none_of_if1]
(where all is a section, and none_of_if is a heading in that section)
but this doesn't work! Some investigation shows that
[link the_boost_algorithm_library.all.none_of_if none_of_if2]
does work - even though the documentation says that the first element in the link is the document id, not the document title.
Am I misunderstanding something?
Is 'all' in an included file?
Yes, it is.
There's a bug which messes up explicit ids when including files. I can't fix it without a version switch because it'll break a lot of existing documentation (I've already got the fix in place for quickbook 1.6). What you have to do is explicitly specify the id when including a file. So:
[library The Boost Algorithm Library [quickbook 1.5] [id algorithm] ... ]
[include:algorithm file.qbk]
Thanks! That fixed it.
If you want to see a real example, I do this in both the unordered and hash documentation.
I'll take a look. Next up: figuring out how to automatically generate a TOC and index ;-) -- Marshall
participants (2)
-
Daniel James -
Marshall Clow