Dear Wiki user, You have subscribed to a wiki page or wiki category on "Struts Wiki" for change notification.
The following page has been changed by NiallPemberton: http://wiki.apache.org/struts/Shale/WikiGuidelines The comment on the change is: Improve wiki tips and add proposed changes section ------------------------------------------------------------------------------ + #pragma section-numbers on ||<rowbgcolor="#FFFFE0">[http://struts.apache.org/struts-shale/index.html Shale Home]||[:Shale:Wiki Home]||[:Shale/UserDocs:User Docs]||[:Shale/SiteMap:Index]||[:Shale/WikiGuidelines: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'''. - = Shale Wiki Guidelines = - The aim of this page is to provide some '''''guidelines''''' for people adding/editing the '''Shale Wiki Pages''' so that it doesn't become too disorganized. + [[TableOfContents]] - == Organization of Pages == - New Shale pages should be creates as '''sub-pages''' of the [:Shale:Main Shale Wiki Page]. For more information on creating sub-pages see HelpOnEditing/SubPages. A [:Shale/Template] has been created so that its easier to creates pages with a common L&F and facilitate navigation around the Shale Wiki. The easiest way to create a new page is to use the facility below. - == Creating a new Page == + == 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'''''. - - Enter the name of the page you want to create below and click on the ''Create Page'' button. This has been configured to use the [:Shale/Template] and make the page a ''child'' of the main [:Shale:Shale Wiki Page]. For example if you enter ''Tutorials'' a page will be created named '''''Shale/Tutorials''''' [[NewPage(Shale/Template,Create new shale page,Shale)]] + For more information on creating sub-pages see HelpOnEditing/SubPages and HelpOnPageCreation. - == Help on Using the Wiki == - The [:Shale/Template] contains examples of the most common page formatting techniques. For more details see the HelpOnEditing page and also the StrutsWikiTips. + == 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... + * {{{Shale/Clay}}} - Clay ''home'' page + * {{{Shale/Clay/FAQ}}} - Clay frequently asked questions + + 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. + + == Wiki Help and Tips == + === 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 :) + + === WikiNames === + (!) One common problem on pages are [:WikiName: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. + + === Help with Links === + 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]}}} || [:Shale/Resources:See Resources] || Specify full page name, with different '''link''' text || + || {{{[:../Resources]}}} || [:../Resources] || Relative to parent of this page. || + || {{{[:../Resources:See Resources]}}} || [:../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]}}} || [:/Foo:See Foo] || Link to a sub-page of '''this''' page, with different '''link''' text. || + + === 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 [http://moinmoin.wikiwikiweb.de/HelpOnEditing MoinMoin HelpOnEditing] page is also sometimes useful and more up to date. + + === Table of Symbols === + The following table lists the symbols/images available and the ''wiki markup'' required to use them: + + [[ShowSmileys]] + + [[Anchor(proposal)]] + == Proposed Shale Wiki Changes == + This is a temporary section (which will eventually) be removed) to discuss further changes in the Shale Wiki structure. + + === 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 [http://moinmoin.wikiwikiweb.de/HelpOnProcessingInstructions#head-90fe7c2176c1dfa6f2de86245c9d7dde868dc64c this page] we can put '''redirects''' from the old pages to the new - so we need to decide the following: + * Don't agree with this - leave the old pages as they are + * Move the content to the new pages and get wiki admin. to '''delete''' old pages. + * Move the content to the new pages and put '''redirects''' on the old pages. + + + || '''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: + * Easier for User Navigation and linking, using the '''sub-page''' structure. + * Pages Named Shale/!SomePage are automatically included in the [:../SiteMap:Index] page. + --------------------------------------------------------------------- To unsubscribe, e-mail: [EMAIL PROTECTED] For additional commands, e-mail: [EMAIL PROTECTED]
