MathRen (TeX math rendering)

Kylo

MathRen for Flarum

NOW SUPPORTS CUSTOM DELIMITERS ($$...$$)!

An extension that handles TeX math rendering for your Flarum forum.

Screenshot

Action

Click to view settings screenshot

Features

Based on KaTeX (the fastest math typesetting library on the web).
Supports AsciiMath syntax.
Display expressions as an inline or a block element.
Compatible with Markdown and BBCode.
Copy any expression's source code to the clipboard.
Integration with flarum/mentions extension so you can quote expressions with selection.
Works on preview mode.

Installation

composer require the-turk/flarum-mathren

Updating

composer update the-turk/flarum-mathren
php flarum cache:clear

Usage

Enable the extension.

Block Expressions `displayMode: true`

Wrap your TeX code with [math] and [/math] or your custom delimiters.

[math]\int_{-\infty}^\infty\hat\xi\,e^{2\pi i\xi x}\,d\xi[/math]

Block expressions will be wrapped with .mathren-block class.

Inline Expressions `displayMode: false`

Wrap your TeX code with [imath] and [/imath] or your custom delimiters.

Lorem ipsum dolor [imath]\varDelta = b^2-4ac[/imath] sit amet.

Inline expressions will be wrapped with .mathren-inline class.

Wrap your expression with `backticks` or code tag to skip rendering.

Links

luceos

Kylo great job, the first extension is always the hardest; getting to know how to write an extension, applying your ideas into code. Well done. And interesting to see how much the math community seems to be attracted to Flarum, I'm curious why this is happening..

Kylo

luceos Well, as a mechanical engineer i can say that science is complicated enough but at least we want our scrapbooks to be simple and pleasant 😄 Thanks for your kind words.

tankerkiller125

luceos Based on talking to the local Math Club at a local university (using flarum, friend of mine is part of club and I recommended flarum) they've told me that the primary reasons they like flarum is that it's minimal, easy to use. highly customizable, and more importantly for them the threads are easy to follow and highly linkable (mentions) meaning that conversations for them is very fluid.

Kylo

🎉 Just released `0.2.0`

I practically rewritten the whole thing. Here is the changelog:

Move settings to the left pane
It was a long set of options to be shown in a modal.
Remove <code /> wrapper
You don't have to wrap your expressions with <code /> tag anymore for Markdown or BBCode compability.
Add <span /> wrapper with customizable class names
You still can stylize your expressions.
Add text editor buttons.
Disabled by default.
Add customizable delimiters options.
Now you can use unlimited set of delimiters through this extension.
Add decisive keywords option to ignore expressions.
Add option for allowing \color command (TeX) to take two arguments.
Update README.md

🐞 Known issues

You're very welcome to open a pull request on GitHub.

When writing with delimiters other than BBCodes, preview mode is still parsing Markdown.
Can't quote an expression with selection.
Macros are not flexible.

Alkir

Kylo syntax error, unexpected ')'
в C:\xampp\htdocs\test_pered_zalivom_na_server\vendor\the-turk\flarum-mathren\src\Listeners\LoadSettings.php строке 72

Kylo

Alkir Whoops! Strange that i didn't get this. It should be fixed now. Could you try again?

Alkir

Kylo Cool, everything works

YUX-IO

Flarum encountered a boot error (ParseError)
syntax error, unexpected ')'
thrown in /www/wwwroot/flarum/vendor/the-turk/flarum-mathren/src/Listeners/LoadSettings.php on line 72

i got this when i enable the extension, so i have to remove it from the backend.
i'm not very faimilar to the php, shoud l delete the ')' ?
thanks

Kylo

YUX-IO it's the same issue that @Alkir has encountered. Please try to remove and install it again and let me know if it solves the issue.

...never mind:

`0.2.1`

Fix syntax error.

YUX-IO

Kylo it seems like i get a bigger problem 😅

Deprecated: Non-static method TheTurk\MathRen\Helpers\ArrayHelpers::commaToArray() should not be called statically in /www/wwwroot/flarum/vendor/the-turk/flarum-mathren/src/Listeners/LoadSettings.php on line 66

Deprecated: Non-static method TheTurk\MathRen\Helpers\ArrayHelpers::bbCodeMatcher() should not be called statically in /www/wwwroot/flarum/vendor/the-turk/flarum-mathren/src/Listeners/LoadSettings.php on line 84

Deprecated: Non-static method TheTurk\MathRen\Helpers\ArrayHelpers::delimiterList() should not be called statically in /www/wwwroot/flarum/vendor/the-turk/flarum-mathren/src/Listeners/LoadSettings.php on line 90

Deprecated: Non-static method TheTurk\MathRen\Helpers\ArrayHelpers::setOptions() should not be called statically in /www/wwwroot/flarum/vendor/the-turk/flarum-mathren/src/Helpers/ArrayHelpers.php on line 16

Fatal error: Uncaught Zend\HttpHandlerRunner\Exception\EmitterException: Output has been emitted previously; cannot emit response in /www/wwwroot/flarum/vendor/zendframework/zend-httphandlerrunner/src/Exception/EmitterException.php:23 Stack trace: #0 /www/wwwroot/flarum/vendor/zendframework/zend-httphandlerrunner/src/Emitter/SapiEmitterTrait.php(39): Zend\HttpHandlerRunner\Exception\EmitterException::forOutputSent() #1 /www/wwwroot/flarum/vendor/zendframework/zend-httphandlerrunner/src/Emitter/SapiEmitter.php(26): Zend\HttpHandlerRunner\Emitter\SapiEmitter->assertNoPreviousOutput() #2 /www/wwwroot/flarum/vendor/zendframework/zend-httphandlerrunner/src/RequestHandlerRunner.php(97): Zend\HttpHandlerRunner\Emitter\SapiEmitter->emit(Object(Zend\Diactoros\Response\HtmlResponse)) #3 /www/wwwroot/flarum/vendor/flarum/core/src/Http/Server.php(44): Zend\HttpHandlerRunner\RequestHandlerRunner->run() #4 /www/wwwroot/flarum/public/index.php(22): Flarum\Http\Server->listen() #5 {main} thrown in /www/wwwroot/flarum/vendor/zendframework/zend-httphandlerrunner/src/Exception/EmitterException.php on line 23

Kylo

these errors compeletely makes sense but why i and some other users are not getting these lol 🤣

`0.2.2`

Fix static methods.

It somehow seems unstable to me even after the changes that i've made. I will run some tests until the next release.

You still can downgrade to v0.1.0 safely.

YUX-IO

Kylo super thanks!!!!! it works!

clarkwinkelmann

Kylo why i and some other users are not getting these lol

Those are PHP warnings/notices/errors, not exceptions. Usually it's recommended to turn them off in php.ini in production, but turn them on for development. You can adjust your php settings on your dev machine to try and get them to show up.

I've had many issues of array to string conversion and undefined index errors in the past because I didn't enable the notices on my computer but the extension ended up installed on server that showed those messages.

Kylo

`0.2.3`

Fix (hopefully) all PHP-related errors/warnings/notices. (shout-out to clarkwinkelmann for pointing me the right direction on this)
Fix \[%e%\] must come last (if any) in the additional delimiters list.
Improve rendering performance.

`0.2.4`

Remove unnecessary files.
Remove filter definitions.
Fix a typo in settings page component.
Fix linebreaks ruins rendering expressions.

`0.2.5`

Add Ukranian language

yuchangye

Thank you for developing this extension!

maybe it is a bug？My formula needs to be added `` to make it useful (⊙_⊙)？

clarkwinkelmann

yuchangye can you expand on what you are entering, what you expect and what happens ? Backticks are usually used for inline code blocks, so I'm not sure what the relation is to this extension ?

Kylo

yuchangye sorry, i didn't understand your issue either. This extension has nothing to do with backticks? If you're a Chinese speaker, you could comment both Chinese and English and then maybe @Littlegolden can help us with the translation.

yuchangye

Kylo emm,sorry my english is poor😥,look this
我的代码块需要加上``包裹才可以生效，是本来就是这样吗？Littlegolden
QQ截图20200305113417.png

Littlegolden

Im ready!

Littlegolden

yuchangye ` 这个符号是用来显示代码的，是表示直接显示被包裹的内容，举个例子：加粗文字的 md 语法是这样的：**加粗**。这样就能防止文字被渲染出效果。按理来说您加入了这个符号。。公式不应该被渲染出来啊。。。

This symbol is an "insert code" symbol. The content wrapped by this symbol will not be rendered into visual content. On my forum, inserting mathematical formulas does not need to add this symbol.

Kylo

yuchangye if you want to prevent them from rendering:

go to mathren settings page -> List of DOM node types to ignore when recursing through -> add code into that list

you could also use [math=ignore][/math] by default for the same effect

Kylo

Littlegolden that makes no sense 🤔

yuchangye could you give me your flarum url so i can look into it?