diff options
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 39 |
1 files changed, 39 insertions, 0 deletions
diff --git a/README.md b/README.md new file mode 100644 index 0000000..9370d1f --- /dev/null +++ b/README.md @@ -0,0 +1,39 @@ +# Extension:Code + +A MediaWiki extension that builds on [SyntaxHighlight] +to provide the following (all in a configurable manner): + +* shorter tags + e.g. `<query>` instead of `<syntaxhighlight lang=sparql>` + +* code actions + e.g. automatically link the [WDQS] for SPARQL code blocks[^1] + +* code linkification + e.g. automatically link Wikidata identifiers in code blocks + +* code pages + e.g. automatically higlight pages with names ending in `.rq` + as SPARQL (and also display the code actions for them) + +Note that code actions are also linkable from other pages via the +`Special:CodeAction` special page, e.g. `Special:CodeAction/run/Example.rq` +attempts to execute the `run` action for the `Example.rq` code page +and redirect the user accordingly. + +## Installation + +1. Place the extension in your extensions directory. +2. Add `wfLoadExtension('Code');` to your `LocalSettings.php`. +3. Visit `Special:CodeAction` it will tell you what other configuration you need. + +(If you want syntax highlighting via [SyntaxHighlight], additionally add +`wfLoadExtension('SyntaxHighlight_GeSHi');` to your `LocalSettings.php`). + + +[^1]: While this can also be achieved just via MediaWiki templates, +this bears the problem that `|` has to be escaped as `{{!}}`, which can +be quite annoying for languages like SPARQL that use `|` as an operator. + +[SyntaxHighlight]: https://www.mediawiki.org/wiki/Special:MyLanguage/Extension:SyntaxHighlight +[WDQS]: https://query.wikidata.org/ |