templatedocumentation  

Contents [hide]
This is an example page of how we can possibly have documentation set up on template pages to help several issues I have witnessed several times.
  1. Users are unsure of how to use different templates
  2. Users unsure which template applies to which Game-Specific Wiki.
  3. Lack of documentation on what each field does.
  4. Not every user knows terminology like "parameter" "commalist" "switch" e.t.c
  5. Users find no uniformity between templates pages inside a game specific wiki, let alone zam-wide
  6. We shouldnt assume the user knows anything about wikis, only they wish to try it out but not feel that stuff is off-limits to them.

I have checked that this works still with minimum width of the page.

If we get a decision to use this system on future templates then I can create more applicable documentation for users and admins to understand it.

Blank Example with Layout

Current Server Compile Time:
Previous Server Compile Time:
Intended For:
What does this Template Do?

Template Example

You can copy and paste the code below and add in applicable content immediately after/below the "=" sign.

Fields to Fill In:
These are fields that can be filled in before you save the page with the template.
  • "Required" means you MUST fill in this field before you save the page.
  • "Optional" means you dont have to fill in anything after the '''='
  • "Switch" means if you want to activate its function means you place a "y" after the =
Field/Function Requirement Description Example Input

If you are unsure what all this means, you can check out the Templates help page.

space for wiki admin sig and gametag here

Example with Content Added

Current Server Compile Time: 120ms
Previous Server Compile Time: n/a
Intended For: All Future Templates
What does this Template Do?
This is a test description to show you where it would go when users see it

Template Example

You can copy and paste the code below and add in applicable content immediately after/below the "=" sign.

{{test template Code
|parameter1=
|parameter1=
|parameter1=
|parameter1=
|}}

Fields to Fill In:
These are fields that can be filled in before you save the page with the template.
  • "Required" means you MUST fill in this field before you save the page.
  • "Optional" means you dont have to fill in anything after the '''='
  • "Switch" means if you want to activate its function means you place a "y" after the =
Field/Function Requirement Description Example Input
|parameter1= Required This is a test Description |parameter1=bdifsdfha
|parameter1= Required This is a test Description |parameter1=
bdifsdfha
|parameter1= Optional This is a test Description |parameter1=bdifsdfha
|parameter1= Switch This is a test Description |parameter1=bdifsdfha
If you are unsure what all this means, you can check out the Templates help page.

Mini Explanations of why I built it this way

  • Some templates are obviously nested and not commalists (Template Fields, and Parameters) to keep individual information seperate for easy editing by future wiki admin.

  • Currently takes 80ms for a blank documentation setup to be compiled. a complex one (like potential mobs/quest/item templates) can handle up to 30 template fields in the documentation without going over 300ms

Bohtauri
ZAM Wikibase Administrator
This template is maintained by Bohtauri. If you have any suggestions or know of any bugs in this page I am more than happy to help you out. We can chat via Private Message. Put in the subject the name of this page and i'll get back to you asap. 		PM Bohtauri
Bohtauri Wiki Profile
All Maintained Pages
Wiki Editing Help
How to Use This
Documentation

ZAM Network
Wikibase™

Categories: Templates Maintained by Bohtauri | ZAM Network
This page last modified 2011-01-17 21:46:11.
© 2024 Fanbyte LLC