Extension:ArchiveLinks

From MediaWiki.org
Jump to: navigation, search
MediaWiki extensions manualManual:Extensions
Crystal Clear action run.png
ArchiveLinks

Release status:Extension status experimental

ImplementationTemplate:Extension#type User interface, Special page
DescriptionTemplate:Extension#description Enables archival of external links with the aim of preventing Link Rot.
Author(s)Template:Extension#username Kevin Browntalk
Latest versionTemplate:Extension#version 0.1 (2011-08-22)
Database changesTemplate:Extension#needs-updatephp Yes
LicenseTemplate:Extension#license No license specified
Download Template:WikimediaDownload/svn
README
ParametersTemplate:Extension#parameters
  • $wgArchiveLinksConfig
Hooks usedTemplate:Extension#hook
ArticleSaveComplete
LinkerMakeExternalLink
LoadExtensionSchemaUpdates
UnitTestsList

Translate the ArchiveLinks extension if it is available at translatewiki.net

Check usage and version matrix.

The ArchiveLinks extension is designed to fight link rot by preemptively archiving external links so that in the event that they go down a copy will still be available.

Installation[edit]

  • Download and place the file(s) in a directory called ArchiveLinks in your extensions/ folder.
  • Add the following code at the bottom of your LocalSettings.php:
require_once "$IP/extensions/ArchiveLinks/ArchiveLinks.php";
  • Run the update script which will automatically create the necessary database tables that this extension needs.
  • YesY Done - Navigate to Special:Version on your wiki to verify that the extension is successfully installed.

Configuration[edit]

All configuration values are put in to a single global variable $wgArchiveLinksConfig as an array. It is important to remember when you are configuring the array not to remove all the values by redefining it by using the array() keyword.

YesY Correct

$wgArchiveLinksConfig['config_value_1'] = true;
$wgArchiveLinksConfig['config_value_2'] = false;


N Not done

$wgArchiveLinksConfig = array(
     'config_val_1' => true,
     'config_val_2' => false,
);

Configuration Options[edit]

The following is a list of the valid configuration options for $wgArchiveLinksConfig.

Config Value Valid Options Description of Value
archive_service
  • internet_archive
  • wikiwix
  • local
  • webcitation
  • archive.org's archival service
  • wikiwix.com's archival service (archiving new links real time on some wikipedia, and all from the past )
  • if you would like to run a local spider this is the option that should be chosen
  • webcitation.org's archival service
generate_feed
  • true
  • false
If this option is set to true the queue table will be used to generate an archive feed that can be accessed via the API by bots and external services. If you would like to run your own local spider this must be set to false.
Example Example

See Also[edit]