Function Repository Resource:

CheckHyperlinks

Source Notebook

Checks hyperlinks in an expression, webpage, or notebook, on your computer or in the cloud

Contributed by: Wolfram Staff

ResourceFunction["CheckHyperlinks"][expr]

checks hyperlinks in expr and reports which can be successfully followed and which are broken.

ResourceFunction["CheckHyperlinks"][expr,props]

gives only the specified properties props of the hyperlinks.

Details and Options

ResourceFunction["CheckHyperlinks"][expr,…] checks hyperlinks either in expr itself or in an object to which expr is pointing.

The following expressions are interpreted as pointers to the target object:

CloudObject

cloud object representing an API or a notebook

NotebookObject

open notebook in the front end

URL

URL object

File

file object

String

string representing a URL, or a path to a notebook or HTML file

Strings that do not point to a notebook or HTML file give an error.

Unless expr has special interpretation rules, ResourceFunction["CheckHyperlinks"] follows only elements with the explicit head Hyperlink.

Notebook expressions have special interpretation rules.

ResourceFunction["CheckHyperlinks"][obj] returns results in the form: <|"Valid"→{vurl₁,vurl₂,…},"Broken"→{burl₁,burl₂,…},"BrokenData"→assoc|>, where vurl_i and burl_i are vaild and broken urls, respectively, and the association assoc is in the form <|burl₁→resp₁,burl₂→resp₂,…|>, where resp_i are response or failure objects for burl_i.

Possible properties in ResourceFunction["CheckHyperlinks"][obj,props] are:

"Valid"

valid URLs

"Broken"

broken URLs

"BrokenData"

association giving broken URLs and corresponding response or failure objects

Examples

Basic Examples (5)

Check a hyperlink:

In[1]:=

Out[1]=

Check only for broken links:

In[2]:=

Out[2]=

Check several hyperlinks:

In[3]:=

Out[3]=

In[4]:=

Out[4]=

Check hyperlinks on a webpage:

In[5]:=

Out[5]=

Check hyperlinks in a cloud object:

In[6]:=

Out[6]=

In[7]:=

Out[7]=

Check the same object given as a URL:

In[8]:=

Out[8]=

In[9]:=

Out[9]=

Scope (7)

Check hyperlinks in an expression:

In[10]:=

ResourceFunction["CheckHyperlinks"][
Hold[If[True, Hyperlink["https://www.wolfram.com"], Hyperlink["https://www.wolfram.com/2"], Hyperlink["https://www.wolfram.com/3"]]]]

Out[10]=

Check hyperlinks in a cloud object:

In[11]:=

Out[11]=

Check hyperlinks in the body of a cloud API function:

In[12]:=

Out[12]=

In[13]:=

Out[13]=

Check hyperlinks in an open notebook object:

In[14]:=

nb = CreateDocument[{TextCell["S1", "Section"], TextCell[Hyperlink["Text link", "http://www.wolfram.com"], "Text"], ExpressionCell[
Hyperlink["Input cell link", "https://www.wolfram.com/1"], "Input"]}];

In[15]:=

Out[15]=

Check hyperlinks in a notebook file, using different representations a pointer to the file:

In[16]:=

In[17]:=

Out[17]=

In[18]:=

Out[18]=

In[19]:=

Out[19]=

Check hyperlinks in a Notebook object:

In[20]:=

ResourceFunction["CheckHyperlinks"][
Notebook[{Cell[
BoxData[TemplateBox[{"link", "http://www.wolfram.com"}, "HyperlinkURL"]], "Text"]}]]

Out[20]=

Check only for the specified properties of the links:

In[21]:=

Out[21]=

In[22]:=

Out[22]=

In[23]:=

Out[23]=

In[24]:=

Out[24]=

Possible Issues (2)

Some front end objects are not currently recognized as special objects:

In[25]:=

In[26]:=

Out[26]=

Apply the Notebook wrapper to check links:

In[27]:=

Out[27]=

Version History

1.0.0 – 24 October 2019

Author Notes

CheckHyperlinks could have an AuthenticationRules option to handle authentication in sub-URLs. (Currently, it simply treats 401 authentication failure codes as “valid”.)

Hyperlinks with Wolfram Language’s own URI are currently ignored (e.g., “paclet:ref/foo”.

Properly integrating options with all the underlying functions will require a little more work. For now, use at your own risk.

License Information

This work is licensed under a Creative Commons Attribution 4.0 International License