| <html> |
| <head> |
| <meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> |
| <title>Frequently Asked Questions</title> |
| <link rel="stylesheet" href="../../../doc/src/boostbook.css" type="text/css"> |
| <meta name="generator" content="DocBook XSL Stylesheets V1.75.2"> |
| <link rel="home" href="../index.html" title="The Boost C++ Libraries BoostBook Documentation Subset"> |
| <link rel="up" href="../quickbook.html" title="Chapter 31. Quickbook 1.5"> |
| <link rel="prev" href="editors.html" title="Editor Support"> |
| <link rel="next" href="ref.html" title="Quick Reference"> |
| </head> |
| <body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> |
| <table cellpadding="2" width="100%"><tr> |
| <td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../boost.png"></td> |
| <td align="center"><a href="../../../index.html">Home</a></td> |
| <td align="center"><a href="../../../libs/libraries.htm">Libraries</a></td> |
| <td align="center"><a href="http://www.boost.org/users/people.html">People</a></td> |
| <td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td> |
| <td align="center"><a href="../../../more/index.htm">More</a></td> |
| </tr></table> |
| <hr> |
| <div class="spirit-nav"> |
| <a accesskey="p" href="editors.html"><img src="../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../quickbook.html"><img src="../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../index.html"><img src="../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="ref.html"><img src="../../../doc/src/images/next.png" alt="Next"></a> |
| </div> |
| <div class="section"> |
| <div class="titlepage"><div><div><h2 class="title" style="clear: both"> |
| <a name="quickbook.faq"></a><a class="link" href="faq.html" title="Frequently Asked Questions">Frequently Asked Questions</a> |
| </h2></div></div></div> |
| <a name="quickbook.faq.can_i_use_quickbook_for_non_boost_documentation_"></a><h4> |
| <a name="id3249294"></a> |
| <a class="link" href="faq.html#quickbook.faq.can_i_use_quickbook_for_non_boost_documentation_">Can |
| I use QuickBook for non-Boost documentation?</a> |
| </h4> |
| <p> |
| QuickBook can be used for non-Boost documentation with a little extra work. |
| </p> |
| <div class="blockquote"><blockquote class="blockquote"><p> |
| <span class="emphasis"><em>Faq contributed by Michael Marcin</em></span> |
| </p></blockquote></div> |
| <p> |
| When building HTML documentation with BoostBook a Boost C++ Libraries header |
| is added to the files. When using QuickBook to document projects outside of |
| Boost this is not desirable. This behavior can be overridden at the BoostBook |
| level by specifying some XSLT options. When using Boost Build version 2 (BBv2) |
| this can be achieved by adding parameters to the BoostBook target declaration. |
| </p> |
| <p> |
| For example: |
| </p> |
| <pre class="programlisting">using quickbook ; |
| |
| xml my_doc : my_doc.qbk ; |
| |
| boostbook standalone |
| : |
| my_doc |
| : |
| <xsl:param>boost.image.src=images/my_project_logo.png |
| <xsl:param>boost.image.alt="\"My Project\"" |
| <xsl:param>boost.image.w=100 |
| <xsl:param>boost.image.h=50 |
| <xsl:param>nav.layout=none |
| ; |
| </pre> |
| <a name="quickbook.faq.is_there_an_easy_way_to_convert_boostbook_docs_to_quickbook_"></a><h4> |
| <a name="id3249346"></a> |
| <a class="link" href="faq.html#quickbook.faq.is_there_an_easy_way_to_convert_boostbook_docs_to_quickbook_">Is |
| there an easy way to convert BoostBook docs to QuickBook?</a> |
| </h4> |
| <p> |
| There's a stylesheet that allows Boostbook generated HTML to be viewed as quickbook |
| source, see <a href="http://svn.boost.org/trac/boost/wiki/QuickbookSourceStylesheetProject" target="_top">http://svn.boost.org/trac/boost/wiki/QuickbookSourceStylesheetProject</a>, |
| so it's then just a cut and paste job to convert the BoostBook to QuickBook |
| (which IMO is a whole lot easier to edit and maintain). |
| </p> |
| <p> |
| --John Maddock |
| </p> |
| </div> |
| <table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr> |
| <td align="left"></td> |
| <td align="right"><div class="copyright-footer">Copyright © 2002, 2004, 2006 Joel de Guzman, |
| Eric Niebler<p> |
| Distributed under the Boost Software License, Version 1.0. (See accompanying |
| file LICENSE_1_0.txt or copy at <a href="http://www.boost.org/LICENSE_1_0.txt" target="_top">http://www.boost.org/LICENSE_1_0.txt</a>) |
| </p> |
| </div></td> |
| </tr></table> |
| <hr> |
| <div class="spirit-nav"> |
| <a accesskey="p" href="editors.html"><img src="../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../quickbook.html"><img src="../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../index.html"><img src="../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="ref.html"><img src="../../../doc/src/images/next.png" alt="Next"></a> |
| </div> |
| </body> |
| </html> |
