Guidelines for Inserting Links: Difference between revisions

Latest revision as of 05:36, 18 January 2024

Internal Hyperlinks

Links to other pages within the Dam Safety Toolbox are encouraged to facilitate navigation and exploration of the range of content on the site. If there are subtopics that relate to a given Topic Page, the inclusion of internal links to related subtopics should be included.

Internal hyperlinks can be created manually by including double brackets around the name of the desired page (e.g., [[Types of Dams]] will create a hyperlink to the Types of Dams page). Internal hyperlinks will appear as blue text that is underlined when a user hovers over it. If an internal hyperlink is defined for a page that does not exist, it will appear as red text and will take the user to the page creation editor if the linked is clicked. To customize the text of the hyperlink, insert a pipe or vertical bar after the name of the page (e.g., [[Types of Dams | many different kinds of dams]] will create a hyperlink to the "Types of Dams" page, but the hyperlinked text will read many different kinds of dams).

External Hyperlinks

To minimize maintenance and the potential for broken hyperlinks, hyperlinks to external websites should be used judiciously. It is appropriate to include external links if a reference is a webpage or some other document that is not publicly available. This may be the case for copyrighted material (e.g., building codes) that is only available for purchase.

External hyperlinks can be created by including single brackets around the URL of the desired page (e.g., [https://damsafety.org/] will create a numbered hyperlink to the ASDSO's main webpage as follows: [1]). External hyperlinks will appear as purple text that is underlined when a user hovers over it. To customize the text of the hyperlink, insert space and text after the URL (e.g., [https://damsafety.org/ ASDSO's site] will create a hyperlink to ASDSO's main webpage, but the hyperlinked text will read ASDSO's site).

Type	Code	Displays As
Internal Link (Basic)	[[Types of Dams]]	Types of Dams
Internal Link (Custom Text)	[[Types of Dams \| many different kinds of dams]]	many different kinds of dams
External Link (Basic)	[https://damsafety.org/]	[2]
External Link (Custom Text)	[https://damsafety.org/ Association of State Dam Safety Officials website (accessed December 22, 2022)]	Association of State Dam Safety Officials website (accessed December 22, 2022)

Auto-Generated Hyperlinks

Each time a page is saved by a contributor, a MediaWiki extension is run to automatically create internal hyperlinks to pages with titles that match the exact text on the saved page. If the auto-generated hyperlinks are not appropriate or desired for a given page, the link can be deleted and text excluded from the auto-linking MediaWiki extension feature by adding the "noautolinks" command (e.g., <noautolinks> there are many different types of dams </noautolinks>. In this case "types of dams" would typically generate an auto-link to the Types of Dams page, but the use of the "noautolinks" command excludes the entire phrase "there are many different types of dams" from internal auto-linking).

Type	Code	Displays As
Auto-Generated Link	Low head dams are very dangerous structures.	Low head dams are very dangerous structures.
Excluded Link	<noautolinks>Low head dams are very dangerous structures.</noautolinks>	Low head dams are very dangerous structures.

Watch the Dam Safety Toolbox Tutorial: Inserting Links for additional help.

Links to Helpful MediaWiki Resources

Links Help Page

Revision ID: 7802
Revision Date: 01/18/2024

@@ Line 1: / Line 1: @@
 __NOTOC__
-[[Category: Formatting]]
+[[Category: Formatting Guidelines]]
+----
 ==Internal Hyperlinks==
-Links to other pages within the Dam Safety Toolbox are encouraged to facilitate <noautolinks>navigation</noautolinks> and exploration of the range of content on the site. If there are subtopics that relate to a given topic page, the inclusion of internal links to related subtopics should be included. Each time a page is saved by a user, a MediaWiki extension is also run to automatically create internal hyperlinks to pages that match the exact text on the saved page. If the auto-generated hyperlinks are not appropriate or desired for a given page, the link can be deleted and text excluded from auto-linking by adding the "noautolinks" command (e.g., <nowiki><noautolinks> there are many different types of dams </noautolinks></nowiki>. In this case "types of dams" would typically generate an auto-link to the [[Types of Dams]] page, but the use of the "noautolinks" command excludes the entire phrase "there are many different types of dams" from internal auto-linking).
+Links to other pages within the Dam Safety Toolbox are encouraged to facilitate <noautolinks>navigation</noautolinks> and exploration of the range of content on the site. If there are subtopics that relate to a given Topic Page, the inclusion of internal links to related subtopics should be included.
-Internal hyperlinks can be created manually by including double brackets around the name of the desired page (e.g., <nowiki>[[Types of Dams]]</nowiki> will create a hyperlink to the [[Types of Dams]] page). Internal hyperlinks will appear as blue text that is underlined when a user hovers over it. If an internal hyperlink is defined for a page that does not exist, it will appear as red text and will take the user to the page creation editor if the linked is clicked.
+Internal hyperlinks can be created manually by including double brackets around the name of the desired page (e.g., <nowiki>[[Types of Dams]]</nowiki> will create a hyperlink to the [[Types of Dams]] page). Internal hyperlinks will appear as blue text that is underlined when a user hovers over it. If an internal hyperlink is defined for a page that does not exist, it will appear as [[red text]] and will take the user to the page creation editor if the linked is clicked. To customize the text of the hyperlink, insert a pipe or vertical bar after the name of the page (e.g., <nowiki>[[Types of Dams | many different kinds of dams]] will create a hyperlink to the "Types of Dams" page</nowiki>, but the hyperlinked text will read [[Types of Dams | many different kinds of dams]]).
-To customize the text of the hyperlink, insert a pipe or vertical bar after the name of the page (e.g., <nowiki>[[Types of Dams | many different kinds of dams]] will create a hyperlink to the "Types of Dams" page</nowiki>, but the hyperlinked text will read [[Types of Dams | many different kinds of dams]]).
+==External Hyperlinks==
+To minimize maintenance and the potential for broken hyperlinks, hyperlinks to external websites should be used judiciously. It is appropriate to include external links if a reference is a webpage or some other document that is not publicly available. This may be the case for copyrighted material (e.g., building codes) that is only available for purchase.
+External hyperlinks can be created by including single brackets around the URL of the desired page (e.g., <nowiki>[https://damsafety.org/]</nowiki> will create a numbered hyperlink to the ASDSO's main webpage as follows: [https://damsafety.org/]). External hyperlinks will appear as purple text that is underlined when a user hovers over it. To customize the text of the hyperlink, insert space and text after the URL (e.g., <nowiki>[https://damsafety.org/ ASDSO's site]</nowiki> will create a hyperlink to ASDSO's main webpage, but the hyperlinked text will read [https://damsafety.org/ ASDSO's site]).
+{| class="wikitable"
+!width="20%"|Type
+!width="40%"|Code
+!width="40%"|Displays As
+|-
+| Internal Link (Basic) || <nowiki>[[Types of Dams]]</nowiki>  || [[Types of Dams]]
+|-
+| Internal Link (Custom Text) || <nowiki>[[Types of Dams | many different kinds of dams]]</nowiki>  || [[Types of Dams | many different kinds of dams]]
+|-
+| External Link (Basic) || <nowiki>[https://damsafety.org/]</nowiki>  || [https://damsafety.org/]
+|-
+| External Link (Custom Text) || <nowiki>[https://damsafety.org/ Association of State Dam Safety Officials website (accessed December 22, 2022)]</nowiki>  || [https://damsafety.org/ Association of State Dam Safety Officials website (accessed December 22, 2022)]
+|}
+==Auto-Generated Hyperlinks==
+Each time a page is saved by a contributor, a MediaWiki extension is run to automatically create internal hyperlinks to pages with titles that match the exact text on the saved page. If the auto-generated hyperlinks are not appropriate or desired for a given page, the link can be deleted and text excluded from the auto-linking MediaWiki extension feature by adding the "noautolinks" command (e.g., <nowiki><noautolinks> there are many different types of dams </noautolinks></nowiki>. In this case "types of dams" would typically generate an auto-link to the [[Types of Dams]] page, but the use of the "noautolinks" command excludes the entire phrase "there are many different types of dams" from internal auto-linking).
-==External Hyperlinks==
+{| class="wikitable"
-To minimize maintenance and the potential for broken hyperlinks, hyperlinks to external websites should be used judiciously. It is appropriate to include external links if a reference is a webpage or some other document that is not publicly available. This may be the case for copyrighted material (e.g., building code) that is only available for purchase.
+!width="20%"|Type
+!width="40%"|Code
+!width="40%"|Displays As
+|-
+| Auto-Generated Link || <nowiki>Low head dams are very dangerous structures.</nowiki>  || [[Low Head Dams|Low head dams]] are very dangerous structures.
+|-
+| Excluded Link || <nowiki><noautolinks>Low head dams are very dangerous structures.</noautolinks></nowiki>  || <noautolinks>Low head dams are very dangerous structures.</noautolinks>
+|}
-External hyperlinks can be created by including single brackets around the URL of the desired page (e.g., <nowiki>[https://damsafety.org/]</nowiki> will create a hyperlink to the ASDSO's main webpage as follows: [www.damsafety.org]). External hyperlinks will appear as purple text that is underlined when a user hovers over it. To customize the text of the hyperlink, insert space and text after the URL (e.g., <nowiki>[https://damsafety.org/ ASDSO's site]</nowiki> will create a hyperlink to ASDSO's main webpage, but the hyperlinked text will read [www.damsafety.org ASDSO's site]).
+Watch the {{Video Icon}} [https://www.youtube.com/watch?v=sue5g1gLd5M Dam Safety Toolbox Tutorial: Inserting Links] for additional help.
 == Links to Helpful MediaWiki Resources ==
+{{Website Icon}} [https://www.mediawiki.org/wiki/Help:Links Links Help Page]
-{{Website Icon}} [https://www.mediawiki.org/wiki/Help:Links Links Help Page]
+{{revhistinf}}