Guidelines for Using Templates: Difference between revisions
From ASDSO Dam Safety Toolbox
(Created page with "__NOTOC__ Category: Formatting ==Internal Hyperlinks== Templates are standard wiki pages or code whose content is designed to be embedded inside other pages. Typically, templates are employed by typing the template name enclosed in double curly brackets (also referred to as braces). Multiple templates have been created that are specific to the Dam Safety Toolbox. These include: * ''Revision History Information (revhistinf)'': This should be included at the bottom of...") |
No edit summary |
||
| Line 3: | Line 3: | ||
==Internal Hyperlinks== | ==Internal Hyperlinks== | ||
Templates are standard wiki pages or code whose content is designed to be embedded inside other pages. Typically, templates are employed by typing the template name enclosed in double curly brackets (also referred to as braces). Multiple templates have been created that are specific to the Dam Safety Toolbox. These include: | Templates are standard wiki pages or code whose content is designed to be embedded inside other pages. Typically, templates are employed by typing the template name enclosed in double curly brackets (also referred to as braces). Multiple templates have been created that are specific to the Dam Safety Toolbox. These include: | ||
* ''Revision History Information (revhistinf)'': This should be included at the bottom of every page on the website. It will note pertinent revision history information including the date of last revision. | * '''Revision History Information (revhistinf)''': This should be included at the bottom of every page on the website. It will note pertinent revision history information including the date of last revision. | ||
* ''Best Practices Resource / References Template'': This template facilitates the consistent addition of best practices resources pages. Learn more [[Guidelines for Creating a Best Practices Resource Page|here]]. | * '''Best Practices Resource / References Template''': This template facilitates the consistent addition of best practices resources pages. Learn more [[Guidelines for Creating a Best Practices Resource Page|here]]. | ||
* ''Training Template'': This template facilitates the consistent addition of training pages. Learn more [[Guidelines for Creating a Training Page|here]]. | * '''Training Template''': This template facilitates the consistent addition of training pages. Learn more [[Guidelines for Creating a Training Page|here]]. | ||
* ''Website Icon'': This should be included in lieu of a bullet or number whenever a resource linking to another website is provided. This helps the user recognize that the hyperlink next to this icon will direct them to another website. | * '''Website Icon''': This should be included in lieu of a bullet or number whenever a resource linking to another website is provided. This helps the user recognize that the hyperlink next to this icon will direct them to another website. | ||
* ''Document Icon'': This should be included in lieu of a bullet or number whenever a resource linking to document is provided. This helps the user recognize that the hyperlink next to this icon will direct them to a best practices resource page where a document can be directly downloaded. | * '''Document Icon''': This should be included in lieu of a bullet or number whenever a resource linking to document is provided. This helps the user recognize that the hyperlink next to this icon will direct them to a best practices resource page where a document can be directly downloaded. | ||
* ''Video Icon'': This should be included in lieu of a bullet or number whenever a resource linking to a video is provided. This helps the user recognize that the hyperlink next to this icon will direct them to YouTube or another video streaming platform. | * '''Video Icon''': This should be included in lieu of a bullet or number whenever a resource linking to a video is provided. This helps the user recognize that the hyperlink next to this icon will direct them to YouTube or another video streaming platform. | ||
{| class="wikitable" | {| class="wikitable" | ||
Revision as of 23:10, 22 December 2022
Internal Hyperlinks
Templates are standard wiki pages or code whose content is designed to be embedded inside other pages. Typically, templates are employed by typing the template name enclosed in double curly brackets (also referred to as braces). Multiple templates have been created that are specific to the Dam Safety Toolbox. These include:
- Revision History Information (revhistinf): This should be included at the bottom of every page on the website. It will note pertinent revision history information including the date of last revision.
- Best Practices Resource / References Template: This template facilitates the consistent addition of best practices resources pages. Learn more here.
- Training Template: This template facilitates the consistent addition of training pages. Learn more here.
- Website Icon: This should be included in lieu of a bullet or number whenever a resource linking to another website is provided. This helps the user recognize that the hyperlink next to this icon will direct them to another website.
- Document Icon: This should be included in lieu of a bullet or number whenever a resource linking to document is provided. This helps the user recognize that the hyperlink next to this icon will direct them to a best practices resource page where a document can be directly downloaded.
- Video Icon: This should be included in lieu of a bullet or number whenever a resource linking to a video is provided. This helps the user recognize that the hyperlink next to this icon will direct them to YouTube or another video streaming platform.
| Type | Code | Displays As |
|---|---|---|
| Revision History Information | {{revhistinf}} |
Revision ID: 6261 |
| Website Icon | {{Website Icon}} |
|
| Document Icon | {{Document Icon}} |
|
| Video Icon | {{Video Icon}} |
|
Links to Helpful MediaWiki Resources
Revision ID: 6261
Revision Date: 12/22/2022