aboutsummaryrefslogtreecommitdiffstats
path: root/doc/src/guide/book.asciidoc
diff options
context:
space:
mode:
authorLoïc Hoguin <[email protected]>2016-01-14 13:35:25 +0100
committerLoïc Hoguin <[email protected]>2016-01-14 13:37:20 +0100
commit4023e7f4e429179fd9c2cce4487c33646c6bd327 (patch)
tree3c4e26d1b5592958e35297c82ad3069bdb642594 /doc/src/guide/book.asciidoc
parentb7d666cfc746f55b0a72ef8d37f703885099daf7 (diff)
downloadcowboy-4023e7f4e429179fd9c2cce4487c33646c6bd327.tar.gz
cowboy-4023e7f4e429179fd9c2cce4487c33646c6bd327.tar.bz2
cowboy-4023e7f4e429179fd9c2cce4487c33646c6bd327.zip
Convert the documentation to Asciidoc
A few small revisions were made, and Erlang.mk has been updated.
Diffstat (limited to 'doc/src/guide/book.asciidoc')
-rw-r--r--doc/src/guide/book.asciidoc72
1 files changed, 72 insertions, 0 deletions
diff --git a/doc/src/guide/book.asciidoc b/doc/src/guide/book.asciidoc
new file mode 100644
index 0000000..15aa42b
--- /dev/null
+++ b/doc/src/guide/book.asciidoc
@@ -0,0 +1,72 @@
+// a2x: --dblatex-opts "-P latex.output.revhistory=0 -P doc.publisher.show=0 -P index.numbered=0"
+// a2x: -d book --attribute tabsize=4
+
+= Cowboy User Guide
+
+= Rationale
+
+include::modern_web.asciidoc[The modern Web]
+
+include::erlang_web.asciidoc[Erlang and the Web]
+
+= Introduction
+
+include::introduction.asciidoc[Introduction]
+
+include::getting_started.asciidoc[Getting started]
+
+include::overview.asciidoc[Request overview]
+
+include::erlang_beginners.asciidoc[Erlang for beginners]
+
+= Configuration
+
+include::routing.asciidoc[routing]
+
+include::constraints.asciidoc[Constraints]
+
+include::static_files.asciidoc[Static files]
+
+= Request and response
+
+include::handlers.asciidoc[Handlers]
+
+include::loop_handlers.asciidoc[Loop handlers]
+
+include::req.asciidoc[The Req object]
+
+include::req_body.asciidoc[Reading the request body]
+
+include::resp.asciidoc[Sending a response]
+
+include::cookies.asciidoc[Using cookies]
+
+include::multipart.asciidoc[Multipart]
+
+= REST
+
+include::rest_principles.asciidoc[REST principles]
+
+include::rest_handlers.asciidoc[Handling REST requests]
+
+include::rest_flowcharts.asciidoc[REST flowcharts]
+
+include::resource_design.asciidoc[Designing a resource handler]
+
+= Websocket
+
+include::ws_protocol.asciidoc[The Websocket protocol]
+
+include::ws_handlers.asciidoc[Handling Websocket connections]
+
+= Internals
+
+include::architecture.asciidoc[Architecture]
+
+include::broken_clients.asciidoc[Dealing with broken clients]
+
+include::middlewares.asciidoc[Middlewares]
+
+include::sub_protocols.asciidoc[Sub protocols]
+
+include::hooks.asciidoc[Hooks]