mediawiki/graph-viz

Online DOT graph renderer and message sequence chart renderer

Installs: 22 416

Dependents: 1

Suggesters: 3

Security: 0

Type:mediawiki-extension

3.1.0 2017-12-18 02:52 UTC

README

Latest Stable Version Packagist download count

The MediaWiki GraphViz extension lets users collaborate to create and display graphs and message sequence charts as in-line images on wiki pages using tools from the open-source Graphviz and Mscgen projects. For more information, consult the release notes.

Requirements

  • PHP 5.4 or later
  • MediaWiki 1.23 or later

Installation

The recommended way to install this extension is by using Composer. Just add the following to the MediaWiki composer.json file and run the `php composer.phar install/update` command.

{
	"require": {
		"mediawiki/graph-viz": "^2.0"
	}
}

Configuration

To configure this extension, you may set any of the following after wfLoadExtension( 'GraphViz' ); in your LocalSettings.php:

  • $wfGraphVizExecPath, defines the path to the GraphViz binaries, such as dot. Default is null, which gets converted to /usr/bin/ on POSIX and C:\Program Files\Graphviz\bin\ on Windows.
  • $wfGraphVizMscgenPath, defines the path to the mscgen binaries. Default is "".
  • $wfGraphVizDefaultImageType, defines the default output image format. Default is "png".

Contribution and support

Development is coordinated by Keith Welter and Jeroen De Dauw.

If you have remarks, questions, or suggestions, please add a topic to the GraphViz extension talk page.

If you want to contribute work to the project, start by reading the MediaWiki hacker tutorial. A list of people who have made contributions in the past can be found here.

To report a bug, go here.

License

Generally published under GNU General Public License 2.0 or later together with third-party plugins and their license.