Extension:Display Title/en

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  magic word. Placing   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.

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

User Preference Options
In addition, there is one user preference option. User preference options have default values that can be overridden in LocalSettings.php (see below). Users can then override those default values by visiting  and editing them on the   tab. The DisplayTitle user preference option is:

To override the default value of a user preference option, you can put code similar to the code below in your "LocalSettings.php". That is, with this code in "LocalSettings.php", the value of  used for a user if they do not edit the value in   will be   rather than the default value of   provided in "extension.json".

Display title on edit pages and edit links
In order for the Display Title to be used on edit pages and links to them, edit the following system messages on your wiki (substituting the wiki's local language where appropriate):

And if you also use Page Forms.

Linking
The behavior of the Display Title extension for different types of links is summarized below. The table shows what the link text will be for different situations. In the table, A represents a page title and a represents the page title with the first character of the page name (i.e. the part after the Namespace: if there is a namespace) in lower case. Note that if a page is a redirect (i.e. Page A in the "Page A Redirects to Page B" columns below) and has a display title set, that display title will be ignored by this extension.

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

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

Lua/Scribunto support
Two Lua (see ) functions exist for getting and setting a page's display title:  and. To use them, you could create a page  containing the following:

You could then use  on a page to set the page's display title to My Display Title, and you could use   to get the display title of page My Page.

Redirects
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
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  rather than the functionality in Semantic Title. Semantic Title is being maintained for backward compatibility.

Release notes

 * Version 4.0.0
 * Drop support for MediaWiki 1.38 and earlier
 * Add  class to subtitle (T205250)
 * Fix subpage subtitles for subpages more than two levels deep (T188872)
 * Fix redirect subtitle so it does not use the displaytitle (T306459)
 * Add name and description properties to composer.json (T311321)
 * Add a user preference to disable the extension (T217179)
 * Coding style and test improvements
 * Version 3.3
 * Do not remove fragments if not proper part of text
 * Change  hook to   hook
 * Replace deprecated
 * Version 3.2
 * Add config option for changing redirect display
 * Replace deprecated
 * Version 3.1
 * Fix incompatibility with the Cite extension
 * Version 3.0
 * Several fixes to anchor/fragment behavior
 * Updates due to code deprecations in MediaWiki
 * Compatibility dropped with MW 1.34 and lower
 * Version 2.2.0
 * Add  array to define a list of pages on which links should not use DisplayTitle
 * Fix behavior when there are underscores in the link text
 * Don't use deprecated ParserBeforeStrip hook
 * Version 2.1.0
 * Added tests
 * Added null title check
 * 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

 * Configuration parameter  will not work if you also have the Semantic Breadcrumb Links extension lower than version 1.5.0 installed. Thus the original page title will not display below the title bar.