Extension:LinkTitles

From MediaWiki.org
Jump to navigation Jump to search
MediaWiki extensions manual
Crystal Clear action run.svg
LinkTitles
Release status: stable
Implementation Page action
Description Automatically adds links to words that match titles of existing pages.
Author(s) Daniel Kraus (bovendertalk)
Latest version 5.0.6 (2018-06-20)
MediaWiki 1.25+
PHP 5.3+
Database changes No
License GNU General Public License 2.0 or later
Download
README.md
What's new?
Parameters
see README.md
Tags
autolinks, noautolinks
Added rights
linktitles-batch
Hooks used
PageContentSave
InternalParseBeforeLinks
GetDoubleUnderscoreIDs
Translate the LinkTitles extension if it is available at translatewiki.net
Check usage and version matrix.

The LinkTitles extension automatically adds links to existing page titles that occur on a given page. This will automatically cross-reference your wiki for you. The extension can operate in three ways that can be used independently:

  1. Whenever a page is edited and saved, the extension will look if any existing page titles occur in the text, and automatically add links ([[...]]) to the corresponding pages.
  2. Links may also be added on the fly whenever a page is rendered for display. Most of the time, MediaWiki will fetch previously rendered pages from cache upon a page request, but whenever a page is refreshed, the LinkTitles extension can add its page links. These links are not hard-coded in the Wiki text. The original content will not be modified.
  3. Batch mode enables Wiki administrators to process all pages in a Wiki at once. Batch processing can either be started from a special page, or from the server's command line (see below).

Installation[edit]

  • Download, extract and place the file(s) in a directory called LinkTitles in your extensions/ folder.
  • Add the following code at the bottom of your LocalSettings.php:
    wfLoadExtension( 'LinkTitles' );
    
  • Configure as required.
  • Yes Done – Navigate to Special:Version on your wiki to verify that the extension is successfully installed.

To users running MediaWiki 1.24 or earlier:

The instructions above describe the new way of installing this extension using wfLoadExtension() If you need to install this extension on these earlier versions (MediaWiki 1.24 and earlier), instead of wfLoadExtension( 'LinkTitles' );, you need to use:

require_once "$IP/extensions/LinkTitles/LinkTitles.php";

Usage and configuration[edit]

Starting with version 5.0.0, detailed usage and configuration information was moved to the README.md file in the extension's repository.

(This enables me to use an offline text editor to edit the file, and it keeps the file under the same version control as the code.)