KSS plugin for client-side display of LaTeX mathematical formula by the 
jsMath library

kss.plugin.jsmath enables the use of the
`jsMath library <http://www.math.union.edu/locate/jsMath>`_ for KSS.

The plugin was sponsored by the
40th International Chemistry Olympiad (ChO), 2008 Budapest.

Egg:    http://pypi.python.org/pypi/kss.plugin.jsmath

Project page:  http://launchpad.net/kss.plugin.jsmath

Repository: hosted in bazaar, on launchpad. It can be checked out with 
the following command:

    bzr branch lp:kss.plugin.jsmath

For commit access, please sign up as member of the team "kissbooth"
on launchpad.net.

To use the development trunk directly from buildout, you can use
the recipe http://pypi.python.org/pypi/gf.recipe.bzr/


Usage
-----

jsMath has its own markers for marking the beginning and end of
the formulas in your text content. In addition, this component
provides a KSS action, that needs to be executed on the nodes,
within which you want the conversion to be enabled. This action
will activate the conversion on the selected areas only.

For example the following rule activates conversion inside all
nodes that are marked with the "mathcontent" CSS class::

    .mathcontent:load {
        action-client: jsmath-activate;
    }

Markup
------

jsMath offers more variants for marking your content, these are
controllable by parameters on the action. According to defaults,
putting the formula between the markers ``\(`` and ``\)`` works out
of the box::

  \( \textstyle \sqrt{x+2}\quad \underline 4\quad \overline{x+y}\quad x^
{\underline n}\quad x^{\overline{m+n}} \quad \sqrt{x^2+\sqrt{\alpha}} \)

The markers only become active in the areas that you select with
KSS.


Dynamic loading
---------------

jsMath has a mechanism for loading its large javascript
dynamically, on demand. The package uses this mechanism combined
with custom code that helps dynamic loading integrate with KSS.

More to be read in the README.

Caveats
-------

Since the conversion happens on client side, you will not be able
to use the same mechanism to convert your pages to PDF, on the
server side.


Special thanks
--------------

Special thanks to Dr. Gábor Magyarfalvi, at the
Institute of Chemistry, Eötvös Loránd University, Budapest,
for his support.


-- 
Balazs Ree

_______________________________________________
Kss-devel mailing list
Kss-devel@codespeak.net
http://codespeak.net/mailman/listinfo/kss-devel

Reply via email to