Introduction

This is the Scarab Wiki. It's intended to help capture information for the Scarab project. 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 Scarab Documentation".

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

  • Tutorials -- tutorials on particular aspects of Scarab
  • How-Tos -- quick descriptions of how to use particular functionality
  • FAQs -- Frequently Asked Questions
  • Wishlist -- Are there bits of Scarab you'd like to see documented?
  • Random Thoughts -- proposed enhancements to Scarab

Getting Started

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 Sand Box 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 User Preferences 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 User Preferences then your name won't appear next to edits in the Recent Changes page, just your IP address. If you've created your own page, then your name will be automatically linked --

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
  • 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 it ;-)

Wiki Etiquette

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

I think that's a great idea -- Hussayn Dabbous.

In order to avoid destroying the textflow of the original page, you can always enter a footnote by placing a [#] besides what you want to comment (where the '#' denotes a small unique number and add a "footnote" at the end of the page. check this in the editor: [1]

See also the JSPWiki etiquette page.

License

Before contributing to this Wiki, please read the license agreement.


Readers comments

[#1] This is my comment -- Hussayn Dabbous

Add new attachment

Only authorized users are allowed to upload new attachments.
« This page (revision-1) was last changed on 16-May-2008 17:24 by unknown [RSS]