Difference between revisions of "Templates-List"
From The RadioReference Wiki
m |
m (updated categories) |
||
| (6 intermediate revisions by the same user not shown) | |||
| Line 4: | Line 4: | ||
==How templates can be useful== | ==How templates can be useful== | ||
*Templates can act like a "rubber-stamp" and like a "cookie-cutter". | *Templates can act like a "rubber-stamp" and like a "cookie-cutter". | ||
| − | *Wiki-page editors may create a template that contains commonly-used boiler-plate text, and use it repeatedly, like a rubber-stamp, in many different Wiki-articles. | + | *Wiki-page editors may create a template that contains commonly-used boiler-plate text, and use it repeatedly, like a "rubber-stamp", in many different Wiki-articles. |
| − | *Wiki-page editors may use | + | *Wiki-page editors may use parameters in templates, to create custom individualized results, but with a common behavior regardless of which article invokes the template, similar to how a "cookie-cutter" gives the same shape to cookies that might have slightly different ingredients. |
| − | *When a template that includes | + | *When a template that includes Web-links, or Wiki-links, is updated to reflect link-updates, all articles that rely on the template are also automatically updated, thus saving considerable time and effort during Wiki-maintenance, and significantly increasing accuracy and correctness throughout the Wiki. |
| + | |||
| + | ==Template Variables or Parameters== | ||
| + | *Templates can make use of three types of parameters -- anonymous, numbered, and named. All three methods are utilized in the RadioReference Wiki. | ||
| + | **For more information about these parameter-types, please visit this external link: [https://www.mediawiki.org/wiki/Help:Templates#Parameters MediaWiki.org:Help:Templates#Parameters] | ||
| + | *Templates can also make use of system-variables to display system-values. | ||
| + | **The available system-variables are listed on this Wiki page: [[Quick guide to editing pages#Variables]]. | ||
==Template Documentation== | ==Template Documentation== | ||
*Templates are documented either in the template itself (when the template is short and simple), or in a "/doc" sub-page. The "/doc" sub-page link will be found at the bottom of the template, and will be the template's name with "/doc" appended to it (without quotes). Example: [[:Template:Cat_State]]'s documentation is located at: [[:Template:Cat_State/doc]] | *Templates are documented either in the template itself (when the template is short and simple), or in a "/doc" sub-page. The "/doc" sub-page link will be found at the bottom of the template, and will be the template's name with "/doc" appended to it (without quotes). Example: [[:Template:Cat_State]]'s documentation is located at: [[:Template:Cat_State/doc]] | ||
| + | *For recommendations and examples of how to document a template, please navigate to: [[Templates-List: Documentation]]. | ||
| + | *'''Please be very careful''' when adding the "/doc" documentation link at the bottom of a template, so that the template's behavior is not modified. Please make sure the "noinclude" tag immediately follows the last character of the template; otherwise unwanted spaces might be added to the template. | ||
| − | == | + | ==Templates List== |
*Template-names have been chosen with the purpose of them sorting alphabetically in such a way that templates with similar purposes will naturally sort together in the list. | *Template-names have been chosen with the purpose of them sorting alphabetically in such a way that templates with similar purposes will naturally sort together in the list. | ||
*The grouping-by-purpose is reflected in the template-lists on the following pages: | *The grouping-by-purpose is reflected in the template-lists on the following pages: | ||
| Line 26: | Line 34: | ||
[[Category:Documentation]] | [[Category:Documentation]] | ||
| + | [[Category:Wiki Editing FAQ]] | ||
Latest revision as of 17:34, 2 February 2016
| Pages: Templates-List: General Use Only, Infobox-Related, Categories-Related, Sets of Related Pages, Doc. |
Contents
Templates
How templates can be useful
- Templates can act like a "rubber-stamp" and like a "cookie-cutter".
- Wiki-page editors may create a template that contains commonly-used boiler-plate text, and use it repeatedly, like a "rubber-stamp", in many different Wiki-articles.
- Wiki-page editors may use parameters in templates, to create custom individualized results, but with a common behavior regardless of which article invokes the template, similar to how a "cookie-cutter" gives the same shape to cookies that might have slightly different ingredients.
- When a template that includes Web-links, or Wiki-links, is updated to reflect link-updates, all articles that rely on the template are also automatically updated, thus saving considerable time and effort during Wiki-maintenance, and significantly increasing accuracy and correctness throughout the Wiki.
Template Variables or Parameters
- Templates can make use of three types of parameters -- anonymous, numbered, and named. All three methods are utilized in the RadioReference Wiki.
- For more information about these parameter-types, please visit this external link: MediaWiki.org:Help:Templates#Parameters
- Templates can also make use of system-variables to display system-values.
- The available system-variables are listed on this Wiki page: Quick guide to editing pages#Variables.
Template Documentation
- Templates are documented either in the template itself (when the template is short and simple), or in a "/doc" sub-page. The "/doc" sub-page link will be found at the bottom of the template, and will be the template's name with "/doc" appended to it (without quotes). Example: Template:Cat_State's documentation is located at: Template:Cat_State/doc
- For recommendations and examples of how to document a template, please navigate to: Templates-List: Documentation.
- Please be very careful when adding the "/doc" documentation link at the bottom of a template, so that the template's behavior is not modified. Please make sure the "noinclude" tag immediately follows the last character of the template; otherwise unwanted spaces might be added to the template.
Templates List
- Template-names have been chosen with the purpose of them sorting alphabetically in such a way that templates with similar purposes will naturally sort together in the list.
- The grouping-by-purpose is reflected in the template-lists on the following pages:
| Pages: Templates-List: General Use Only, Infobox-Related, Categories-Related, Sets of Related Pages, Doc. |