Difference between revisions of "Wolfire Wiki Editing Standards"

From Wolfire Games Wiki
Jump to: navigation, search
Line 5: Line 5:
 
This Wiki makes extensive use of templates. Templates allow you to re-use Wiki code and allow for editing of many pages simultaneously.
 
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 code that all templates should contain:
+
This section will contain an comprehensive tutorial on templates, in the meantime here is the format that a template should be in:
  
 
<pre>
 
<pre>
<noinclude><!--
+
<!--
PRIVATE
+
 
Categories --> <!--
+
PRIVATE // Only displayed on this page, not transcluded on pages that use this template
 +
--><noinclude><!--
 +
Categories -->{{CT | Templates}} ...<!--
 
Constants --> <!--
 
Constants --> <!--
Content--> <!--
+
Content --> <!--
 
--></noinclude><!--
 
--></noinclude><!--
  
PUBLIC
+
PUBLIC // Displayed on this page, and transcluded on pages that use this template
 
Categories --> <!--
 
Categories --> <!--
 
Constants--> <!--
 
Constants--> <!--
Content-->
+
Content --> <!--
 +
 
 +
INCLUDED // Not displayed on this page, only transcluded on pages that use this template
 +
--><includeonly><!--
 +
Categories --> <!--
 +
Constants --> <!--
 +
Content --> <!--
 +
--></includeonly>
 
</pre>
 
</pre>
  

Revision as of 08:05, 7 November 2009

Future location of the Wolfire Wiki Editing Standards

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 here is the format that a template should be in:

<!--

PRIVATE // Only displayed on this page, not transcluded on pages that use this template
--><noinclude><!--
Categories -->{{CT | Templates}} ...<!--
Constants --> <!--
Content --> <!--
--></noinclude><!--

PUBLIC // Displayed on this page, and transcluded on pages that use this template
Categories --> <!--
Constants--> <!--
Content --> <!--

INCLUDED // Not displayed on this page, only transcluded on pages that use this template
--><includeonly><!--
Categories --> <!--
Constants --> <!--
Content --> <!--
--></includeonly>

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.