book.asciidoc 2.3 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697
  1. // a2x: --dblatex-opts "-P latex.output.revhistory=0 -P doc.publisher.show=0 -P index.numbered=0"
  2. // a2x: --dblatex-opts "-s cowboy"
  3. // a2x: -d book --attribute tabsize=4
  4. = Cowboy User Guide
  5. // REST: where should i handle bindings? init, probably. qs? in media type functions
  6. // REST: explain how a module per media type is good; module may be shared between client/server
  7. // @todo Put the list of RFCs and other documents supported somewhere.
  8. = Rationale
  9. include::modern_web.asciidoc[The modern Web]
  10. include::erlang_web.asciidoc[Erlang and the Web]
  11. = Introduction
  12. include::introduction.asciidoc[Introduction]
  13. include::getting_started.asciidoc[Getting started]
  14. include::flow_diagram.asciidoc[Flow diagram]
  15. = Configuration
  16. include::listeners.asciidoc[Listeners]
  17. include::routing.asciidoc[Routing]
  18. include::constraints.asciidoc[Constraints]
  19. = Handlers
  20. include::handlers.asciidoc[Handlers]
  21. include::loop_handlers.asciidoc[Loop handlers]
  22. include::static_files.asciidoc[Static files]
  23. = Request and response
  24. include::req.asciidoc[Request details]
  25. include::req_body.asciidoc[Reading the request body]
  26. include::resp.asciidoc[Sending a response]
  27. include::cookies.asciidoc[Using cookies]
  28. include::multipart.asciidoc[Multipart]
  29. = REST
  30. include::rest_principles.asciidoc[REST principles]
  31. include::rest_handlers.asciidoc[Handling REST requests]
  32. include::rest_flowcharts.asciidoc[REST flowcharts]
  33. include::resource_design.asciidoc[Designing a resource handler]
  34. = Websocket
  35. include::ws_protocol.asciidoc[The Websocket protocol]
  36. include::ws_handlers.asciidoc[Websocket handlers]
  37. = Advanced
  38. include::streams.asciidoc[Streams]
  39. include::middlewares.asciidoc[Middlewares]
  40. // @todo Rather have two chapters, custom handlers and custom protocol upgrades
  41. include::sub_protocols.asciidoc[Sub protocols]
  42. = Additional information
  43. include::migrating_from_1.0.asciidoc[Migrating from Cowboy 1.0 to 2.0]
  44. // @todo Maybe history? Could take info from architecture also.
  45. include::specs.asciidoc[HTTP and other specifications]
  46. = Deprecated chapters
  47. == About the deprecated chapters
  48. The following chapters were relevant in Cowboy 1.0. They have
  49. not been updated for Cowboy 2.0 yet. The information in these
  50. chapters may or may not be useful.
  51. include::architecture.asciidoc[Architecture]
  52. include::overview.asciidoc[Overview]