Welcome to the AJAX Cookbook!

Create a new Cookbook Recipe

Contributing

Cookbook entries should be named in the format [ShortDescription]. Try to keep description to 3-5 words max.

Please follow similar style to that used in other entries (including note boxes, code boxes etc).

Tagging a Recipe

I have tried to make this as painless as possible so that people start tagging recipes more. When you create your recipe there should be a form at the bottom which allows you tag a recipe based on keywords relevant to it. Please make good use of these to enable people to find recipes more easily. To add additional tags click on the links for the tag list on the left of the table and edit that page.

Writing a Recipe

• Give a few sentences explaining the use-case and outline the problem
• Try to provide sufficient context in code/config snippets
  • Don't just give the 1-line xml config, show how it fits into the bigger picture
• However, keep snippets concise and relevant
  • Avoid excessive //comments
  • Don't need imports
  • Don't need class/method context if just showing API call
• Try to show before/after output of the particular method
• Link to relevant docs (i.e. more detail in user guides)
• Use note boxes to hi-light any issues around the particular recipe
• Add any suggestions to CookbookSuggestions