summaryrefslogtreecommitdiff
path: root/doc/html/quickbook/faq.html
blob: e8b269d9a866727c83394dfef97889af3c77acbb (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<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.76.1">
<link rel="home" href="../index.html" title="The Boost C++ Libraries BoostBook Documentation Subset">
<link rel="up" href="../quickbook.html" title="Chapter&#160;44.&#160;Quickbook 1.6">
<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>Frequently Asked Questions</h2></div></div></div>
<h3>
<a name="quickbook.faq.h0"></a>
      <span><a name="quickbook.faq.can_i_use_quickbook_for_non_boost_documentation_"></a></span><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>
    </h3>
<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
    :
        &lt;xsl:param&gt;boost.image.src=images/my_project_logo.png
        &lt;xsl:param&gt;boost.image.alt="\"My Project\""
        &lt;xsl:param&gt;boost.image.w=100
        &lt;xsl:param&gt;boost.image.h=50
        &lt;xsl:param&gt;nav.layout=none
    ;
</pre>
<h3>
<a name="quickbook.faq.h1"></a>
      <span><a name="quickbook.faq.is_there_an_easy_way_to_convert_boostbook_docs_to_quickbook_"></a></span><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>
    </h3>
<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 &#169; 2002, 2004, 2006 Joel de Guzman,
      Eric Niebler<br>Copyright &#169; 2010, 2011 Daniel James<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>