[xwiki-devs] [Proposal] MathTex plugin integration
Hi dev folks, I developed a math plugin ("MathTex") to render LaTeX math expressions in XWiki. Currently the plugin supports two formula renderer: - The default one (contained in xwiki-plugin-mathtex-core.jar) is LGPL and thus can be embedded in the XWiki packages - The other one is GPL (powered by JMathTex) and gives better results. It can used by adding the xwiki-plugin-mathtex-ext.jar to the classpath and adding a parameter to the xwiki.cfg to override the default renderer (xwiki.plugins.mathtex.builder=org.thenesis.xwiki.plugin.mathtex.JMathTexFormulaImageBuilder) In order to work this plugin requires modifications of some parts of the XWiki default classes/files: - xwiki.cfg - macros.txt/macros.vm - struts-config.xml - XWikiRightServiceImpl.java (privileges for actions) So an admin couldn't just grab it from the plugin zone and make it work out-of-the-box. Hence I would like to propose this plugin for integration in XWiki with two alternatives: 1) Full integration 2) Partial integration (macros, struts-config.xml, XWikiRightServiceImpl.java changes) + users still have to load the plugin jar(s) from the plugin zone. --Guillaume Legris
Guillaume, can you compare this to the usage of the MathTran webservice (for which contributed a very short macro found in xwiki jira) ? Could you provide a web-page about the MathTeX plugin. MathTeX seems to be a name that is used for several different things, among others a cgi script. Finally, could you provide syntax examples and coverage, if it is a home-grown TeX processor. thanks in advance paul Le 03-juin-09 à 11:23, Guillaume Legris a écrit :
Hi dev folks,
I developed a math plugin ("MathTex") to render LaTeX math expressions in XWiki.
Currently the plugin supports two formula renderer: - The default one (contained in xwiki-plugin-mathtex-core.jar) is LGPL and thus can be embedded in the XWiki packages - The other one is GPL (powered by JMathTex) and gives better results. It can used by adding the xwiki-plugin-mathtex-ext.jar to the classpath and adding a parameter to the xwiki.cfg to override the default renderer (xwiki .plugins .mathtex .builder =org.thenesis.xwiki.plugin.mathtex.JMathTexFormulaImageBuilder)
In order to work this plugin requires modifications of some parts of the XWiki default classes/files: - xwiki.cfg - macros.txt/macros.vm - struts-config.xml - XWikiRightServiceImpl.java (privileges for actions)
So an admin couldn't just grab it from the plugin zone and make it work out-of-the-box.
Hence I would like to propose this plugin for integration in XWiki with two alternatives: 1) Full integration 2) Partial integration (macros, struts-config.xml, XWikiRightServiceImpl.java changes) + users still have to load the plugin jar(s) from the plugin zone.
--Guillaume Legris _______________________________________________ devs mailing list [email protected] http://lists.xwiki.org/mailman/listinfo/devs
Hi Paul,
can you compare this to the usage of the MathTran webservice (for which contributed a very short macro found in xwiki jira) ?
MathTran is a very good service but there are some potential issues: - Not reachable from a local wiki (for ex. from a company LAN) without internet access (or with limited internet access) - Availability: MathTran doesn't guarantee a level of QoS (from the MathTran website: "We try to keep the site on-line all day, every day but we do not guarantee this") - Performances: Likewise But as MathTex supports pluggable renderers, a MathTran renderer can be also added if required. Thus users could use the same macro syntax whatever the renderer actually used. It probably means I should merge some of your previous works, if you're ok.
Could you provide a web-page about the MathTeX plugin.
You can find some demos here (temporary page) : http://midpath.thenesis.org/bin/view/Main/MathTexPlugin
MathTeX seems to be a name that is used for several different things, among others a cgi script.
The MathTex plugin is not related to libraries with similar names. I don't think it really collides as it's just a xwiki specific plugin and not a new library. But maybe another name would be better. -- Guillaume
Le 03-juin-09 à 16:30, Guillaume Legris a écrit :
can you compare this to the usage of the MathTran webservice (for which contributed a very short macro found in xwiki jira) ?
MathTran is a very good service but there are some potential issues: - Not reachable from a local wiki (for ex. from a company LAN) without internet access (or with limited internet access) - Availability: MathTran doesn't guarantee a level of QoS (from the MathTran website: "We try to keep the site on-line all day, every day but we do not guarantee this") - Performances: Likewise
Against this, the plugin could do caching at the xwiki level. This would also enable the very famous js-finety of MathTran that can adjust baselines (because it can then parse the png header). Pluggeability is dangerous: if you change the thing it might break all the fomrulæ but I guess it's acceptable.
But as MathTex supports pluggable renderers, a MathTran renderer can be also added if required. Thus users could use the same macro syntax whatever the renderer actually used. It probably means I should merge some of your previous works, if you're ok.
You can certainly do that but there's very little to be done. MathTran can also be compiled on your own server...
Could you provide a web-page about the MathTeX plugin.
You can find some demos here (temporary page) : http://midpath.thenesis.org/bin/view/Main/MathTexPlugin
MathTeX seems to be a name that is used for several different things, among others a cgi script.
The MathTex plugin is not related to libraries with similar names. I don't think it really collides as it's just a xwiki specific plugin and not a new library. But maybe another name would be better.
Then just choose "XWiki TeX Plugin" I would suggest. paul
Hi Guillaume, On Wed, Jun 3, 2009 at 5:10 PM, Paul Libbrecht <[email protected]> wrote:
Le 03-juin-09 à 16:30, Guillaume Legris a écrit :
can you compare this to the usage of the MathTran webservice (for which contributed a very short macro found in xwiki jira) ?
MathTran is a very good service but there are some potential issues: - Not reachable from a local wiki (for ex. from a company LAN) without internet access (or with limited internet access) - Availability: MathTran doesn't guarantee a level of QoS (from the MathTran website: "We try to keep the site on-line all day, every day but we do not guarantee this") - Performances: Likewise
Against this, the plugin could do caching at the xwiki level. This would also enable the very famous js-finety of MathTran that can adjust baselines (because it can then parse the png header).
Pluggeability is dangerous: if you change the thing it might break all the fomrulæ but I guess it's acceptable.
But as MathTex supports pluggable renderers, a MathTran renderer can be also added if required. Thus users could use the same macro syntax whatever the renderer actually used. It probably means I should merge some of your previous works, if you're ok.
You can certainly do that but there's very little to be done.
MathTran can also be compiled on your own server...
Could you provide a web-page about the MathTeX plugin.
You can find some demos here (temporary page) : http://midpath.thenesis.org/bin/view/Main/MathTexPlugin
MathTeX seems to be a name that is used for several different things, among others a cgi script.
The MathTex plugin is not related to libraries with similar names. I don't think it really collides as it's just a xwiki specific plugin and not a new library. But maybe another name would be better.
Then just choose "XWiki TeX Plugin" I would suggest.
Great, I'd love to see the plugin in action somewhere to see how it behaves. XWiki TeX Plugin or XWikiTeX sounds good to me as a name for the plugin. Guillaume paul
_______________________________________________ devs mailing list [email protected] http://lists.xwiki.org/mailman/listinfo/devs
-- Guillaume Lerouge Product Manager - XWiki Skype ID : wikibc http://guillaumelerouge.com/
Guillaume Legris wrote:
Hi dev folks,
I developed a math plugin ("MathTex") to render LaTeX math expressions in XWiki.
Currently the plugin supports two formula renderer: - The default one (contained in xwiki-plugin-mathtex-core.jar) is LGPL and thus can be embedded in the XWiki packages - The other one is GPL (powered by JMathTex) and gives better results. It can used by adding the xwiki-plugin-mathtex-ext.jar to the classpath and adding a parameter to the xwiki.cfg to override the default renderer (xwiki.plugins.mathtex.builder=org.thenesis.xwiki.plugin.mathtex.JMathTexFormulaImageBuilder)
In order to work this plugin requires modifications of some parts of the XWiki default classes/files: - xwiki.cfg - macros.txt/macros.vm - struts-config.xml - XWikiRightServiceImpl.java (privileges for actions)
So an admin couldn't just grab it from the plugin zone and make it work out-of-the-box.
Hence I would like to propose this plugin for integration in XWiki with two alternatives: 1) Full integration 2) Partial integration (macros, struts-config.xml, XWikiRightServiceImpl.java changes) + users still have to load the plugin jar(s) from the plugin zone.
What Guillaume forgot to ask, what do we do with the plugin? Should it be part of the core? Should it be put on code.xwiki.org? Should we setup the xlets repository? -- Sergiu Dumitriu http://purl.org/net/sergiu/
If we can put it xlet repository it will be better. -arvind On Wed, Jun 3, 2009 at 10:23 PM, Sergiu Dumitriu <[email protected]> wrote:
Guillaume Legris wrote:
Hi dev folks,
I developed a math plugin ("MathTex") to render LaTeX math expressions in XWiki.
Currently the plugin supports two formula renderer: - The default one (contained in xwiki-plugin-mathtex-core.jar) is LGPL and thus can be embedded in the XWiki packages - The other one is GPL (powered by JMathTex) and gives better results. It can used by adding the xwiki-plugin-mathtex-ext.jar to the classpath and adding a parameter to the xwiki.cfg to override the default renderer
(xwiki.plugins.mathtex.builder=org.thenesis.xwiki.plugin.mathtex.JMathTexFormulaImageBuilder)
In order to work this plugin requires modifications of some parts of the XWiki default classes/files: - xwiki.cfg - macros.txt/macros.vm - struts-config.xml - XWikiRightServiceImpl.java (privileges for actions)
So an admin couldn't just grab it from the plugin zone and make it work out-of-the-box.
Hence I would like to propose this plugin for integration in XWiki with two alternatives: 1) Full integration 2) Partial integration (macros, struts-config.xml, XWikiRightServiceImpl.java changes) + users still have to load the plugin jar(s) from the plugin zone.
What Guillaume forgot to ask, what do we do with the plugin? Should it be part of the core? Should it be put on code.xwiki.org? Should we setup the xlets repository?
-- Sergiu Dumitriu http://purl.org/net/sergiu/ _______________________________________________ devs mailing list [email protected] http://lists.xwiki.org/mailman/listinfo/devs
Sergiu Dumitriu wrote:
Guillaume Legris wrote:
Hi dev folks,
I developed a math plugin ("MathTex") to render LaTeX math expressions in XWiki.
Currently the plugin supports two formula renderer: - The default one (contained in xwiki-plugin-mathtex-core.jar) is LGPL and thus can be embedded in the XWiki packages - The other one is GPL (powered by JMathTex) and gives better results. It can used by adding the xwiki-plugin-mathtex-ext.jar to the classpath and adding a parameter to the xwiki.cfg to override the default renderer (xwiki.plugins.mathtex.builder=org.thenesis.xwiki.plugin.mathtex.JMathTexFormulaImageBuilder)
In order to work this plugin requires modifications of some parts of the XWiki default classes/files: - xwiki.cfg - macros.txt/macros.vm - struts-config.xml - XWikiRightServiceImpl.java (privileges for actions)
So an admin couldn't just grab it from the plugin zone and make it work out-of-the-box.
Hence I would like to propose this plugin for integration in XWiki with two alternatives: 1) Full integration 2) Partial integration (macros, struts-config.xml, XWikiRightServiceImpl.java changes) + users still have to load the plugin jar(s) from the plugin zone.
What Guillaume forgot to ask, what do we do with the plugin? Should it be part of the core? Should it be put on code.xwiki.org? Should we setup the xlets repository?
Guillaume, I think it would be better to become part of the official platform, and I'll be maintaining it. Could you create a Jira issue and attach the code to it, please? Thanks. -- Sergiu Dumitriu http://purl.org/net/sergiu/
participants (5)
-
Arvind Gupta -
Guillaume Legris -
Guillaume Lerouge -
Paul Libbrecht -
Sergiu Dumitriu