Extension:CharInsert/en

The CharInsert extension allows to create JavaScript links that when clicked, insert predefined text into the text box.

These links are usually used in MediaWiki:Edittools (example on this wiki) system message.

Syntax
Use tags with a space-separated list of characters or tags for which you wish to allow insertion.

You can use + sign inside a tag to define a place to:


 * insert selected text or
 * place cursor if no text was selected.

You have to enclose templates and spaces inside :

Individual characters
Individual characters are just listed between the "charinsert" tags.

results in

Combined characters
Combined characters are listed between the "charinsert" tags and connected by the "+" sign.

results in

Overriding display text
A different display text can be specified in the  attribute (if you use this, you should use separate   tags for each character in order to specify different display texts).

results in

Advanced Installation
Important: You must have for this to work.

Styling


To give the charinsert lists additional styling, wrap the contents of your Edittools between  and  and add styling for them to your. This site (www.mediawiki.org) does that to make the links appear like buttons (as shown in the screenshot to the side). The below stylesheet was used for that, copy it to your to apply the same styling.

Alternatively, you can choose a style closer to the Wikimedia Design Style Guide and the WikimediaUI theme:

Scripting
If you have many CharInsert links, one could use JavaScript to put them in separate groups and allow dynamic switching with a dropdown menu. For example to separate diacritical characters from wikisyntax etc. Several sites (such as mediawiki.org, de.wikipedia.org and en.wikipedia.org) have done this. They all implemented it in different ways though. Documented below is the way it is done on mediawiki.org:


 * 1. Wrap all the charinsert tags on MediaWiki:Edittools into a container and give it a descriptive, unique, ID (for example "mw-edittools-charinsert"):
 * 2. Wrap each individual block of charinserts into tags like this:
 * Don't change the word 'mw-edittools-section'
 * The text behind "data-section-title=" will identify this group in the dropdown menu.
 * Make sure there is one group without the ' ' directive: That will be the default choice in the dropdown menu. On this site, it is called 'Standard' while the other groups are named by the language for which the characters are significant.
 * 3. Copy the contents of MediaWiki:Gadget-Edittools.js to an equally named page on your own wiki
 * 4. Add the following code to your :
 * Edittools[ResourceLoader|default]|Edittools.js
 * 3. Copy the contents of MediaWiki:Gadget-Edittools.js to an equally named page on your own wiki
 * 4. Add the following code to your :
 * Edittools[ResourceLoader|default]|Edittools.js

English Wikipedia CharInsert menu
For implementing CharInsert menu like the one used on the English Wikipedia, either export gadgets: Charinsert-core, Charinsert-styles, and Charinsert and then import them on your own wiki through Special:Import or if you want to do it manually, copy the following four interface pages to your wiki:


 * MediaWiki:Gadget-charinsert-core.js (Wikipedia) - Main JavaScript file.
 * MediaWiki:Gadget-charinsert-styles.css (Wikipedia) - Creates surrounding boxes around the symbols/characters giving them the look of buttons.
 * MediaWiki:Gadget-charinsert.js (Wikipedia) - CharInsert loader.
 * MediaWiki:Gadget-charinsert (Wikipedia) - For the text shown in user preferences' gadgets section.


 * In your MediaWiki:Gadgets-definition, add the following definitions:

charinsert-core[ResourceLoader|hidden|dependencies=jquery.textSelection,user,mediawiki.storage]|charinsert-core.js charinsert-styles[ResourceLoader|hidden|type=styles]|charinsert-styles.css This particular English Wikipedia character set also contains templates, which will need to be defined separately, if they are to be used on your Wiki.
 * charinsert[ResourceLoader|default|peers=charinsert-styles]|charinsert.js
 * }
 * MediaWiki:Edittools (Wikipedia) - Only for users with JavaScript turned off or unsupported (which disables the WikiEditor extension too), therefore not really necessary or useful either. It only shows symbols/characters as simple text below the editor window, which can then be copy-pasted and thus be of some help to editors. Apparently, it does not get activated in English Wikipedia for disabled JavaScript.

English Wikipedia Solution checked on: November 6, 2018