Math not rendered without network connection (Windows) (Trac #639)

[ajj]

Testing on Windows 7, a lack of network connection means that the math in the documentation does not get rendered.

On the Mac, it is still being rendered even without a network connection.

I thought that mathjax was being bundled, so this should be working.

Migrated from http://trac.sasview.org/ticket/639

{
    "status": "assigned",
    "changetime": "2017-10-26T12:37:01",
    "_ts": "2017-10-26 12:37:01.721958+00:00",
    "description": "Testing on Windows 7, a lack of network connection means that the math in the documentation does not get rendered.\n\nOn the Mac, it is still being rendered even without a network connection.\n\nI thought that mathjax was being bundled, so this should be working.",
    "reporter": "ajj",
    "cc": "",
    "resolution": "",
    "workpackage": "SasView Bug Fixing",
    "time": "2016-08-30T15:07:39",
    "component": "SasView",
    "summary": "Math not rendered without network connection (Windows)",
    "priority": "critical",
    "keywords": "",
    "milestone": "SasView 4.3.0",
    "owner": "ajj",
    "type": "defect"
}

[butlerpd]

Trac update at 2016/09/05 14:43:22: butler changed priority from "major" to "critical"

[butlerpd]

Trac update at 2016/09/05 14:43:55:

• butler changed owner from "" to "pkienzle"
• butler changed status from "new" to "assigned"

[pkienzle]

Trac update at 2016/09/07 12:53:51:

• pkienzle changed _comment0 from:

!MathJax can be shipped with !SasView.

We need to add _static/MathJax to the doc tree, with the following files from the !MathJax distribution (776 kB):

{{{
MathJax.js
config/TeX-AMS-MML_HTMLorMML-full.js
fonts/HTML-CSS/TeX/woff/*
jax/output/HTML-CSS/fonts/TeX/*
}}}

The html header needs the following:
{{{
<script type="text/x-mathjax-config">
MathJax.Hub.Config({
"HTML-CSS": {
//undefinedFamily: ["STIXGeneral, 'Arial Unicode MS', serif"],
preferredFont: "TeX",
availableFonts: ["TeX"],
webFont: "TeX",
imageFont: null
}
});
</script>
</script>
<script type="text/javascript" src="../../_static/MathJax/MathJax.js?config=TeX-AMS-MML_HTMLorMML-full"></script>
}}}

to:

1473255409788826

• pkienzle changed _comment1 from:

!MathJax can be shipped with !SasView.

We need to add _static/MathJax to the doc tree, with the following files from the !MathJax distribution (776 kB):

{{{
MathJax.js
config/TeX-AMS-MML_HTMLorMML-full.js
fonts/HTML-CSS/TeX/woff/*
jax/output/HTML-CSS/fonts/TeX/*
}}}

The html header needs the following:
{{{
<script type="text/x-mathjax-config">
MathJax.Hub.Config({
"HTML-CSS": {
//undefinedFamily: ["STIXGeneral, 'Arial Unicode MS', serif"],
preferredFont: "TeX",
availableFonts: ["TeX"],
webFont: "TeX",
imageFont: null
}
});
</script>
</script>
<script type="text/javascript" src="../../_static/MathJax/MathJax.js?config=TeX-AMS-MML_HTMLorMML-full"></script>
}}}

We might be able to accomplish this by updating sphinx conf.py with:

{{{
mathjax_path="MathJax/MathJax.js?config=TeX-AMS-MML_HTMLorMML-full&delayStartupUntil=configured"
}}}

and adding _templates/layout.html with:
{{{
{% extends "!layout.html" %}

{%- block extrahead %}
<script type="text/javascript">
MathJax.Hub.Config({
// displayAlign: "left",
// displayIndent: "2.5em",
"HTML-CSS": {
//undefinedFamily: ["STIXGeneral, 'Arial Unicode MS', serif"],
preferredFont: "TeX",
availableFonts: ["TeX"],
webFont: "TeX",
imageFont: null
}
});
MathJax.Hub.Configured()
</script>
{% endblock %}
}}}

to:

1473255885801011

• pkienzle commented:

!MathJax can be shipped with !SasView.

We need to add _static/MathJax to the doc tree, with the following files from the !MathJax distribution (776 kB):

    MathJax.js
    config/TeX-AMS-MML_HTMLorMML-full.js
    fonts/HTML-CSS/TeX/woff/*
    jax/output/HTML-CSS/fonts/TeX/*

The html header needs the following:

    <script type="text/x-mathjax-config">
    MathJax.Hub.Config({
      "HTML-CSS": {
        //undefinedFamily: ["STIXGeneral, 'Arial Unicode MS', serif"],
        preferredFont: "TeX",
        availableFonts: ["TeX"],
        webFont: "TeX",
        imageFont: null
      }
    });
    </script>
    </script>
    <script type="text/javascript" src="../../_static/MathJax/MathJax.js?config=TeX-AMS-MML_HTMLorMML-full"></script>

We might be able to accomplish this by updating sphinx conf.py with:

    mathjax_path="MathJax/MathJax.js?config=TeX-AMS-MML_HTMLorMML-full&delayStartupUntil=configured"

and adding _templates/layout.html with:

{% extends "!layout.html" %}

{%- block extrahead %}
       <script type="text/javascript">
       MathJax.Hub.Config({
           // displayAlign: "left",
           // displayIndent: "2.5em",
           "HTML-CSS": {
             //undefinedFamily: ["STIXGeneral, 'Arial Unicode MS', serif"],
             preferredFont: "TeX",
             availableFonts: ["TeX"],
             webFont: "TeX",
             imageFont: null
           }
       });
       MathJax.Hub.Configured()
       </script>
{% endblock %}

There are a few options for including !MathJax with !SasView:

• Add the 776 kB of binary files to sasmodels or to sasview that you update from time to time with the latest !MathJax?

• Pull a particular tagged version of !MathJax from [https://github.com/mathjax/MathJax/releases github] as part of the build, and copy the appropriate files and subdirectories?

• Use [https://git-scm.com/book/en/v2/Git-Tools-Submodules git submodules] to link directly to !MathJax?

[butlerpd]

Trac update at 2016/09/13 14:26:06:

• butler commented:

maybe best to move to 4.1? We could provide a PDF downladable somewhere?

• butler changed owner from "pkienzle" to "ajj"

[rozyczko]

Trac update at 2016/09/20 13:44:10:

• piotr changed _comment0 from:

This is slightly more convoluted. On my windows box I need to also add fonts/HTML-CSS/TeX/eot/*

Also, extensions/ is required if we want to enable right-click context menu, as in the online version.
It is possible than on other machines/systems/OSes we need to add more subdirectories in fonts/*

Obviously adding everything is not an option, as uncompressed MathJax is 172MB.

to:

1474379141909554

• piotr commented:

This is slightly more convoluted. On my windows box I need to also add

fonts/HTML-CSS/TeX/eot/*

Also,

extensions/

is required if we want to enable right-click context menu, as in the online version.
It is possible than on other machines/systems/OSes we need to add more subdirectories in fonts/*

Obviously adding everything is not an option, as uncompressed MathJax is 172MB.

[ajj]

Trac update at 2016/09/23 14:18:40: ajj commented:

https://github.com/mathjax/MathJax-grunt-cleaner/blob/master/Gruntfile.js

seems to be the "official" way to do this - clone the repo and run grunt. However, this is yet another lot of infrastructure.

If it is all local, we should probably just have a script to pull in the right bits and update occasionally as mathjax changes.