commons-issues mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From "Sebb (JIRA)" <j...@apache.org>
Subject [jira] [Commented] (MATH-1006) Add support for embedding Tex in javadoc via MathJax
Date Mon, 15 Jul 2013 14:00:54 GMT

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

Sebb commented on MATH-1006:
----------------------------

mvn javadoc:javadoc uses the BUILD section; mvn site uses the REPORTING section.

Generally if one wants to generate a report as part of site generation and stand-alone, the
configuration has to appear it two places.

See for example the apache-rat-plugin configuration in CP32.
                
> Add support for embedding Tex in javadoc via MathJax
> ----------------------------------------------------
>
>                 Key: MATH-1006
>                 URL: https://issues.apache.org/jira/browse/MATH-1006
>             Project: Commons Math
>          Issue Type: Bug
>    Affects Versions: 3.2
>            Reporter: Phil Steitz
>            Priority: Minor
>             Fix For: 3.3
>
>         Attachments: mathjax.patch
>
>
> It would be convenient to be able to embed Tex expressions in javadoc.  This can be accomplished
via the [MathJax|http://www.mathjax.org/] javascript display engine.  MathJax can be integrated
into javadoc by passing a -header option to the doclet that points to the MathJax javascript
sources.  Both maven and ant support this via configuration.  Once pom.xml (maven) and build.xml
(ant) are modified to make the MathJax functions available, javadoc can embed Tex expressions
by using standard Tex escapes: &#92;\( ... &#92;\) for inline, &#92;\[ ... &#92;\]
for formulas.

--
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

Mime
View raw message