Skip to content

Commit 584785f

Browse files
committed
DOC-3174: Remove unused options
1 parent a93e0ac commit 584785f

File tree

1 file changed

+1
-81
lines changed

1 file changed

+1
-81
lines changed

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

Lines changed: 1 addition & 81 deletions
Original file line numberDiff line numberDiff line change
@@ -1,23 +1,3 @@
1-
[[suggestededits_uid]]
2-
== `suggestededits_uid`
3-
4-
The `{plugincode}_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.
5-
6-
*Type:* `+String+`
7-
8-
=== Example: using `{plugincode}_uid`
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_uid: 'unique-identifier' // replace this with a unique string to identify the user
18-
});
19-
----
20-
211
[[suggestededits_model]]
222
== `suggestededits_model`
233

@@ -104,7 +84,7 @@ In either case, if a model is not provided, the plugin will generate a new model
10484

10585
*Default value:* `'html'`
10686

107-
=== Example: using `{plugincode}_css_url`
87+
=== Example: using `{plugincode}_content`
10888

10989
// Add a working and tested configuration.
11090
[source,js]
@@ -118,63 +98,3 @@ tinymce.init({
11898
suggestededits_content: 'model' // change this value to set the content source
11999
});
120100
----
121-
122-
[[suggestededits_css_url]]
123-
== `suggestededits_css_url`
124-
125-
The `{plugincode}_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 `{plugincode}_diff_classes`.
126-
127-
*Type:* `+String+`
128-
129-
*Default value:* `'${pluginUrl}/css/{plugincode}.css'`
130-
131-
=== Example: using `{plugincode}_css_url`
132-
133-
// Add a working and tested configuration.
134-
[source,js]
135-
----
136-
tinymce.init({
137-
selector: 'textarea', // Change this value according to your HTML
138-
suggestededits_css_url: './suggestededits.css'
139-
});
140-
----
141-
142-
[[suggestededits_diff_classes]]
143-
== `suggestededits_diff_classes`
144-
145-
The `{plugincode}_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 `{plugincode}_css_url` option.
146-
147-
[NOTE]
148-
The CSS class names must exist in the xref:{plugincode}_css_url[`+suggestededits_css_url+`].
149-
150-
*Type:* `+Object+`
151-
152-
*Default value:* `addition`, `removal`, `modification`
153-
154-
Below are the default CSS classes:
155-
156-
[source,js]
157-
----
158-
{
159-
addition: 'tox-suggestededits__annotation--added',
160-
removal: 'tox-suggestededits__annotation--removed',
161-
modification: 'tox-suggestededits__annotation--modified'
162-
}
163-
----
164-
165-
=== Example: using `{plugincode}_diff_classes`
166-
167-
[source,js]
168-
----
169-
tinymce.init({
170-
selector: 'textarea', // change this value according to your HTML
171-
plugins: 'suggestededits',
172-
toolbar: 'suggestededits',
173-
suggestededits_css_url: './suggestededits.css',
174-
suggestededits_diff_classes: {
175-
addition: 'added',
176-
removal: 'removed',
177-
modification: 'modified'
178-
}
179-
});
180-
----

0 commit comments

Comments
 (0)