Difference between revisions of "Wolfire Wiki Editing Standards"
(→Introduction) |
|||
| Line 1: | Line 1: | ||
| + | [[Category:Tutorials]] | ||
| + | [[Category:Help]] | ||
| + | [[Category:Wolfire]] | ||
| + | |||
<!-- | <!-- | ||
| Line 12: | Line 16: | ||
Content --> | Content --> | ||
Future location of the Wolfire Wiki Editing Standards | Future location of the Wolfire Wiki Editing Standards | ||
| − | |||
| − | |||
| − | |||
=Introduction= | =Introduction= | ||
| Line 20: | Line 21: | ||
For starters if you are reading this page it means you want to help with the wiki. Yay for you! | For starters if you are reading this page it means you want to help with the wiki. Yay for you! | ||
| − | Now, the first step is to log in at the top right corner using your 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. | + | 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 is 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. | 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. | ||
| Line 28: | Line 31: | ||
Just remember that there are many categories already available, and typos will add your thing into another category. So double check and if you don't see any category that fits create your own. | Just remember that there are many categories already available, and typos will add your thing into another category. So double check and if you don't see any category that fits create your own. | ||
| + | |||
| + | Contents are 'organized' by adding: | ||
| + | <pre> | ||
| + | ={1}Intro= | ||
| + | =={1.1}Thing== | ||
| + | ==={1.1.1}partOfThingOne=== | ||
| + | ==={1.1.2}partOfThingTwo=== | ||
| + | =={1.2}OtherThing== | ||
| + | ={2}(actually no idea what this should be)= | ||
| + | ... | ||
| + | ... | ||
| + | ... | ||
| + | </pre> | ||
| + | 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== | ==Editing== | ||
| + | ANYONE WHO UNDERSTANDS THIS SECTION PLEASE EXPLAIN IT MORE | ||
Here is the format that all code should be in: | Here is the format that all code should be in: | ||
| Line 88: | Line 107: | ||
This section will contain an comprehensive tutorial on templates, in the meantime | This section will contain an comprehensive tutorial on templates, in the meantime | ||
| + | |||
==Learning by Example== | ==Learning by Example== | ||
Revision as of 06:36, 16 June 2011
Future location of the Wolfire Wiki Editing Standards
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 is 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 please, for the love of god, add a category to the file you will upload or the article you will write. You do that by adding this to the BEGINNING of your page:[[Category:what ever you want]] [[Category:]] (for your copy and pasting needs)
Just remember that there are many categories already available, and typos will add your thing into another category. So double check and if you don't see any category that fits create your own.
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, a typical template has this code:
<!--
PRIVATE
--><noinclude><!--
Categories --><!--
--></noinclude><!--
Categories -->{{CT|Templates}}<!--
Content -->
This is an example template
<!--
--></noinclude><!--
INCLUDED
--><includeonly><!--
Content -->THIS IS WHERE THE TEMPLATE STUFF GOES<!--
--></includeonly>
PUBLIC
-none-
-->
Templates
This Wiki makes extensive use of templates. Templates allow you to re-use Wiki code and allow for editing of many pages simultaneously.
This section will contain an comprehensive tutorial on templates, in the meantime
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.
