Uploaded image for project: 'Commons Math'
  1. Commons Math
  2. MATH-1006

Add support for embedding Tex in javadoc and site docs via MathJax

    Details

    • Type: Bug
    • Status: Closed
    • Priority: Minor
    • Resolution: Fixed
    • Affects Version/s: 3.2
    • Fix Version/s: 3.3
    • Labels:
      None

      Description

      It would be convenient to be able to embed Tex expressions in javadoc, xdocs and apt. This can be accomplished via the MathJax 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: \( ... \) for inline, \[ ... \] for formulas.

        Attachments

          Issue Links

            Activity

              People

              • Assignee:
                Unassigned
                Reporter:
                psteitz Phil Steitz
              • Votes:
                0 Vote for this issue
                Watchers:
                1 Start watching this issue

                Dates

                • Created:
                  Updated:
                  Resolved: