Doc: Templates: Difference between revisions

From Memento Database Wiki
Jump to navigation Jump to search
(Created page with "{{Stamp|2023-08-02|5.0.6 beta|}} {{BannerMenu}} {{PageTitle| Use of wiki templates in the Memento wiki}} MediaWiki templates are used in the Memento wiki for 3 reasons. # Once you become familiar with a template, it will generally make its job extremely easy as compared to entering the text again on every page. # Whenever a change to a template's standardized text is required, the change can be made once in the template, and all wiki pages that use the template will auto...")
 
mNo edit summary
Line 4: Line 4:
MediaWiki templates are used in the Memento wiki for 3 reasons.
MediaWiki templates are used in the Memento wiki for 3 reasons.
# Once you become familiar with a template, it will generally make its job extremely easy as compared to entering the text again on every page.
# Once you become familiar with a template, it will generally make its job extremely easy as compared to entering the text again on every page.
# Whenever a change to a template's standardized text is required, the change can be made once in the template, and all wiki pages that use the template will automatically be used from them I .
# Whenever a change to a template's standardized text is required, the change can be made once in the template, and all wiki pages that use the template will automatically be used from then on.
# The job of a template is to include standardized test into a wiki page. This standardization keeps the wiki more more consistent and correct.
# The job of a template is to include standardized test into a wiki page. This standardization keeps the wiki consistent and correct.


Some templates are merely standard boilerplate and are the same every time they are used. An example of this is BannerMenu. The banner menu is the banner menu. There are no options or parameters.
Some templates are merely standard boilerplate and are the same every time they are used. An example of this is BannerMenu. The banner menu is the banner menu. There are no options or parameters.


Other templates may consist of standard text that has the ability for the page author to provide one or more parameters that enable different pages to include the same standard text except for substation of the parameter(s). An example is PageTitle, which provides for 1 parameter, which is the title of the page. Using the template allows the positioning and the formatting of the title text to be standardized, while allowing the page author the ability to name each page according to its content.
Other templates may consist of standard text that has the ability for the page author to provide one or more parameters that enable different pages to include the same standard text except for substitution of the parameter(s). An example is PageTitle, which provides for 1 parameter, which is the title of the page. Using the template allows the positioning and the formatting of the title text to be standardized, while allowing the page author the ability to name each page according to its content.
(Note that the name by which the page is called in the wiki is one thing (like Spec: Integer field), whereas the page title is the text to be displayed at the top of the page, which will generally differ to some degree (like '''The Integer field type''').)
(Note that the '''name''' by which the page is called in the wiki is one thing (like Spec: Integer field), whereas the page '''title''' is the text to be displayed at the top of the page, which will generally differ to some degree (like '''The Integer field type''').)

Revision as of 00:16, 2 August 2023

« Page as of 2023-08-02, editions Mobile 5.0.6 beta, Desktop »

Wiki
Home
About
Wiki | Memento
Getting started
Wiki | Memento
Indexes
Mobile | Desktop | Scripting
Support
Wiki | Memento
 Use of wiki templates in the Memento wiki

MediaWiki templates are used in the Memento wiki for 3 reasons.

  1. Once you become familiar with a template, it will generally make its job extremely easy as compared to entering the text again on every page.
  2. Whenever a change to a template's standardized text is required, the change can be made once in the template, and all wiki pages that use the template will automatically be used from then on.
  3. The job of a template is to include standardized test into a wiki page. This standardization keeps the wiki consistent and correct.

Some templates are merely standard boilerplate and are the same every time they are used. An example of this is BannerMenu. The banner menu is the banner menu. There are no options or parameters.

Other templates may consist of standard text that has the ability for the page author to provide one or more parameters that enable different pages to include the same standard text except for substitution of the parameter(s). An example is PageTitle, which provides for 1 parameter, which is the title of the page. Using the template allows the positioning and the formatting of the title text to be standardized, while allowing the page author the ability to name each page according to its content. (Note that the name by which the page is called in the wiki is one thing (like Spec: Integer field), whereas the page title is the text to be displayed at the top of the page, which will generally differ to some degree (like The Integer field type).)