Extension:Display Title

From MediaWiki.org
Jump to navigation Jump to search


MediaWiki extensions manualManual:Extensions
Crystal Clear action run.svg
Display Title

Release status:Extension status stable

ImplementationTemplate:Extension#type User interface, Parser function
DescriptionTemplate:Extension#description Uses displaytitle page property in link text and talk page title; optionally displays original page title as subtitle; and provides parser function to query displaytitle
Author(s)Template:Extension#username
Latest versionTemplate:Extension#version 2.0.0 (2017-12-06)
Compatibility policyCompatibility#mediawiki_extensions master
MediaWikiTemplate:Extension#mediawiki 1.29+
PHPTemplate:Extension#php 5.5+
Database changesTemplate:Extension#needs-updatephp No
LicenseTemplate:Extension#license MIT License
Download
ParametersTemplate:Extension#parameters
  • $wgDisplayTitleHideSubtitle
Hooks usedTemplate:Extension#hook
ParserFirstCallInitManual:Hooks/ParserFirstCallInit
ParserBeforeStripManual:Hooks/ParserBeforeStrip
BeforePageDisplayManual:Hooks/BeforePageDisplay
PersonalUrlsManual:Hooks/PersonalUrls
HtmlPageLinkRendererBeginManual:Hooks/HtmlPageLinkRendererBegin
PersonalUrlsManual:Hooks/PersonalUrls
ScribuntoExternalLibrariesManual:Hooks/ScribuntoExternalLibraries

Translate the Display Title extension if it is available at translatewiki.net

Check usage and version matrix.

IssuesPhabricator

Open tasks · Report a bug

The Display Title extension allows a page's display title to be used as the default link text in links to the page - both links from other pages as well as self-links on the page. Display Title also uses the display title of a page as part of the title of its talk page. It optionally displays the original page title as a subtitle on the page. And, it provides a parser function to query a page's display title.

This extension builds on functionality in MediaWiki core that supports setting a page's display title using the DISPLAYTITLE magic word. Placing {{DISPLAYTITLE:My Display Title}} on a page stores the value of the display title (My Display Title in this case) in the displaytitle page property of the MediaWiki page_props table and, if configured appropriately, displays that value on the page as the title in the title bar. The Display Title extension queries the displaytitle value in the page_props table to provide its features.

Installation[edit]

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

Configuration parameters[edit]

Configuration Flag Default Value Description
$wgDisplayTitleHideSubtitle false If false, display the page's original title as a subtitle below the title bar.

While not strictly necessary for the functioning of Display Title, in order to allow the {{DISPLAYTITLE:...}} magic word to function as expected, set the following MediaWiki core configuration variables:

$wgAllowDisplayTitle = true;
$wgRestrictDisplayTitle = false;

Usage[edit]

#getdisplaytitle parser function[edit]

The #getdisplaytitle parser function gets the display title of the page provided. For example:

{{#getdisplaytitle:Book:42}}

will show the displaytitle of page Book:42. To get the display title of the current page, use:

{{#getdisplaytitle:{{FULLPAGENAME}}}}

Lua/Scribunto support[edit]

Two Lua (see Extension:Scribunto) functions exist for getting and setting a page's display title: mw.ext.displaytitle.get() and mw.ext.displaytitle.set(). To use them, you could create a page Module:DisplayTitle containing the following:

local p = {}

function p.set(frame)
	return mw.ext.displaytitle.set(frame.args[1])
end

function p.get(frame)
	return mw.ext.displaytitle.get(frame.args[1])
end

return p

You could then use {{#invoke:DisplayTitle|set|My Display Title}} on a page to set the page's display title to My Display Title, and you could use {{#invoke:DisplayTitle|get|My Page}} to get the display title of page My Page.

Redirects[edit]

For redirect pages, if the target page has a display title, it will be used as the display title of the redirect page.

Note that this has two implications that may be unexpected the first time a user sees them. When a page with a display title is moved leaving a redirect, on the page indicating that the move was a success the link text will be the same for both the source and target pages. And, on the Special:WhatLinksHere page for a page with a display title that is the target of a redirect, the link text of the redirect page will be the display title of the target page.

A single level of redirect will be followed.

History[edit]

The functionality in this extension evolved as part of the Semantic Title extension. Special thanks go to Van de Bugger, the author of version 1.0 of Semantic Title.

Display Title relies only on functionality in MediaWiki core; it does not depend on any other extension. The functionality in Display Title has been removed from Semantic Title, which now retains solely the functionality to set a page's display title from a Semantic MediaWiki property or Cargo field. However, it is recommended that a page's display title be set using {{DISPLAYTITLE:...}} rather than the functionality in Semantic Title. Semantic Title is being maintained for backward compatibility.

Release notes[edit]

Version 2.0.0
  • Compatibility dropped with MW 1.28 and lower
  • Bug fixes:
    • T181669: Handle integers passed as link text
    • Fixed bug introduced in version 1.5.2 that caused self links to be wrapped in HtmlArmor
Version 1.5.3
  • On redirect pages, show display title of target page
    • Follows a single level of redirect
Version 1.5.2
  • Bug fixes:
    • T180413: Use supplied link text rather than display title when link text matches page title except for case of first character
    • T180409: Undefined variable: found in "DisplayTitleHooks.php" on line 152
    • T181228: Display titles with italics show as HTML
Version 1.5.1
  • Fixed issue for logged-in users on using action "info"
Version 1.5
  • Text that should have overridden link text was being ignored
  • Fix link to user page in header (personal URLs)
Version 1.4
  • Updated to work with MediaWiki 1.28+
Version 1.3
  • Modified self-links to determine display text identically to non-self-links
Version 1.2
  • Added mw.ext.displaytitle.get() and mw.ext.displaytitle.get() Lua functions written by User:Oetterer
Version 1.1
  • Added check for title with only fragment when creating link
Version 1.0
  • Initial release

Known incompatibilities[edit]

  • Configuration parameter $wgDisplayTitleHideSubtitle will not work if you also have the Semantic Breadcrumb Links extension installed. Thus the original page title will not display below the title bar.

See also[edit]