diff --git a/doc/clog-manual.html b/doc/clog-manual.html index c8c1f48..0849cca 100644 --- a/doc/clog-manual.html +++ b/doc/clog-manual.html @@ -359,19 +359,29 @@ properties (to use for :property) are based on the event type.
[function] INITIALIZE ON-NEW-WINDOW-HANDLER &KEY (HOST "0.0.0.0") (PORT 8080) (BOOT-FILE "/boot.html") (STATIC-BOOT-JS NIL) (STATIC-ROOT (MERGE-PATHNAMES "./static-files/" (ASDF/SYSTEM:SYSTEM-SOURCE-DIRECTORY :CLOG)))
[function] INITIALIZE ON-NEW-WINDOW-HANDLER &KEY (HOST "0.0.0.0") (PORT 8080) (SERVER :HUNCHENTOOT) (EXTENDED-ROUTING NIL) (LONG-POLL-FIRST NIL) (BOOT-FILE "/boot.html") (BOOT-FUNCTION NIL) (STATIC-BOOT-HTML NIL) (STATIC-BOOT-JS NIL) (STATIC-ROOT (MERGE-PATHNAMES "./static-files/" (ASDF/SYSTEM:SYSTEM-SOURCE-DIRECTORY :CLOG)))
Inititalize CLOG on a socket using HOST and PORT to serve BOOT-FILE
as the default route to establish web-socket connections and static
-files located at STATIC-ROOT. If CLOG was already initialized and not
-shut down, this function does the same as set-on-new-window (does not
-change the static-root). If ON-NEW-WINDOW-HANDLER is nil no handler is
-set and none is removed. STATIC-ROOT by default is the "directory CLOG
-is installed in ./static-files" If the variable clog:overide-static-root
-is set STATIC-ROOT will be ignored. If BOOT-FILE is nil no default
-boot-file will be set for root path, i.e. /. If static-boot-js is t
-then boot.js is served from the file /js/boot.js instead of the
-compiled version.
STATIC-ROOT. The webserver used with CLACK can be
+chosed with :SERVER. If EXTENDED-ROUTING is t routes will match even
+if extend with additional / and additional paths. If
+LONG-POLLING-FIRST is t, the output is sent as HTML instead of
+websocket commands until on-new-window-handler ends, this should be
+used in webserver applications to enable crawling of your website. If
+CLOG was already initialized and not shut down, this function does the
+same as set-on-new-window (does not change the static-root). If
+ON-NEW-WINDOW-HANDLER is nil no handler is set and none is
+removed. STATIC-ROOT by default is the "directory CLOG is installed
+in ./static-files" If the variable clog:overide-static-root is set
+STATIC-ROOT will be ignored. If BOOT-FILE is nil no default boot-file
+will be set for root path, i.e. /. If static-boot-js is t then boot.js
+is served from the file /js/boot.js instead of the compiled
+version. If static-boot-html is nil if boot.html is not present will
+use compiled version. boot-function if set is called with the url and
+the contents of boot-file and its return value replaces the contents
+sent to the brower, this allows adding content for search engine
+optimization, see tutorial 12 for an example.
@@ -380,11 +390,11 @@ compiled version.
[function] SET-ON-NEW-WINDOW ON-NEW-WINDOW-HANDLER &KEY (PATH "/") (BOOT-FILE "/boot.html")
-Set or change the on-new-window handler or set a new one for PATH
-using BOOT_FILE. Paths should always begin with a '/'. If PATH is set to
-"default" will use boot-file when the route can not be determined, ie
-a static html file including boot.js that has not been added with this
-function. If BOOT-FILE is nil path is removed.
Set or change the ON-NEW-WINDOW-HANDLER for PATH using
+BOOT_FILE. Paths should always begin with a forward slash '/'. If PATH
+is set to :default any path without another route and there is no
+static file matching the requested path ON-NEW-WINDOW-HANDLER and
+BOOT-FILE will be used. If BOOT-FILE is nil path is removed.
diff --git a/source/clog-system.lisp b/source/clog-system.lisp index dfe52f1..217412e 100644 --- a/source/clog-system.lisp +++ b/source/clog-system.lisp @@ -106,6 +106,7 @@ optimization, see tutorial 12 for an example." :host host :port port :server server + :long-poll-first long-poll-first :extended-routing extended-routing :boot-file boot-file :boot-function boot-function