[MediaWiki-commits] [Gerrit] Add missing dependencies for image update script - change (mediawiki...mathoid)
Mobrovac has submitted this change and it was merged. Change subject: Add missing dependencies for image update script .. Add missing dependencies for image update script Change-Id: I72f86662d7191281464e37c1e34a542101baf570 Use dev config for testing Change-Id: I23fad24d9d0832ec073113e770ee17a13208ca0b Update documentation Change-Id: Iab41826d844225ca54ffa09f18783a2d42145d69 Update node modules Change-Id: I4d5dd658cbc8f59b880aa2296f34a6e65c8f Update readme Change-Id: I83a34d00b8f7ae144962f42b3cd46f32191a89bd Add speech output format Change-Id: I2df5c2c3d1d466434dc16df0defdd59641a6700e Rename noSpeak to nospeech * Add config option speechOn, which enables speech output by default. * Prior to this change, speech was enabled by default for all request once it was activated. Change-Id: I2df5c2c3d1d466434dc16df0defdd59641a6700e Enable speech by default for /speech endpoint * otherwise the endpoint would not print anything Change-Id: I47ccd7548ca478023475a6d9f95aea10403edeb6 Update MathJax node version * Kill mathoid worker on MathJax Processing Errors, otherwise mathoid just becomes unresponsive, which is worse. Change-Id: I70b01c312ed80152308ef900bb9cf593607ffe92 --- M .gitignore M README.md M config.dev.yaml M config.prod.yaml A doc/test_results/ns/performance_mml.txt A doc/test_results/ns/performance_png.txt A doc/test_results/ns/performance_svg.txt A doc/test_results/ns/performance_texvcinfo.txt M doc/test_results/performance_mml.txt M doc/test_results/performance_png.txt M doc/test_results/performance_svg.txt M doc/test_results/performance_texvcinfo.txt M package.json M routes/mathoid.js M test/features/math/mathjax-texvc.js M test/features/math/simple.js M test/utils/server.js 17 files changed, 341 insertions(+), 120 deletions(-) Approvals: Mobrovac: Verified; Looks good to me, approved diff --git a/.gitignore b/.gitignore index 19c009f..c817e86 100644 --- a/.gitignore +++ b/.gitignore @@ -14,3 +14,4 @@ .idea mathoid*.iml config.vagrant.yaml +Thumbs.db diff --git a/README.md b/README.md index a9e92be..439c25c 100644 --- a/README.md +++ b/README.md @@ -10,8 +10,20 @@ ## Installation -see http://formulasearchengine.com/mathoid +Install node 4.2.3, iojs-v2.5.0 or a compatible node version and npm version 2.14.7 or similar. +Thereafter, install mathoid by running +```bash +npm install mathoid +nodejs /node_modules/mathoid/server.js +``` +To install mathoid as a unix service there is a [script](scripts/gen-init-scripts.rb). +### Running the tests +To run the tests you need to install mocha. +After that you can run the tests from the mathoid folder. +```bash +npm test +``` ## API Description @@ -19,6 +31,7 @@ Additional entry points for individual formats are * /texvcinfo does not do any rendering. Only displays information regarding the texvc input. +* /speech returns the speech output only * /mml only MathML * /svg only SVG * /png only PNG @@ -44,7 +57,7 @@ * mml (MathML input, used in latexml rendering mode) * ascii (ascii mathml input, experimental) - noSpeak + nospeech * optional * if speech output is enabled this switch suppresses speech output for one particular request @@ -52,8 +65,9 @@ * svg: creates and svg image (turned on by default) * img: creates a img element with dimension information about the svg image * png: creates png images using java -* speakText: creates speech output using speech rule engine +* speech: creates speech output using speech rule engine * texvcinfo: displays information regarding the texvc input (experimental) +* speechOn: default setting for speech output. 'true' is equivalent to the old speakText. ## Performance The performance tests can be run by executing the [performance.sh](scripts/performance.sh) script. @@ -63,11 +77,17 @@ |format |time|sd| |||--| -| [texvcinfo](doc/test_results/performance_texvcinfo.txt) |0008|0006.5| -| [mml](doc/test_results/performance_mml.txt) |1207|0626.4| -| [svg](doc/test_results/performance_svg.txt) |1295|0434.7| -| [png](doc/test_results/performance_png.txt) |3116|2301.2| +| [texvcinfo](doc/test_results/performance_texvcinfo.txt) |0004|003.0| +| [mml](doc/test_results/performance_mml.txt) |0308|057.8| +| [svg](doc/test_results/performance_svg.txt) |0313|048.1| +| [png](doc/test_results/performance_png.txt) |1656|988.3| +|format (without speech support) |time|sd| +|--||--| +| [texvcinfo](doc/test_results/ns/performance_texvcinfo.txt) |0005|004.6| +| [mml](doc/test_results/ns/performance_mml.txt) |0031|008.0| +| [svg](doc/test_results/ns/performance_svg.txt) |0028|006.5| +| [png](doc/test_results/ns/performance_png.txt)
[MediaWiki-commits] [Gerrit] Add missing dependencies for image update script - change (mediawiki...mathoid)
Physikerwelt has uploaded a new change for review. https://gerrit.wikimedia.org/r/260539 Change subject: Add missing dependencies for image update script .. Add missing dependencies for image update script Change-Id: I72f86662d7191281464e37c1e34a542101baf570 Use dev config for testing Change-Id: I23fad24d9d0832ec073113e770ee17a13208ca0b Update documentation Change-Id: Iab41826d844225ca54ffa09f18783a2d42145d69 Update node modules Change-Id: I4d5dd658cbc8f59b880aa2296f34a6e65c8f Update readme Change-Id: I83a34d00b8f7ae144962f42b3cd46f32191a89bd Add speech output format Change-Id: I2df5c2c3d1d466434dc16df0defdd59641a6700e Rename noSpeak to nospeech * Add config option speechOn, which enables speech output by default. * Prior to this change, speech was enabled by default for all request once it was activated. Change-Id: I2df5c2c3d1d466434dc16df0defdd59641a6700e Enable speech by default for /speech endpoint * otherwise the endpoint would not print anything Change-Id: I47ccd7548ca478023475a6d9f95aea10403edeb6 Update MathJax node version * Kill mathoid worker on MathJax Processing Errors, otherwise mathoid just becomes unresponsive, which is worse. Change-Id: I70b01c312ed80152308ef900bb9cf593607ffe92 --- M .gitignore M README.md M config.dev.yaml M config.prod.yaml A doc/test_results/ns/performance_mml.txt A doc/test_results/ns/performance_png.txt A doc/test_results/ns/performance_svg.txt A doc/test_results/ns/performance_texvcinfo.txt M doc/test_results/performance_mml.txt M doc/test_results/performance_png.txt M doc/test_results/performance_svg.txt M doc/test_results/performance_texvcinfo.txt M package.json M routes/mathoid.js M test/features/math/mathjax-texvc.js M test/features/math/simple.js M test/utils/server.js 17 files changed, 341 insertions(+), 120 deletions(-) git pull ssh://gerrit.wikimedia.org:29418/mediawiki/services/mathoid refs/changes/39/260539/2 diff --git a/.gitignore b/.gitignore index 19c009f..c817e86 100644 --- a/.gitignore +++ b/.gitignore @@ -14,3 +14,4 @@ .idea mathoid*.iml config.vagrant.yaml +Thumbs.db diff --git a/README.md b/README.md index a9e92be..439c25c 100644 --- a/README.md +++ b/README.md @@ -10,8 +10,20 @@ ## Installation -see http://formulasearchengine.com/mathoid +Install node 4.2.3, iojs-v2.5.0 or a compatible node version and npm version 2.14.7 or similar. +Thereafter, install mathoid by running +```bash +npm install mathoid +nodejs /node_modules/mathoid/server.js +``` +To install mathoid as a unix service there is a [script](scripts/gen-init-scripts.rb). +### Running the tests +To run the tests you need to install mocha. +After that you can run the tests from the mathoid folder. +```bash +npm test +``` ## API Description @@ -19,6 +31,7 @@ Additional entry points for individual formats are * /texvcinfo does not do any rendering. Only displays information regarding the texvc input. +* /speech returns the speech output only * /mml only MathML * /svg only SVG * /png only PNG @@ -44,7 +57,7 @@ * mml (MathML input, used in latexml rendering mode) * ascii (ascii mathml input, experimental) - noSpeak + nospeech * optional * if speech output is enabled this switch suppresses speech output for one particular request @@ -52,8 +65,9 @@ * svg: creates and svg image (turned on by default) * img: creates a img element with dimension information about the svg image * png: creates png images using java -* speakText: creates speech output using speech rule engine +* speech: creates speech output using speech rule engine * texvcinfo: displays information regarding the texvc input (experimental) +* speechOn: default setting for speech output. 'true' is equivalent to the old speakText. ## Performance The performance tests can be run by executing the [performance.sh](scripts/performance.sh) script. @@ -63,11 +77,17 @@ |format |time|sd| |||--| -| [texvcinfo](doc/test_results/performance_texvcinfo.txt) |0008|0006.5| -| [mml](doc/test_results/performance_mml.txt) |1207|0626.4| -| [svg](doc/test_results/performance_svg.txt) |1295|0434.7| -| [png](doc/test_results/performance_png.txt) |3116|2301.2| +| [texvcinfo](doc/test_results/performance_texvcinfo.txt) |0004|003.0| +| [mml](doc/test_results/performance_mml.txt) |0308|057.8| +| [svg](doc/test_results/performance_svg.txt) |0313|048.1| +| [png](doc/test_results/performance_png.txt) |1656|988.3| +|format (without speech support) |time|sd| +|--||--| +| [texvcinfo](doc/test_results/ns/performance_texvcinfo.txt) |0005|004.6| +| [mml](doc/test_results/ns/performance_mml.txt) |0031|008.0| +| [svg](doc/test_results/ns/performance_svg.txt)
