Difference between revisions of "MediaWiki:Common.js/edit.js"

// <syntaxhighlight lang="javascript">
// Special edit-page functions, loaded for specific pages in MediaWiki:Common.js/edit.js
//== Imported from en.wikipedia.org and modified (parts removed).
// for authors see http://en.wikipedia.org/w/index.php?title=MediaWiki:Common.js/edit.js&action=history


/** Extra toolbar options ******************************************************
 *  
 *  Description: Adds extra buttons to the editing toolbar.
 *  
 *  To disable this script, add <code>mwCustomEditButtons = [];<code> to [[Special:Mypage/monobook.js]].
 *  
 *  Maintainers: [[User:MarkS]], [[User:Voice of All]], [[User:R. Koot]]
 */

if (mwCustomEditButtons) {
    mwCustomEditButtons.push({
        "imageFile": "https://upload.wikimedia.org/wikipedia/en/c/c8/Button_redirect.png",
        "speedTip": "Redirect",
        "tagOpen": "#REDIRECT [[",
        "tagClose": "]]",
        "sampleText": "Target page name"
    });
    
    mwCustomEditButtons.push({
        "imageFile": "https://upload.wikimedia.org/wikipedia/en/c/c9/Button_strike.png",
        "speedTip": "Strike",
        "tagOpen": "<s>",
        "tagClose": "</s>",
        "sampleText": "Strike-through text"
    });
    
    mwCustomEditButtons.push({
         "imageFile": "https://upload.wikimedia.org/wikipedia/en/1/13/Button_enter.png",
        "speedTip": "Line break",
        "tagOpen": "<br />",
        "tagClose": "",
        "sampleText": ""
    });
    
    mwCustomEditButtons.push({
        "imageFile": "https://upload.wikimedia.org/wikipedia/en/8/80/Button_upper_letter.png",
        "speedTip": "Superscript",
        "tagOpen": "<sup>",
        "tagClose": "</sup>",
        "sampleText": "Superscript text"
    });
    
    mwCustomEditButtons.push({
        "imageFile": "https://upload.wikimedia.org/wikipedia/en/7/70/Button_lower_letter.png",
        "speedTip": "Subscript",
        "tagOpen": "<sub>",
        "tagClose": "</sub>",
        "sampleText": "Subscript text"
    });
 
    mwCustomEditButtons.push({
        "imageFile": "https://upload.wikimedia.org/wikipedia/commons/5/58/Button_small.png",
        "speedTip": "Small",
        "tagOpen": "<small>",
        "tagClose": "</small>",
        "sampleText": "Small Text"
    });
    
    mwCustomEditButtons.push({
        "imageFile": "https://upload.wikimedia.org/wikipedia/commons/7/74/Button_comment.png",
        "speedTip": "Insert hidden Comment",
        "tagOpen": "<!-- ",
        "tagClose": " -->",
        "sampleText": "Comment"
    });
    
    mwCustomEditButtons.push({
        "imageFile": "https://upload.wikimedia.org/wikipedia/en/1/12/Button_gallery.png",
        "speedTip": "Insert a picture gallery",
        "tagOpen": "\n<gallery>\n",
        "tagClose": "\n</gallery>",
        "sampleText": "Image:Example.jpg|Caption1\nImage:Example.jpg|Caption2"
    });
    
    mwCustomEditButtons.push({
        "imageFile": "https://upload.wikimedia.org/wikipedia/en/f/fd/Button_blockquote.png",
        "speedTip": "Insert block of quoted text",
        "tagOpen": "<blockquote>\n",
        "tagClose": "\n</blockquote>",
        "sampleText": "Block quote"
    });
    
    mwCustomEditButtons.push({
        "imageFile": "https://upload.wikimedia.org/wikipedia/en/6/60/Button_insert_table.png",
        "speedTip": "Insert a table",
        "tagOpen": '{| class="wikitable" border="1"\n|',
        "tagClose": "\n|}",
        "sampleText": "-\n! header 1\n! header 2\n! header 3\n|-\n| row 1, cell 1\n| row 1, cell 2\n| row 1, cell 3\n|-\n| row 2, cell 1\n| row 2, cell 2\n| row 2, cell 3"
    });
    
    mwCustomEditButtons.push({
        "imageFile": "https://upload.wikimedia.org/wikipedia/commons/7/79/Button_reflink.png",
        "speedTip": "Insert a reference",
        "tagOpen": "<ref>",
        "tagClose": "</ref>",
        "sampleText": "Insert footnote text here"
    });

    mwCustomEditButtons.push({
        "imageFile": "https://upload.wikimedia.org/wikipedia/commons/d/d2/Button_source.png",
        "speedTip": "Insert source code syntax highlighting (e.g. bash)",
        "tagOpen": "<syntaxhighlight lang=\"bash\">\n",
        "tagClose": "</syntaxhighlight>",
        "sampleText": "df -h # shows disk’s free space in a human readable form"
    });
}


//fix edit summary prompt for undo
//this code fixes the fact that the undo function combined with the "no edit summary prompter" causes problems if leaving the
//edit summary unchanged
//this was added by [[User:Deskana]], code by [[User:Tra]]
//see bug 8912
addOnloadHook(function () {
    if (document.location.search.indexOf("undo=") != -1
        && document.getElementsByName('wpAutoSummary')[0]) {
        document.getElementsByName('wpAutoSummary')[0].value='1';
    }
})

/** Edittools javascript loader ************************************************
 *
 *  Description: Pulls in [[MediaWiki:Edittools.js]]. Includes a cache-bypassing
 *  version number in the URL in order to allow any changes to the edittools to
 *  be rapidly deployed to users.
 *
 *  Note that, by default, this function does nothing unless the element with
 *  the ID "editpage-specialchars" (which contains the old edittools code in
 *  [[MediaWiki:Edittools]], and will be retained as a placeholder in the new
 *  implementation) has a class named "edittools-version-NNN", where NNN is a
 *  number.  If the class name has "test" before the number, the code will only
 *  run for users who have set "window.testJsEdittools = true" in their user JS.
 *  The "test" should be retained in the class name until the new edittools
 *  implementation is ready and fully tested, and until at least 30 days have
 *  passed since this loader stub was added (which will be in 27 June 2008).
 *
 *  For compatibility with Alex Smotrov's original implementation, on which this
 *  code is loosely based (see [[mw:User talk:Alex Smotrov/edittools.js]]), this
 *  loader can also be disabled by setting "window.noDefaultEdittools = true".
 *
 *  Maintainers: [[User:Ilmari Karonen]]
 */

addOnloadHook(function () {
    // needs to be deferred until the DOM has fully loaded
    var placeholder = document.getElementById("editpage-specialchars");
    if (!placeholder || window.noDefaultEdittools) return;
    var match = /(?:^| )edittools-version-(\d+)(?: |$)/.exec(placeholder.className);
    
    // set window.testJsEdittools = true to enable testing before full deployment
    if (!match && window.testJsEdittools)
        match = /(?:^| )edittools-version-(test\d+)(?: |$)/.exec(placeholder.className);
    
    if (!match) return;
    var url = wgScript + '?title=MediaWiki:Edittools.js&action=raw&ctype=text/javascript&nocache=' + match[1];
    importScriptURI(url);
});

/**
  * Add buttons to the UI toolbar
  */
if ( typeof $j !== 'undefined' && typeof $j.fn.wikiEditor !== 'undefined' ) {
  $j( function() {
    $j( '#wpTextbox1' ).wikiEditor( 'addToToolbar', {
      'section': 'advanced',
      'group': 'insert',
      'tools': {
        'syntaxhighlight': {
          label: 'Syntax highlighting',
          type: 'button',
          icon: 'https://upload.wikimedia.org/wikipedia/commons/d/d2/Button_source.png',
          action: {
            type: 'encapsulate',
            options: {
              pre: "<syntaxhighlight lang=\"bash\">\n",
              post: "\n</syntaxhighlight>"
            }
          }
        },
        'category': {
          label: 'Insert a category',
          type: 'button',
          icon: 'https://upload.wikimedia.org/wikipedia/commons/b/b4/Button_category03.png',
          action: {
            type: 'encapsulate',
            options: {
              pre: "[[Category: ",
              post: "]]"
            }
          }
        },
        'comment': {
          label: 'Insert a comment',
          type: 'button',
          icon: 'https://upload.wikimedia.org/wikipedia/commons/7/74/Button_comment.png',
          action: {
            type: 'encapsulate',
            options: {
              pre: "<!-- ",
              post: " -->"
            }
          }
        },
        'blockquote':{
          label: 'Insert a blockquote',
          type: 'button',
          icon: 'https://upload.wikimedia.org/wikipedia/en/f/fd/Button_blockquote.png',
          action: {
            type: 'encapsulate',
            options: {
              pre: "<blockquote>\n",
              post: "\n</blockquote>"
            }
          }
        }
      }
    });
    $j( '#wpTextbox1' ).wikiEditor( 'addToToolbar', {
      'section': 'advanced',
      'group': 'format',
      'tools': {
        'strikethrough': {
          label: 'Strike out',
          type: 'button',
          icon: 'https://upload.wikimedia.org/wikipedia/commons/3/30/Btn_toolbar_rayer.png',
          action: {
            type: 'encapsulate',
            options: {
              pre: "<s>",
              post: "</s>"
            }
          }
        }
      }
    });
  });
}

// </syntaxhighlight>