logo       

Re: Some reflections on using quickbook: msg#00030

lib.boost.documentation

Subject: Re: Some reflections on using quickbook

Reece Dunn wrote:
Hi,

I am getting used to the quickbook format (a lot faster to write and easier to read than boostbook!) However, I have a few observations:

1. Tables - I can't specify row or column spans (cells that span several rows or columns). This is easy in HTML via rowspan and colspan, but there is no quickbook equivalent.

Nor is there a DocBook equivalent, unless I am mistaken.

2. Pre - the following fragment isn't processed correctly:

[Run this command line:
[pre cat file.txt | grep -F hello]
]

Because "pre" is a block level markup. Use:

[^cat file.txt | grep -F hello]

instead.

3. Code - you can't specify no syntax highlighting:

[Run this command line: ``echo Hello World!``]

Use ^ instead:

[^echo Hello World!]

4. Code - adjacent code fragments aren't concatenated:

[For example:
``int foo()``
``{``
``}``
]

Shouldn't that be:

``
int foo()
{
}
``

??

5. Code fragments spanning multiple lines retain all whitespace, thus the code fragment:

[For example:
``int foo()
{
std::cout << "bar" << std::endl;
}``
]

gets incorrectly formatted w.r.t. spacing.

What were you expecting?

Regards,
--
Joel de Guzman
http://www.boost-consulting.com
http://spirit.sf.net



-------------------------------------------------------
SF.Net email is sponsored by:
Tame your development challenges with Apache's Geronimo App Server. Download
it for free - -and be entered to win a 42" plasma tv or your very own
Sony(tm)PSP. Click here to play: http://sourceforge.net/geronimo.php
_______________________________________________
Boost-docs mailing list
Boost-docs@xxxxxxxxxxxxxxxxxxxxx
Unsubscribe and other administrative requests:
https://lists.sourceforge.net/lists/listinfo/boost-docs



<Prev in Thread] Current Thread [Next in Thread>
Google Custom Search

News | FAQ | advertise