Some of my TOC additions embedded, feel free to comment...
(incorporated the suggestions from issue 21 and those made in this
thread already)
I also added a big section on doing reslet based development as I think
there is a big difference in listing 'what it is and does' versus 'how
one should combine things to solve typical problems'
other suggestions?
regards,
-marc=
Jerome Louvel wrote:
[...]
Here is a draft TOC to start with :)
1. Introduction
1.1. Overview
1.2. Usage scenarios
1.3. Getting Started
(where to download and
showing hello world and environment.cgi like samples)
1.4. Other sources
1.4.1. of reslet.org information
(site mailinglist, issues, books, javadocs...)
1.4.2. of ReST insights, theory and literature
1.5. How to use this manual
2. What's new in Restlet 1.1?
3. Restlet API - Core
(with clear diagrams and 'responsibility-collaboration statements on the
main classes/interfaces
a good exaplanation of instances, I would even want to start with
3.0 Main design principles and benefits
(things like same API for client and server logic, same API for all
protocols, content negotiation on resources' representations)
3.1. Main classes
3.1.1 Uniform, Request and Response classes
3.1.2 Restlet class
3.2. Connectors
3.3. Routers
3.4. Filters
3.5. Components
3.6. Applications
3.7. Resources
4. Restlet API - Extensions
4.1. Atom extension
4.2. FileUpload extension
4.3. FreeMarker extension
4.4. JAXB extension
4.5. JSON extension
4.6. Spring extension
4.7. Velocity extension
4.8. WADL extension
5. Doing Restlet Based Development
5.1. Setting up your environment
5.1.1. with Maven
5.1.2. with Eclipse
5.1.3. with Netbeans
5.1.4. with Intellij
5.1.5. with ant
5.2. Tips and tricks
5.2.1. Caching pitfalls
5.2.2. Logging
5.2.3. Debugging and Tracing
5.2.4. Performance monitoring
5.3. Full Real life samples
5.3.1. restlet.org
5.3.2. petshop?
5.3.3. other?
5.4. Common solutions to common problems
5.4.1 Whatever Problem 1
5.4.2 Whatever Problem 2
... (should mainly refer to other sections above, and just make
combinations of things already explained?
should cover authentication, authorization,
content filtering, stying & skinning, templating,
redoing webMVC pattern? persistence layer, streaming mode,
large representations, push events,
ajax client collaboration, ...)
(introducing above should shift numbers of below course...)
5. Noelios Restlet Engine - Core
5.1. Restlet API engine
5.2. Default HTTP connectors
5.3. Local connectors
5.3.1. File system access
5.3.2. Classloaders access
5.3.3. Web archive access
6. Noelios Restlet Engine - Extensions
6.1. Grizzly HTTP server connector
6.2. Apache HTTP client connector
6.3. JavaMail SMTP client connector
6.4. JDBC client connector
6.5. Jetty HTTP server connector
6.6. JXTA HTTP connectors
6.7. HttpURLConnection client connector
6.8. Servlet container adapter
6.9. SimpleFramework HTTP server connector
8. Contribution Section
8.1. Running Restlet.Org from trunk
8.2. Filing bugs and sending in patches
8.3. Contributing to the documents
8.4. Help spread the word.
(maybe some advise and suggestions on that?)
