diff --git a/README.md b/README.md index 1031f5b..11ac959 100644 --- a/README.md +++ b/README.md @@ -13,7 +13,7 @@ This extension provides the `#mermaid` parser function to support the generation ## Requirements - PHP 5.6 or later -- MediaWiki 1.31 or later +- MediaWiki 1.33 or later ## Installation and configuration diff --git a/docs/RELEASE-NOTES.md b/docs/RELEASE-NOTES.md index 3b9e81d..6eb3e38 100644 --- a/docs/RELEASE-NOTES.md +++ b/docs/RELEASE-NOTES.md @@ -1,6 +1,12 @@ This file contains the *release notes* of the **Mermaid** extension. See also the [readme], the [installation and configuration information] and [usage examples]. +### 2.2.0 + +Released on March 7, 2020. + +* Introcudes the flowchart useMaxWidth configuration parameter +* Translation updates from https://translatewiki.net ### 2.1.1 @@ -12,7 +18,7 @@ Released on May 20, 2019. Released on March 5, 2019. -* Drops support for MediaWiki 1.30 and earlier +* Drops support for MediaWiki 1.32 and earlier * Removes deprecated `mediawiki.api.parse` alias ### 2.0.0 diff --git a/docs/USAGE.md b/docs/USAGE.md index b84ed12..538fa65 100644 --- a/docs/USAGE.md +++ b/docs/USAGE.md @@ -19,8 +19,29 @@ participant Bob ``` ![image](https://user-images.githubusercontent.com/1245473/34535703-14a32100-f106-11e7-9201-ea90a6286c58.png) + +Version 2.2.0 of this extension brought support for the flowchart useMaxWidth configuration parameter. It prevents +the respective chart from being resized to fit the size of the screen. + +It is passed to the parser function like shown: +``` +{{#mermaid:graph LR; + ... + | + config.flowchart.useMaxWidth = false +}} +``` +Note that is is also possible to further adapt the graph using CSS, e.g. to add a scrollbar: + +``` +.ext-mermaid > div { + overflow: scroll; +} +``` + Further [examples][examplesmw] have been created on wiki. + [readme]: https://github.com/SemanticMediaWiki/Mermaid/blob/master/README.md [mermaid]: https://github.com/knsv/mermaid [examplemjs]: https://mermaidjs.github.io/ diff --git a/extension.json b/extension.json index 0299c95..1c5e1c3 100644 --- a/extension.json +++ b/extension.json @@ -1,6 +1,6 @@ { "name": "Mermaid", - "version": "2.2.0-alpha", + "version": "2.2.0", "author": [ "James Hong Kong" ], @@ -9,7 +9,7 @@ "license-name": "GPL-2.0-or-later", "type": "parserhook", "requires": { - "MediaWiki": ">= 1.31" + "MediaWiki": ">= 1.33" }, "MessagesDirs": { "Mermaid": [ @@ -21,5 +21,5 @@ "Mermaid::onExtensionFunction" ], "load_composer_autoloader": true, - "manifest_version": 2 + "manifest_version": 1 }