[jira] [Commented] (MAHOUT-1198) Allow Latex in javadox

[Andrew Musselman (JIRA)]

    [ 
https://issues.apache.org/jira/browse/MAHOUT-1198?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=13644849#comment-13644849
 ] 

Andrew Musselman commented on MAHOUT-1198:
------------------------------------------

The MathJax site says you can configure it to render using MathML if the 
service is down..

http://www.mathjax.org/demos/mathml-samples/

http://www.w3.org/Math/
http://www.w3.org/Math/whatIsMathML.html
                
> Allow Latex in javadox
> ----------------------
>
>                 Key: MAHOUT-1198
>                 URL: https://issues.apache.org/jira/browse/MAHOUT-1198
>             Project: Mahout
>          Issue Type: Bug
>            Reporter: Ted Dunning
>
> We are headed into a release (hopefully) and now would be a nice time to add 
> the capability to generate javadocs with embedded latex.
> Following a hint from commons math, I tested a way to inject mathjax into the 
> header of the resulting web-site and got good results (see 
> http://tdunning.github.io/bandit-ranking/ especially docs for 
> GammaNormalDistribution and BetaBinomialDistribution.
> The basic idea is that we need to add the following config to the javadocs 
> plugin:
> {quote}
> <configuration>
>     <additionalparam>-header &apos;&lt;script 
> type=&quot;text/javascript&quot; 
> src=&quot;http://cdn.mathjax.org/mathjax/latest/MathJax.js?config=TeX-AMS_HTML&quot;&gt;
>  &lt;/script&gt;&apos;</additionalparam>
> </configuration>
> {quote}
> Having done this, \[ \] and \( \) can be used to embed latex equations in the 
> javadocs.

--
This message is automatically generated by JIRA.
If you think it was sent incorrectly, please contact your JIRA administrators
For more information on JIRA, see: http://www.atlassian.com/software/jira