Difference between revisions of "Wolfire Wiki Editing Standards"

From Wolfire Games Wiki
Jump to: navigation, search
m (→‎Content Box)
m (→‎Example Two)
Line 131: Line 131:
 
===Example Two===
 
===Example Two===
  
−
The to-do list template looks like this: {{Wolfire Wiki To Do}}
+
The to-do list template <pre>{{Wolfire Wiki To Do}}</pre> adds this: {{Wolfire Wiki To Do}}
  
 
----
 
----

Revision as of 20:30, 19 June 2011

Work in Progress Work in Progress: Comments & Edits Welcome


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 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.

Categories

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 are some help pages on categorization:

Editing a Wiki Page

  • ANYONE WHO UNDERSTANDS THIS SECTION PLEASE EXPLAIN IT MORE

Wiki Code

This article is a stub. You should help Wolfire by expanding it.

Here is the format that all edit code should start out with: 

<!--
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 -->

Links

To add links in your page you use: 

to link to a page:

[[page_name |Page Name]] == Page Name

[[page name]] == page name

to link to a category its important not to forget the colon ':' in front:

[[: category: Wiki Contributors]] == category: Wiki Contributors

you can also link to a special page by:

[[special: Special Page]] == special: Special Page

Content Box

This article is a stub. You should help Wolfire by expanding it.
Contents are 'organized' by adding: 

=={1}Intro==
=={2.1}Thing==
==={2.1.1}partOfThingOne===
==={2.1.2}partOfThingTwo===
=={3}OtherThing==
=={4}(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.

Templates

This article is a stub. You should help Wolfire by expanding it.


* 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.

Example One

For instance: 

<center>{{WQA in Progress}}</center>

adds

Work in Progress 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.

Example Two

The to-do list template 
{{Wolfire Wiki To Do}}
adds this:

Fresh

Uhoh...

Stale

Finished

  • Went through and categorized all files... whew...

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

This article is a stub. You should help Wolfire by expanding it.


Note: These examples were not picked for any reason apart from being educational resources.

Category:Tutorials

Next Phase

Now goto to the Category: Wiki Contributors page and see whats happening with the wiki.

Retrieved from "https://wiki.wolfire.com/index.php?title=Wolfire_Wiki_Editing_Standards&oldid=2727"