Link to jsMath's easy/load.js only if the documentation is built with --jsmath

[qed777]

sage -docbuild tutorial html renders all mathematics as images, but if the jsMath library is present, its processor hides all display equations.

See sage-devel.

This is a follow-up to #5799.

Component: documentation

Author: Mitesh Patel

Reviewer: David Loeffler

Merged: sage-4.1.1.alpha0

Issue created by migration from https://trac.sagemath.org/ticket/6512

[qed777]

Attachment: trac_6512_jsmath_fix.patch.gz

[qed777]

comment:1

The patch removes a redundant link to jsMath. Sphinx should now include references to jsMath in its output only if --jsmath is part of the command-line. For example,

sage -docbuild reference html --jsmath

[qed777]

Author: Mitesh Patel

[loefflerd]

comment:4

This works for me: with the patch installed, it loads jsMath when it's needed, and doesn't load it when it isn't. Positive review.

[loefflerd]

Reviewer: David Loeffler

[sagetrac-mvngu]

Merged: sage-4.1.1.alpha0

[sagetrac-mvngu]

comment:6

Mitesh, thank you very much for fixing this.

[jasongrout]

comment:7

I agree that the change above looks like the correct one. Another option was to have jsmath automatically typeset the stuff in the alt parameter of the img files. Davide Cervone sent me a message with a way to do that:

Jason:

I've attached a javascript file that should do the preprocessing that you need.  It implements the suggestion I made to you about making span's with display:none so that the images show until jsMath reprocesses them.  You can load it just before jsMath/easy/load.js, or you could add it to the loadFiles list in easy/load.js.  Let me know if this doesn't do the trick for you.

Davide

On Jul 13, 2009, at 11:34 PM, jason-sage@creativetrax.com wrote:

> Davide P. Cervone wrote:
>> Jason:
>>
>> Here's what's going on:  jsMath looks for DIV's and SPAN's that are marked by CLASS="math" and treats their contents as TeX source code to process.  It replaces the original contents of the DIV or SPAN with the typeset version of the TeX code.  Because the image's are not DIV's or SPAN's jsMath ignores them (even though they are CLASS="math"), but the <DIV CLASS="math"> that contains an image is processed by jsMath.  It takes the text content of the DIV (empty in this case) and typesets it (the result is blank).  Thus the image disappears and is replaced by nothing.
>
> Thanks!  Your explanation and suggestions below are very appreciated!
>
> Jason 

The javascript code is:

(function () {
  var PREPROCESS = function () {
    var parent, span, i;
    var img = document.getElementsByTagName("img");
    for (i = 0; i < img.length; i++) {
      if (img[i].alt) {
        parent = img[i].parentNode.parentNode;
        if (img[i].className === "math") {
          span = img[i].parentNode.insertBefore(document.createElement("span"),img[i]);
          span.className = "math";
          span.appendChild(img[i]);
          span = span.appendChild(document.createElement("span"));
          span.style.display = "none";
          span.appendChild(document.createTextNode(img[i].alt));
        } else if (parent && parent.tagName.toLowerCase() === "div" && parent.className === "math") {
          span = img[i].parentNode.appendChild(document.createElement("span"));
          span.style.display = "none";
          span.appendChild(document.createTextNode(img[i].alt));
        }
      }
    }
  };
  
  if (window.addEventListener) {window.addEventListener("load",PREPROCESS,false)}
  else if (window.attachEvent) {window.attachEvent("onload",PREPROCESS)}
  else {window.onload = PREPROCESS}
})();