Diff

mod_latex/README.md @ 6003:fe081789f7b5

All community modules: Unify file extention of Markdown files to .md
author Menel <menel@snikket.de>
date Tue, 22 Oct 2024 10:26:01 +0200
parent 1803:4d73a1a6ba68
line wrap: on
line diff
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/mod_latex/README.md	Tue Oct 22 10:26:01 2024 +0200
@@ -0,0 +1,39 @@
+---
+labels:
+- 'Stage-Beta'
+summary: Replace LaTeX markup in messages with embedded images
+...
+
+Introduction
+============
+
+This module intercepts messages between users and into chatrooms, and
+attaches a links to a rendered version of any
+[LaTeX](http://en.wikipedia.org/wiki/LaTeX) in the message. This
+requires client support for
+[XHTML-IM](http://xmpp.org/extensions/xep-0071.html), and fetching
+images via HTTP.
+
+This module was tested with the [Gajim](http://gajim.org/) client.
+
+Details
+=======
+
+There is no configuration (yet). The module uses
+[MathTran](http://www.mathtran.org/) to render the LaTeX.
+
+Todo
+====
+
+-   Support for other rendering services (easy)
+-   Provide a built-in rendering service (e.g. mimetex)
+-   Send the images inline over XMPP (little client support at the
+    moment)
+
+Compatibility
+=============
+
+  ----- -------
+  0.6   Works
+  0.7   Works
+  ----- -------