WikiStructure

From OpenSimulator

(Difference between revisions)
Jump to: navigation, search
(What do we need help with?)
(Informational Tags for Pages)
Line 94: Line 94:
  
 
{{deprecate|Nov. 21 1997|NewArticle}}  
 
{{deprecate|Nov. 21 1997|NewArticle}}  
Purpose: To be used on the pages of deprecated functions. New page is to be created with replacement function. Suggest copying over the content of the page of the deprecated function, and make modifications in the content of the new page.  
+
'''Purpose:''' To be used on the pages of deprecated functions. New page is to be created with replacement function. Suggest copying over the content of the page of the deprecated function, and make modifications in the content of the new page.  
  
 
'''Tag:''' <nowiki>{{deprecate|<MM DD YYYY>|<newname>}}</nowiki>
 
'''Tag:''' <nowiki>{{deprecate|<MM DD YYYY>|<newname>}}</nowiki>
Line 103: Line 103:
  
 
{{thirdparty}}
 
{{thirdparty}}
Purpose: To be used on pages dealing with 3rd party add-ons, modules, and so forth, so as to clearly, uniformly, and effortlessly mark them as 3rd party software.  
+
'''Purpose:''' To be used on pages dealing with 3rd party add-ons, modules, and so forth, so as to clearly, uniformly, and effortlessly mark them as 3rd party software.  
  
 
'''Tag:''' <nowiki>{{thirdparty}}</nowiki>
 
'''Tag:''' <nowiki>{{thirdparty}}</nowiki>

Revision as of 17:54, 26 December 2010

Technical Reference -> Terms -> Editing WikiStructure

Contents

Contributing to the Wiki

Thank you for wanting to help with the wiki, but before you start, it is very important that you have a basic understanding of how to edit a wiki, and how it works

Here are a few basic wiki-specific tags and concepts:

  1. In a wiki, you don't need HTML. Instead, use the Wiki markup equivalents.
  2. Want to link to another page? Take the name of the page (not the URL!) and put them in double square brackets, like so: [[Example]]. After saving the page, it will look like Example. This is called an internal link.
  3. If you want preformatted text, don't use <pre></pre>, but simply start the sentence with a single space.
  4. If you create a new page, add it to a category. To do so, first go to category:categories and from there, find the category that would be best suited for your article. Then add the text [[Category:NameOfCategory]] to your page. If after saving, the name of the category shows up in red text at the bottom of the page, then you chose a non-existant category, and you should check the exact spelling of that category.
  5. To add an internal link to a category, add a colon before the word "category", so that it looks as follows: [[:Category:NameOfCategory]]. If you neglect to add that colon, then your page will be added to that category instead of creating a link.
  6. Want a table? Use Wiki markup! It's faster, and smaller. To convert existing HTML tables to Wiki markup, you can use the online tool at http://www.uni-bonn.de/~manfear/html2wiki-tables.php which does a pretty good job.
  7. NEVER EVER just empty a page. The information, no matter how outdated it may be, may still hold value for some people. If you believe that a page should be deleted instead of being archived, add the text {{delete|Your reason for wanting the page deleted}} to the top of the page, and save it. A sysop (a.k.a. Wiki admin) will then review your proposal to delete, and if accepted, will delete the page.

For more info on how to edit Wiki pages, see http://www.mediawiki.org/wiki/Help:Editing

What do we need help with?

There are a lot of pages in the opensim wiki today, many of which aren't really up to snuff.

Have a look around, and if you find an article that you think you can add to, then feel free to do so. One place to look could be The stubs category.

Another way to help, is to go through and tag pages. See below for tags and templates that you could apply to the pages in the wiki.

What else is there to be done?

  • Update Navigation links - Mark Malewski
  • Check the WIKI for orphan pages and bad links - Mark Malewski
  • Twist the developer's arms, and try to get updated content for WIKI pages - Mark Malewski
  • Mind Map for the Wiki - SeanDague

See also WikiTodo

Wiki Office Hours

Wright Plaza on Thursday Afternoons at 19:00 GMT. Come there to help us make the OpenSim wiki a world class information resource for OpenSim. See Office Hours for up-to-date information about this meeting.

Tags

The following macros should be used to tag pages that are not up to par. This will help us keep a list of things needed to improve the wiki. Don't worry too much about marking a page incorrectly, tagging these pages makes them show up under various Categories and wiki admins will clear tags if they aren't appropriate.

Pages That Need Fixing

Purpose: This page had good information at one point, but it is too out of date to really have value now. We need to capture the information in another page, or do major work to bring the page up to date.

Tag: {{obsolete}}


Purpose: The information on this page is out of date. However, it may still hold value to some people (examples are chat logs, version history, or OpenSim 0.6x specific info) or needs to be preserved for other reasons. It should be marked as archived information to prevent confusion.

Tag: {{archive}}


Purpose: While the content of the page is good, it's too hard to understand without examples. We'd like to get examples into this page to make it more user friendly.

Tag: {{needsexample}}


Purpose: This page has a little bit of information, but it's very incomplete. It probably can stay in the same place but needs more helping hands.

Tag: {{content}}


Pages that need deleting (use sparsely!)

Purpose: This page does not belong on the wiki. It contains spam, is an empty page, a vanity page, or is considered rubbish otherwise.

Always specify the reason for the delete request. Without one, the page will not be deleted.

Tag: {{delete|Reason}}

Example: {{delete|This is an example of the delete tag.}}


Template:Spam Purpose: This template is to be used on pages that are, or contain spam.

Tag: {{spam}}

Informational Tags for Pages

Purpose: This is used on pages that represent future proposals, so that people don't get the idea that this is the way that opensim currently works.

Tag: {{proposal}}



Purpose: To be used on the pages of deprecated functions. New page is to be created with replacement function. Suggest copying over the content of the page of the deprecated function, and make modifications in the content of the new page.

Tag: {{deprecate|<MM DD YYYY>|<newname>}}

Example: {{deprecate|Nov. 21 1997|NewArticle}}



Purpose: To be used on pages dealing with 3rd party add-ons, modules, and so forth, so as to clearly, uniformly, and effortlessly mark them as 3rd party software.

Tag: {{thirdparty}}

Personal tools
General
About This Wiki