Difference between revisions of "Wolfire Wiki Editing Standards"

From Wolfire Games Wiki
Jump to: navigation, search
(Templates)
Line 1: Line 1:
 
Future location of the Wolfire Wiki Editing Standards
 
Future location of the Wolfire Wiki Editing Standards
  
==Templates==
+
==Editing==
 
 
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 here is the format that a template should be in:
+
Here is the format that all code should be in:
  
 
<pre>
 
<pre>
Line 30: Line 28:
  
 
</pre>
 
</pre>
 +
 +
For example, a typical template has this code:
 +
 +
<pre>
 +
<!--
 +
 +
PRIVATE // Only displayed on this page, not transcluded on pages that use this template
 +
--><noinclude><!--
 +
Categories -->{{CT|Templates}}<!--
 +
Content -->
 +
This is an example template
 +
<!--
 +
--></noinclude><!--
 +
 +
INCLUDED // Not displayed on this page, only transcluded on pages that use this template
 +
--><includeonly><!--
 +
Content --> //THIS IS WHERE THE TEMPLATE STUFF GOES//<!--
 +
--></includeonly>
 +
 +
PUBLIC // Displayed on this page, and transcluded on pages that use this template
 +
-none-
 +
-->
 +
</pre>
 +
 +
 +
==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==
 
==Learning by Example==

Revision as of 23:11, 9 November 2009

Future location of the Wolfire Wiki Editing Standards

Editing

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 // Only displayed on this page, not transcluded on pages that use this template
--><noinclude><!--
Categories -->{{CT|Templates}}<!--
Content -->
This is an example template
<!--
--></noinclude><!--

INCLUDED // Not displayed on this page, only transcluded on pages that use this template
--><includeonly><!--
Content --> //THIS IS WHERE THE TEMPLATE STUFF GOES//<!--
--></includeonly>

PUBLIC // Displayed on this page, and transcluded on pages that use this template
-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.


  • Wikipedia The Behemoth that started it all. Examine their extensive code at your own risk.