[jira] [Created] (MJAVADOC-699) mathjax based on dependency

[Ernst Reissner (Jira)]

Ernst Reissner created MJAVADOC-699:
---------------------------------------

             Summary: mathjax based on dependency
                 Key: MJAVADOC-699
                 URL: https://issues.apache.org/jira/browse/MJAVADOC-699
             Project: Maven Javadoc Plugin
          Issue Type: New Feature
          Components: javadoc
    Affects Versions: next-release
            Reporter: Ernst Reissner


For including math in api docs I use mathjax. 

To that end i configure the javadoc plugin as follows: 
```
          <additionalOptions>
            <additionalOption>-Xdoclint:all 
-Xdoclint:-missing</additionalOption>
            <additionalOption>--allow-script-in-comments</additionalOption>
          </additionalOptions>
          <header>
            &lt;script type="text/javascript" 
        
src="http://cdn.mathjax.org/mathjax/latest/MathJax.js?config=TeX-AMS_HTML,https://www.simuline.eu/MathJax/config/myDefault.js"&gt;
 &lt;/script&gt;
          </header>
```

you can see that I download the config from 
```
https://www.simuline.eu/MathJax/config/myDefault.js
```

I think this is not what I want to do, because it is public and unversioned. 
Have a look at 
https://maven.apache.org/plugins/maven-javadoc-plugin/examples/help-configuration.html
 describing javadoc plugins concept for helpfiles: 
it is based on dependencies. 

This is a quite general solution also other plugins make use of 
as summarized in https://adangel.org/2016/02/22/sharing-pmd-rulesets/: 
It is on 
 -   Checkstyle configuration
 -   PMD configuration
-   FindBugs configuration
 -   Code-Formatting configuration for IDEs
 -   ...

My suggestion is to use that also for mathjax config and maybe also for the 
converter 
which is http://cdn.mathjax.org/mathjax/latest/MathJax.js?config=TeX-AMS_HTML 
in my case but I would also prefer a local solution with specified version (in 
my case 'latest'). 




--
This message was sent by Atlassian Jira
(v8.20.1#820001)