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
- Lead text explaining the template's purpose.
- (Sometimes) Parameters section
- (If required, sometimes) Specific parameter subsection.
- Usage section
- (If needed, optional) Example section
- See also section
- That should be changed to this
- Lead text explaining the template's purpose.
- Usage section
- (If required) Parameters subsection
- (If required) Specific parameter subsubsection.
- (If required) Parameters subsection
- (If needed, optional) Example section (Note: It should be on tables)
- See also section
How to clean up documentations[]
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 <pre style="display: table;">{{Template|parameters}}</pre> to display all the parameters on the template, and below that goes the explanation of all the existent parameters, using {{p|parameter}} ({{cd}} should only be used when talking about technical things such as namespaces). 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.
There are two examples of how the general style of these type of templates should be:
General example
Parameters section example
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 <pre style="display: table;">{{Template|parameters}}</pre> 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):
Documentation example
Priorities[]
- Message box
- Infobox
- Hatnotes
- Templates like
{{only}} - Multi-type like
{{conjecture}} - (Add and specify more templates, modifying this list)
Members[]
To join the project, add your signature to the bottom of this list using ~~~.
- User:Supeika (Message box templates)
- User:ItsPlantseed
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}}{{conjecture}}
- Templates missing the "See also" section
{{needs render}}{{experimental}}{{in development}}{{exclusive}}{{outdated edition}}{{outdated feature}}{{unobtainable}}{{mcrs diagrams}}{{more images}}{{more sounds}}{{unreleased version}}{{disclaimer}}