mod_latex/README.wiki
changeset 1786 29f3d6b7ad16
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/mod_latex/README.wiki	Mon Aug 24 16:43:56 2015 +0200
@@ -0,0 +1,21 @@
+#summary Replace LaTeX markup in messages with embedded images
+#labels Stage-Beta
+
+= Introduction =
+
+This module intercepts messages between users and into chatrooms, and attaches a links to a rendered version of any [http://en.wikipedia.org/wiki/LaTeX LaTeX] in the message. This requires client support for [http://xmpp.org/extensions/xep-0071.html XHTML-IM], and fetching images via HTTP.
+
+This module was tested with the [http://gajim.org/ Gajim] client.
+
+= Details =
+
+There is no configuration (yet). The module uses [http://www.mathtran.org/ MathTran] 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 ||
\ No newline at end of file