MediaWiki:Gadget-friendlywelcome.js

// <nowiki>(function($) {/* **************************************** *** friendlywelcome.js: Welcome module **************************************** * Mode of invocation:     Tab ("Wel"), or from links on diff pages * Active on:              Any page with relevant user name (userspace, *                         contribs, etc.) and diff pages */Twinkle.welcome = function friendlywelcome() {if (Twinkle.getPrefill('friendlywelcome')) {if (Twinkle.getPrefill('friendlywelcome') === 'auto') {Twinkle.welcome.auto();} else {Twinkle.welcome.semiauto();}} else {Twinkle.welcome.normal();}};Twinkle.welcome.auto = function() {if (mw.util.getParamValue('action') !== 'edit') {// userpage not empty, aborting auto-welcomereturn;}Twinkle.welcome.welcomeUser();};Twinkle.welcome.semiauto = function() {Twinkle.welcome.callback(mw.config.get('wgRelevantUserName'));};Twinkle.welcome.normal = function() {var isDiff = mw.util.getParamValue('diff');if (isDiff) {// check whether the contributors' talk pages exist yetvar $oldDiffUsernameLine = $('#mw-diff-otitle2');var $newDiffUsernameLine = $('#mw-diff-ntitle2');var $oldDiffHasRedlinkedTalkPage = $oldDiffUsernameLine.find('span.mw-usertoollinks a.new:contains(talk)').first();var $newDiffHasRedlinkedTalkPage = $newDiffUsernameLine.find('span.mw-usertoollinks a.new:contains(talk)').first();var diffHasRedlinkedTalkPage = $oldDiffHasRedlinkedTalkPage.length > 0 || $newDiffHasRedlinkedTalkPage.length > 0;if (diffHasRedlinkedTalkPage) {var spanTag = function(color, content) {var span = document.createElement('span');span.style.color = color;span.appendChild(document.createTextNode(content));return span;};var welcomeNode = document.createElement('strong');var welcomeLink = document.createElement('a');welcomeLink.appendChild(spanTag('Black', '['));welcomeLink.appendChild(spanTag('Goldenrod', 'welcome'));welcomeLink.appendChild(spanTag('Black', ']'));welcomeNode.appendChild(welcomeLink);if ($oldDiffHasRedlinkedTalkPage.length > 0) {var oHref = $oldDiffHasRedlinkedTalkPage.attr('href');var oWelcomeNode = welcomeNode.cloneNode(true);oWelcomeNode.firstChild.setAttribute('href', oHref + '&' + $.param({friendlywelcome: Twinkle.getPref('quickWelcomeMode') === 'auto' ? 'auto' : 'norm',vanarticle: Morebits.pageNameNorm}));$oldDiffHasRedlinkedTalkPage[0].parentNode.parentNode.appendChild(document.createTextNode(' '));$oldDiffHasRedlinkedTalkPage[0].parentNode.parentNode.appendChild(oWelcomeNode);}if ($newDiffHasRedlinkedTalkPage.length > 0) {var nHref = $newDiffHasRedlinkedTalkPage.attr('href');var nWelcomeNode = welcomeNode.cloneNode(true);nWelcomeNode.firstChild.setAttribute('href', nHref + '&' + $.param({friendlywelcome: Twinkle.getPref('quickWelcomeMode') === 'auto' ? 'auto' : 'norm',vanarticle: Morebits.pageNameNorm}));$newDiffHasRedlinkedTalkPage[0].parentNode.parentNode.appendChild(document.createTextNode(' '));$newDiffHasRedlinkedTalkPage[0].parentNode.parentNode.appendChild(nWelcomeNode);}}}// Users and IPs but not IP rangesif (mw.config.exists('wgRelevantUserName') && !Morebits.ip.isRange(mw.config.get('wgRelevantUserName'))) {Twinkle.addPortletLink(function() {Twinkle.welcome.callback(mw.config.get('wgRelevantUserName'));}, 'Wel', 'friendly-welcome', 'Welcome user');}};Twinkle.welcome.welcomeUser = function welcomeUser() {Morebits.status.init(document.getElementById('mw-content-text'));$('#catlinks').remove();var params = {template: Twinkle.getPref('quickWelcomeTemplate'),article: Twinkle.getPrefill('vanarticle') || '',mode: 'auto'};var userTalkPage = mw.config.get('wgFormattedNamespaces')[3] + ':' + mw.config.get('wgRelevantUserName');Morebits.wiki.actionCompleted.redirect = userTalkPage;Morebits.wiki.actionCompleted.notice = 'Welcoming complete, reloading talk page in a few seconds';var wikipedia_page = new Morebits.wiki.page(userTalkPage, 'User talk page modification');wikipedia_page.setFollowRedirect(true);wikipedia_page.setCallbackParameters(params);wikipedia_page.load(Twinkle.welcome.callbacks.main);};Twinkle.welcome.callback = function friendlywelcomeCallback(uid) {if (uid === mw.config.get('wgUserName') && !confirm('Are you really sure you want to welcome yourself?...')) {return;}var Window = new Morebits.simpleWindow(600, 420);Window.setTitle('Welcome user');Window.setScriptName('Twinkle');Window.addFooterLink('Welcoming Committee', 'WP:WC');Window.addFooterLink('Welcome prefs', 'WP:TW/PREF#welcome');Window.addFooterLink('Twinkle help', 'WP:TW/DOC#welcome');Window.addFooterLink('Give feedback', 'WT:TW');var form = new Morebits.quickForm(Twinkle.welcome.callback.evaluate);form.append({type: 'select',name: 'type',label: 'Type of welcome:',event: Twinkle.welcome.populateWelcomeList,list: [{ type: 'option', value: 'standard', label: 'Standard welcomes', selected: !mw.util.isIPAddress(mw.config.get('wgRelevantUserName')) },{ type: 'option', value: 'anonymous', label: 'IP user welcomes', selected: mw.util.isIPAddress(mw.config.get('wgRelevantUserName')) },{ type: 'option', value: 'wikiProject', label: 'WikiProject welcomes' },{ type: 'option', value: 'nonEnglish', label: 'Non-English welcomes' }]});form.append({type: 'div',id: 'welcomeWorkArea',className: 'morebits-scrollbox'});form.append({type: 'input',name: 'article',label: '* Linked article (if supported by template):',value: Twinkle.getPrefill('vanarticle') || '',tooltip: 'An article might be linked from within the welcome if the template supports it. Leave empty for no article to be linked.  Templates that support a linked article are marked with an asterisk.'});var previewlink = document.createElement('a');$(previewlink).click(function() {Twinkle.welcome.callbacks.preview(result);  // |result| is defined below});previewlink.style.cursor = 'pointer';previewlink.textContent = 'Preview';form.append({ type: 'div', name: 'welcomepreview', label: [ previewlink ] });form.append({ type: 'submit' });var result = form.render();Window.setContent(result);Window.display();// initialize the welcome listvar evt = document.createEvent('Event');evt.initEvent('change', true, true);result.type.dispatchEvent(evt);};Twinkle.welcome.populateWelcomeList = function(e) {var type = e.target.value;var container = new Morebits.quickForm.element({ type: 'fragment' });if ((type === 'standard' || type === 'anonymous') && Twinkle.getPref('customWelcomeList').length) {container.append({ type: 'header', label: 'Custom welcome templates' });container.append({type: 'radio',name: 'template',list: Twinkle.getPref('customWelcomeList'),event: function() {e.target.form.article.disabled = false;}});}var sets = Twinkle.welcome.templates[type];$.each(sets, function(label, templates) {container.append({ type: 'header', label: label });container.append({type: 'radio',name: 'template',list: $.map(templates, function(properties, template) {return {value: template,label: '{{' + template + '}}: ' + properties.description + (properties.linkedArticle ? '\u00A0*' : ''),  // U+00A0 NO-BREAK SPACEtooltip: properties.tooltip  // may be undefined};}),event: function(ev) {ev.target.form.article.disabled = !templates[ev.target.value].linkedArticle;}});});var rendered = container.render();$(e.target.form).find('div#welcomeWorkArea').empty().append(rendered);var firstRadio = e.target.form.template[0];firstRadio.checked = true;var vals = sets[Object.keys(sets)[0]];e.target.form.article.disabled = vals[firstRadio.value] ? !vals[firstRadio.value].linkedArticle : true;};// A list of welcome templates and their properties and syntax// The four fields that are available are "description", "linkedArticle", "syntax", and "tooltip".// The three magic words that can be used in the "syntax" field are://   - $USERNAME$  - replaced by the welcomer's username, depending on user's preferences//   - $ARTICLE$   - replaced by an article name, if "linkedArticle" is true//   - $HEADER$    - adds a level 2 header (most templates already include this)//   - $EXTRA$     - custom message to be added at the end of the template. not implemented yet.Twinkle.welcome.templates = {standard: {'General welcome templates': {'welcome': {description: 'standard welcome',linkedArticle: true,syntax: '{{subst:welcome|$USERNAME$|art=$ARTICLE$}} ~~~~'},'welcome-retro': {description: 'a welcome message with a small list of helpful links',linkedArticle: true,syntax: '{{subst:welcome-retro|$USERNAME$|art=$ARTICLE$}} ~~~~'},'welcome-short': {description: 'a shorter welcome message',syntax: '{{subst:W-short|$EXTRA$}}'},'welcome-cookie': {description: 'a welcome message with some helpful links and a plate of cookies',syntax: '{{subst:welcome cookie}} ~~~~'},'welcoming': {description: 'welcome message with tutorial links and basic editing tips',syntax: '{{subst:Welcoming}}'}},'Specific welcome templates': {'welcome-belated': {description: 'welcome for users with more substantial contributions',syntax: '{{subst:welcome-belated|$USERNAME$}}'},'welcome student': {description: 'welcome for students editing as part of an educational class project',syntax: '$HEADER$ {{subst:welcome student|$USERNAME$}} ~~~~'},'welcome teacher': {description: 'welcome for course instructors involved in an educational class project',syntax: '$HEADER$ {{subst:welcome teacher|$USERNAME$}} ~~~~'},'welcome non-latin': {description: 'welcome for users with a username containing non-Latin characters',syntax: '{{subst:welcome non-latin|$USERNAME$}} ~~~~'}},'Problem user welcome templates': {'first article': {description: 'for someone whose first article did not meet page creation guidelines',linkedArticle: true,syntax: '{{subst:first article|$ARTICLE$|$USERNAME$}}'},'welcome-COI': {description: 'for someone who has edited in areas where they may have a conflict of interest',linkedArticle: true,syntax: '{{subst:welcome-COI|$USERNAME$|art=$ARTICLE$}} ~~~~'},'welcome-auto': {description: 'for someone who created an autobiographical article',linkedArticle: true,syntax: '{{subst:welcome-auto|$USERNAME$|art=$ARTICLE$}} ~~~~'},'welcome-copyright': {description: 'for someone who has been adding copyright violations to articles',linkedArticle: true,syntax: '{{subst:welcome-copyright|$ARTICLE$|$USERNAME$}} ~~~~'},'welcome-delete': {description: 'for someone who has been removing information from articles',linkedArticle: true,syntax: '{{subst:welcome-delete|$ARTICLE$|$USERNAME$}} ~~~~'},'welcome-image': {description: 'welcome with additional information about images (policy and procedure)',linkedArticle: true,syntax: '{{subst:welcome-image|$USERNAME$|art=$ARTICLE$}}'},'welcomelaws': {description: 'welcome with information about copyrights, NPOV, the sandbox, and vandalism',syntax: '{{subst:welcomelaws|$USERNAME$}} ~~~~'},'welcomenpov': {description: 'for someone whose initial efforts do not adhere to the neutral point of view policy',linkedArticle: true,syntax: '{{subst:welcomenpov|$ARTICLE$|$USERNAME$}} ~~~~'},'welcomeunsourced': {description: 'for someone whose initial efforts are unsourced',linkedArticle: true,syntax: '{{subst:welcomeunsourced|$ARTICLE$|$USERNAME$}} ~~~~'},'welcomevandal': {description: 'for someone whose initial efforts appear to be vandalism',linkedArticle: true,syntax: '{{subst:welcomevandal|$ARTICLE$|$USERNAME$}}'},'welcomespam': {description: 'welcome with additional discussion of anti-spamming policies',linkedArticle: true,syntax: '{{subst:welcomespam|$ARTICLE$|$USERNAME$}} ~~~~'},'welcometest': {description: 'for someone whose initial efforts appear to be tests',linkedArticle: true,syntax: '{{subst:welcometest|$ARTICLE$|$USERNAME$}} ~~~~'}}},anonymous: {'Anonymous user welcome templates': {'welcome-anon': {description: 'for anonymous users; encourages creating an account',linkedArticle: true,syntax: '{{subst:welcome-anon|art=$ARTICLE$}} ~~~~'},'thanks': {description: 'for anonymous users; short; encourages creating an account',linkedArticle: true,syntax: '== Welcome! ==\n{{subst:thanks|page=$ARTICLE$}} ~~~~'},'welcome-anon-test': {description: 'for anonymous users who have performed test edits',linkedArticle: true,syntax: '{{subst:welcome-anon-test|$ARTICLE$|$USERNAME$}} ~~~~'},'welcome-anon-unconstructive': {description: 'for anonymous users who have vandalized or made unhelpful edits',linkedArticle: true,syntax: '{{subst:welcome-anon-unconstructive|$ARTICLE$|$USERNAME$}}'},'welcome-anon-constructive': {description: 'for anonymous users who fight vandalism or edit constructively',linkedArticle: true,syntax: '{{subst:welcome-anon-constructive|art=$ARTICLE$}}'},'welcome-anon-delete': {description: 'for anonymous users who have removed content from pages',linkedArticle: true,syntax: '{{subst:welcome-anon-delete|$ARTICLE$|$USERNAME$}} ~~~~'}}},wikiProject: {'WikiProject-specific welcome templates': {'TWA invite': {description: 'invite the user to The Wikipedia Adventure (not a welcome template)',syntax: '{{subst:WP:TWA/InviteTW|signature=~~~~}}'},'welcome-anatomy': {description: 'welcome for users with an apparent interest in anatomy topics',syntax: '{{subst:welcome-anatomy}} ~~~~'},'welcome-athletics': {description: 'welcome for users with an apparent interest in athletics (track and field) topics',syntax: '{{subst:welcome-athletics}}'},'welcome-au': {description: 'welcome for users with an apparent interest in Australia topics',syntax: '{{subst:welcome-au}} ~~~~'},'welcome-bd': {description: 'welcome for users with an apparent interest in Bangladesh topics',linkedArticle: true,syntax: '{{subst:welcome-bd|$USERNAME$||$EXTRA$|art=$ARTICLE$}} ~~~~'},'welcome-bio': {description: 'welcome for users with an apparent interest in biographical topics',syntax: '{{subst:welcome-bio}} ~~~~'},'welcome-cal': {description: 'welcome for users with an apparent interest in California topics',syntax: '{{subst:welcome-cal}} ~~~~'},'welcome-conserv': {description: 'welcome for users with an apparent interest in conservatism topics',syntax: '{{subst:welcome-conserv}}'},'welcome-cycling': {description: 'welcome for users with an apparent interest in cycling topics',syntax: '{{subst:welcome-cycling}} ~~~~'},'welcome-dbz': {description: 'welcome for users with an apparent interest in Dragon Ball topics',syntax: '{{subst:welcome-dbz|$EXTRA$|sig=~~~~}}'},'welcome-et': {description: 'welcome for users with an apparent interest in Estonia topics',syntax: '{{subst:welcome-et}}'},'welcome-de': {description: 'welcome for users with an apparent interest in Germany topics',syntax: '{{subst:welcome-de}} ~~~~'},'welcome-in': {description: 'welcome for users with an apparent interest in India topics',linkedArticle: true,syntax: '{{subst:welcome-in|$USERNAME$|art=$ARTICLE$}} ~~~~'},'welcome-math': {description: 'welcome for users with an apparent interest in mathematical topics',linkedArticle: true,syntax: '{{subst:welcome-math|$USERNAME$|art=$ARTICLE$}} ~~~~'},'welcome-med': {description: 'welcome for users with an apparent interest in medicine topics',linkedArticle: true,syntax: '{{subst:welcome-med|$USERNAME$|art=$ARTICLE$}} ~~~~'},'welcome-no': {description: 'welcome for users with an apparent interest in Norway topics',syntax: '{{subst:welcome-no}} ~~~~'},'welcome-pk': {description: 'welcome for users with an apparent interest in Pakistan topics',linkedArticle: true,syntax: '{{subst:welcome-pk|$USERNAME$|art=$ARTICLE$}} ~~~~'},'welcome-phys': {description: 'welcome for users with an apparent interest in physics topics',linkedArticle: true,syntax: '{{subst:welcome-phys|$USERNAME$|art=$ARTICLE$}} ~~~~'},'welcome-pl': {description: 'welcome for users with an apparent interest in Poland topics',syntax: '{{subst:welcome-pl}} ~~~~'},'welcome-rugbyunion': {description: 'welcome for users with an apparent interest in rugby union topics',syntax: '{{subst:welcome-rugbyunion}} ~~~~'},'welcome-ru': {description: 'welcome for users with an apparent interest in Russia topics',syntax: '{{subst:welcome-ru}} ~~~~'},'welcome-starwars': {description: 'welcome for users with an apparent interest in Star Wars topics',syntax: '{{subst:welcome-starwars}} ~~~~'},'welcome-ch': {description: 'welcome for users with an apparent interest in Switzerland topics',linkedArticle: true,syntax: '{{subst:welcome-ch|$USERNAME$|art=$ARTICLE$}} ~~~~'},'welcome-uk': {description: 'welcome for users with an apparent interest in Ukraine topics',syntax: '{{subst:welcome-uk}} ~~~~'},'welcome-roads': {description: 'welcome for users with an apparent interest in roads and highways topics',syntax: '{{subst:welcome-roads}}'},'welcome-videogames': {description: 'welcome for users with an apparent interest in video game topics',syntax: '{{subst:welcome-videogames}}'},'WikiProject Women in Red invite': {description: 'welcome for users with an intrest in writing about women',syntax: '{{subst:WikiProject Women in Red invite|1=~~~~}}'}}},nonEnglish: {'Non-English welcome templates': {'welcomeen': {description: 'welcome for users whose first language is not listed here',syntax: '{{subst:welcomeen}}'},'welcomeen-ar': {description: 'welcome for users whose first language appears to be Arabic',syntax: '{{subst:welcomeen-ar}}'},'welcomeen-sq': {description: 'welcome for users whose first language appears to be Albanian',syntax: '{{subst:welcomeen-sq}}'},'welcomeen-zh': {description: 'welcome for users whose first language appears to be Chinese',syntax: '{{subst:welcomeen-zh}}'},'welcomeen-nl': {description: 'welcome for users whose first language appears to be Dutch',syntax: '{{subst:welcomeen-nl}}'},'welcomeen-fi': {description: 'welcome for users whose first language appears to be Finnish',syntax: '{{subst:welcomeen-fi}}'},'welcomeen-fr': {description: 'welcome for users whose first language appears to be French',syntax: '{{subst:welcomeen-fr}}'},'welcomeen-de': {description: 'welcome for users whose first language appears to be German',syntax: '{{subst:welcomeen-de}}'},'welcomeen-he': {description: 'welcome for users whose first language appears to be Hebrew',syntax: '{{subst:welcomeen-he}}'},'welcomeen-ja': {description: 'welcome for users whose first language appears to be Japanese',syntax: '{{subst:welcomeen-ja}}'},'welcomeen-ko': {description: 'welcome for users whose first language appears to be Korean',syntax: '{{subst:welcomeen-ko}}'},'welcomeen-ml': {description: 'welcome for users whose first language appears to be Malayalam',syntax: '{{subst:welcomeen-ml}}'},'welcomeen-mr': {description: 'welcome for users whose first language appears to be Marathi',syntax: '{{subst:welcomeen-mr}}'},'welcomeen-or': {description: 'welcome for users whose first language appears to be Oriya (Odia)',syntax: '{{subst:welcomeen-or}}'},'welcomeen-pt': {description: 'welcome for users whose first language appears to be Portuguese',syntax: '{{subst:welcomeen-pt}}'},'welcomeen-ro': {description: 'welcome for users whose first language appears to be Romanian',syntax: '{{subst:welcomeen-ro}}'},'welcomeen-ru': {description: 'welcome for users whose first language appears to be Russian',syntax: '{{subst:welcomeen-ru}}'},'welcomeen-es': {description: 'welcome for users whose first language appears to be Spanish',syntax: '{{subst:welcomeen-es}}'},'welcomeen-sv': {description: 'welcome for users whose first language appears to be Swedish',syntax: '{{subst:welcomeen-sv}}'},'welcomeen-uk': {description: 'welcome for users whose first language appears to be Ukrainian',syntax: '{{subst:welcomeen-uk}}'}}}};Twinkle.welcome.getTemplateWikitext = function(type, template, article) {// the iteration is required as the type=standard has two groupsvar properties;$.each(Twinkle.welcome.templates[type], function(label, templates) {properties = templates[template];if (properties) {return false; // break}});if (properties) {return properties.syntax.replace('$USERNAME$', Twinkle.getPref('insertUsername') ? mw.config.get('wgUserName') : '').replace('$ARTICLE$', article ? article : '').replace(/\$HEADER\$\s*/, '== Welcome ==\n\n').replace('$EXTRA$', '');  // EXTRA is not implemented yet}return '{{subst:' + template + (article ? '|art=' + article : '') + '}}' +(Twinkle.getPref('customWelcomeSignature') ? ' ~~~~' : '');};Twinkle.welcome.callbacks = {preview: function(form) {var previewDialog = new Morebits.simpleWindow(750, 400);previewDialog.setTitle('Welcome template preview');previewDialog.setScriptName('Welcome user');previewDialog.setModality(true);var previewdiv = document.createElement('div');previewdiv.style.marginLeft = previewdiv.style.marginRight = '0.5em';previewdiv.style.fontSize = 'small';previewDialog.setContent(previewdiv);var previewer = new Morebits.wiki.preview(previewdiv);var input = Morebits.quickForm.getInputData(form);previewer.beginRender(Twinkle.welcome.getTemplateWikitext(input.type, input.template, input.article), 'User talk:' + mw.config.get('wgRelevantUserName')); // Force wikitext/correct usernamevar submit = document.createElement('input');submit.setAttribute('type', 'submit');submit.setAttribute('value', 'Close');previewDialog.addContent(submit);previewDialog.display();$(submit).click(function() {previewDialog.close();});},main: function(pageobj) {var params = pageobj.getCallbackParameters();var text = pageobj.getPageText();// abort if mode is auto and form is not emptyif (pageobj.exists() && params.mode === 'auto') {Morebits.status.info('Warning', 'User talk page not empty; aborting automatic welcome');Morebits.wiki.actionCompleted.event();return;}var welcomeText = Twinkle.welcome.getTemplateWikitext(params.type, params.template, params.article);if (Twinkle.getPref('topWelcomes')) {var hasTalkHeader = /^\{\{Talk ?header\}\}/i.test(text);if (hasTalkHeader) {text = text.replace(/^\{\{Talk ?header\}\}\n{0,2}/i, '');text = '{{Talk header}}\n\n' + welcomeText + '\n\n' + text;text = text.trim();} else {text = welcomeText + '\n\n' + text;}} else {text += '\n' + welcomeText;}var summaryText = 'Welcome to Wikipedia!';pageobj.setPageText(text);pageobj.setEditSummary(summaryText);pageobj.setChangeTags(Twinkle.changeTags);pageobj.setWatchlist(Twinkle.getPref('watchWelcomes'));pageobj.setCreateOption('recreate');pageobj.save();}};Twinkle.welcome.callback.evaluate = function friendlywelcomeCallbackEvaluate(e) {var form = e.target;var params = Morebits.quickForm.getInputData(form); // : type, template, articleparams.mode = 'manual';Morebits.simpleWindow.setButtonsEnabled(false);Morebits.status.init(form);var userTalkPage = mw.config.get('wgFormattedNamespaces')[3] + ':' + mw.config.get('wgRelevantUserName');Morebits.wiki.actionCompleted.redirect = userTalkPage;Morebits.wiki.actionCompleted.notice = 'Welcoming complete, reloading talk page in a few seconds';var wikipedia_page = new Morebits.wiki.page(userTalkPage, 'User talk page modification');wikipedia_page.setFollowRedirect(true);wikipedia_page.setCallbackParameters(params);wikipedia_page.load(Twinkle.welcome.callbacks.main);};Twinkle.addInitCallback(Twinkle.welcome, 'welcome');})(jQuery);// </nowiki>