Author: dshevchenko
Date: 2010-12-22 13:21:34 EST (Wed, 22 Dec 2010)
New Revision: 67415
URL: http://svn.boost.org/trac/boost/changeset/67415
Log:
Doc
Removed:
sandbox/configurator/libs/configurator/doc/rationale.html
Text files modified:
sandbox/configurator/libs/configurator/doc/acknowledgments.html | 6 +++---
sandbox/configurator/libs/configurator/doc/advanced_usage.html | 2 +-
sandbox/configurator/libs/configurator/doc/appendix.html | 6 +++---
sandbox/configurator/libs/configurator/doc/common_usage.html | 2 +-
sandbox/configurator/libs/configurator/doc/config_file_customizing.html | 2 +-
sandbox/configurator/libs/configurator/doc/config_file_format.html | 20 ++++++++++++--------
sandbox/configurator/libs/configurator/doc/examples.html | 23 +++++++----------------
sandbox/configurator/libs/configurator/doc/index.html | 7 +------
sandbox/configurator/libs/configurator/doc/overview.html | 10 +++++-----
sandbox/configurator/libs/configurator/doc/reference.html | 2 +-
sandbox/configurator/libs/configurator/doc/requirements.html | 6 +++---
11 files changed, 38 insertions(+), 48 deletions(-)
Modified: sandbox/configurator/libs/configurator/doc/acknowledgments.html
==============================================================================
--- sandbox/configurator/libs/configurator/doc/acknowledgments.html (original)
+++ sandbox/configurator/libs/configurator/doc/acknowledgments.html 2010-12-22 13:21:34 EST (Wed, 22 Dec 2010)
@@ -24,7 +24,7 @@
<hr/>
<div class="navigation">
-
+ <img src="src/images/next_disabled.png" alt="Next">
</div>
<h2>Acknowledgments</h2>
@@ -50,13 +50,13 @@
<br/><br/>
<div class="last_revised">Last revised
- <!--webbot bot="Timestamp" s-type="EDITED" s-format="%d %B, %Y" startspan -->10
+ <!--webbot bot="Timestamp" s-type="EDITED" s-format="%d %B, %Y" startspan -->22
December, 2010<!--webbot bot="Timestamp" endspan i-checksum="38514" --></div>
<hr/>
<div class="navigation">
-
+ <img src="src/images/next_disabled.png" alt="Next">
</div>
</body>
</html>
Modified: sandbox/configurator/libs/configurator/doc/advanced_usage.html
==============================================================================
--- sandbox/configurator/libs/configurator/doc/advanced_usage.html (original)
+++ sandbox/configurator/libs/configurator/doc/advanced_usage.html 2010-12-22 13:21:34 EST (Wed, 22 Dec 2010)
@@ -34,7 +34,7 @@
<br/><br/>
<div class="last_revised">Last revised
- <!--webbot bot="Timestamp" s-type="EDITED" s-format="%d %B, %Y" startspan -->10
+ <!--webbot bot="Timestamp" s-type="EDITED" s-format="%d %B, %Y" startspan -->22
December, 2010<!--webbot bot="Timestamp" endspan i-checksum="38514" --></div>
<hr/>
Modified: sandbox/configurator/libs/configurator/doc/appendix.html
==============================================================================
--- sandbox/configurator/libs/configurator/doc/appendix.html (original)
+++ sandbox/configurator/libs/configurator/doc/appendix.html 2010-12-22 13:21:34 EST (Wed, 22 Dec 2010)
@@ -24,7 +24,7 @@
<hr/>
<div class="navigation">
-
+
</div>
<h2>Appendix</h2>
@@ -32,13 +32,13 @@
<br/><br/>
<div class="last_revised">Last revised
- <!--webbot bot="Timestamp" s-type="EDITED" s-format="%d %B, %Y" startspan -->10
+ <!--webbot bot="Timestamp" s-type="EDITED" s-format="%d %B, %Y" startspan -->22
December, 2010<!--webbot bot="Timestamp" endspan i-checksum="38514" --></div>
<hr/>
<div class="navigation">
-
+
</div>
</body>
</html>
Modified: sandbox/configurator/libs/configurator/doc/common_usage.html
==============================================================================
--- sandbox/configurator/libs/configurator/doc/common_usage.html (original)
+++ sandbox/configurator/libs/configurator/doc/common_usage.html 2010-12-22 13:21:34 EST (Wed, 22 Dec 2010)
@@ -219,7 +219,7 @@
<br/><br/>
<div class="last_revised">Last revised
- <!--webbot bot="Timestamp" s-type="EDITED" s-format="%d %B, %Y" startspan -->10
+ <!--webbot bot="Timestamp" s-type="EDITED" s-format="%d %B, %Y" startspan -->22
December, 2010<!--webbot bot="Timestamp" endspan i-checksum="38514" --></div>
<hr/>
Modified: sandbox/configurator/libs/configurator/doc/config_file_customizing.html
==============================================================================
--- sandbox/configurator/libs/configurator/doc/config_file_customizing.html (original)
+++ sandbox/configurator/libs/configurator/doc/config_file_customizing.html 2010-12-22 13:21:34 EST (Wed, 22 Dec 2010)
@@ -191,7 +191,7 @@
<br/>
<div class="last_revised">Last revised
- <!--webbot bot="Timestamp" s-type="EDITED" s-format="%d %B, %Y" startspan -->10
+ <!--webbot bot="Timestamp" s-type="EDITED" s-format="%d %B, %Y" startspan -->22
December, 2010<!--webbot bot="Timestamp" endspan i-checksum="38514" --></div>
<hr/>
Modified: sandbox/configurator/libs/configurator/doc/config_file_format.html
==============================================================================
--- sandbox/configurator/libs/configurator/doc/config_file_format.html (original)
+++ sandbox/configurator/libs/configurator/doc/config_file_format.html 2010-12-22 13:21:34 EST (Wed, 22 Dec 2010)
@@ -24,7 +24,7 @@
<hr/>
<div class="navigation">
-
+
</div>
<h2>Configuration file format</h2>
@@ -48,14 +48,16 @@
<br/><br/>
<h3><a name="section"></a>Section</h3>
- Set of options is often corresponds to some conceptual entity, so it often combined in the section. For example:
+ Set of options is often corresponds to some conceptual entity, so it useful to combine in the section. For example:
<pre class="config">
<Server>
Host = 127.0.0.1
Port = 80
</Server>
</pre>
-Section <strong>Server</strong> corresponds to some server. Of course, you can use arbitrary nesting sections:
+Section <strong>Server</strong> corresponds to some server, and options <strong>Host</strong> and <strong>Port</strong> regarded not as an independent options, but as parts of conceptual entity "Server".
+<br/><br/>
+Of course, you can use arbitrary nesting sections:
<pre class="config">
<Server>
Host = 127.0.0.1
@@ -77,13 +79,15 @@
</Plugins>
</Server>
</pre>
-As you see, section's name enclosed in XML-like angle brackets (<strong><</strong>---<strong>></strong> for section opening, <strong></</strong>---<strong>></strong> for section closing). You can change enclosing format (for details, see Configuration file customizing).
+As you see, section's name enclosed in XML-like angle brackets (<strong><</strong>---<strong>></strong> for section opening, <strong></</strong>---<strong>></strong> for section closing). This is default format, but you can set custom format (for details, see Configuration file customizing).
<br/><br/>
The careful reader may notice that option's name (for example, <strong>Admin login</strong>) and option's value (for example, <strong>sync check browser</strong>) can contains spaces, except when space/tab using as separator (for details, see Configuration file customizing).
<br/><br/>
<h3><a name="comments"></a>Comments</h3>
- Comments are very useful almost in any configuration file. You can use one-line or multi-line comments, in C++-style:
+ Comments are very useful almost in any configuration file. You can use one-line or multi-line comments.
+ <br/><br/>
+ By default, using comments in C++-style:
<pre class="config">
//
// Common info about this config
@@ -104,16 +108,16 @@
</Security>
</Server>
</pre>
-You can change sign for one-line comment (for details, see Configuration file customizing).
+But you can change signs for one-line comments and for multi-line comments (for details, see Configuration file customizing).
<br/><br/>
<div class="last_revised">Last revised
- <!--webbot bot="Timestamp" s-type="EDITED" s-format="%d %B, %Y" startspan -->10
+ <!--webbot bot="Timestamp" s-type="EDITED" s-format="%d %B, %Y" startspan -->22
December, 2010<!--webbot bot="Timestamp" endspan i-checksum="38514" --></div>
<hr/>
<div class="navigation">
-
+
</div>
</body>
</html>
Modified: sandbox/configurator/libs/configurator/doc/examples.html
==============================================================================
--- sandbox/configurator/libs/configurator/doc/examples.html (original)
+++ sandbox/configurator/libs/configurator/doc/examples.html 2010-12-22 13:21:34 EST (Wed, 22 Dec 2010)
@@ -24,34 +24,25 @@
<hr/>
<div class="navigation">
-
+
</div>
<h2>Examples</h2>
- <h3>Hello, world!</h3>
+ There is some examples of Boost.Configurator usage, with detailed explanation.
- Simplest configuration file:
-
-
-
- <h3>Medium</h3>
-
-
-
- <h3>Advanced</h3>
-
-
+ <ul>
+ <li>Hello, world</li>
+ </ul>
<br/><br/>
<div class="last_revised">Last revised
- <!--webbot bot="Timestamp" s-type="EDITED" s-format="%d %B, %Y" startspan -->10
+ <!--webbot bot="Timestamp" s-type="EDITED" s-format="%d %B, %Y" startspan -->22
December, 2010<!--webbot bot="Timestamp" endspan i-checksum="38514" --></div>
<hr/>
<div class="navigation">
-
-</div>
+
</body>
</html>
Modified: sandbox/configurator/libs/configurator/doc/index.html
==============================================================================
--- sandbox/configurator/libs/configurator/doc/index.html (original)
+++ sandbox/configurator/libs/configurator/doc/index.html 2010-12-22 13:21:34 EST (Wed, 22 Dec 2010)
@@ -88,11 +88,6 @@
<div class="table_of_contents_main">Reference</div>
<div class="table_of_contents_main">Examples</div>
- <div class="table_of_contents_first">
- Hello, world!<br/>
- Medium<br/>
- Advanced<br/>
- </div>
<div class="table_of_contents_main">Appendix</div>
<div class="table_of_contents_first">
@@ -108,7 +103,7 @@
<br/><br/>
<div class="last_revised">Last revised
- <!--webbot bot="Timestamp" s-type="EDITED" s-format="%d %B, %Y" startspan -->10
+ <!--webbot bot="Timestamp" s-type="EDITED" s-format="%d %B, %Y" startspan -->22
December, 2010<!--webbot bot="Timestamp" endspan i-checksum="38514" --></div>
<hr/>
Modified: sandbox/configurator/libs/configurator/doc/overview.html
==============================================================================
--- sandbox/configurator/libs/configurator/doc/overview.html (original)
+++ sandbox/configurator/libs/configurator/doc/overview.html 2010-12-22 13:21:34 EST (Wed, 22 Dec 2010)
@@ -24,7 +24,7 @@
<hr/>
<div class="navigation">
-
+
</div>
<h2>Overview</h2>
@@ -70,7 +70,7 @@
conf.load( "/some/path/to/hello_world.conf" );
std::string host = conf.get_value_of< Host >();
- std::cout << "Value of host: " << host << std::endl;
+ std::cout << "Host: " << host << std::endl;
} catch ( const std::exception& exc ) {
std::cerr << exc.what() << std::endl;
}
@@ -82,18 +82,18 @@
Console output:
<pre class="terminal">
-Value of host: 127.0.0.1
+Host: 127.0.0.1
</pre>
<br/>
<div class="last_revised">Last revised
- <!--webbot bot="Timestamp" s-type="EDITED" s-format="%d %B, %Y" startspan -->10
+ <!--webbot bot="Timestamp" s-type="EDITED" s-format="%d %B, %Y" startspan -->22
December, 2010<!--webbot bot="Timestamp" endspan i-checksum="38514" --></div>
<hr/>
<div class="navigation">
-
+
</div>
</body>
</html>
Deleted: sandbox/configurator/libs/configurator/doc/rationale.html
==============================================================================
--- sandbox/configurator/libs/configurator/doc/rationale.html 2010-12-22 13:21:34 EST (Wed, 22 Dec 2010)
+++ (empty file)
@@ -1,140 +0,0 @@
-<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
-
-<html>
-<head>
- <meta http-equiv="Content-Language" content="en-us">
- <meta http-equiv="Content-Type" content="text/html; charset=us-ascii">
- <link rel="stylesheet" type="text/css" href="../../../boost.css">
-
- <title>Configurator - Rationale</title>
-<link rel="icon" href="/favicon.ico" type="image/ico"><link rel="stylesheet" type="text/css" href="/style-v2/section-basic.css"></head>
-
-<body link="#0000FF" vlink="#800080"> <div id="boost-common-heading-doc">
- <div class="heading-inner">
- <div class="heading-placard"></div>
-
- <h1 class="heading-title">
- <a href="/">
- <img src="/gfx/space.png" alt= "Boost C++ Libraries" class="heading-logo" />
- <span class="heading-boost">Boost</span>
- <span class="heading-cpplibraries">C++ Libraries</span>
- </a></h1>
-
- <p class="heading-quote">
- <q>...one of the most highly
- regarded and expertly designed C++ library projects in the
- world.</q> <span class="heading-attribution">— <a href=
- "http://www.gotw.ca/" class="external">Herb Sutter</a> and <a href=
- "http://en.wikipedia.org/wiki/Andrei_Alexandrescu" class="external">Andrei
- Alexandrescu</a>, <a href=
- "http://safari.awprofessional.com/?XmlId=0321113586" class="external">C++
- Coding Standards</a></span></p>
-
- <div class="heading-sections">
- <ul>
- <li class="welcome-section-tab">Welcome</li>
- <li class="boost-section-tab">Introduction</li>
- <li class="community-section-tab">Community</li>
- <li class="development-section-tab">Development</li>
- <li class="support-section-tab">Support</li>
- <li class="doc-section-tab">Documentation</li>
- </ul>
- </div>
-</div>
- </div>
-
- <div id="boost-common-heading-doc-spacer"></div>
-
-
- <h1 align="center">Configurator</h1>
-
- <h2 align="center">Rationale</h2>
- <dl class="index">
- <dt>Introduction</dt>
- <dt>Hello, world!</dt>
- <dt>Features</dt>
- </dl>
-
- <h2><a name="introduction" id="introduction"></a>Introduction</h2>
-
- <p>
- Many programs (especially servers, daemons, etc.) requires configuration file for work, so it handling is very common task. Actually, this handling add up to four tasks:
- <ol>
- <li>obtaining options from configuration file,</li>
- <li>check correctness (in all senses of this word) of obtained options,</li>
- <li>storing options,</li>
- <li>issuance of the options values on demand.</li>
- </ol>
-
-Configurator library provides general solution for this tasks. It very easy to use.
- </p>
-
- <h2><a name="topic1" id="topic1"></a>Hello, world!</h2>
-
- <p>
- Simplest configuration file:
-<div style="margin-left: 6px; margin-right: 6px; padding-left: 6px; padding-right: 6px; background: #F5F5DC; border: 1px solid #DEB887; font-family: monospace; font-size: 13px">
-<pre>
-// hello_world.conf
-Host = 127.0.0.1
-</pre>
-</div>
-<br/>
-Code for work with it:
-<pre>
-#include <boost/configurator/configurator.hpp>
-
-#include <iostream>
-
-int main( int argc, char* argv[] ) {
- try {
- boost::cf::configurator configurator;
- configurator.add_option( "Host" );
-
- configurator.parse( "/some/path/to/hello_world.conf" );
-
- std::string value_of_host = configurator.get_value( "Host" );
- std::cout << "Value of host: " << value_of_host << std::endl;
- } catch ( const std::exception& exc ) {
- std::cerr << exc.what() << std::endl;
- }
-
- return 0;
-}
-</pre>
- </p>
-
- <h2><a name="topic2" id="topic2"></a>Features</h2>
-
- <p>
- <ul>
- <li>Simplicity (easy-to-learn and easy-to-use).</li>
- <li>Header-only (does not require building).</li>
- <li>Cross-platform (there is only ISO C++ code and Boost C++ libraries).</li>
- <li>Allows to set option's necessity.</li>
- <li>Allows to set option's default value.</li>
- <li>Allows to set another "name-value" separator, instead default '='.</li>
- <li>Allows to use arbitrary nesting of sections.</li>
- <li>Checks of value's semantic, like correct path, etc.</li>
- <li>Provides common checks of options and sections, like duplication, incorrection, etc.</li>
- <li>Supports single-line and multi-line comments (in C++ style).</li>
- <li>Allow to register options with multi-values.</li>
- <li>Singleton-variant of configurator class.</li>
- <li>Case-sensitivity (or insensitivity) for names of options and sections.</li>
-</ul>
- </p>
-
- <hr>
-
- <p>Revised
- <!--webbot bot="Timestamp" s-type="EDITED" s-format="%d %B, %Y" startspan -->30
- November, 2010<!--webbot bot="Timestamp" endspan i-checksum="38514" --></p>
-
- <p><i>Copyright © 2010 Denis Shevchenko</i></p>
-
- <p><i>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">http://www.boost.org/LICENSE_1_0.txt>)</i></p>
-</body>
-</html>
Modified: sandbox/configurator/libs/configurator/doc/reference.html
==============================================================================
--- sandbox/configurator/libs/configurator/doc/reference.html (original)
+++ sandbox/configurator/libs/configurator/doc/reference.html 2010-12-22 13:21:34 EST (Wed, 22 Dec 2010)
@@ -187,7 +187,7 @@
<br/><br/>
<div class="last_revised">Last revised
- <!--webbot bot="Timestamp" s-type="EDITED" s-format="%d %B, %Y" startspan -->10
+ <!--webbot bot="Timestamp" s-type="EDITED" s-format="%d %B, %Y" startspan -->22
December, 2010<!--webbot bot="Timestamp" endspan i-checksum="38514" --></div>
<hr/>
Modified: sandbox/configurator/libs/configurator/doc/requirements.html
==============================================================================
--- sandbox/configurator/libs/configurator/doc/requirements.html (original)
+++ sandbox/configurator/libs/configurator/doc/requirements.html 2010-12-22 13:21:34 EST (Wed, 22 Dec 2010)
@@ -24,7 +24,7 @@
<hr/>
<div class="navigation">
-
+
</div>
<h2>Requirements</h2>
@@ -32,13 +32,13 @@
<br/><br/>
<div class="last_revised">Last revised
- <!--webbot bot="Timestamp" s-type="EDITED" s-format="%d %B, %Y" startspan -->10
+ <!--webbot bot="Timestamp" s-type="EDITED" s-format="%d %B, %Y" startspan -->22
December, 2010<!--webbot bot="Timestamp" endspan i-checksum="38514" --></div>
<hr/>
<div class="navigation">
-
+
</div>
</body>
</html>