Skip to content

Commit 0c1de39

Browse files
committed
Update what's-new, and add example of loading a11y extensions
1 parent 6c24c44 commit 0c1de39

File tree

3 files changed

+61
-1
lines changed

3 files changed

+61
-1
lines changed

server/start.rst

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,8 @@ See the `MathJax node demos
1111
examples of how to use MathJax from a `node` application. These are
1212
categorized into three groups
1313

14+
* `Examples using MathJax components the simple way
15+
<https://github.com/mathjax/MathJax-demos-node/tree/master/simple#simple-component-examples>`__
1416
* `Examples using MathJax components via the startup module
1517
<https://github.com/mathjax/MathJax-demos-node/tree/master/component#component-based-examples>`__
1618
* `Examples using MathJax components loaded by hand

upgrading/whats-new-3.1.rst

Lines changed: 44 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -17,6 +17,9 @@ for several issues with version 3.0. These are described below.
1717
* :ref:`v3.1-startup-promise`
1818
* :ref:`v3.1-typesetClear`
1919
* :ref:`v3.1-getMathItemsWithin`
20+
* :ref:`v3.1-sreReady`
21+
* :ref:`v3.1-liteDOM`
22+
* :ref:`v3.1-demos`
2023

2124
------
2225

@@ -206,4 +209,45 @@ the MathItems for the typeset math within a DOM container element (or
206209
collection of DOM elements). See :ref:`get-math-items` for details.
207210

208211

212+
.. _v3.1-sreReady:
213+
214+
Change to SRE Interface
215+
=======================
216+
217+
In version 3.0.5, The `a11y/sre` module exposed a value
218+
:attr:`sreReady` that was a promise that would be resolved when the
219+
Speech-Rule Engine was ready to use. Due to changes in SRE (which can
220+
now be configured to load localized translation data, and so may
221+
become un-ready while that is happening), the :attr:`sreReady` value
222+
in version 3.1.0 is now a function returning a promise, so should be
223+
called as :meth:`sreReady()`.
224+
225+
226+
.. _v3.1-liteDOM:
227+
228+
Fixes to the LiteDOM and DOMAdaptors
229+
====================================
230+
231+
The `LiteDOM` in version 3.0.5 failed to process comments correctly:
232+
they were properly read and ignored, but where not included in the
233+
output when the DOM is serialized. In version 3.1.0, this has been
234+
fixes so that comments are properly maintained. In addition, the
235+
:attr:`doctype` of the document is now retained by the `LiteDOM`, and
236+
can be accessed by a new :meth:`doctype()` method of the `DOMAdaptor`
237+
class (and its subclasses).
238+
239+
240+
.. _v3.1-demos:
241+
242+
Updated Demos
243+
=============
244+
245+
The `web <https://github.com/mathjax/MathJax-demos-web#MathJax-demos-web>`__
246+
and `node <https://github.com/mathjax/MathJax-demos-node#MathJax-demos-node>`__
247+
examples have been updated to use the new features available in
248+
version 3.1.0, and to include more examples. In particular, the node
249+
examples now include demonstrations of using the simpler loading
250+
mechanism for node applications, using puppeteer to perform
251+
server-side processing, and using JSDOM for server-side processing.
252+
209253
|-----|

web/components/accessibility.rst

Lines changed: 15 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,21 @@ assistive technology.
1212
* :ref:`explorer-component`
1313
* :ref:`assistive-mml-component`
1414

15-
These are described below.
15+
To load one of these components, include the component name in the
16+
:attr:`load` array of the :attr:`loader` block of your MathJax
17+
configuration. For example:
18+
19+
.. code-block:: html
20+
21+
<script>
22+
MathJax = {
23+
loader: {
24+
load: ['a11y/semantic-enrich']
25+
}
26+
}
27+
</script>
28+
29+
to load the `semantic-enrich` extension.
1630

1731
.. note::
1832

0 commit comments

Comments
 (0)