Constant Noble:Template documentation

From Constant Noble
Jump to navigation Jump to search

Templates are a very powerful feature of MediaWiki, but can be confusing to new users and even experienced users can have difficulty making sense of the more complex ones. Templates should therefore be accompanied by documentation to improve usability.

Template documentation should explain what a template does and how to use it. It should be simple enough that a user without complete knowledge of the intricacies of template syntax—which includes many experienced contributors who focus their attention elsewhere—can use it correctly. This is especially true in the case of very widely used templates.

On this wiki, there is a dedicated Documentation namespace replacing the original function of Project:Template documentation/ from the earliest stages of its development on ByetHost.

When creating templates, {{Template starter}} (preloaded via the Preloader extension) provides an instance of {{doc tag}}, which in turn supplies a create/edit link to the doc page in question and a transclusion of the contents below. The link is structured thus: https://constantnoble.miraheze.org/wiki/Documentation:Foo?action=edit&preload=Template:Doc_starter (where "Foo" represents the template about to be described with {{Doc starter}}). When creating doc pages, the {{Doc starter intro}} notice is seen within MediaWiki:Newarticletext (above the editbox), and {{doc cat}} (short for "documentation category") is placed at the bottom of the "Doc starter" code.

List

These links are also found at Category:Documentation pages.

From Wikipedia
From Wikipedia

Part or all of this page uses material from Project:Template documentation, originally located at Wikipedia. The list of original contributors can be found in its page history. Text on Wikipedia is available under the Creative Commons Attribution-ShareAlike 3.0 license; additional terms may apply.