Merge pull request #27 from mathjax/tex2speech

Adds tex2speech script.

Author: zorkow

speech/action.js

@@ -1,5 +1,6 @@
 require('mathjax-full/js/util/asyncLoad/node.js');
 require('mathjax-full/js/a11y/semantic-enrich.js');
+require('mathjax-full/js/a11y/sre-node.js');
 const {STATE} = require('mathjax-full/js/core/MathItem.js');
 
 //
@@ -17,6 +18,26 @@ function removeSemanticData(math) {
   });
 }
 
+
+const sreDefault = {
+    domain: 'mathspeak',
+    style: 'default'
+};
+
+
+// Configures SRE from key value pairs.
+exports.sreconfig = function(data) {
+    let config = {};
+    if (data) {
+        for (let i = 0, key; key = data[i]; i++) {
+            let value = data[++i];
+            config[key] = value || false;
+        }
+    }
+    sre.setupEngine(Object.assign({}, sreDefault, config));
+};
+
+
 //
 //  The renderActions needed to remove the data-semantic-attributes.
 //    STATE.ENRICHED is the priority of the enrichment, so this will rung just after enrichment.

speech/tex2speech

@@ -0,0 +1,100 @@
+#! /usr/bin/env -S node -r esm
+
+/*************************************************************************
+ *
+ *  speech/tex2mml
+ *
+ *  Uses MathJax v3 to convert a TeX string to a MathML string with speech.
+ *
+ * ----------------------------------------------------------------------
+ *
+ *  Copyright (c) 2019 The MathJax Consortium
+ *
+ *  Licensed under the Apache License, Version 2.0 (the "License");
+ *  you may not use this file except in compliance with the License.
+ *  You may obtain a copy of the License at
+ *
+ *      http://www.apache.org/licenses/LICENSE-2.0
+ *
+ *  Unless required by applicable law or agreed to in writing, software
+ *  distributed under the License is distributed on an "AS IS" BASIS,
+ *  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ *  See the License for the specific language governing permissions and
+ *  limitations under the License.
+ */
+
+
+//
+//  The default TeX packages to use
+//
+const PACKAGES = 'base, autoload, require, ams, newcommand';
+
+//
+//  Get the command-line arguments
+//
+var argv = require('yargs')
+    .demand(0).strict()
+    .usage('$0 [options] "math" > file.txt')
+    .options({
+        inline: {
+            boolean: true,
+            describe: "process as inline math; generally not relevant"
+        },
+        packages: {
+            default: PACKAGES,
+            describe: 'the packages to use, e.g. "base, ams"; use "*" to represent the default packages, e.g, "*, bbox"'
+        },
+        speech: {
+            default: 'shallow',
+            describe: 'level of speech: deep, shallow, none'
+        },
+        sre: {
+            array: true,
+            nargs: 2,
+            describe: "SRE flags as key value pairs"
+        },
+        dist: {
+            boolean: true,
+            default: false,
+            describe: 'true to use webpacked version, false to use mathjax3 source files'
+        }
+    })
+    .argv;
+
+const action = require('./action.js');
+
+//
+// Pass additional arguments to SRE.
+// 
+action.sreconfig(argv.sre);
+
+//
+//  Configure MathJax
+//
+MathJax = {
+    loader: {
+        paths: {mathjax: 'mathjax-full/es5', sre: 'mathjax-full/js/a11y/sre-node'},
+        source: (argv.dist ? {} : require('mathjax-full/components/src/source.js').source),
+        require: require,
+        load: ['input/tex-full', 'adaptors/liteDOM']
+    },
+    tex: {
+        packages: argv.packages.replace('\*', PACKAGES).split(/\s*,\s*/)
+    }
+}
+
+//
+//  Load the MathJax startup module
+//
+require('mathjax-full/' + (argv.dist ? 'es5' : 'components/src/startup') + '/startup.js');
+
+//
+//  Wait for MathJax to start up, and then typeset the math
+//
+MathJax.startup.promise.then(() => {    MathJax.tex2mmlPromise(argv._[0] || '', {
+        display: !argv.inline,
+        em: argv.em,
+        ex: argv.ex,
+        containerWidth: argv.width
+}).then(mml => console.log(sre.toSpeech(mml)));
+}).catch(err => console.log(err));