Extension:SoftRedirector/en

From Linux Web Expert

Revision as of 03:56, 17 June 2023 by imported>FuzzyBot (Updating to match new version of source page)
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)

MediaWiki extensions manual
File:OOjs UI icon advanced.svg
SoftRedirector
Release status: beta
Implementation Special page
Description Enables the designation of soft redirect pages with a magic word
Author(s) MJLtalk
Latest version 0.13
MediaWiki 1.28+
PHP 5.4+
License No license specified
Download
<translate> Download extension</translate>
<translate> Git</translate> [?]:
Example Special:SoftRedirectPages on MJL Testing Wiki
Quarterly downloads Lua error in Module:Extension at line 172: bad argument #1 to 'inNamespace' (unrecognized namespace name 'skin').
Public wikis using Lua error in Module:Extension at line 172: bad argument #1 to 'inNamespace' (unrecognized namespace name 'skin').
Translate the SoftRedirector extension if it is available at translatewiki.net

SoftRedirector is fork of MediaWiki extension Disambiguator that is trying to do for soft redirects what it does for disambiguation pages. It should allow you to designate all soft redirect pages with the __SOFTREDIR__ magic word (or an equivalent alias), which then marks them as such in the database. It is currently unclear if this will allow other extensions to handle soft redirect pages as a separate class of page.

Installation

  • <translate> [[<tvar name=2>Special:ExtensionDistributor/SoftRedirector/en</tvar>|Download]] and move the extracted <tvar name=name>SoftRedirector/en</tvar> folder to your <tvar name=ext>extensions/</tvar> directory.</translate>
    <translate> Developers and code contributors should install the extension [[<tvar name=git>Special:MyLanguage/Download from Git</tvar>|from Git]] instead, using:</translate>cd extensions/
    git clone https://gerrit.wikimedia.org/r/mediawiki/extensions/SoftRedirector%2Fen
  • <translate> Add the following code at the bottom of your <tvar name=1>LocalSettings.php </tvar> file:</translate> 
    wfLoadExtension( 'SoftRedirector/en' );
  • Configure as required.
  • File:OOjs UI icon check-constructive.svg <translate> Done</translate> – <translate> Navigate to <tvar name=special>Special:Version</tvar> on your wiki to verify that the extension is successfully installed.</translate>

Configuration

The following configuration variables can be set from your LocalSettings.php file.

  • $wgSoftRedirectorIndicateLinks - whether to add a 'mw-softredir' CSS class to links to soft redirect pages (default is true)

Features

SoftRedirector provides the following features:

  • Programmatic identification of soft redirects pages via the __SOFTREDIR__ magic word
  • New special pages for listing all soft redirects and pages linking to soft redirects
  • New API functions equivalent to the above special pages as well as an API function for querying whether or not a page is a soft redirect
  • Modifies Special:LonelyPages to ignore soft redirects
  • Modifies Special:Random to ignore soft redirects (requires MediaWiki 1.26.0)
  • If VisualEditor is enabled, allows marking a page as a soft redirect via the page properties interface
  • If VisualEditor is enabled, shows whether a page is a soft redirect or not in the link inspector
  • If VisualEditor is enabled, shows whether a page is a soft redirect or not in the link dialog
  • If configured, add a 'mw-softredir' CSS class to links to soft redirect (See #Configuration below)

Usage

On wiki

Once SoftRedirector is installed, the best way to use it is to add the __SOFTREDIR__ magic word to a template that is then included in all of your soft redirect pages.

Once the magic word is in place, your soft redirects will all have the 'soft redirect' page property assigned to them in the database. This property resides in the page_props table.

You will also have two new Special pages :

  • Special:SoftRedirectPages - which lists all the soft redirect pages on your wiki.
  • Special:SoftRedirectPageLinks - which lists all of the pages on your wiki that link to soft redirect pages.

With API

To list all the soft redirects: 

api.php?action=query&list=querypage&qppage=softredirectpages

To list all the soft redirect links: 

api.php?action=query&list=querypage&qppage=SoftRedirectPageLinks

Note that on wikis running in MiserMode (all WMF wikis), both the special page and API interface for SoftRedirectPageLinks are limited to a certain number of results (typically 1000–5000).

To see if an individual page is a soft redirect page: 

api.php?action=query&titles=Bug&prop=pageprops&ppprop=softredirect

If it is a soft redirect page it will include 'softredirect' in its pageprops. Note that the softredirect pageprop, if present, will have its value set to an empty string, so be careful about testing it as a boolean.

See also

Retrieved from "https://www.linuxwebexpert.com/wiki/index.php?title=Extension:SoftRedirector/en&oldid=29898"