MediaWiki:Gadget-find-archived-section.js: Difference between revisions

Revision as of 15:04, 2 August 2020

Revision as of 13:45, 20 April 2021

Line 5:

* | Please discuss changes on the talk page or on [[WT:Gadget]] before editing. |

* |_____________________________________________________________________________|

*

* Gadget to navigate to an archived section after following its broken link.

*

* Author: SD0001

* Documentation: [[User:SD0001/find-archived-section]]

*

*/

Line 16:

// START EDITING HERE FOR LOCALISATION

// Messages: translate these strings if porting to a non-English language wiki

mw.messages.set({

var msg = {

"starterfas-textfinding": "'Looks like the discussion \"$1\" has been archived. "Finding archived discussion...',

"fas-exact-match": 'Looks like the discussion "$1" has been archived. <b><a href="$2">Click to see archived discussion</a></b> <small>(<a href="$3">or search in archives</a>)</small>',

"finding": "Finding archived discussion...",

"fas-inexact-match": 'Looks like the discussion "$1" has been archived. <a href="$2">Click to search in archives</a>.',

"click-link": "Click to see archived discussion",

"fas-no-search-results": "'No search results found for section \"$1\" in archives. It may have been removed or renamed, or you may have followed a malformed link."',

});

"search-link-found": "(or search in archives)", // link to search results when an exact match was obtained.

"search-link-notfound": "Click to search in archives" // link to search results when an exact match was NOT obtained.

};

var config = {

// Function to introduce arbitrary changes to prefix.

Line 35 ⟶ 34:

case "Wikipedia:Administrators' noticeboard":

return "Wikipedia:Administrators' noticeboard/Archive";

default:

return prefix;

}

Line 56 ⟶ 55:

var sectionName = decodeURIComponent(

window.___location.hash.slice(1) // to remove the leading #

.replace(/_/g, ' ')

);

Line 66 ⟶ 65:

if (!sectionName || // no section name in URL

sectionName.indexOf('/media/') === 0 || // URLs used by MediaViewer

/^\d{12} /.test(sectionName) || // URLs used by convenientDiscussions

document.getElementById(sectionName.replace(/ /g, '_')) !== null) { // section exists on page

return;

}

var sanitiseString = function(str, escapeHtml) {

// if str contains $ signs, we don't want String.prototype.replace to treat them with special meaning

return (escapeHtml ? mw.html.escape(str) : str).replace(/\$/g, '$$$$');

};

var escapeQuotes = function(str) {

Line 81 ⟶ 76:

$('#mw-content-text').before(

$('<div>')

.text(mw.msg[('starterfas-text'].replace('$1finding', sanitiseString(sectionName, false)) + msg['finding'])

.addClass('archived-section-prompt')

.css({

Line 118 ⟶ 113:

}

var divHtml;

var results = json.query.search;

if (results.length === 0) {

divHtml = msg[$('no.archived-searchsection-resultsprompt']).replacehtml(mw.msg('$1fas-no-results', sanitiseStringmw.html.escape(sectionName, true)));

} else {

Line 134 ⟶ 128:

var result = results[i];

// sectiontitle in API output has spaces encoded as underscores

if (
result.sectiontitle) {&&

if (result.sectiontitle === sectionName_ || result.sectiontitle === sectionNameDotDecoded_)

}) {

result.sectiontitle === sectionNameDotDecoded_) {

pageTitle = result.title;

pageTitlesectionNameFound = result.titlesectiontitle.replace(/_/g, ' ');

break;

sectionNameFound = result.sectiontitle.replace(/_/g, ' ');

break;

}

}

}

Line 151 ⟶ 144:

});

divHtmlvar escapedSectionName = msg['starter-text']mw.replace('$1', sanitiseStringhtml.escape(sectionNameFound || sectionName, true));

if (pageTitle) { // if a section with the same name was found

var discussionLink = mw.util.getUrl(pageTitle) + '#' + mw.util.wikiUrlencode(sectionNameFound);

$('.archived-section-prompt').html(mw.msg('fas-exact-match', escapedSectionName, discussionLink, searchLink));

divHtml += '<b><a href="' + discussionLink + '">' + msg['click-link'] + '</a></b> ';

divHtml += '<small><a href="' + searchLink + '">' + msg['search-link-found'] + '</a></small>. ';

} else {

$('.archived-section-prompt').html(mw.msg('fas-inexact-match', escapedSectionName, searchLink));

divHtml += '<a href="' + searchLink + '">' + msg['search-link-notfound'] + '</a>. ';

}

}

$('.archived-section-prompt').html(divHtml);

}).catch(function(err) {