Merge pull request #391 from mathjax/134

[main] add option for custom path variables

Author: dpvc

README.md

@@ -63,6 +63,7 @@ The `config` method is used to set _global_ configuration options. Its default o
   undefinedCharError: false, // determines whether "unknown characters" (i.e., no glyph in the configured fonts) are saved in the error array
   extensions: '',            // a convenience option to add MathJax extensions
   fontURL: 'https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.2/fonts/HTML-CSS', // for webfont urls in the CSS for HTML output
+  paths: {},                  // configures custom path variables (e.g., for third party extensions, cf. test/config-third-party-extensions.js)
   MathJax: { }               // standard MathJax configuration options, see https://docs.mathjax.org for more detail.
 }
 ```

lib/main.js

@@ -40,6 +40,7 @@ var displayMessages = false;      // don't log Message.Set() calls
 var displayErrors = true;         // show error messages on the console
 var undefinedChar = false;        // unknown characters are not saved in the error array
 var extensions = '';              // no additional extensions used
+var paths = {};                   // additional paths (for third party extensions)
 var fontURL = '';  // location of web fonts for CHTML
 
 var defaults = {
@@ -156,6 +157,11 @@ function ConfigureMathJax() {
     AuthorInit: function () {
       MathJax = window.MathJax;
 
+      // Add custom paths to configuration
+      for (let key in paths) {
+        MathJax.Ajax.config.path[key] = paths[key];
+      }
+
       delete MathJax.Hub.config.styles;               // don't need any styles
       MathJax.Hub.Startup.MenuZoom = function () {};  // don't load menu or zoom code
       MathJax.Extension.MathEvents = {
@@ -324,7 +330,7 @@ function ConfigureMathJax() {
             this.d = this.D = (bbox.height + bbox.y)*scale;
           }
         });
-        
+
         //
         //  Don't have mglyph load images
         //
@@ -515,7 +521,7 @@ function ConfigureMathJax() {
       });
     }
   };
-  
+
   if (extensions) {
     //
     // Parse added extensions list and add to standard ones
@@ -958,6 +964,7 @@ exports.config = function (config) {
   if (config.displayErrors != null)      {displayErrors   = config.displayErrors}
   if (config.undefinedCharError != null) {undefinedChar   = config.undefinedCharError}
   if (config.extensions != null)         {extensions      = config.extensions}
+  if (config.paths != null)              {paths           = config.paths}
   if (config.fontURL != null)            {fontURL         = config.fontURL}
   if (config.MathJax) {
     // strip MathJax config blocks to avoid errors

package-lock.json

@@ -0,0 +1,9 @@
+MathJax.Hub.Register.StartupHook("TeX Jax Ready", function () {
+  MathJax.InputJax.TeX.Definitions.Add({
+    macros: {
+      test: ["Macro", "\text{This is a Test}"]
+    }
+  });
+});
+
+MathJax.Ajax.loadComplete("[test]/test.js");

test/assets/test.js

@@ -0,0 +1,22 @@
+var tape = require('tape');
+var mjAPI = require("../lib/main.js");
+const path = require('path');
+
+tape('Configuring third party extensions', function(t) {
+    t.plan(1);
+    var tex = '\\test';
+    mjAPI.config( {
+        extensions: '[test]/test.js',
+        paths: {
+            'test': path.join(__dirname,'assets/')
+        }
+    });
+    mjAPI.start();
+    mjAPI.typeset({
+        math: tex,
+        format: "TeX",
+        mmlNode: true
+    }, function(data) {
+        t.notOk(data.errors, 'No error loading the extension');
+    });
+});