Jump to content

FamilySearch Wiki:Template documentation: Difference between revisions

m (fix template)
 
Line 76: Line 76:
==Several templates, one documentation page==
==Several templates, one documentation page==
When several templates work together or are very similar then it is often clearer and easier to maintain one single documentation page that documents them together. The simplest way to do this is to make a full documentation page at one of the templates, and then make "soft redirects" from the other templates. That is, to make very short documentation pages at the other templates that have only one or two sentences that states where the full documentation can be found and link to it. See for instance {{tl|wrap}}.
When several templates work together or are very similar then it is often clearer and easier to maintain one single documentation page that documents them together. The simplest way to do this is to make a full documentation page at one of the templates, and then make "soft redirects" from the other templates. That is, to make very short documentation pages at the other templates that have only one or two sentences that states where the full documentation can be found and link to it. See for instance {{tl|wrap}}.
==Stub templates==
Stub templates are one of the very rare forms of template that do not generally have documentation. As all stub templates operate in identical ways, they could theoretically be linked to one documentation page giving instruction for their use. This is, however, regarded as superfluous, since all stub templates already contain a link to [[FamilySearch Wiki:Stub]], which more thoroughly covers all the information that would normally be covered by a documentation page.


== Tips & tricks ==
== Tips & tricks ==