Constant Noble:Template documentation
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.
- !!
- !(
- '
- 's
- ((
- ))
- 1st letter stats
- ;
- =
- ACPTP
- A to Z
- Abbr
- About
- Administrative divisions of Rogatia
- Analyser
- Anchor
- Backstory
- Birth date
- Blockquote
- Br
- Breakdown
- By year
- CHF
- CMT
- Casetip
- Category
- Changelog row
- Character
- Character box
- Character box/preload
- Cinema
- Cl
- Code
- Comma
- Commons
- Company
- Conj
- Conjugation model
- Conjugation table
- Container category
- Corpus
- DPL3 category
- Data
- Date
- Decl
- Declension
- Declension/Shell
- Definition/Arrays
- Definition/EN/Senses
- Definition/EN/Verb
- Definition/Etymology
- Definition/Examples
- Definition/Nearby
- Definition/Position
- Definition/RFM/Senses
- Definition/Sandbox
- Definition/Word Family
- Definition/Word Links
- Definition/Word Lists
- Deictical ablaut
- Deviant
- Deviation
- Disambig
- Doc cat
- Doc starter
- Doc starter intro
- Doc tag
- Documentation
- Dossier block left
- Dossier block right
- EWL coverage
- Entry
- FTA days
- FTA post
- FTA year
- FTG
- FTG list
- FWOTD
- Family tree
- File
- File info
- Film
- Find
- For
- Form
- From Miraheze Meta
- From Wikimedia Commons
- From Wikipedia
- From the Author
- Further information
- Gamut details
- Grammar
- Grammar link
- Grammar nav
- Hatnote
- Help
- Hidden category
- Ibpl
- Ibr
- Indicatives
- Infobox
- Int
- Interlinear
- Interlinear/Block
- Ithkuil case
- Keyword
- Language
- Language colour
- Lexicon DNA
- Lorem ipsum
- Lua
- Main
- MediaWiki
- Message
- Mhm
- Mhmu
- Module
- Morpheme
- Morpheme-cat
- Morpheme data
- Morpheme data/ACI
- Morpheme data/Adjective
- Morpheme data/Affixes
- Morpheme data/Article
- Morpheme data/Noun
- Morpheme data/Numeral
- Morpheme data/Pronoun
- Morpheme data/Verb
- Morpheme data/Verb/Passive
- Multi-col
- Mutation
- Mutation/10b
- Mutation/10c
- Mutation/11a
- Mutation/11b
- Mutation/11c i
- Mutation/11c ii
- Mutation/11c iii
- Mutation/12a ii
- Mutation/12b
- Mutation/1a i a
- Mutation/1a i b
- Mutation/1a i c
- Mutation/1a ii a
- Mutation/1a ii b
- Mutation/1a iii a
- Mutation/1a iii b
- Mutation/1b i
- Mutation/1b ii
- Mutation/1b iii
- Mutation/1b iv
- Mutation/1b v
- Mutation/1c i a
- Mutation/1c i b
- Mutation/1c ii
- Mutation/1d
- Mutation/1e i
- Mutation/1e ii
- Mutation/1f i
- Mutation/1f ii
- Mutation/1g i
- Mutation/1g ii
- Mutation/1g iv
- Mutation/2a i a
- Mutation/2a i b i
- Mutation/2a i c
- Mutation/2a ii a
- Mutation/2a ii b i
- Mutation/2a ii b ii
- Mutation/2a ii c
- Mutation/2a iii a i
- Mutation/2a iii b
- Mutation/2a iii c i
- Mutation/2a iii c ii
- Mutation/2b i
- Mutation/2b iii a
- Mutation/2b iii b
- Mutation/2b iv a
- Mutation/2b iv b
- Mutation/2c i a i
- Mutation/2c i a ii
- Mutation/2c i a iii
- Mutation/2c i b i
- Mutation/2c i b ii
- Mutation/2c i b iii
- Mutation/2c ii
- Mutation/2c iii
- Mutation/2c iv
- Mutation/3a
- Mutation/3b i a
- Mutation/3b i b i
- Mutation/3b i b ii
- Mutation/3b ii a
- Mutation/3b ii b
- Mutation/3b iii c i
- Mutation/3b iii c ii
- Mutation/3b iv a
- Mutation/3b iv c
- Mutation/3c i a
- Mutation/3c i b
- Mutation/3c ii
- Mutation/3c iii
- Mutation/4a
- Mutation/4b
- Mutation/4c i
- Mutation/4c ii a
- Mutation/4c ii b
- Mutation/4d i
- Mutation/4d ii a
- Mutation/5a
- Mutation/5b i
- Mutation/5b ii a
- Mutation/5b ii b
- Mutation/5c i
- Mutation/6
- Mutation/7a
- Mutation/7b
- Mutation/7c i
- Mutation/8a
- Mutation/8b
- Mutation/8c i
- Mutation/8c ii
- Mutation/8c iii
- Mutation/9a
- Mutation/9b
- Mutation/9c
- Mutation/9d i
- Mutation/9d iii
- Mutation/D1a i a
- Mutation/D1c i a
- Mutation/R1/11a
- Mutation/R1/11b
- Mutation/R1/1a i a
- Mutation/R1/1a i b
- Mutation/R1/1a ii a
- Mutation/R1/1a iii a
- Mutation/R1/1b i
- Mutation/R1/1b ii
- Mutation/R1/1c i a
- Mutation/R1/1c ii
- Mutation/R1/1e ii
- Mutation/R1/1f i
- Mutation/R1/1f ii
- Mutation/R1/2a i a
- Mutation/R1/2a i b i
- Mutation/R1/2a i c
- Mutation/R1/2a ii a
- Mutation/R1/2a ii b i
- Mutation/R1/2a ii b ii
- Mutation/R1/2a iii a i
- Mutation/R1/2a iii b
- Mutation/R1/2a iii c i
- Mutation/R1/2b i
- Mutation/R1/2b iii a
- Mutation/R1/2b iv a
- Mutation/R1/2c i a i
- Mutation/R1/2c i a iii
- Mutation/R1/2c i b i
- Mutation/R1/2c ii
- Mutation/R1/2c iv
- Mutation/R1/3a
- Mutation/R1/3b i a
- Mutation/R1/3b i b ii
- Mutation/R1/3b ii a
- Mutation/R1/3b iv a
- Mutation/R1/3c i a
- Mutation/R1/3c ii
- Mutation/R1/3c iii
- Mutation/R1/4a
- Mutation/R1/4c i
- Mutation/R1/4d i
- Mutation/R1/4d ii b
- Mutation/R1/4d iii
- Mutation/R1/5a
- Mutation/R1/5b i
- Mutation/R1/5b ii a
- Mutation/R1/6
- Mutation/R1/8a
- Mutation/R1/8b
- Mutation/R1/9a
- Mutation/R1/9b
- Mutation/R1/9c
- Mutation/R1/9d i
- Mutation/R1/9d iv
- Mutation/R1/U1a i a/aid
- Mutation/R1/U1a i a/ant
- Mutation/R1/U1a i a/ard
- Mutation/R1/U1a i a/aurd
- Mutation/R1/U1a i a/uit
- Mutation/R2/11a
- Mutation/R2/11b
- Mutation/R2/11c iii
- Mutation/R2/1a i a
- Mutation/R2/1a i b
- Mutation/R2/1a i c
- Mutation/R2/1a ii a
- Mutation/R2/1a iii a
- Mutation/R2/1b i
- Mutation/R2/1b ii
- Mutation/R2/1b iv
- Mutation/R2/1c i a
- Mutation/R2/1c ii
- Mutation/R2/1d
- Mutation/R2/1e i
- Mutation/R2/1e ii
- Mutation/R2/1f i
- Mutation/R2/1g iii
- Mutation/R2/2a i a
- Mutation/R2/2a i c
- Mutation/R2/2a ii a
- Mutation/R2/2a ii b i
- Mutation/R2/2a ii b ii
- Mutation/R2/2a iii a i
- Mutation/R2/2a iii a ii
- Mutation/R2/2a iii b
- Mutation/R2/2a iii c i
- Mutation/R2/2b i
- Mutation/R2/2b iii a
- Mutation/R2/2b iii b
- Mutation/R2/2b iv a
- Mutation/R2/2c i a i
- Mutation/R2/2c i b i
- Mutation/R2/2c i b ii
- Mutation/R2/2c ii
- Mutation/R2/2c iv
- Mutation/R2/3a
- Mutation/R2/3b i a
- Mutation/R2/3b i b i
- Mutation/R2/3b iv a
- Mutation/R2/3c i a
- Mutation/R2/3c ii
- Mutation/R2/3c iii
- Mutation/R2/4a
- Mutation/R2/4b
- Mutation/R2/4c i
- Mutation/R2/4c ii b
- Mutation/R2/5a
- Mutation/R2/5b i
- Mutation/R2/5c i
- Mutation/R2/7b
- Mutation/R2/8a
- Mutation/R2/8b
- Mutation/R2/8c i
- Mutation/R2/9a
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. |