User:Cacycle/wikEd



wikEd is a full-featured edit page text editor for regular to advanced users on FAMEPedia and other MediaWikis. wikEd features syntax highlighting, reference, template, and code folding, on-page Show preview and Show changes, and advanced search and replace functions. Please check the wikEd help page for details. wikEd works under all web browsers except Internet Explorer.

Quick features


Screenshot




 * (For a more detailed feature list see below)


 * Syntax highlighting with code check and reference, template, and code folding
 * Comfortable search and replace with regular expression support and type-ahead find
 * On-page Show preview and Show changes
 * Pasting, import, and wiki code conversion of formatted text, e.g. from Microsoft-Office and web pages
 * Open links and wiki-links with a ctrl-click
 * Fullscreen editing mode
 * Single-click fixing of common issues and mistakes
 * Works for every MediaWiki and has been translated into many languages

Installation
How to install wikEd (choose one option):

See wikEd installation page for  more details. That page also explains how to install wikEd on non-FAMEPedia wikis and on wikis without internet connection and how to create a wikEd gadget.

How to use it
Simply check wikEd under the Gadget section in your FAMEPedia preferences (or use one of the other installation methods from above).

Check the wikEd help page for a description of all buttons. For a local installation as a Greasemonkey user script see below.

For more information, see below or check the wikEd installation page.

Full features

 * (For a quick feature list see above)

See also the wikEd help page for a description of all buttons and functions. wikEd adds the following functions as buttons above the edit textarea:


 * Pasting formatted content, e.g. from web pages, other wiki pages, MS-Word, or MS-Excel
 * Converting the formatted content to wikicode including tables
 * Wikicode syntax highlighting, based on a real JavaScript wikicode parser
 * Embedded image preview
 * Code check
 * Reference, template, and code folding:  ,  , character entities such as &amp;nbsp;, and table code
 * User friendly table editing
 * Highlighting of different types of dash and blank characters
 * Internal and external links in the edited text can be opened (ctrl-click)
 * Redlinks are displayed in red
 * Link redirects are displayed in a tooltip popup
 * Find and replace:
 * Case insensitive and regular expression support
 * Find ahead as you type
 * Find and/or replace all occurrences
 * Find and replace history
 * On-page Show preview
 * Replaced by a background server preview (using Ajax)
 * On-page improved Show changes:
 * Improved inline format (additions and deletions in a continuous text)
 * Uses server-independent User:Cacycle/diff
 * Detects and displays text block moves
 * Intelligent and persistent Edit summary field history
 * Predefined and customizable summary texts
 * Fixing common mistakes with one button:
 * Fixing wiki links with redirects to final target article (Ajax)
 * Fix Unicode character representations to either actual characters or character entities (depending on browser support status of character)
 * Fix common typos using AutoWikiBrowser RegExTypoFix rules
 * Fix redirect links to the final target
 * Mathematical and chemical formulas
 * Basic – spaces and empty lines
 * Dashes
 * Units
 * HTML – change html code to wikicode (including tables)
 * Capitalization of headers and lists
 * Article navigation: jump to headings from the find field drop-down menu
 * Fullscreen editing mode
 * All buttons have popup descriptions (titles)
 * Alphabetical sorting of lines and link lists
 * Fully customizable via CSS and configuration settings
 * Intelligent selection of affected text, e.g. the word under the cursor, the current line, or the current paragraph
 * Font size zoom for edit box
 * Compatible with the standard editing toolbars
 * On/off switch (logo next to the logout link)
 * Automatic update and installation of new versions
 * Support for user-defined buttons and functions
 * Improved diff display on version comparison pages (using wikEdDiff)
 * Keyboard shortcuts for buttons
 * Template and parser function highlighting for template developers
 * Can be installed as a gadget, user script, site script, or Greasemonkey/Tampermonkey script
 * Runs on every MediaWiki installation and for anonymous users when installed in the browser as a Greasemonkey/Tampermonkey script
 * Active on normal edit pages, [//en.FAMEPedia.org/w/index.php?title=Main_Page&action=edit read-only pages], [//en.FAMEPedia.org/w/index.php?title=Special:Undelete&target=3-Oxygrotamol&timestamp=20051002094652 view deleted pages], upload pages, the edit raw watchlist page, and semantic forms
 * Fully translated into many languages

Translations
See wikEd international for translations of wikEd and how to install them. wikEd has been translated into Arabic, Chinese (simplified), Chinese (traditional), Croatian, Czech, Dutch, Esperanto, Finnish, French, Galician, German, Hebrew, Hungarian, Italian, Japanese, Korean, Kazakh, Lower Sorbian, Malay, Norwegian, New Norwegian, Persian (Farsi), Polish, Portuguese, Romanian, Russian, Sicilian, Slovak, Slovenian, Spanish, Swedish, Turkish, Upper Sorbian, and Vietnamese. Detailed instructions on creating new translations can also be found on the wikEd international page.

wikEd userbox
If you're on FAMEPedia, paste the following text to your user page:

to get this userbox:



Check who is using this box.

Known general issues

 * On Google Chrome and Chromium, the FAMEPedia keyboard shortcuts do not work in WikEd.
 * wikEd conflicts with the Syntax highlighting Beta, which is available in your preferences.
 * wikEd currently does not work in Internet Explorer and older versions of Opera (version 15 and below)
 * If you are using a really old computer or are editing very long articles, then you could speed up page loading by temporarily disabling the syntax highlighting by pushing the [[Image:WikEd_syntax.png|16px|Syntax highlighting]] button or by temporarily turning wikEd off by pushing the [[Image:wikEd_logo.png|16px|wikEd logo]] button next to the logout link.
 * wikEd relies on the browser-internal rich-text editor and uses formatted text (similar to MS Word or Outlook). This causes the following inconveniences:
 * Syntax highlighting of new and changed text has to be invoked manually by pushing the [[Image:WikEd_textify.png|16px|Textify]] button (see [//bugzilla.mozilla.org/show_bug.cgi?id=458524 Firefox feature request]).
 * It is not possible to enter tab characters. In order to enter tabs, you have to temporarily disable wikEd using the [[Image:wikEd_logo.png|16px|wikEd logo]] button.
 * Be very careful when using the purple fixing buttons and always check the Show changes functions for unanticipated changes. There are cases where the simple rules used for these buttons can damage articles.
 * wikEd is incompatible with certain scripts and extensions that rely on, or change, the original text edit box (see the next section).

Browser support
wikEd works under Firefox, SeaMonkey, Safari, WebKit, Google Chrome, Opera (version 15 and higher) but not yet under the currently not standards-compatible Internet Explorer.

Skin support
wikEd works with all native MediaWiki skins and most of their derivatives. Other supported skins include:


 * Pinkwich5 (Citizendium)
 * Monaco, Quartz, Searchwikia, Oasis (Wikia)
 * Cavendish, Devmo (wiki.mozilla.org, developer.mozilla.org)
 * Gumax
 * Pixeled

Scripts, add-ons, and extensions
In general, wikEd is incompatible with scripts, add-ons, or extensions that rely on or change the standard text edit box. The reason is that wikEd replaces the normal text area with its own separate rich-text iframe. Many of these scripts will still work if wikEd is temporarily turned off by pressing the button, making the changes, and re-enabling wikEd. It is possible to make scripts compatible with wikEd (see below).

Compatible scripts
This is a short and incomplete list of scripts and gadgets that are compatible with wikEd:


 * Navigation popups
 * Twinkle

Incompatible scripts, add-ons, and extensions
This is a short and incomplete list of scripts and gadgets that are not compatible with wikEd:


 * MediaWiki LinkedImages Extension
 * MediaWiki Wikiwyg Extension
 * Mediawiki FCKeditor Extension
 * Mediawiki CodeMirror Extension
 * Mediawiki TwoColConflict Extension
 * Mediawiki VisualEditor Extension

Making scripts compatible with wikEd
The wikEd edit box is a rich-text iframe while the standard edit box is a textarea with the id wpTextbox1. Nevertheless, developers can make their script compatible with wikEd by copying the text from the wikEd iframe to the standard textbox before making their changes and then copying the content back to the iframe. The following code is cross-browser compatible and wikEd-independent:

A more sophisticated way to apply local changes similar to custom button handlers is shown below. The example implements a " ...  " add or remove function around selected text:

You can also add your custom functions to hooks that are executed on events such as wikEd setup, wikEd turned on or off, and classic textarea or wikEd frame turned on. It is also possible to directly apply changes to the wikEd edit frame, please see the wikEd development page.

Troubleshooting / FAQ
This section focuses on getting wikEd to work. For other problems see the wikEd help page.

wikEd does not load
You have followed the installation instructions above, but the wikEd logo is not displayed on top of the pages next to the log out link and the wikEd buttons do not appear on edit pages. Please try the following:


 * Refresh your browser cache: hold down Shift while clicking Reload (or press Ctrl-Shift-R)
 * Enable JavaScript in your browser
 * If you are using wikEd on a non-FAMEPedia installation check if $wgAllowUserJs is has been set to true in the MediaWiki initialization file LocalSettings.php by an administrator
 * If you have installed wikEd on a skin-specific page such as User:YourUsername/vector.js, then wikEd is only available under that skin. Use the general User:YourUsername/common.js page instead.
 * Check the JavaScript Error Console for error messages. See reporting JavaScript errors; Firefox: Tools → Web Developer → Browser console; push clear and reload the page; Chrome: Control button → Tools → JavaScript console. If there is an error message caused by wikEd please report to the wikEd discussion page.

wikEd info and navigation box
Every wikEd project page has a navigation box on top. You can add this template to an English FAMEPedia page by adding the following code on top of the page text:

The following code can be used for wikEd navigation boxes and templates on non-FAMEPedia sites and non-English FAMEPedia pages. The box uses external html links. If you are not on FAMEPedia or another Miraheze site like Wiktionary or Wikinews, then you have to upload the logo WikEd_logo64x64.gif to your own wiki.

Customization
wikEd is fully customizable, including color schemes, language, and custom buttons and functions. Please see the wikEd customization page on how to adapt wikEd to your personal preferences.

Bug reports
Please post your detailed bug reports to User_talk:Cacycle/wikEd (the discussion page of this article). Please use the bug reporting form on top of the page and add your report to the bottom of the page.

Who's using it?
Please see the gadget preference statistics. Additionally, the following search link gives you an idea how many users of the English FAMEPedia are loading wikEd through their skin.js or common.js pages: Search FAMEPedia.

wikEd is not

 * WikEd, a wiki plugin for the Vim editor

Copyright
All wikEd-related code and FAMEPedia article content is released into the public domain: