|
|
Boost-Commit : |
From: lists.drrngrvy_at_[hidden]
Date: 2007-08-15 22:36:42
Author: drrngrvy
Date: 2007-08-15 22:36:40 EDT (Wed, 15 Aug 2007)
New Revision: 38707
URL: http://svn.boost.org/trac/boost/changeset/38707
Log:
altered preface/introduction
Text files modified:
sandbox/SOC/2007/cgi/libs/cgi/doc/Jamfile.v2 | 6 ++--
sandbox/SOC/2007/cgi/libs/cgi/doc/src/cgi.qbk | 6 +++-
sandbox/SOC/2007/cgi/libs/cgi/doc/src/introduction.qbk | 20 ---------------
sandbox/SOC/2007/cgi/libs/cgi/doc/src/preface.qbk | 52 ++++++++++++++++++++++++++++++++++++++-
4 files changed, 57 insertions(+), 27 deletions(-)
Modified: sandbox/SOC/2007/cgi/libs/cgi/doc/Jamfile.v2
==============================================================================
--- sandbox/SOC/2007/cgi/libs/cgi/doc/Jamfile.v2 (original)
+++ sandbox/SOC/2007/cgi/libs/cgi/doc/Jamfile.v2 2007-08-15 22:36:40 EDT (Wed, 15 Aug 2007)
@@ -3,9 +3,9 @@
# subject to the Boost Software License, Version 1.0. (See accompanying
# file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt)
-#project boost/bwomcgi/doc
-# : build-dir ../../../bin.v2
-# ;
+project boost_cgi_doc
+ : build-dir ../../../bin.v2
+ ;
import boostbook : boostbook ;
import quickbook ;
Modified: sandbox/SOC/2007/cgi/libs/cgi/doc/src/cgi.qbk
==============================================================================
--- sandbox/SOC/2007/cgi/libs/cgi/doc/src/cgi.qbk (original)
+++ sandbox/SOC/2007/cgi/libs/cgi/doc/src/cgi.qbk 2007-08-15 22:36:40 EDT (Wed, 15 Aug 2007)
@@ -8,7 +8,7 @@
[library CGI
[quickbook 1.3]
[version 0.01]
- [id boost.cgi]
+ [id boost.blam.cgi]
[dirname the_document_dir]
[copyright 2007 Darren Garvey]
[purpose Thoughts about CGI implementation]
@@ -27,7 +27,7 @@
[def __asio__ [@http://asio.sourceforge.net Asio]]
[def __reading_the_docs__ [link boost.cgi.intro.reading_the_docs reading the docs]]
-[def __naming conventions__ [link boost.cgi.intro.naming_conventions naming conventions]]
+[def __naming_conventions__ [link boost.cgi.intro.naming_conventions naming conventions]]
[def __tutorial__ [link boost.cgi.tutorial tutorial]]
[def __reference__ [link /doc/html/cgi/reference.html reference]]
@@ -74,3 +74,5 @@
[/xinclude ../output.boostbook]
[include reference.qbk]
+
+[/include acknowledgements.qbk]
Modified: sandbox/SOC/2007/cgi/libs/cgi/doc/src/introduction.qbk
==============================================================================
--- sandbox/SOC/2007/cgi/libs/cgi/doc/src/introduction.qbk (original)
+++ sandbox/SOC/2007/cgi/libs/cgi/doc/src/introduction.qbk 2007-08-15 22:36:40 EDT (Wed, 15 Aug 2007)
@@ -8,25 +8,5 @@
[section:intro Introduction]
-[section:reading_the_docs Structure of the Documentation]
-
-[tip Hopefully after reading this you'll be able to get through the docs and use the library quicker.]
-
-
-[endsect]
-
-[section Naming Conventions]
-
-CGI -> cgi
-async CGI -> acgi
-FastCGI -> fcgi
-SCGI -> scgi
-
-*_request
-*_acceptor
-*_service
-
-[endsect]
-
[endsect]
Modified: sandbox/SOC/2007/cgi/libs/cgi/doc/src/preface.qbk
==============================================================================
--- sandbox/SOC/2007/cgi/libs/cgi/doc/src/preface.qbk (original)
+++ sandbox/SOC/2007/cgi/libs/cgi/doc/src/preface.qbk 2007-08-15 22:36:40 EDT (Wed, 15 Aug 2007)
@@ -7,8 +7,56 @@
[section Preface]
-Boost.CGI is a library to aid the creation of scalable CGI programs in Standard C++. This library rests on top of and should appear familiar to users of Boost.Asio. Currently the __cgi__, [-__scgi__ and __fcgi__] protocols are supported.
+[section Overview]
+
+Boost.CGI is a library for writing CGI programs in Standard C++. It can be used to write anything from simple 'adming scripts' to full-fledged, scalable applications. This library rests on top of and should appear familiar to users of Boost.Asio. Currently the __cgi__, [-__scgi__ and __fcgi__] protocols are supported.
+
+[endsect]
+
+[section Motivation]
+
+C++ isn't a particularly common choice for CGI programming, although it is a powerful one and can be used to produce maintainable and uncompromisingly efficient applications with any feature possible in any other language.
+
+A complete discussion about the benefits of CGI programming in C++ is beyond the scope of this document, but here is a short list:
+
+* Having a binary application is inherently more secure than scripting languages in the situation where an error causes the application, rather than the output to be returned to the client. See http://www.w3.org/Security/Faq/wwwsf4.html for more.
+
+* C++ has a very large and professional user base, providing a wealth of expertise and experience.
+
+* Billions of lines of C++ code can be reused to reduce development/testing times.
+
+* In places where RAD (rapid application development) is of the utmost importance, scripting languages can still be used, for instance by using [link __boost_python__ Boost.Python] - though it could be argued that C++ and RAD are not mutually exclusive.
+
+* C++ is ['fast]. You can rest assured that the language will never be a bottleneck in your applications.
+
+* C++ rarely misses out on access to new technologies: for instance, if a new RDBMS came out tomorrow, it would almost certainly ship with a C/C++ API. The same would not be true for most other languages.
+
+
+
+In these days of 'Web 2.0' - with web applications becoming increasingly complex and responsive (ie. asynchronous, vis-Ã -vis AJAX) all while being required to scale boundlessly - the benefits of C++ begin to appear.
+
+[endsect]
+
+[section How to use this manual]
+
+You should probably just read it in order. Simple enough, no?
+
+[section Naming Conventions]
+
+CGI -> cgi
+async CGI -> acgi
+FastCGI -> fcgi
+SCGI -> scgi
+
+*_request
+*_acceptor
+*_service
+
+[endsect]
+
+
+[endsect]
+
-[include acknowledgements.qbk]
[endsect]
Boost-Commit list run by bdawes at acm.org, david.abrahams at rcn.com, gregod at cs.rpi.edu, cpdaniel at pacbell.net, john at johnmaddock.co.uk