Boost logo

Boost :

Subject: [boost] [quickbook] template vs block vs phrase issues
From: Andreas Pokorny (andreas.pokorny_at_[hidden])
Date: 2012-12-06 08:45:29


Hi,
I use quickbook to write software design documentation targeting pdf.
We now introduce a requirements tracking system that includes both
source code and design documents. To describe or refer to requirements
in docbook docments special xml markup is needed. I.e. something like
<reqfooo><status>approved</status><version>1</version><id>DoOnlyNeededStuff</id><description></description></regfoo>.
Since I do not want to write XML I added quickbook templates:

[template reqfoo[id
contents]'''<reqcfoo><id>'''[id]'''</id>'''[contents]'''</reqfoo>''']
[template sdesc[contents]'''<shortdesc>'''[contents]'''</shortdesc>''']
[template verification[contents]'''<verifycrit>'''[contents]'''</verifycrit>''']
[template source[contents]'''<source>'''[contents]'''</source>''']
[template usecase[contents]'''<usecase>'''[contents]'''</usecase>''']
[template status[contents]'''<status>'''[contents]'''</status>''']
[template version[contents]'''<version>'''[contents]'''</version>''']

and finally:
[template desc[contents]'''<description>'''[contents] '''</description>''']

Now I want to use block elements inside the contents parameter of
desc. Is there any way to achieve that? The only thing I can think of
is:

[template desc[]'''<description>''']
[template enddesc[]'''</description>''']

But then quickbook is just as good as xml!

I tried to make desc a block level template by adding a line break at
different positions, but then I get broken xml code, since para tags
are spread around <description>

regards
Andreas


Boost list run by bdawes at acm.org, gregod at cs.rpi.edu, cpdaniel at pacbell.net, john at johnmaddock.co.uk