Home
Categories
Dictionary
Download
Project Details
Changes Log
What Links Here
How To
Syntax
FAQ
License

archiveurl element



The "archiveurl" element allow to define a link to an external file which is stored in the Internet Wayback machine. The attributes of this element are:
  • "href": the URL of the link
  • "archive": the URL of the archive
  • "checkLink": false to not check the validity of the link even if the configuration property specifies that links should be checked[1]

One and only one of the "href" and "archive" attributes must be present:
  • "href" is used to specify the original URL of the web page which is archived in the Internet Wayback machine. The tool will access the Internet Wayback machine api to get the "closest" archive for this web page
  • "archive" is used to specify the archive to use for the external link

Configuration properties

Several configuration properties allow to configure if the existence of links is checked or not:
  • "checkLinks" specify that the presence of external links must be checked[2]
    for the "archiveurl" element, the presence of anchors if the "#" tag is found in the link construction is not checked
  • "checkHTTPLinks" specify if the URL links with the "http" protocol are checked. This property will only be used if the "checkLinks" property is set to true.

The preence of the link will be checked whatever the value for "checkHTTPLinks" for the "href" attribute case, because the tool must access the Internet Wayback machine to get the effective archive link.

Example

  This is an <archiveurl archive="https://web.archive.org/web/20231215081820/https://www.marmottan.fr/expositions/morisot-sacriste/">morisot-sacriste</a>
or
   This is an <archiveurl href="https://www.marmottan.fr/expositions/morisot-sacriste/">morisot-sacriste</a>

Notes

  1. ^ See checking external links
  2. ^ for the "archiveurl" element, the presence of anchors if the "#" tag is found in the link construction is not checked

See also


Categories: syntax

docJGenerator Copyright (c) 2016-2023 Herve Girod. All rights reserved.