@wiris/mathtype-tinymce6 8.9.1 → 8.9.2

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/README.md CHANGED
@@ -1,95 +1,96 @@
1
- # MathType for TinyMCE V6
2
-
3
- Type and handwrite mathematical notation with MathType.
4
-
5
- Easily include quality math equations in your documents and digital content.
6
-
7
- ## Table of Contents
8
-
9
- - [Install instructions](#install-instructions)
10
- - [Known issues](#known-issues)
11
- - [Services](#services)
12
- - [Documentation](#documentation)
13
- - [Displaying on Target Page](#displaying-on-target-page)
14
- - [Privacy policy](#privacy-policy)
15
-
16
- ## Install instructions
17
-
18
- 1. Install the npm module:
19
-
20
- ```bash
21
- npm install @wiris/mathtype-tinymce6
22
- ```
23
- > MathType is fully compatible with TinyMCE 6 from version 6.1.0.
24
-
25
- 2. Add the plugin as an external plugin:
26
-
27
- ```js
28
- tinymce.init({
29
- external_plugins: {
30
- 'tiny_mce_wiris': `node_modules/@wiris/mathtype-tinymce6/plugin.min.js`,
31
- }
32
- });
33
- ```
34
-
35
-
36
- 3. Add MathType buttons to the TinyMCE6 toolbar and the recommended settings:
37
-
38
- ```js
39
- tinymce.init({
40
- toolbar: 'tiny_mce_wiris_formulaEditor tiny_mce_wiris_formulaEditorChemistry',
41
- // We recommend to set 'draggable_modal' to true to avoid overlapping issues
42
- // with the different UI modal dialog windows implementations between core and third-party plugins on TinyMCE.
43
- // @see: https://github.com/wiris/html-integrations/issues/134#issuecomment-905448642
44
- draggable_modal: true,
45
-
46
- // This option allows you to introduce mathml formulas with wiris plugins.
47
- // Not enabling this, will provide formulas from beeing created and rendered.
48
- extended_valid_elements: '*[.*]',
49
-
50
- // You could set a different language for MathType editor:
51
- // language: 'fr_FR',
52
- // mathTypeParameters: {
53
- // editorParameters: { language: 'fr' },
54
- // },
55
- });
56
- ```
57
-
58
- Notice the example assumes this directory structure:
59
-
60
- ```
61
- └───index.html
62
- └───node_modules
63
- └───@wiris/mathtype-tinymce6
64
- ```
65
-
66
- ## Known issues
67
-
68
- * The editor's caret is lost when inserting a new formula on Safari with ChemType [#486](https://github.com/wiris/html-integrations/issues/486)
69
-
70
- ## Services
71
-
72
- This npm module uses remotely hosted services to render MathML data. However, we recommend you install these services on your backend. This will allow you, among other things, to configure the service and to locally store the images generated by MathType.
73
-
74
- The services are available for Java, PHP, .NET and Ruby on Rails. If you use any of these technologies, please download the plugin for your backend technology from [here](https://store.wiris.com/en/products/downloads/mathtype/integrations#froala?utm_source=npmjs&utm_medium=referral).
75
-
76
- ## Displaying on Target Page
77
-
78
- In order to display mathematical formulas on the target page, i.e. the page where content produced by the HTML editor will be visible, the target page needs to include the [MathType script](https://docs.wiris.com/en/mathtype/mathtype_web/integrations/mathml-mode#add_a_script_to_head). For example for the default setting this would be:
79
- ```html
80
- <script src="https://www.wiris.net/demo/plugins/app/WIRISplugins.js?viewer=image"></script>
81
- ```
82
-
83
- ## Documentation
84
-
85
- To find out more information about MathType, please go to the following documentation:
86
-
87
- * [Install instructions](https://docs.wiris.com/mathtype/en/mathtype-integrations/mathtype-for-html-editors/mathtype-for-tinymce.html?utm_source=npmjs&utm_medium=referral)
88
- * [MathType documentation](https://docs.wiris.com/en/mathtype/mathtype_web/start?utm_source=npmjs&utm_medium=referral)
89
- * [Introductory tutorials](https://docs.wiris.com/en/mathtype/mathtype_web/intro_tutorials?utm_source=npmjs&utm_medium=referral)
90
- * [Service customization](https://docs.wiris.com/en/mathtype/mathtype_web/integrations/config-table?utm_source=npmjs&utm_medium=referral)
91
- * [Testing](https://docs.wiris.com/en/mathtype/mathtype_web/integrations/html/plugins-test?utm_source=npmjs&utm_medium=referral)
92
-
93
- ## Privacy policy
94
-
95
- The [MathType Privacy Policy](https://www.wiris.com/en/mathtype-privacy-policy/?utm_source=npmjs&utm_medium=referral) covers the data processing operations for the MathType users. It is an addendum of the company’s general Privacy Policy and the [general Privacy Policy](https://www.wiris.com/en/privacy-policy?utm_source=npmjs&utm_medium=referral) still applies to MathType users.
1
+ # MathType for TinyMCE V6
2
+
3
+ Type and handwrite mathematical notation with MathType.
4
+
5
+ Easily include quality math equations in your documents and digital content.
6
+
7
+ ## Table of Contents
8
+
9
+ - [Install instructions](#install-instructions)
10
+ - [Known issues](#known-issues)
11
+ - [Services](#services)
12
+ - [Documentation](#documentation)
13
+ - [Displaying on Target Page](#displaying-on-target-page)
14
+ - [Privacy policy](#privacy-policy)
15
+
16
+ ## Install instructions
17
+
18
+ 1. Install the npm module:
19
+
20
+ ```bash
21
+ npm install @wiris/mathtype-tinymce6
22
+ ```
23
+
24
+ > MathType is fully compatible with TinyMCE 6 from version 6.1.0.
25
+
26
+ 2. Add the plugin as an external plugin:
27
+
28
+ ```js
29
+ tinymce.init({
30
+ external_plugins: {
31
+ tiny_mce_wiris: `node_modules/@wiris/mathtype-tinymce6/plugin.min.js`,
32
+ },
33
+ });
34
+ ```
35
+
36
+ 3. Add MathType buttons to the TinyMCE6 toolbar and the recommended settings:
37
+
38
+ ```js
39
+ tinymce.init({
40
+ toolbar: "tiny_mce_wiris_formulaEditor tiny_mce_wiris_formulaEditorChemistry",
41
+ // We recommend to set 'draggable_modal' to true to avoid overlapping issues
42
+ // with the different UI modal dialog windows implementations between core and third-party plugins on TinyMCE.
43
+ // @see: https://github.com/wiris/html-integrations/issues/134#issuecomment-905448642
44
+ draggable_modal: true,
45
+
46
+ // This option allows you to introduce mathml formulas with wiris plugins.
47
+ // Not enabling this, will provide formulas from beeing created and rendered.
48
+ extended_valid_elements: "*[.*]",
49
+
50
+ // You could set a different language for MathType editor:
51
+ // language: 'fr_FR',
52
+ // mathTypeParameters: {
53
+ // editorParameters: { language: 'fr' },
54
+ // },
55
+ });
56
+ ```
57
+
58
+ Notice the example assumes this directory structure:
59
+
60
+ ```
61
+ └───index.html
62
+ └───node_modules
63
+ └───@wiris/mathtype-tinymce6
64
+ ```
65
+
66
+ ## Known issues
67
+
68
+ - The editor's caret is lost when inserting a new formula on Safari with ChemType [#486](https://github.com/wiris/html-integrations/issues/486)
69
+
70
+ ## Services
71
+
72
+ This npm module uses remotely hosted services to render MathML data. However, we recommend you install these services on your backend. This will allow you, among other things, to configure the service and to locally store the images generated by MathType.
73
+
74
+ The services are available for Java, PHP, .NET and Ruby on Rails. If you use any of these technologies, please download the plugin for your backend technology from [here](https://store.wiris.com/en/products/downloads/mathtype/integrations#froala?utm_source=npmjs&utm_medium=referral).
75
+
76
+ ## Displaying on Target Page
77
+
78
+ In order to display mathematical formulas on the target page, i.e. the page where content produced by the HTML editor will be visible, the target page needs to include the [MathType script](https://docs.wiris.com/en/mathtype/mathtype_web/integrations/mathml-mode#add_a_script_to_head). For example for the default setting this would be:
79
+
80
+ ```html
81
+ <script src="https://www.wiris.net/demo/plugins/app/WIRISplugins.js?viewer=image"></script>
82
+ ```
83
+
84
+ ## Documentation
85
+
86
+ To find out more information about MathType, please go to the following documentation:
87
+
88
+ - [Install instructions](https://docs.wiris.com/mathtype/en/mathtype-integrations/mathtype-for-html-editors/mathtype-for-tinymce.html?utm_source=npmjs&utm_medium=referral)
89
+ - [MathType documentation](https://docs.wiris.com/en/mathtype/mathtype_web/start?utm_source=npmjs&utm_medium=referral)
90
+ - [Introductory tutorials](https://docs.wiris.com/en/mathtype/mathtype_web/intro_tutorials?utm_source=npmjs&utm_medium=referral)
91
+ - [Service customization](https://docs.wiris.com/en/mathtype/mathtype_web/integrations/config-table?utm_source=npmjs&utm_medium=referral)
92
+ - [Testing](https://docs.wiris.com/en/mathtype/mathtype_web/integrations/html/plugins-test?utm_source=npmjs&utm_medium=referral)
93
+
94
+ ## Privacy policy
95
+
96
+ The [MathType Privacy Policy](https://www.wiris.com/en/mathtype-privacy-policy/?utm_source=npmjs&utm_medium=referral) covers the data processing operations for the MathType users. It is an addendum of the company’s general Privacy Policy and the [general Privacy Policy](https://www.wiris.com/en/privacy-policy?utm_source=npmjs&utm_medium=referral) still applies to MathType users.