User:DWalden (WMF)/WikiEditor

Documentation for setting up and testing the WikiEditor extension, also known as the "2010 wikitext editor".

Installing

edit

From your mediawiki repository

  1. cd extensions
  2. git clone https://gerrit.wikimedia.org/r/mediawiki/extensions/WikiEditor
  3. cd ..
  4. Add to your LocalSettings.php the line: wfLoadExtension( 'WikiEditor' );
  5. docker-compose up -d && docker-compose exec mediawiki composer update && docker-compose exec mediawiki php maintenance/update.php --quick

You should be able to go to any page on your local wiki and open the source editor. You will see a new set of menu options at the top of the text input field.

If not, it might be that it is disabled. Go to Special:Preferences, click the "Editing" tab and check the option that says "Enable the editing toolbar"

 

Things to consider when testing

edit
  • Consider regressions:
    • Test that you can still successfully enter an external link to another website (could be anything like http://duckduckgo.com)
    • Test you can still enter an internal link (e.g. enter just the title of another page on the same wiki like Polar_bear)
  • If possible, compare the behaviour of the "Insert link" dialog now to an earlier version. I think you can only do this if you set it up locally.
    • I put instructions how to install it locally above. After you have installed it locally, to get the older version of the software, do:
      • cd extensions/WikiEditor
      • git checkout fd74287b2f234ca33f7af8a227dd4b0c51d2a7b5
  • Experiment with different ways of interacting with the dialog, such as pressing the enter key to submit.
  • I have found some inconsistency in the behaviour of the "Insert link" dialog when using it to add multiple links in the same session.
    • Try repeating adding a link several times in a row and see if the outcome is the same each time. (For an example of a bug like this see T297371)
    • Try closing the dialog and reopening it. It normally returns to the same state it was in when you closed it.

Components

edit