ASDSO Dam Safety Toolbox

Guidelines for Inserting Links: Difference between revisions

From ASDSO Dam Safety Toolbox
Jump to: navigation, search
(Created page with "__NOTOC__ Category: Formatting ==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. 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 ex...")
 
No edit summary
Line 2: Line 2:
[[Category: Formatting]]
[[Category: Formatting]]
==Internal Hyperlinks==
==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. 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 linking by adding the command<nowiki><noautolinks> around the text as demonstrated here.</noautolinks><nowiki/>
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 linking by adding the command<nowiki><noautolinks> around the text as demonstrated here.</noautolinks></nowiki>


Internal hyperlinks can be created manually by including double brackets around the name of the desired page (e.g., <nowiki>[[Types of Dams]] will create a hyperlink to the "Types of Dams" page<nowiki/>). 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 learn more about how to customize the text of the hyperlink, visit the MediaWiki Links Help Page below.
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==
==External Hyperlinks==
To minimize maintenance and the potential for broken hyperlinks, hyperlinks to external websites should be used judiciously.
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.


Once a citation has been used on a topic page, subsequent sentences and paragraphs on the same page can be referenced using a ShortID. This only works within a single topic page. ShortIDs do not carry over to other pages of the website.  
External hyperlinks can be created by including single brackets around the URL of the desired page (e.g., <nowiki>[www.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>[www.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]).
 
{| class="wikitable"
!width="30%"|Type
!width="50%"|Code
!width="20%"|Displays As
|-
| Internal Reference || <nowiki><ref name="SmallDams">[[Design of Small Dams| Design of Small Dams (Bureau of Reclamation, 1987)]]</ref></nowiki> || <ref name="SmallDams">[[Design of Small Dams| Design of Small Dams (Bureau of Reclamation, 1987)]]</ref>
|-
| External Reference || <nowiki><ref name="ASDSO">[https://damsafety.org/ Association of State Dam Safety Officials Website (ASDSO, 2022)]</ref></nowiki> || <ref name="ASDSO">[https://damsafety.org/ Association of State Dam Safety Officials Website (ASDSO, 2022)]</ref>
|-
| Subsequent Reference on Same Page Using ShortID || <nowiki><ref name="SmallDams"/> </nowiki>  || <ref name="SmallDams"/>
|}


== Links to Helpful MediaWiki Resources ==
== 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]

Revision as of 22:13, 22 December 2022

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. 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 linking by adding the command<noautolinks> around the text as demonstrated here.</noautolinks>

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 code) that is only available for purchase.

External hyperlinks can be created by including single brackets around the URL of the desired page (e.g., [www.damsafety.org] 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., [www.damsafety.org ASDSO's site] will create a hyperlink to ASDSO's main webpage, but the hyperlinked text will read [www.damsafety.org ASDSO's site]).

Links to Helpful MediaWiki Resources

Links Help Page