Introduction

This is the original announcement] documentation Wiki. It's intended to help capture information for the Cocoon documentation project. According to the [http://marc.theaimsgroup.com/?l=xml-cocoon-docs&m=102872966215640&w=2 this can be seen as "some kind of breeding pool where documentation can grow until it is mature enough to be migrated to the official Cocoon Documentation".

Feel free to add new content to this Wiki, including (but not limited to):

  • Tutorials – tutorials on particular aspects of Cocoon
  • HowTos – quick 'HOW TO' documents, describing how to use a particular piece of functionality
  • Snippets – scraps of documentation, perhaps grabbed from one of the CocoonMailingLists
  • FAQs – Frequently Asked Questions
  • Wishlist – Are there bits of Cocoon you'd like to see documented?
  • RT – proposed enhancements to Cocoon

Getting Started

You can find plenty of documentation, tips, editing examples, etc. at the MoinMoinWiki

Basically a Wiki is a web site where everyone can freely add contents to the pages or create new pages. The Portland Pattern Repository Wiki contains a lot of information about what Wiki are and how they work.

If you're new to Wiki sites, then have a play in the SandBox where you can try out page editing without breaking anything important.

You can then create a page for yourself, with links to your home page, email address, etc. Just click on UserPreferences and enter your name. Once you've created your page, then make a link to it from People.

See also HowToCreateNewPages.

Note: if you don't set the UserPreferences then your name won't appear next to edits in the RecentChanges page, just your IP address. If you've created your own page, then your name will be automatically linked – LeighDodds

Help

  • There's a search box on any page, so you can enter keywords to search the entire Wiki if you can't find something directly.
  • The left menu has a number of useful navigation options to help you find your way around:
    • Direct links to table of contents pages for various sections of this Wiki.
    • Recent Changes shows which pages have altered, and by who.
    • Undefined Pages indicates pages which have been referenced, but not created yet. This can be used as a "to-do list" if you want to write some content.
    • Referenced By lists pages that have links to the one you're currently looking at. Useful for navigating around a particular topic
  • There is an RSS 1.0 feed for this Wiki, so you can monitor changes using an RSS reader, or have the changes automatically integrated into your blog. There's an orange XML button on the navigation bar that links to the feed. If you're running Radio Userland then click on the other button to automatically subscribe.
  • JSPWiki is safe against concurrent modification of pages: if two users try to modify the same page at the same time, the user who last tries to save the modified page gets a nice warning about what's happening. Try it with two different browsers if you don't believe me (wink)

Wiki Etiquette

It's usually good Wiki etiquette to label your comments with your name, e.g:

I think that's a great idea – LeighDodds. #1

See also the JSPWiki etiquette page.

License

Before contributing to this Wiki, please read the License.

Readers comments

I'm wondering if/when we should use footnotes for comments instead of writing comments online. In DistributingCocoonApplications, for example, I find footnotes good as they keep the original text clean. – BertrandDelacretaz

I'd say use what works. For example it may get tricky adding footnotes to footnotes!. The main point is to ensure that you label your comments, so everyone knows who is making them. We can evolve other suggestions over time – LeighDodds

What keeps malicious users from tampering with other peoples work??? – Kris ... We do! Yes, we are watching.

Shouldn't everypage have a "comments" type of section, or is it good ettiquitte to type comments straight in the body? – KeithMarais

  • No labels