1<html> 2<head> 3<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> 4<title>How to read the documentation</title> 5<link rel="stylesheet" href="../../../../../doc/src/boostbook.css" type="text/css"> 6<meta name="generator" content="DocBook XSL Stylesheets V1.79.1"> 7<link rel="home" href="../index.html" title="Chapter 1. Boost.Log v2"> 8<link rel="up" href="../index.html" title="Chapter 1. Boost.Log v2"> 9<link rel="prev" href="../index.html" title="Chapter 1. Boost.Log v2"> 10<link rel="next" href="installation.html" title="Installation and compatibility"> 11</head> 12<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> 13<table cellpadding="2" width="100%"><tr><td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../../boost.png"></td></tr></table> 14<hr> 15<div class="spirit-nav"> 16<a accesskey="p" href="../index.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../index.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="installation.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a> 17</div> 18<div class="section"> 19<div class="titlepage"><div><div><h2 class="title" style="clear: both"> 20<a name="log.how_to_read"></a><a class="link" href="how_to_read.html" title="How to read the documentation">How to read the documentation</a> 21</h2></div></div></div> 22<p> 23 The documentation is oriented to both new and experienced library users. However, 24 users are expected to be familiar with commonly used Boost components, such 25 as <code class="computeroutput"><span class="identifier">shared_ptr</span></code>, <code class="computeroutput"><span class="identifier">make_shared</span></code> (see <a href="http://www.boost.org/doc/libs/release/libs/smart_ptr/smart_ptr.htm" target="_top">Boost.SmartPtr</a>), 26 and <code class="computeroutput"><span class="identifier">function</span></code> (<a href="http://www.boost.org/doc/libs/release/doc/html/function.html" target="_top">Boost.Function</a>). 27 Some parts of the documentation will refer to other Boost libraries, as needed. 28 </p> 29<p> 30 If this is your first experience with the library, it is recommended to read 31 the <a class="link" href="design.html" title="Design overview">Design overview</a> section for a first glance 32 at the library's capabilities and architecture. The <a class="link" href="installation.html" title="Installation and compatibility">Installation</a> 33 and <a class="link" href="tutorial.html" title="Tutorial">Tutorial</a> sections will help to get 34 started experimenting with the library. The tutorial gives an overview of the 35 library features with sample code snippets. Some tutorial steps are presented 36 in two forms: simple and advanced. The simple form typically describes the 37 most common and easy way to do the task and it is being recommended to be read 38 by new users. The advanced form usually gives an expanded way to do the same 39 thing but with an in-depth explanation and the ability to do some extra customization. 40 This form may come in handy for more experienced users and should generally 41 be read if the easy way does not satisfy your needs. 42 </p> 43<p> 44 Besides the tutorial there is a <a class="link" href="detailed.html" title="Detailed features description">Detailed features 45 description</a> chapter. This part describes other tools provided by the 46 library that were not covered by the tutorial. This chapter is best read on 47 a case by case basis. 48 </p> 49<p> 50 Last, but not least, there is a reference which gives the formal description 51 of library components. 52 </p> 53<p> 54 To keep the code snippets in this documentation simple, the following namespace 55 aliases are assumed to be defined: 56 </p> 57<pre class="programlisting"><span class="keyword">namespace</span> <span class="identifier">logging</span> <span class="special">=</span> <span class="identifier">boost</span><span class="special">::</span><span class="identifier">log</span><span class="special">;</span> 58<span class="keyword">namespace</span> <span class="identifier">sinks</span> <span class="special">=</span> <span class="identifier">boost</span><span class="special">::</span><span class="identifier">log</span><span class="special">::</span><span class="identifier">sinks</span><span class="special">;</span> 59<span class="keyword">namespace</span> <span class="identifier">src</span> <span class="special">=</span> <span class="identifier">boost</span><span class="special">::</span><span class="identifier">log</span><span class="special">::</span><span class="identifier">sources</span><span class="special">;</span> 60<span class="keyword">namespace</span> <span class="identifier">expr</span> <span class="special">=</span> <span class="identifier">boost</span><span class="special">::</span><span class="identifier">log</span><span class="special">::</span><span class="identifier">expressions</span><span class="special">;</span> 61<span class="keyword">namespace</span> <span class="identifier">attrs</span> <span class="special">=</span> <span class="identifier">boost</span><span class="special">::</span><span class="identifier">log</span><span class="special">::</span><span class="identifier">attributes</span><span class="special">;</span> 62<span class="keyword">namespace</span> <span class="identifier">keywords</span> <span class="special">=</span> <span class="identifier">boost</span><span class="special">::</span><span class="identifier">log</span><span class="special">::</span><span class="identifier">keywords</span><span class="special">;</span> 63</pre> 64</div> 65<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr> 66<td align="left"></td> 67<td align="right"><div class="copyright-footer">Copyright © 2007-2019 Andrey Semashev<p> 68 Distributed under the Boost Software License, Version 1.0. (See accompanying 69 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>). 70 </p> 71</div></td> 72</tr></table> 73<hr> 74<div class="spirit-nav"> 75<a accesskey="p" href="../index.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../index.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="installation.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a> 76</div> 77</body> 78</html> 79
