Skip to content

Commit 8fa5056

Browse files
author
Sorita Heng
committed
replace all instanes of plugin name and code
1 parent f252ba0 commit 8fa5056

File tree

14 files changed

+144
-144
lines changed

14 files changed

+144
-144
lines changed

modules/ROOT/examples/live-demos/trackchanges/example.js renamed to modules/ROOT/examples/live-demos/suggestededits/example.js

File renamed without changes.

modules/ROOT/examples/live-demos/trackchanges/index.html renamed to modules/ROOT/examples/live-demos/suggestededits/index.html

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,22 +1,12 @@
11
<textarea id="trackchanges">
22
{{logofordemoshtml}}
33

4-
<h2 style="text-align: center;">Welcome to the TinyMCE Track Changes demo!</h2>
4+
<h2 style="text-align: center;">Welcome to the TinyMCE Suggested Edits demo!</h2>
55

6-
<p style="text-align: center;">Try out the Track Changes feature by typing in the editor and then clicking the Review Changes button in the toolbar.</p>
6+
<p style="text-align: center;">Try out the Suggested Edits feature by typing in the editor and then clicking the Review Changes button in the toolbar.</p>
77

88
<p style="text-align: center;">And visit the <a href="https://www.tiny.cloud/pricing">pricing page</a> to learn more about our Premium plugins.</p>
99

10-
<h2>Found a bug?</h2>
11-
12-
<p>If you believe you have found a bug please create an issue on the <a href="https://github.com/tinymce/tinymce/issues">GitHub repo</a> to report it to the developers.</p>
13-
14-
<h2>Finally…</h2>
15-
16-
<p>Don’t forget to check out <a href="http://www.plupload.com" target="_blank">Plupload</a>, the upload solution featuring HTML5 upload support.</p>
17-
<p>Thanks for supporting TinyMCE. We hope it helps you and your users create great content.</p>
18-
<p>All the best from the TinyMCE team.</p>
19-
2010
<h2>A simple table to play with</h2>
2111

2212
<table style="border-collapse: collapse; width: 100%;" border="1">
@@ -41,4 +31,14 @@ <h2>A simple table to play with</h2>
4131
</tbody>
4232
</table>
4333

34+
<h2>Found a bug?</h2>
35+
36+
<p>If you believe you have found a bug please create an issue on the <a href="https://github.com/tinymce/tinymce/issues">GitHub repo</a> to report it to the developers.</p>
37+
38+
<h2>Finally…</h2>
39+
40+
<p>Don’t forget to check out <a href="http://www.plupload.com" target="_blank">Plupload</a>, the upload solution featuring HTML5 upload support.</p>
41+
<p>Thanks for supporting TinyMCE. We hope it helps you and your users create great content.</p>
42+
<p>All the best from the TinyMCE team.</p>
43+
4444
</textarea>

modules/ROOT/examples/live-demos/trackchanges/index.js renamed to modules/ROOT/examples/live-demos/suggestededits/index.js

File renamed without changes.

‎modules/ROOT/nav.adoc‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -351,6 +351,7 @@
351351
**** xref:introduction-to-tiny-spellchecker.adoc[Spell Checker]
352352
**** xref:custom-dictionaries-for-tiny-spellchecker.adoc[Adding custom dictionaries]
353353
*** xref:autocorrect.adoc[Spelling Autocorrect]
354+
*** xref:suggestededits.adoc[Suggested Edits]
354355
*** xref:tableofcontents.adoc[Table of Contents]
355356
*** xref:advanced-templates.adoc[Templates]
356357
*** Tiny Drive
@@ -377,7 +378,6 @@
377378
***** xref:tinydrive-pick.adoc[The Pick API]
378379
***** xref:tinydrive-type-interfaces.adoc[TypeScript interfaces]
379380
**** xref:tinydrive-changelog.adoc[Changelog]
380-
*** xref:suggestededits.adoc[Suggested Edits]
381381
** Open source plugins
382382
*** xref:accordion.adoc[Accordion]
383383
*** xref:anchor.adoc[Anchor]

‎modules/ROOT/pages/7.0-release-notes.adoc‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -49,7 +49,7 @@ The following new Premium plugins was released alongside {productname} 7.0.
4949
[[premium-plugin-revision-history]]
5050
=== Revision History
5151

52-
The new Premium plugin, **Revision History**, allows you to track changes made to content in the {productname} editor and restore previous versions of the content.
52+
The new Premium plugin, **Revision History**, allows you to Suggested Edits made to content in the {productname} editor and restore previous versions of the content.
5353

5454
For information on the **Revision History** plugin, see xref:revisionhistory.adoc[Revision History].
5555

‎modules/ROOT/pages/suggestededits.adoc‎

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44
:description_short: A view of tracked changes made by multiple authors
55
:keywords: plugin, Suggested Edits, changes, diff
66
:pluginname: Suggested Edits
7-
:plugincode: trackchanges
7+
:plugincode: suggestededits
88
:plugincategory: premium
99

1010
include::partial$misc/admon-revisionhistory-paid-addon-pricing.adoc[]
@@ -62,9 +62,9 @@ For example:
6262
----
6363
tinymce.init({
6464
selector: 'textarea', // change this value according to your HTML
65-
plugins: 'trackchanges',
66-
toolbar: 'trackchanges',
67-
trackchanges_model: {
65+
plugins: 'suggestededits',
66+
toolbar: 'suggestededits',
67+
suggestededits_model: {
6868
version: 1,
6969
maxId: 0,
7070
contents: [
@@ -76,15 +76,15 @@ tinymce.init({
7676
}
7777
]
7878
},
79-
trackchanges_uid: 'unique-identifier' // replace this with a unique string to identify the user
79+
suggestededits_uid: 'unique-identifier' // replace this with a unique string to identify the user
8080
});
8181
----
8282

8383
== Options
8484

8585
The following configuration options affect the behavior of the {pluginname} plugin.
8686

87-
include::partial$configuration/trackchanges-options.adoc[leveloffset=+1]
87+
include::partial$configuration/suggestededits-options.adoc[leveloffset=+1]
8888

8989
include::partial$misc/plugin-toolbar-button-id-boilerplate.adoc[]
9090

modules/ROOT/partials/commands/trackchanges-cmds.adoc renamed to modules/ROOT/partials/commands/suggestededits-cmds.adoc

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,11 +2,11 @@
22
|===
33
|Command |Description
44

5-
|trackchanges |Toggle the Track Changes view
5+
|suggestededits |Toggle the Suggested Edits view
66
|===
77

88
.Examples
99
[source,js]
1010
----
11-
tinymce.activeEditor.execCommand('trackchanges');
11+
tinymce.activeEditor.execCommand('suggestededits');
1212
----

‎modules/ROOT/partials/configuration/defaultmenuitems.adoc‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ tinymce.init({
55
menu: {
66
file: { title: 'File', items: 'newdocument restoredraft | preview | importword exportpdf exportword | print | deleteallconversations' },
77
edit: { title: 'Edit', items: 'undo redo | cut copy paste pastetext | selectall | searchreplace' },
8-
view: { title: 'View', items: 'code revisionhistory trackchanges | visualaid visualchars visualblocks | spellchecker | preview fullscreen | showcomments' },
8+
view: { title: 'View', items: 'code revisionhistory suggestededits | visualaid visualchars visualblocks | spellchecker | preview fullscreen | showcomments' },
99
insert: { title: 'Insert', items: 'image link media addcomment pageembed codesample inserttable | math | charmap emoticons hr | pagebreak nonbreaking anchor tableofcontents | insertdatetime' },
1010
format: { title: 'Format', items: 'bold italic underline strikethrough superscript subscript codeformat | styles blocks fontfamily fontsize align lineheight | forecolor backcolor | language | removeformat' },
1111
tools: { title: 'Tools', items: 'spellchecker spellcheckerlanguage | a11ycheck code wordcount' },

‎modules/ROOT/partials/configuration/suggestededits-options.adoc‎

Lines changed: 110 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,110 @@
1+
[[suggestededits_model]]
2+
== `suggestededits_model`
3+
4+
The `suggestededits_model` option sets the initial model of the document to begin tracking changes. It takes as input an object representing the document. If no value is set, the plugin will generate the model by default.
5+
6+
//*Type:* xref:#trackeddocument[TrackedDocument] `+Object+`
7+
8+
=== Example: using `suggestededits_model`
9+
10+
// Add a working and tested configuration.
11+
[source,js]
12+
----
13+
tinymce.init({
14+
selector: 'textarea', // Change this value according to your HTML
15+
plugins: 'suggestededits',
16+
toolbar: 'suggestededits',
17+
suggestededits_model: {
18+
version: 1,
19+
maxId: 0,
20+
contents: [
21+
{
22+
type: 'p',
23+
children: [
24+
{ text: 'Hello, World!' }
25+
]
26+
}
27+
]
28+
}
29+
});
30+
----
31+
32+
[[suggestededits_uid]]
33+
== `suggestededits_uid`
34+
35+
The `suggestededits_uid` is a _required_ option that takes as input a unique string to identify the current user. This is used to attribute changes made by the user.
36+
37+
*Type:* `+String+`
38+
39+
=== Example: using `suggestededits_uid`
40+
41+
// Add a working and tested configuration.
42+
[source,js]
43+
----
44+
tinymce.init({
45+
selector: 'textarea', // Change this value according to your HTML
46+
plugins: 'suggestededits',
47+
toolbar: 'suggestededits',
48+
suggestededits_uid: 'unique-identifier' // replace this with a unique string to identify the user
49+
});
50+
----
51+
52+
[[suggestededits_css_url]]
53+
== `suggestededits_css_url`
54+
55+
The `suggestededits_css_url` option sets the location where a CSS file containing change annotations in the {pluginname} view should be loaded from. To override the default CSS classes, use this option alongside `suggestededits_diff_classes`.
56+
57+
*Type:* `+String+`
58+
59+
*Default value:* `'${pluginUrl}/css/suggestededits.css'`
60+
61+
=== Example: using `suggestededits_css_url`
62+
63+
// Add a working and tested configuration.
64+
[source,js]
65+
----
66+
tinymce.init({
67+
selector: 'textarea', // Change this value according to your HTML
68+
suggestededits_css_url: './suggestededits.css'
69+
});
70+
----
71+
72+
[[suggestededits_diff_classes]]
73+
== `suggestededits_diff_classes`
74+
75+
The `suggestededits_diff_classes` option configures the CSS classes applied to the change annotations in the {pluginname} view. This is useful to set custom styles and must be used in combination with the `suggestededits_css_url` option.
76+
77+
[NOTE]
78+
The CSS class names must exist in the xref:suggestededits_css_url[`+suggestededits_css_url+`].
79+
80+
*Type:* `+Object+`
81+
82+
*Default value:* `addition`, `removal`, `modification`
83+
84+
Below are the default CSS classes:
85+
86+
[source,js]
87+
----
88+
{
89+
addition: 'tox-suggestededits__annotation--added',
90+
removal: 'tox-suggestededits__annotation--removed',
91+
modification: 'tox-suggestededits__annotation--modified'
92+
}
93+
----
94+
95+
=== Example: using `suggestededits_diff_classes`
96+
97+
[source,js]
98+
----
99+
tinymce.init({
100+
selector: 'textarea', // change this value according to your HTML
101+
plugins: 'suggestededits',
102+
toolbar: 'suggestededits',
103+
suggestededits_css_url: './suggestededits.css',
104+
suggestededits_diff_classes: {
105+
addition: 'added',
106+
removal: 'removed',
107+
modification: 'modified'
108+
}
109+
});
110+
----

‎modules/ROOT/partials/configuration/trackchanges-options.adoc‎

Lines changed: 0 additions & 110 deletions
This file was deleted.

0 commit comments

Comments
 (0)