Minecraft Wiki:Projects/Template documentation cleanup

This project plans to rewrite the documentation of templates to make them easy to understand for the common user. They can be organized on so many different ways that there should be a common style of how they should be written.

Template documentation

 * The current general layout to write a documentation:


 * 1) Lead text explaining the template's purpose.
 * 2) (Sometimes) Parameters section
 * 3) (If required, sometimes) Specific parameter subsection.
 * 4) Usage section
 * 5) (If needed, optional) Example section
 * 6) See also section


 * That should be changed to this:


 * 1) Lead text explaining the template's purpose.
 * 2) Usage section
 * 3) (If required) Parameters subsection
 * 4) (If required) Specific parameter subsubsection.
 * 5) (If needed, optional) Example section
 * 6) See also section

Message boxes
Message box templates are the most used ones, and they should be (for now) the main priority of the project.

The Usage section has to use  to display all the parameters on the template, and below that goes the explanation of all the existent parameters, using either   or   (preferably using  ) being followed by specifications. If required, a parameter can have specifications below the general list of parameters.

Below that goes the optional Example section, which isn't required normally, but if the parameters become too confusing for ediors, a general explanation using examples is the best way to solve that. Finally goes the See also section, whish lists related or similar templates, using  to start a subdivision to divide the types of templates there.

This is how the documentation of the stub template looks, and should be the general style for this type of templates:

Infoboxes
Infoboxes are the second most important type of templates used on the wiki, so they are also part of the main priority (not the main focus for now).

The Usage section has to use  to display all the parameters on the template. Then goes a table showing all the existent parameters, their descriptions, and a note if needed. If required, a parameter can have specifications below the general list of parameters, on a specific subsection.

Below that goes the optional Example section, which isn't required normally on these templates. Finally goes the See also section, whish lists related or similar templates, using  to start a subdivision to divide the types of templates there.

To see an example of what we should do, see the documentation of the block template (note that it still needs to be improved, but for now it works fine):

Priorities

 * 1) Message box
 * 2) Infobox
 * 3) Hatnotes
 * 4) Templates like only
 * 5) Multi-type like conjecture
 * 6) (Add and specify more templates, modifying this list)

Members

 * User:Thejoaqui777 (Message box templates)

Finalized templates

 * currently editing
 * wip
 * stub
 * stub section
 * missing information
 * empty section
 * section needing info
 * cleanup
 * improve lead
 * rewrite
 * update
 * orphan
 * delete
 * delete when
 * speedy delete
 * move
 * split
 * splitting
 * merge
 * merging
 * technical
 * needs render
 * experimental