mirror of
https://gerrit.wikimedia.org/r/mediawiki/extensions/Cite
synced 2024-12-27 05:52:51 +00:00
ba137fba88
* Include the README in generated JS docs. * Tweak stray top-level files to explain their role. Note that the wmf template forces these files to appear on the docs home page... Bug: T358641 Change-Id: If421414340903991f50a06a76551bd7cd2904c5e
114 lines
3.3 KiB
JavaScript
114 lines
3.3 KiB
JavaScript
'use strict';
|
|
|
|
/**
|
|
* @file Dynamic highlighting while reading an article
|
|
* @author Thiemo Kreuz
|
|
*/
|
|
( function () {
|
|
/**
|
|
* Checks if the ID uses a composite format that does not only consist of a sequential number.
|
|
*
|
|
* @param {string} id
|
|
* @return {boolean}
|
|
*/
|
|
function isNamedReference( id ) {
|
|
// Note: This assumes IDs start with the prefix; this is guaranteed by the parser function
|
|
return /^cite_ref-\D/.test( id );
|
|
}
|
|
|
|
/**
|
|
* @param {string} id
|
|
* @param {jQuery} $content
|
|
* @return {boolean}
|
|
*/
|
|
function isReusedNamedReference( id, $content ) {
|
|
if ( !isNamedReference( id ) ) {
|
|
return false;
|
|
}
|
|
|
|
// Either the ID is already a reuse, or at least one reuse exists somewhere else on the page
|
|
return id.slice( -2 ) !== '-0' ||
|
|
$content.find( '.references a[href="#' + $.escapeSelector( id.slice( 0, -1 ) ) + '1"]' ).length;
|
|
}
|
|
|
|
/**
|
|
* @param {jQuery} $backlinkWrapper
|
|
* @return {jQuery}
|
|
*/
|
|
function makeUpArrowLink( $backlinkWrapper ) {
|
|
let textNode = $backlinkWrapper[ 0 ].firstChild;
|
|
const accessibilityLabel = mw.msg( 'cite_references_link_accessibility_back_label' );
|
|
const $upArrowLink = $( '<a>' )
|
|
.addClass( 'mw-cite-up-arrow-backlink' )
|
|
.attr( 'aria-label', accessibilityLabel )
|
|
.attr( 'title', accessibilityLabel );
|
|
|
|
if ( !textNode ) {
|
|
return $upArrowLink;
|
|
}
|
|
|
|
// Skip additional, custom HTML wrappers, if any.
|
|
while ( textNode.firstChild ) {
|
|
textNode = textNode.firstChild;
|
|
}
|
|
|
|
if ( textNode.nodeType !== Node.TEXT_NODE || textNode.data.trim() === '' ) {
|
|
return $upArrowLink;
|
|
}
|
|
|
|
const upArrow = textNode.data.trim();
|
|
// The text node typically contains "↑ ", and we need to keep the space.
|
|
textNode.data = textNode.data.replace( upArrow, '' );
|
|
|
|
// Create a plain text and a clickable "↑". CSS :target selectors make sure only
|
|
// one is visible at a time.
|
|
$backlinkWrapper.prepend(
|
|
$( '<span>' )
|
|
.addClass( 'mw-cite-up-arrow' )
|
|
.text( upArrow ),
|
|
$upArrowLink
|
|
.text( upArrow )
|
|
);
|
|
|
|
return $upArrowLink;
|
|
}
|
|
|
|
/**
|
|
* @param {jQuery} $backlink
|
|
*/
|
|
function updateUpArrowLink( $backlink ) {
|
|
// It's convenient to stop at the class name, but it's not guaranteed to be there.
|
|
const $backlinkWrapper = $backlink.closest( '.mw-cite-backlink, li' );
|
|
let $upArrowLink = $backlinkWrapper.find( '.mw-cite-up-arrow-backlink' );
|
|
|
|
if ( !$upArrowLink.length && $backlinkWrapper.length ) {
|
|
$upArrowLink = makeUpArrowLink( $backlinkWrapper );
|
|
}
|
|
|
|
$upArrowLink.attr( 'href', $backlink.attr( 'href' ) );
|
|
}
|
|
|
|
mw.hook( 'wikipage.content' ).add( function ( $content ) {
|
|
// We are going to use the ID in the code below, so better be sure one is there.
|
|
$content.find( '.reference[id] > a' ).on( 'click', function () {
|
|
const id = $( this ).parent().attr( 'id' );
|
|
|
|
$content.find( '.mw-cite-targeted-backlink' ).removeClass( 'mw-cite-targeted-backlink' );
|
|
|
|
// Bail out if there is not at least a second backlink ("cite_references_link_many").
|
|
if ( !isReusedNamedReference( id, $content ) ) {
|
|
return;
|
|
}
|
|
|
|
// The :not() skips the duplicate link created below. Relevant when double clicking.
|
|
const $backlink = $content.find( '.references a[href="#' + $.escapeSelector( id ) + '"]:not(.mw-cite-up-arrow-backlink)' )
|
|
.first()
|
|
.addClass( 'mw-cite-targeted-backlink' );
|
|
|
|
if ( $backlink.length ) {
|
|
updateUpArrowLink( $backlink );
|
|
}
|
|
} );
|
|
} );
|
|
}() );
|