Guidelines for Using Templates: Difference between revisions

Latest revision as of 20:15, 28 September 2023

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.
Citations: This should also be included at the bottom of every page on the website when in-text citations are used. Learn more here.
Best Practices / Other Resource Template: This template facilitates the consistent addition of 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 linking to another website. 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 linking to document. 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 and viewed.
Video Icon: This should be included in lieu of a bullet or number whenever linking to a video. This helps the user recognize that the hyperlink next to this icon will direct them to YouTube or another video streaming platform.
Picture Template: This templates facilitates consistency in formatting and sizing of photos on Topic Pages.

Type

Code

Displays As

Revision History Information

Revision ID: 7678
Revision Date: 09/28/2023

Website Icon

Document Icon

Video Icon

Picture

{{Picture |image=LAB2.JPG |link=https://damsafety.org/ |caption=This is a labyrinth weir. }}

This is a labyrinth weir.

Links to Helpful MediaWiki Resources

Templates Help Page

Revision ID: 7678
Revision Date: 09/28/2023

@@ Line 1: / Line 1: @@
 __NOTOC__
-[[Category: Formatting]]
+[[Category: Formatting Guidelines]]
-==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 [[Guidelines for Creating a Best Practices Resource Page|here]].
+* '''Citations''': This should also be included at the bottom of every page on the website when in-text citations are used. Learn more [[Guidelines for Inserting a Citation|here]].
-* '''Training Template''': This template facilitates the consistent addition of training pages. Learn more [[Guidelines for Creating a Training Page|here]].
+* '''Best Practices / Other Resource Template''': This template facilitates the consistent addition of Resources pages. Learn more [[Guidelines for Creating a Resource 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 linking to another website. 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 linking to document. 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 linking to document. 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 and viewed.
 * '''Video Icon''': This should be included in lieu of a bullet or number whenever linking to a video. This helps the user recognize that the hyperlink next to this icon will direct them to YouTube or another video streaming platform.
+* '''Picture Template''': This templates facilitates consistency in formatting and sizing of photos on Topic Pages.
 {| class="wikitable"
@@ Line 22: / Line 24: @@
 |-
 | Video Icon || <nowiki>{{Video Icon}}</nowiki>  || {{Video Icon}}
+|-
+| Picture || <nowiki>{{Picture
+|image=LAB2.JPG
+|link=https://damsafety.org/
+|caption=This is a labyrinth weir.
+}}</nowiki>  || {{Picture
+|image=LAB2.JPG
+|link=https://damsafety.org/
+|caption=This is a labyrinth weir.
+}}
 |}