User:MarkS/Extra edit buttons

Extra edit buttons allows the user to change the buttons on the top of the edit panel. The main features are:
 * Ability to add buttons to the toolbar. Extra Edit buttons makes a large number of extra buttons available to the user. Simply including the script will add a set of extra buttons to your toolbar.
 * The option to change the order of the buttons.
 * The option to remove the standard buttons
 * The option to include extra user defined buttons.
 * Popup dialog boxes to easily customise the markup code that is entered.

Supported Browsers
I normally test Extra Edit buttons:
 * Firefox (Windows XP SP2)
 * Internet Explorer 7 (Windows XP SP2)
 * Internet Explorer 6 (Windows XP SP2)
 * Opera (Windows XP SP2).
 * Safari (Windows) v3.0.1 onwards

The code will normally be tweaked to ensured that it works fully on these browsers.

I may sometimes test on:
 * SeaMonkey (Windows XP SP2)
 * Firefox on Linux (Ubuntu).
 * Konqueror (Ubunutu)
 * Earlier version of IE

Users
A list of users of XEB is kept at List of users. The list will be used to help contact interested parties in the event of new features/radical changes/problems. XEB will work whether or not you are on the list of users.

Simple Install
For extra edit page buttons, put the following code in your monobook.js, replacing "monobook" with the name of your skin, in all lowercase (using "standard" for Classic skin).

Once this has been done, refresh Wikipedia in your browser (select Refresh or Reload) and the new buttons will be available on your toolbar. You do not need to do anything further. If after using the extra edit buttons for some time you wish to alter the buttons available or the order of the buttons then please read the more detailed instructions below.

Customised Install
To fully customise extra edit buttons then add the following code to your monobook.js, replacing "monobook" with the name of your skin, in all lowercase (using "standard" for Classic skin).

Note: If you don't add one or more of these variables to your monobook.js then extra edit buttons will still work.
 * XEBOrder specifies which buttons to display and the order in which to display them
 * rmEditButtons lists the standard buttons to remove
 * myButtons lists extra buttons which you wish to use with extra edit buttons.

The buttons
Extra edit buttons includes the buttons listed below. Those marked as standard are added to your toolbar if you install XEB. The remaining buttons can be included by using the XEBOrder option (see below).

You can also specify completely new buttons to be included using the myButtons option (see below).

{| border='1' class="wikitable sortable" !| Icon || Name || Standard || Code || Popup || Comments / What is shown when editing
 * [[Image:Bold icon.png]] || Bold || || 0 || || Bold text
 * [[Image:Italic icon.png]] || Italic || || 1 || || Italic text
 * [[Image:Button_link.png]] || Wiki link || || 2 || || Link title
 * [[Image:External link icon.png]] || Web link || || 3 || || link title
 * [[Image:Headline icon.png]] || Heading || || 4 || || == Headline text ==
 * [[Image:Image icon.png]] || Image || || 5 || || [[Image:Example.jpg]]
 * [[Image:Media icon.png]] || Media File Link || || 6 || || [[Media:Example.ogg]]
 * [[Image:Math icon.png]] || Mathematical Formula || || 7 || || $$Insert formula here$$
 * [[Image:Nowiki icon.png]] || No Wiki || || 8 || ||  Insert non-formatted text here
 * [[Image:Signature icon.png]] || Signature || || 9 || || -- ~
 * [[Image:H-line icon.png]] || Horizontal Line || || 10 || ||
 * [[Image:Button_headline2.png]] || Secondary Headline || * ||A || ||
 * [[Image:Media icon.png]] || Media File Link || || 6 || || [[Media:Example.ogg]]
 * [[Image:Math icon.png]] || Mathematical Formula || || 7 || || $$Insert formula here$$
 * [[Image:Nowiki icon.png]] || No Wiki || || 8 || ||  Insert non-formatted text here
 * [[Image:Signature icon.png]] || Signature || || 9 || || -- ~
 * [[Image:H-line icon.png]] || Horizontal Line || || 10 || ||
 * [[Image:Button_headline2.png]] || Secondary Headline || * ||A || ||
 * [[Image:Signature icon.png]] || Signature || || 9 || || -- ~
 * [[Image:H-line icon.png]] || Horizontal Line || || 10 || ||
 * [[Image:Button_headline2.png]] || Secondary Headline || * ||A || ||
 * [[Image:H-line icon.png]] || Horizontal Line || || 10 || ||
 * [[Image:Button_headline2.png]] || Secondary Headline || * ||A || ||
 * [[Image:Button_headline2.png]] || Secondary Headline || * ||A || ||

Secondary headline

 * [[Image:Button_enter.png]] || Line break ||  ||B || ||
 * [[Image:Button_enter.png]] || Line break ||  ||B || ||

Left-aligned text Centred text Right-aligned text
 * [[Image:Button_align_left.png]] || Align left || * ||D || ||
 * [[Image:Button_align_left.png]] || Align left || * ||D || ||
 * [[Image:Button_center.png]] || Centred text || * ||C || ||
 * [[Image:Button_center.png]] || Centred text || * ||C || ||
 * [[Image:Button_align_right.png]] || Align Right || * ||D1 || ||
 * [[Image:Button_align_right.png]] || Align Right || * ||D1 || ||
 * [[Image:Button_font_color.png]] || Coloured text || * ||F || || Coloured text
 * [[Image:Button_underline.png]] || Underline || * ||U || ||  Underlined text
 * [[Image:Button_strike.png]] || Strike through text || * ||S || || Struck out text
 * [[Image:Button_sup_letter.png]] || Superscript || ||I1 |||| undefined
 * [[Image:Button_sub_letter.png]] || Subscript || ||I2 || || Subscript text
 * [[Image:Button_small.png]] || Small text || * ||J1 || || Small Text
 * [[Image:Button_array.png]] || Insert table|| * ||E|| Yes || Displays a popup allow the user to set the type of table they want. Typical markup inserted:
 * [[Image:Button_sup_letter.png]] || Superscript || ||I1 |||| undefined
 * [[Image:Button_sub_letter.png]] || Subscript || ||I2 || || Subscript text
 * [[Image:Button_small.png]] || Small text || * ||J1 || || Small Text
 * [[Image:Button_array.png]] || Insert table|| * ||E|| Yes || Displays a popup allow the user to set the type of table they want. Typical markup inserted:
 * [[Image:Button_small.png]] || Small text || * ||J1 || || Small Text
 * [[Image:Button_array.png]] || Insert table|| * ||E|| Yes || Displays a popup allow the user to set the type of table they want. Typical markup inserted:
 * [[Image:Button_array.png]] || Insert table|| * ||E|| Yes || Displays a popup allow the user to set the type of table they want. Typical markup inserted:

; Definition
 * [[Image:Btn_toolbar_gallery.png]] || Insert a gallery || * ||G || ||
 * [[Image:Btn_toolbar_gallery.png]] || Insert a gallery || * ||G || ||
 * [[Image:Button_definition_list.png]] || Definition list || * ||Q || ||
 * [[Image:Button_definition_list.png]] || Definition list || * ||Q || ||

: Item 2


 * [[Image:Btn_toolbar_enum.png]] || Numbered list || * ||W || ||
 * 1) Element 1
 * 1) Element 1


 * 1) Element 2
 * 1) Element 3

* Element 1
 * [[Image:Btn_toolbar_liste.png]] || Bulleted list || * ||X || ||
 * [[Image:Btn_toolbar_liste.png]] || Bulleted list || * ||X || ||

* Element 2 * Element 3

Block quote ==Notes==
 * [[Image:Button_category03.png]] || Category || * ||K || ||
 * [[Image:Button_shifting.png]] || Tabs || * ||L || || :
 * [[Image:Button blockquote.png]] || Block quote text || * ||M || || 
 * [[Image:Button_shifting.png]] || Tabs || * ||L || || :
 * [[Image:Button blockquote.png]] || Block quote text || * ||M || || 
 * [[Image:Button blockquote.png]] || Block quote text || * ||M || || 
 * [[Image:Button_comment.png]] || Comment || * ||H || ||
 * [[Image:Button_code.png]] || Insert code || * ||O || ||
 * [[Image:Button_reflink.png]] || Reference (see below) || * ||R ||Yes ||
 * [[Image:Button_plantilla.png]] || Add a template || * ||T || ||
 * [[Image:Button_redirect.png]] || Redirect ||   ||V || || #REDIRECT Article Name
 * [[Image:Button_miss_signature.png]] || Unsigned post || || FS || || user name or IP
 * [[Image:Button_big.png]] || Big text|| ||J2 || || Big text
 * [[Image:Button_nbsp.png]] || Non breaking space ||  ||N || ||
 * [[Image:Button_pre.png]] || Pre formatted text ||  ||P || ||  Pre formatted text
 * [[Image:Button_sub_link.png]] || Link to a sub page ||  ||P1 || || Page/Sub_Page
 * [[Image:Button_reflink.png]] || Start a reference (see below)||  ||R1 || ||  |
 * [[Image:Button template alt.png]] || Reference footer || || R4|| ||
 * [[Image:Button_nbsp.png]] || Non breaking space ||  ||N || ||
 * [[Image:Button_pre.png]] || Pre formatted text ||  ||P || ||  Pre formatted text
 * [[Image:Button_sub_link.png]] || Link to a sub page ||  ||P1 || || Page/Sub_Page
 * [[Image:Button_reflink.png]] || Start a reference (see below)||  ||R1 || ||  |
 * [[Image:Button template alt.png]] || Reference footer || || R4|| ||
 * [[Image:Button_reflink.png]] || Start a reference (see below)||  ||R1 || ||  |
 * [[Image:Button template alt.png]] || Reference footer || || R4|| ||
 * [[Image:Button_reflink_advanced_3.png]] || End a reference (see below) ||  ||R3 || || "/> |
 * [[Image:Button template alt.png]] || Reference footer || || R4|| ||
 * [[Image:Button template alt.png]] || Reference footer || || R4|| ||

Removing buttons: rmEditButtons
rmEditButtons is an array which lists the index numbers of the standard english wikipedia buttons you wish to remove. For example:

will remove buttons 0 and 2 from your toolbar.

will remove all the standard buttons from your toolbar. You may wish to use this option if you want to fully customise the toolbar and specify where the standard buttons appear in the toolbar.

rmEditButtons can only remove buttons that Wikipedia itself places on your toolbar. These buttons have numbered IDs. IF you wish to remove buttons from the default extra buttons supplied by XEB then you must use the XEBOrder variable and specify all the buttons you want XEB to add to your toolbar.

Standard Wikipedia buttons
The Wikimedia software used to power Wikipedia provides 10 standard buttons. The English version of Wikipedia then provides a further 11 standard buttons. These 21 buttons are the default toolbar shown to users. XEB provides access to these buttons using numeric codes starting from 0 (so Bold is 0, Italic is 1). You can use these codes in two ways: (i) You can include them in XEBOrder to make a standard button appear somewhere else in the toolbar, (ii) You can use then in rmEditButtons to stop wikipedia displaying them. In this way you can customise the whole toolbar.

User defined buttons: myButtons
XEB can also work with extra buttons created by the user. To do this you must define the myButtons variable in your monobook.js. The format of myButtons is:

where:


 * Code is a code for the button. You should place this code in XEBOrder to make your button appear on the toolbar. You can use any text you like. However, it is recommended that you start the code with an underscore to make sure it doesn't clash with any future standard XEB buttons. This must be in upper case letters.
 * URL is the full URL to the button image. You must enter the URL of the image on its own, rather than the Wikimedia page that describes the button, so use: http://upload.wikimedia.org/wikipedia/commons/f/f0/Bouton_Vandale0.png rather than http://commons.wikimedia.org/wiki/Image:Bouton_Vandale0.png
 * ToolTip is the popup tooltip that will appear when the mouse moves over the button.
 * Before is the text to insert before the current cursor location.
 * After is the text to place after the current cursor location.
 * Text is the text that is placed between before and after. If the user has selected text in the edit box when the button is pressed this selected text will be placed between before and after instead.

This example defines two extra buttons:

For more examples and usable buttons, see the !voting/discussion buttons made by Willscrlt.

Pictures for myButtons
This is the list of buttons we know of so far (the list below includes the standard buttons). Buttons used by the 'extra buttons' have captions. Please upload any new buttons you find to the commons:Category:ButtonToolbar and add them to the gallery below (in alphabetical image order, so we can find duplicates and easily know what is there). Buttons not in Commons cat are tagged as MOVE TO COMMONS (please upload them to Commons and remove the tag from the gallery). The list as of now may contain duplicates, images not upload to commons and images at commons not at category — please help fix it!

Popups
From the 6 March 2007 XEB includes popups on a number of buttons. Popups are dialog boxes that float over the web page when you click on the button. The dialog boxes are to make it easier to customise in more detail the markup code that gets entered.

The popups currently available are:

Requests
If you want something extra added or changed then you can:


 * Amend the code. Please note: If you amend the main code (User:MarkS/extraeditbuttons.js) then everybody who uses XEB will pick up the change at the same. For this reason you should test changes in a development version (see below) before amending the live code.
 * Leave a request on the talk page, ideally with the code you want added.

Changes

 * April 24 2006 changed toolbar buttons-now on two lines.
 * Wikipedia has revised how it builds toolbar buttons. Wikipedia now seems to build its toolbar buttons through on onload event after the page has loaded. Extra edit buttons overrode this which stopped the buttons working. However, as the buttons are now loading after the page has loaded the extra edit buttons now have to be added first. The choice was either add the buttons before wikipedia's or add them on a separate line. I have gone for a separate line.


 * April 25 2006 fundamental changes
 * I have removed all the original code which insert HTML into the toolbar and replaced it by filling in the javascript array wmCustomEditButtons. This seems to be the official way to do it and the resulting code is a lot neater.


 * June 26 2006 Added 4 extra buttons: template, category, reflink and references
 * October 13 2006 Complete rewrite of the code added. Ability to change the order of the buttons and which buttons are shown.
 * November 19 2006 Added tl button and updated two images.
 * December 13 2006 All toolbar buttons (XEB and standard buttons) are now fully customizable. Changes to the timing of when the buttons are setup. Users can now defined their own buttons. Ability to remove some or all of the standard buttons. Order of standard Wikipedia buttons can changed.
 * 6 March 2007 Major upgrade. XEB now features popups on some of the buttons. These display a dialog box to complete with parameters. The markup code then depends on the inserted text.
 * 8 March 2007. Quick update to fix a bug. It looks as if the order of items in the array which stores the mediaWiki standard buttons has changed. When these were copied to XEB then the URL of the image ended up as the popup text. This quick update copies the info a different way. The bug only affect people who reused the standard MediaWiki buttons elsewhere in the toolbar.
 * 28 April 2007. Update to the way text from popups is inserted into the page. This mainly affects IE which had problems putting the text in right place after Wikipedia's edit box had lost focus. Version: 3.1

Development Versions
My test version can be found under User:MarkS/Extra edit buttons/dev.js. This version may or may not be different to the live version. You can use this version by updating your monobook.js to use the test version rather than the live version.

If trying out your own changes then you can use the test version or you may find it easier to take a copy of the live code and create a test version under your userpages. Change the reference in your monobook.js to this test version. Then try out your changes. Once your changes have been made and tested then either update the live code or ask me. Note: When I update the live version I usually test in IE7, Opera and Firefox (Windows versions).

Installing XEB on your own Wiki
Installing XEB on setups other than Wikipedia is not something that is supported. However, the steps may help:


 * 1) You will need your own setup of the MediaWiki software. This is not something I can help you with. However, I have used Wiki on a stick and found it easy to setup. I have also installed XEB on it.
 * 2) You must enable users to run Javascript by setting $wgAllowUserJS to true in LocalSettings.php (see: )
 * 3) For the simplest install create a user called MarkS (or see below at 6).
 * 4) Copy the XEB script from User:MarkS/extraeditbuttons.js to the same location on your wiki
 * 5) Copy the XEB css from User:MarkS/XEB/live.css to the same location on your wiki
 * 6) Get users to include the script by editing their monobook.js. (Note: The easiest way to do this without creating a user MarkS is adding an accordant line in [MonoBook].php (the php of your skin)!) You might be able to do this the same way that it works on Wikipedia (see the top of this article). Alternatively use the following lines (changing the URL as necessary):
 * 7. Once the script is running you should move the images from MediaWiki to your own wiki.

There may be other ways to install the script. For example it could be installed in common.js which would provide the script to all users. I have never tried this.

Credits

 * Brian0918 who supplied the code to English Wikipedia from Hebrew Wikipedia
 * Ingoolemo for supply the code for four of the buttons and the original GIF images (which I converted to PNG)
 * Olliminatore for supplying a major rewrite of the code producing something significantly shorter and simpler
 * Karl Dickman for converting some GIF images to PNG images

de:User:Olliminatore/Extra-Editbuttons es:User:Axxgreazz/Monobook-Suite/Botonera