Add documentation pointing to http_server for most use cases.

Author: kamahen

README.md

@@ -10,7 +10,7 @@ both HTTP and HTTPS connections and handle all request methods.
 
 ## Server library
 
-The main server libarys are
+The main server libraris are
 
   - `library(http/thread_httpd)` implements the server
   - `library(http/http_dispatch)` implements binding locations
@@ -21,6 +21,12 @@ The main server libarys are
   - `library(http/html_write)` implements generating HTML
   - `library(http/http_json)` implements reading and writing JSON documents.
 
+For simplicity, you can use `library(http/http_server)`, which
+combines the typical HTTP libraries that most servers need. The
+idea of a common request handling system and three controlling
+libraries is outdated; the threaded server now being the only sensible
+controlling library.
+
 # Requirements
 
 This library uses functionality from the `ssl` package to support HTTPS,

html_write.pl

@@ -101,6 +101,10 @@
 
 /** <module> Write HTML text
 
+Most   code   doesn't   need  to   use  this   directly;  instead   use
+library(http/http_server),  which  combines   this  library  with   the
+typical HTTP libraries that most servers need.
+
 The purpose of this library  is  to   simplify  writing  HTML  pages. Of
 course, it is possible to  use  format/3   to  write  to the HTML stream
 directly, but this is generally not very satisfactory:

http_dispatch.pl

@@ -76,6 +76,10 @@
 
 /** <module> Dispatch requests in the HTTP server
 
+Most   code   doesn't   need  to   use  this   directly;  instead   use
+library(http/http_server),  which  combines   this  library  with   the
+typical HTTP libraries that most servers need.
+
 This module can be placed between   http_wrapper.pl  and the application
 code to associate HTTP _locations_ to   predicates that serve the pages.
 In addition, it associates parameters  with   locations  that  deal with

http_dyn_workers.pl

@@ -50,6 +50,10 @@
 
 /** <module> Dynamically schedule HTTP workers.
 
+Most   code   doesn't   need  to   use  this   directly;  instead   use
+library(http/http_server),  which  combines   this  library  with   the
+typical HTTP libraries that most servers need.
+
 This module defines  hooks  into  the   HTTP  framework  to  dynamically
 schedule worker threads. Dynamic scheduling relieves   us from finding a
 good value for the size of the HTTP worker pool.

http_json.pl

@@ -80,6 +80,10 @@
 
 /** <module> HTTP JSON Plugin module
 
+Most   code   doesn't   need  to   use  this   directly;  instead   use
+library(http/http_server),  which  combines   this  library  with   the
+typical HTTP libraries that most servers need.
+
 This module adds hooks to several parts   of  the HTTP libraries, making
 them JSON-aware.  Notably:
 

http_parameters.pl

@@ -59,6 +59,10 @@
 
 /** <module> Extract parameters (GET and POST) from HTTP requests
 
+Most   code   doesn't   need  to   use  this   directly;  instead   use
+library(http/http_server),  which  combines   this  library  with   the
+typical HTTP libraries that most servers need.
+
 This module is used to extract the value  of GET or POST parameters from
 an HTTP request. The typical usage is e.g.,
 

http_server.pl

@@ -87,8 +87,13 @@
 
 /** <module> HTTP server library
 
-This library combines the core server  functionality provided by several
-libraries that are needed by almost any web server.
+This  library  combines  the  core  server  functionality  provided  by
+several libraries that are needed by almost any web server.  It exports
+the   commonly   used  predicates   from    library(http/thread_httpd),
+library(http/http_dispatch),                library(http/http_wrapper),
+library(http/http_parameters),                library(http/html_write),
+library(http/http_json),      and       library(http/http_dyn_workers).
+
 */
 
 %!  http_server(+Options) is det.

http_wrapper.pl

@@ -57,6 +57,10 @@
 
 /** <module> Server processing of an HTTP request
 
+Most   code   doesn't   need  to   use  this   directly;  instead   use
+library(http/http_server),  which  combines   this  library  with   the
+typical HTTP libraries that most servers need.
+
 This library provides  the  core  of   the  implementation  of  the HTTP
 protocol at the server side and is   mainly intended for *internal use*.
 It   is   used   by    library(thread_httpd)   and   library(inet_httpd)

thread_httpd.pl

@@ -83,6 +83,10 @@
 
 /** <module> Threaded HTTP server
 
+Most   code   doesn't   need  to   use  this   directly;  instead   use
+library(http/http_server),  which  combines   this  library  with   the
+typical HTTP libraries that most servers need.
+
 This library defines the HTTP server  frontend of choice for SWI-Prolog.
 It is based on the multi-threading   capabilities of SWI-Prolog and thus
 exploits multiple cores  to  serve   requests  concurrently.  The server