BookWriting

Pages that have children

These pages should be an overview of the sum total of pages contained below it. It should be a few paragraphs and sum up what's going to take place in the following pages

Pages with no children

These pages should each be pretty long. Generally, you want to start out with a brief introduction, provide an anecdote and then continue in depth on the subject.

Sections

At the very least, each group of pages should have the following:

• A page containing the problem, the state of the art and overview.
• A page containing solutions to the problem and why things are done the way they are
• A page going through examples of how to use the discussed solution

What we're looking for

Bear in mind this is meant to be an instructional book, not an all inclusive reference to the Dojo API. With this in mind, content should be more functional, simple examples that can be expanded upon by even the newest of Dojo users. For example, a page on loading widgets might list the simplest way to include a widget, but not explain how the widget itself works. A second example might consist of how to connect an event using the event system, but not go into the details of working around closures.

The book is meant to show the user the Dojo way, or "Dojo philosophy" as many like to call it. It should enable users to understand the API documentation rather than give them the API documentation.

How to write

Part 1 is meant to focus on the main point of dojo. Event system, io, widgets, fixing the back button. It's building a foundation of the core components that will be filled in as we continue. It's called "Using dojo" because the focus is on the use of our components, not the manipulation of them. Any code should be used to tie things together.

Part 2 is meant to focus on more than just tying things together. We want users to know how to build their own widgets, packages, extend CSS and HTML and get into the nitty gritty of things

Part 3 is a "look into the engine" explaining not only how thing work but why we designed them that way. Like Part 1, it should focus on the major areas, or areas which are particularly interesting.

How to create pages

On any page where the dojo.book sidebar appears (including this page) click "Create new page". The new page will have the currently viewed page selected as its parent by default