diff options
Diffstat (limited to 'www/wiki/extensions/Mermaid/docs')
| -rw-r--r-- | www/wiki/extensions/Mermaid/docs/INSTALL.md | 71 | ||||
| -rw-r--r-- | www/wiki/extensions/Mermaid/docs/ISSUE_TEMPLATE.md | 15 | ||||
| -rw-r--r-- | www/wiki/extensions/Mermaid/docs/PULL_REQUEST_TEMPLATE.md | 12 | ||||
| -rw-r--r-- | www/wiki/extensions/Mermaid/docs/RELEASE-NOTES.md | 42 | ||||
| -rw-r--r-- | www/wiki/extensions/Mermaid/docs/USAGE.md | 27 |
5 files changed, 167 insertions, 0 deletions
diff --git a/www/wiki/extensions/Mermaid/docs/INSTALL.md b/www/wiki/extensions/Mermaid/docs/INSTALL.md new file mode 100644 index 00000000..9d65af40 --- /dev/null +++ b/www/wiki/extensions/Mermaid/docs/INSTALL.md @@ -0,0 +1,71 @@ +This file contains the *installation and configuration instructions* for the **Mermaid** extension. See also the +[readme], the [release notes] and [usage examples]. + +## Installation + +The recommended way to install this extension is using [Composer](http://getcomposer.org) with +[MediaWiki's built-in support for Composer](https://www.mediawiki.org/wiki/Composer). + +### Step 1 + +Change to the base directory of your MediaWiki installation. This is where the "LocalSettings.php" +file is located. If you have not yet installed Composer do it now by running the following command +in your shell: + + wget https://getcomposer.org/composer.phar + +### Step 2 + +If you do not have a "composer.local.json" file yet, create one and add the following content to it: + +``` +{ + "require": { + "mediawiki/mermaid": "~2.1" + } +} +``` + +If you already have a "composer.local.json" file add the following line to the end of the "require" +section in your file: + + "mediawiki/mermaid": "~2.1" + +Remember to add a comma to the end of the preceding line in this section. + +### Step 3 + +Run the following command in your shell: + + php composer.phar update --no-dev + +Note if you have Git installed on your system add the `--prefer-source` flag to the above command. Also +note that it may be necessary to run this command twice. If unsure do it twice right away. + +### Step 4 + +Add the following line to the end of your "LocalSettings.php" file: + + wfLoadExtension( 'Mermaid' ); + +### Verify installation success + +As final step, you can verify Mermaid got installed by looking at the "Special:Version" page on your wiki and +check that it is listed. + +### Configuration + +One configuration parameter is provided allowing to choose the basic theme for rendereing the graphs, diagrams +and charts. By default the rendering is set to use the `forest` theme: + + $mermaidgDefaultTheme = 'forest'; + +If one would like to use one of the other themes provided (`default`, `neutral` or `dark`) the configuration +parameter can be set to it after invoking the extension, e.g.: + + wfLoadExtension( 'Mermaid' ); + $mermaidgDefaultTheme = 'neutral'; + +[readme]: https://github.com/SemanticMediaWiki/Mermaid/blob/master/README.md +[release notes]: https://github.com/SemanticMediaWiki/Mermaid/blob/master/docs/RELEASE-NOTES.md +[usage examples]: https://github.com/SemanticMediaWiki/Mermaid/blob/master/docs/USAGE.md diff --git a/www/wiki/extensions/Mermaid/docs/ISSUE_TEMPLATE.md b/www/wiki/extensions/Mermaid/docs/ISSUE_TEMPLATE.md new file mode 100644 index 00000000..2ef2a952 --- /dev/null +++ b/www/wiki/extensions/Mermaid/docs/ISSUE_TEMPLATE.md @@ -0,0 +1,15 @@ +### Setup and configuration + +- Mermaid version: +- MediaWiki version: +- PHP version: +- Database system (MySQL, PostgresQL, etc.) and version: + +### Issue + +Produces a [stack trace](https://www.semantic-mediawiki.org/wiki/Help:Identifying_bugs) and outputs: + +``` +``` + +Steps to reproduce the observation (recommendation is to use the [sandbox](http://www.sandbox.semantic-mediawiki.org)): diff --git a/www/wiki/extensions/Mermaid/docs/PULL_REQUEST_TEMPLATE.md b/www/wiki/extensions/Mermaid/docs/PULL_REQUEST_TEMPLATE.md new file mode 100644 index 00000000..baa76247 --- /dev/null +++ b/www/wiki/extensions/Mermaid/docs/PULL_REQUEST_TEMPLATE.md @@ -0,0 +1,12 @@ +This PR is made in reference to: # + +This PR addresses or contains: +- ... +- ... +- ... + +This PR includes: +- [ ] Tests (unit/integration) +- [ ] CI build passed + +Fixes # diff --git a/www/wiki/extensions/Mermaid/docs/RELEASE-NOTES.md b/www/wiki/extensions/Mermaid/docs/RELEASE-NOTES.md new file mode 100644 index 00000000..3b9e81d1 --- /dev/null +++ b/www/wiki/extensions/Mermaid/docs/RELEASE-NOTES.md @@ -0,0 +1,42 @@ +This file contains the *release notes* of the **Mermaid** extension. See also the +[readme], the [installation and configuration information] and [usage examples]. + + +### 2.1.1 + +Released on May 20, 2019. + +* Fixes loading of configuration settings + +### 2.1.0 + +Released on March 5, 2019. + +* Drops support for MediaWiki 1.30 and earlier +* Removes deprecated `mediawiki.api.parse` alias + +### 2.0.0 + +Released on February 18, 2019. + +* Updates to using version 8.0.0 of the mermaid script language. +* Translation updates from https://translatewiki.net + +### 1.0.1 + +Released on February 13, 2018. + +* Improves ID entropy for generated diagrams and charts +* Translation updates from https://translatewiki.net + +### 1.0.0 + +Released on January 16, 2018. + +* Initial release using version 7.0.5 of the mermaid script language. +* Added an `MERMAID` parser to easily generate diagrams and flowcharts with the help of the mermaid script language +* Localizations from https://translatewiki.net + +[readme]: https://github.com/SemanticMediaWiki/Mermaid/blob/master/README.md +[installation and configuration information]: https://github.com/SemanticMediaWiki/Mermaid/blob/master/docs/INSTALL.md +[usage examples]: https://github.com/SemanticMediaWiki/Mermaid/blob/master/docs/USAGE.md diff --git a/www/wiki/extensions/Mermaid/docs/USAGE.md b/www/wiki/extensions/Mermaid/docs/USAGE.md new file mode 100644 index 00000000..b84ed126 --- /dev/null +++ b/www/wiki/extensions/Mermaid/docs/USAGE.md @@ -0,0 +1,27 @@ +This file contains basic *usage information* for the **Mermaid** extension. See also the [readme]. + +The `#mermaid` parser function allows to add [mermaid][mermaid] typed content to a wiki article. Copying, +[example syntax][examplemjs] is as easy as: + +``` +{{#mermaid:sequenceDiagram +participant Alice +participant Bob + Alice->John: Hello John, how are you? + loop Healthcheck + John->John: Fight against hypochondria + end + Note right of John: Rational thoughts <br/>prevail... + John-->Alice: Great! + John->Bob: How about you? + Bob-->John: Jolly good! +}} +``` + + +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/ +[examplesmw]: https://sandbox.semantic-mediawiki.org/wiki/Mermaid |