Difference between revisions of "Wolfire Wiki Editing Standards"
m (→Useful Examples) |
m |
||
| Line 80: | Line 80: | ||
</pre> | </pre> | ||
| − | |||
For example, the to-do list template uses this code: | For example, the to-do list template uses this code: | ||
| − | <pre> | + | <pre>{{stub}} |
| − | {{stub}} | ||
<!-- | <!-- | ||
PRIVATE // Only displayed on this page, not transcluded on pages that use this template | PRIVATE // Only displayed on this page, not transcluded on pages that use this template | ||
--><noinclude><!-- | --><noinclude><!-- | ||
| − | Categories --> {{CT| | + | Categories --> {{CT| Main Page}} {{CT| Wiki Contributors}}<!-- |
Constants --> <!-- | Constants --> <!-- | ||
Content --> | Content --> | ||
=Introduction= | =Introduction= | ||
| − | The way this works is that if you have or currently contributing to the wiki | + | The way this works is that if you have or currently contributing to the wiki put your work or progress in the "Fresh" section. If no work has been done on the task for two weeks it will go "stale". Please try to keep things fresh and move things to "Stale" if you a) can't work on it or b) see no progress for a while. It is up to you to keep things fresh! Please help us out. |
| − | put your work or progress in the "Fresh" section. | ||
| − | If no work has been done on the task for two weeks it will go "stale". | ||
| − | Please try to keep things fresh and move things to "Stale" if you a) can't work on it or b) see no progress for a while. | ||
| − | It is up to you to keep things fresh! Please help us out. | ||
Then when you are sure that you are completely finished put it in the "Finished" category. | Then when you are sure that you are completely finished put it in the "Finished" category. | ||
| + | |||
| + | (I would like to create a template to add here anything that has the improvement needed template in it. If you know how to do that please go ahead) | ||
==Format== | ==Format== | ||
Here is how you write the things in the list. | Here is how you write the things in the list. | ||
| − | + | ||
| + | pre | ||
*What needs done [[link to where you should go]] [[link to how to do it]] | *What needs done [[link to where you should go]] [[link to how to do it]] | ||
dd/mm/yy something meaningful was last done | dd/mm/yy something meaningful was last done | ||
**List of things that need to be done before finishing the parent task | **List of things that need to be done before finishing the parent task | ||
| − | + | /pre | |
| − | I just listed a top/down approach to creating the to-do list. | + | I just listed a top/down approach to creating the to-do list. If you prefer the bottom/up approach then post the children tasks by themselves with links to their parents. |
| − | If you prefer the bottom/up approach then post the children tasks by themselves with links to their parents. | ||
<!-- | <!-- | ||
--></noinclude> | --></noinclude> | ||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
=To-do List= | =To-do List= | ||
==Fresh== | ==Fresh== | ||
| − | * Help create wiki editing standards. [[Wolfire_Wiki_Editing_Standards | Help here!]] 16/6/11 | + | * Help create wiki editing standards. [[Wolfire_Wiki_Editing_Standards | Help here!]] 16/6/11 theres a lot to do in [[Wolfire_Wiki_Editing_Standards]] |
| − | theres a lot to do in [[Wolfire_Wiki_Editing_Standards]] | ||
**Explaining editing format | **Explaining editing format | ||
**Finding good examples of wiki editing not just generic ones | **Finding good examples of wiki editing not just generic ones | ||
| Line 138: | Line 118: | ||
**Add suggestions from SPF | **Add suggestions from SPF | ||
**Add tutorials from SPF | **Add tutorials from SPF | ||
| − | **Get people to post/upload their art and/or mods | + | **Get people to post/upload their art and/or mods to the wiki |
***Make a tutorial page on how to upload stuff to the wiki | ***Make a tutorial page on how to upload stuff to the wiki | ||
| + | * Check categories [[Special:Categories | Help here!]] | ||
==Stale== | ==Stale== | ||
| + | * Find places for the [[Special:DeadendPages |deadened pages]] | ||
* How to create and use templates correctly [[Wolfire_Wiki_Editing_Standards | VERY IMPORTANT]] | * How to create and use templates correctly [[Wolfire_Wiki_Editing_Standards | VERY IMPORTANT]] | ||
* Set up a system that makes it easy to add items to the "Fresh", "Stale", or "Finished" lists | * Set up a system that makes it easy to add items to the "Fresh", "Stale", or "Finished" lists | ||
| Line 149: | Line 131: | ||
* The OG graphics features page needs work [[Graphics | Help here!]] | * The OG graphics features page needs work [[Graphics | Help here!]] | ||
* Categorize all images (link to [[Special:UncategorizedImages |Uncategorized Images]]) | * Categorize all images (link to [[Special:UncategorizedImages |Uncategorized Images]]) | ||
| − | + | * Identify and update out of date, stub and duplicate pages [[:Category:Improvement Needed Templates| Use the Templates from here!]] | |
| − | * Identify and update out of date, stub and duplicate pages [[:Category:Improvement Needed Templates| | ||
* Fully set up the various portals [[:Category:Portals|Help Here!]] | * Fully set up the various portals [[:Category:Portals|Help Here!]] | ||
* Finish front page. | * Finish front page. | ||
| − | * Much, much more... | + | * [[:Category:Improvement_Needed| Much, much more...]] |
==Finished== | ==Finished== | ||
Revision as of 08:38, 17 June 2011
Work in Progress: Comments & Edits Welcome
Future location of the Wolfire Wiki Editing Standards
Contents
Introduction
For starters if you are reading this page it means you want to help with the wiki. Yay for you!
We are still very much unorganized, so contributing at this stage is important. I'm actually making all of this up as I go along. You can help decide how things are organized by joining the Wolfire Forums and discussing the crap out of how bad the wiki is and how it should be.
Now, the first step is to log in at the top right corner using your wolfire (does it need to be SPF?) login (if you have an underscore in your handle/alias/name you might have some trouble). Only after logging in can you then begin to contribute to the wiki.
Editing a wiki may seem like a daunting task if you don't know that much about modding, code or wikis, but it really only requires common sense to edit a wiki. No knowledge of code is needed. There are a few basic formatting markers but those are easy to pick up. It's more important to know how to communicate through your words than to code.
Remember the more you help, the easier it becomes for the next person to contribute and learn.
Just remember that there are many categories already available, and typos will add your page into another category. So double check and if you don't see any category that fits ask before creating your own. List of Categories
Here's the wikipedia page on categorization. [1] [2]
Contents are 'organized' by adding:
={1}Intro=
=={1.1}Thing==
==={1.1.1}partOfThingOne===
==={1.1.2}partOfThingTwo===
=={1.2}OtherThing==
={2}(actually no idea what this should be)=
...
...
...
- There is still no wolfire wiki convention yet to how you should organize your page. When it happens, though, please stick to the convention.
Editing
ANYONE WHO UNDERSTANDS THIS SECTION PLEASE EXPLAIN IT MORE
Here is the format that all code should be in:
<!-- PRIVATE // Only displayed on this page, not transcluded on pages that use this template --><noinclude><!-- Categories --> <!-- Constants --> <!-- Content --> <!-- --></noinclude> <!-- INCLUDED // Not displayed on this page, only transcluded on pages that use this template --><includeonly><!-- Categories --> <!-- Constants --> <!-- Content --> <!-- --></includeonly> PUBLIC // Displayed on this page, and transcluded on pages that use this template Categories --> <!-- Constants--> <!-- Content -->
For example, the to-do list template uses this code:
{{stub}}
<!--
PRIVATE // Only displayed on this page, not transcluded on pages that use this template
--><noinclude><!--
Categories --> {{CT| Main Page}} {{CT| Wiki Contributors}}<!--
Constants --> <!--
Content -->
=Introduction=
The way this works is that if you have or currently contributing to the wiki put your work or progress in the "Fresh" section. If no work has been done on the task for two weeks it will go "stale". Please try to keep things fresh and move things to "Stale" if you a) can't work on it or b) see no progress for a while. It is up to you to keep things fresh! Please help us out.
Then when you are sure that you are completely finished put it in the "Finished" category.
(I would like to create a template to add here anything that has the improvement needed template in it. If you know how to do that please go ahead)
==Format==
Here is how you write the things in the list.
pre
*What needs done [[link to where you should go]] [[link to how to do it]]
dd/mm/yy something meaningful was last done
**List of things that need to be done before finishing the parent task
/pre
I just listed a top/down approach to creating the to-do list. If you prefer the bottom/up approach then post the children tasks by themselves with links to their parents.
<!--
--></noinclude>
=To-do List=
==Fresh==
* Help create wiki editing standards. [[Wolfire_Wiki_Editing_Standards | Help here!]] 16/6/11 theres a lot to do in [[Wolfire_Wiki_Editing_Standards]]
**Explaining editing format
**Finding good examples of wiki editing not just generic ones
* Add [[Wolfire_Games_Wiki:Community_Portal | fan suggestion place]] 16/6/11
**Add suggestions from SPF
**Add tutorials from SPF
**Get people to post/upload their art and/or mods to the wiki
***Make a tutorial page on how to upload stuff to the wiki
* Check categories [[Special:Categories | Help here!]]
==Stale==
* Find places for the [[Special:DeadendPages |deadened pages]]
* How to create and use templates correctly [[Wolfire_Wiki_Editing_Standards | VERY IMPORTANT]]
* Set up a system that makes it easy to add items to the "Fresh", "Stale", or "Finished" lists
* Build an official Wolfire Tutorials page using previous Wolfire blog posts
* [[Overgrowth_Alpha_FAQ | OG FAQ]]
* [[Lugaru | Lugaru page]], specifically the walkthrough guide.
* The OG graphics features page needs work [[Graphics | Help here!]]
* Categorize all images (link to [[Special:UncategorizedImages |Uncategorized Images]])
* Identify and update out of date, stub and duplicate pages [[:Category:Improvement Needed Templates| Use the Templates from here!]]
* Fully set up the various portals [[:Category:Portals|Help Here!]]
* Finish front page.
* [[:Category:Improvement_Needed| Much, much more...]]
==Finished==
* Categorize all pages as of 16/6/11 (link to [[Special:UncategorizedPages |Uncategorized Pages]])
Templates
- SOMEONE WHO UNDERSTANDS THIS STUFF SHOULD HELP ASAP
The sooner its done, the sooner more people can learn how to contribute to the wiki.
This section should contain a more comprehensive tutorial on templates and how to build them. We also need a link to all of the templates that this wiki currently has in use.
This Wiki makes extensive use of templates. Templates allow you to re-use Wiki code and allow for editing of many pages simultaneously.
For instance:
<center>{{WQA in Progress}}</center>
adds
Work in Progress: Comments & Edits Welcome
In Category:Improvement Needed Templates there are a list of improvement templates. Open them up and see how they work. It will help you with understanding how to write you own.
Learning by Example
Any wiki using the standard wiki engine will allow you to see its source, and so it's easy to learn how to create an awesome wiki: all you have to do is look at their code
You can do that by either clicking "Edit"/"Edit this page" or "Source"/"View source".
Useful Examples
Note: These examples were not picked for any reason apart from being educational resources.
- Wikipedia The Behemoth that started it all. Examine their extensive code at your own risk.
- Wikia Not one wiki, but a vast collections of wikis hosted in one location.
- A variety of cool Wikia Wikis:
Next Phase
Now get to the To Do List and start helping the wiki stay fresh.
