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 11:11:04 GMT

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

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

Sorry, it seems just {{MathJax.js}} is insufficient as it will try to load various other resources
by relative paths. 

For reference, in theory we could include the whole MathJax distribution repackaged into Maven
artifacts from http://www.webjars.org/, by modifying {{maven-javadoc-plugin}} to:

{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}/META-INF/resources/webjars/mathjax/2.7.0/MathJax.js"&gt;&lt;/script&gt;'</additionalparam>
               <resourcesArtifacts>
                       <resourcesArtifact>
                           <groupId>org.webjars.npm</groupId>
                           <artifactId>mathjax</artifactId>
                           <version>2.7.0</version>
                       </resourcesArtifact>
               </resourcesArtifacts>
</configuration>
</plugin>
{code}

However this doesn't work, as for compatibility with WAR, webjars have folders like {{META-INF/resources/webjars/mathjax/2.7.0}},
but {{maven-javadoc-plugin}}
sadly [ignores META-INF|https://github.com/apache/maven-plugins/blob/a9566e14f980ff52f3ee3c89d64d6b98b03c0305/maven-javadoc-plugin/src/main/java/org/apache/maven/plugin/javadoc/AbstractJavadocMojo.java#L4234].

Another problem is that the mathjax JAR is 23 MB (it is also the complete git source tree),
which in our case would be embedded within each of the module's Javadoc folders, and also
within the javadoc.jar (if we add that javadoc config to {{<build><plugins>}})

So -- sorry for this disgression - I think I will change my opinion to go with the new official
CDN hosted at https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.1/MathJax.js  (as currently
committed on master).

> 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