Extension:DrawioEditor

MediaWiki extensions manual
OOjs UI icon advanced.svg
DrawioEditor
Release status: stable
Implementation Parser function
Description draw.io editor integration
Author(s) (Markus Geberttalk)
Latest version 1.1
License MIT License
Download
  • $wgDrawioEditorImageType
  • $wgDrawioEditorImageInteractive
Translate the DrawioEditor extension if it is available at translatewiki.net
Check usage and version matrix.
Issues Open tasks · Report a bug

OverviewEdit

This is a MediaWiki extension that integrates the draw.io flow chart editor and allows inline editing of charts.

WarningsEdit

Please read these warnings carefully before use:

  • The actual editor functionality is loaded from draw.io. This code only provides integration.
  • Be aware that draw.io is an online service and while this plugin integrates the editor using an iframe and communicates with it only locally in your browser (javascript postMessage), it cannot guarantee that the code loaded from draw.io will not upload any data to foreign servers. This may be a privacy concern. Read the Privacy section in the documentation on GitHub for more information. When in doubt, don't use draw.io or this module. You have been warned!
  • This plugin is quite new and probably still has bugs, so it may or may not work with your installation.

FeaturesEdit

  • draw.io chart creation and editing.
  • SVG and PNG support. The file type can be configured globally and changed on a per-image basis.
  • Inline Editing and javascript uploads on save, you never leave or reload the wiki page.
  • Image files are transparently stored in the standard wiki file store, you don't need to worry about them.
  • Versioning is provided by the file store, revert to an older version of the chart at any time.
  • Draw.io original XML data is stored within the image files, so only one file must be stored per chart.
  • Supports multiple charts per page.
  • Supports relative and fixed chart dimensions.

RequirementsEdit

  • When you intend to use SVG which is recommended, you might want to install Extension:NativeSvgHandler too. Also you need a browser that supports SVG.
  • While displaying charts may work in older browsers, especially when using PNG (SVG is default and recommended), saving charts requires a fairly recent browser.

InstallationEdit

  • Download and place the file(s) in a directory called DrawioEditor in your extensions/ folder.
  • Add the following code at the bottom of your LocalSettings.php:
    wfLoadExtension( 'DrawioEditor' );
    
  •   Done – Navigate to Special:Version on your wiki to verify that the extension is successfully installed.

UsageEdit

Add the following to any wiki page to insert a draw.io chart:

{{#drawio:ChartName}}

Save the page and you'll see a placeholder with an Edit link on its top right. Click it to start the draw.io editor.

Please head over to GitHub for further usage instructions and examples: https://github.com/wikimedia/mediawiki-extensions-DrawioEditor/blob/master/README.md#usage

See alsoEdit

LinksEdit