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

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

Rank to TopRank to BottomBulk Copy AttachmentsBulk Move AttachmentsVotersWatch issueWatchersConvert to sub-taskLinkCloneUpdate Comment AuthorReplace String in CommentUpdate Comment VisibilityDelete Comments
    XMLWordPrintableJSON

Details

    • Bug
    • Status: Closed
    • Minor
    • Resolution: Fixed
    • 3.2
    • 3.3
    • None
    • 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

          This comment will be Viewable by All Users Viewable by All Users
          Cancel

          People

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

            Dates

              Created:
              Updated:
              Resolved:

              Slack

                Issue deployment