Shale Home

Wiki Home

User Docs

Index

Guidelines

Go Up


The aim of this page is to provide some help / guidelines for people editing or adding new pages to the Shale Wiki.

1. Creating New Shale Pages

New Shale pages should be created using the Shale/Template and be sub-pages of the main Shale Wiki Page - enter the name of the page you want to create below and click on the Create new shale page button to do this automatically. For example if you enter Tutorials a page will be created named Shale/Tutorials.

For more information on creating sub-pages see HelpOnEditing/SubPages and HelpOnPageCreation.

2. Organization of Pages

Please consider carefully {1} The name of a page and {2} where the page will go in the structure. If its likely that alot more pages will be created on this subject area, then consider a new sub-page structure. For example, Clay is probably a good candidate for an addtional sub-page structure, so rather than creating a Shale/ClayFAQ page, a more suitable structure might be...

This will allow future Clay pages to be easily added and the standard menu bar Go Up link will allow users to easily navigate back up the structure.

3. Wiki Help and Tips

3.1. Please Use Preview

Every time a page is saved an email message is sent to the Struts Dev mailing list and can create alot of noise there <:( If you use the preview button {1} it renews your lock on the page and {2} allows you to check your changes before saving - hopefully reducing the number of saves you do :)

3.2. WikiNames

(!) One common problem on pages are WikiNames - that is where the wiki automagically creates a link for captialized words such as FooBar, which it assumes are wiki pages. You can prevent this by putting an exclamation mark (i.e. ! ) before the word - for example !FooBar was used in this sentance to render without a link.

Because Shale is a single word rather than WikiName, then simply putting the name of the page doesn't generate a correct link. Below are examples of how to render links to Shale pages in this sub page structure:

Wiki Markup

Rendered Link

Notes

[:Shale/Resources]

Shale/Resources

Specify full page name.

[:Shale/Resources:See Resources]

See Resources

Specify full page name, with different link text

[:../Resources]

../Resources

Relative to parent of this page.

[:../Resources:See Resources]

See Resources

Relative to parent of this page, with different link text.

[:../]

../

Parent page.

[:../:Up]

Up

Parent page, with different link text.

[:/Foo]

/Foo

Link to a sub-page of this page.

[:/Foo:See Foo]

See Foo

Link to a sub-page of this page, with different link text.

3.4. Editing Help Pages

The Shale/Template contains examples of some common page formatting techniques - so when you create a new page, you have something to get started with. For more details about editing see the HelpOnEditing page. The MoinMoin HelpOnEditing page is also sometimes useful and more up to date.

3.5. Table of Symbols

The following table lists the symbols/images available and the wiki markup required to use them:

Markup Display Markup Display Markup Display Markup Display
X-( X-( :D :D <:( <:( :o :o
:( :( :) :) B) B) :)) :))
;) ;) /!\ /!\ <!> <!> (!) (!)
:-? :-? :\ :\ >:> >:> |) |)
:-( :-( :-) :-) B-) B-) :-)) :-))
;-) ;-) |-) |-) (./) (./) {OK} {OK}
{X} {X} {i} {i} {1} {1} {2} {2}
{3} {3} {*} {*} {o} {o}    

4. Proposed Shale Wiki Changes

This is a temporary section (which will eventually) be removed) to discuss further changes in the Shale Wiki structure.

4.1. Move/Delete Existing pages

There are a number of Shale wiki pages that were created before the current structure was put in place. I propose moving the content of these pages to pages that conform to new page naming convention. According to this page we can put redirects from the old pages to the new - so we need to decide the following:

Existing Page

Move Content To

Redirect or Delete Old Page?

StrutsShale

already replaced by Shale page

Redirect

BuildingShale

Shale/!BuildingShale

Delete

ShaleReleasePlans

Shale/Release

Redirect

ShaleRelease100

Shale/Release/Plan100

Delete

ShaleRelease101

Shale/Release/Plan101

Redirect

ShaleValidation

Shale/Validation

Delete

ShaleAndSpring

Shale/Spring

Delete

ShaleTestFramework

Shale/!TestFramework

Delete

ShaleCoreLibrary

Shale/!CoreLibrary

Delete

ShaleRemoting

Shale/Remoting

Delete

One valid question might be why do this? Two reasons:

Shale/WikiGuidelines (last edited 2009-09-20 23:12:48 by localhost)