Skip to content

About

[READ ONLY] Split of phactorial/phactorial from One-Learning-Community/phactorial. Open issues and PRs there.

Topics

Resources

Stars

0 stars

Watchers

0 watching

Forks

Latest commit

 

History

11 Commits

Folders and files

Repository files navigation

Phactorial

Equations made simple.

phactorial/phactorial core

Math typesetting in plain PHP. It reads TeX or MathML and writes SVG, PNG, MathML, TeX, Word equations (OMML) or plain text. It needs PHP 8.4. No Node, no browser, no fonts on the server.

composer require phactorial/phactorial
use Phactorial\MathRender;

echo MathRender::fromTex('x = \frac{-b \pm \sqrt{b^2 - 4ac}}{2a}')->display()->svg(pad: 1);

Every glyph is a path, so the SVG needs no web font. Inline SVG sits on the text's baseline, and every SVG has an aria-label with the formula as text. For other formats, end the call with png(), mathml(), omml(), tex() or text().

Chemistry works the same way:

echo MathRender::fromTex('\ce{CH4 + 2O2 -> CO2 + 2H2O}')->svg();
  • Reads the TeX math commands KaTeX and MathJax support, and MathML from equation editors, Word and the web.
  • Reads mhchem chemistry (\ce, \pu), which reaches Word and MathML as real equations.
  • Converts TeX to MathML, MathML to TeX, and either to Word.
  • Never throws on input. Fixed limits keep hostile formulas cheap, and anything not drawn as written is reported.
  • About 0.1 ms per formula once the font is loaded; about 15 ms for the first formula in a new process without opcache.

Documentation

  • Overview, with a comparison to KaTeX and MathJax
  • Recipes: web pages, email, Word, conversion, alt text, untrusted input
  • Input: the builder, TeX, MathML, notes and limits
  • Output: one-call output, layout options and every writer
  • Custom backends: the display list, glyph outlines, fonts

Testing

vendor/bin/phpunit
composer analyse
php tests/render-fixtures.php   # writes tests/out/*.svg, .png (needs rsvg-convert) and index.html

tests/Fixtures.php holds the sample formulas. Fixtures named *-inline use text style; the rest use display style.

Operator spacing and stretching come from the W3C MathML Core operator dictionary. bin/gen-operators.php generates resources/operators.php and records the snapshot URL in its header.

Issues and pull requests

Development happens in One-Learning-Community/phactorial. Report issues and send pull requests there.

Credits

The layout design follows ziamath (MIT). The bundled STIX Two Math is under the SIL Open Font License 1.1 (resources/fonts/OFL.txt).

About

[READ ONLY] Split of phactorial/phactorial from One-Learning-Community/phactorial. Open issues and PRs there.

Topics

Resources

Stars

0 stars

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages