commons-issues mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From "Stian Soiland-Reyes (JIRA)" <j...@apache.org>
Subject [jira] [Commented] (NUMBERS-36) mathjax CDN shutting down - will soon break javadoc
Date Tue, 09 May 2017 10:35:04 GMT

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

Stian Soiland-Reyes commented on NUMBERS-36:
--------------------------------------------

I guess ideally the MathJax.js should be included, that means we don't rely on the third-party
CDN and avoid any firewall/security concerns for anyone else hosting the JavaDoc.

This seems to work across the modules:

{code:xml}
      <plugin>
        <groupId>org.apache.maven.plugins</groupId>
        <artifactId>maven-javadoc-plugin</artifactId>
        <configuration>
                <additionalparam>-Xdoclint:all --allow-script-in-comments -header '&lt;script
type="text/javascript" src="{@docRoot}/resources/MathJax.js?config=TeX-AMS-MML_HTMLorMML"&gt;&lt;/script&gt;'</additionalparam>
          <!-- <aggregate>true</aggregate> -->
                <javadocDirectory>${numbers.parent.dir}/src/main/javadoc</javadocDirectory>
                <docfilessubdirs>true</docfilessubdirs>
        </configuration>
      </plugin>
{code}

And then a single file {{src/main/javadoc/resources/MathJax.js}}

Agreed?  It would have to be replaced from mathjax.org  in{{src/main/javadoc}} when a new
MathJax is needed - but the CDN approach would also require version within URL to be updated.


Another advantage is that if then the javascript will also be embedded in the javadoc.jar
(note however that Eclipse don't render with Javascript)

> mathjax CDN shutting down - will soon break javadoc
> ---------------------------------------------------
>
>                 Key: NUMBERS-36
>                 URL: https://issues.apache.org/jira/browse/NUMBERS-36
>             Project: Commons Numbers
>          Issue Type: Bug
>            Reporter: Stian Soiland-Reyes
>            Assignee: Stian Soiland-Reyes
>
> Javadoc for Commons Math, Commons Numbers and friends use a the [MathJax|https://www.mathjax.org/]
Javascript in order to render LaTeX equation within Javadoc. (See MATH-1006)
> This used to be included as http://cdn.mathjax.org/mathjax/latest/MathJax.js?config=TeX-AMS-MML_HTMLorMML
-- but now [cdn.mathjax.org is shutting down|https://www.mathjax.org/cdn-shutting-down/].
There is a temporary redirect.
> There are several alternatives suggested, with the recommended being:
> {code}
> <script type="text/javascript" async
>   src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.1/MathJax.js?...">
> </script>
> {code}
> Other alternatives include rawgit.com - e.g. https://cdn.rawgit.com/mathjax/MathJax/2.7.1/MathJax.js
with a fixed version - which is probably a good thing. I've tried this approach for Commons
Numbers, which seems to work -- not sure if adding {{?config=TeX-AMS-MML_HTMLorMML}} would
make any difference there as rawgit caches the file directly from GitHub.
> Of course the MathJax javascript is Apache-licensed, so we could easily embed it in the
ASF source code - but then in multi-module projects I wonder if we would then need to share
it across all modules.



--
This message was sent by Atlassian JIRA
(v6.3.15#6346)

Mime
View raw message