Skip to content

Commit 07c3d28

Browse files
hamza0867lnewson
andauthored
feature(Plugins/Premium/Fromat Painter -> PowerPaste): Update docs for premium plugins section from formatpainter to powerpaste (#2308)
* featue(Plugins/Premium/Fromat Painter -> PowerPaste): Update docs for premium plugins section from formatpainter to powerpaste * Update modules/ROOT/partials/configuration/mentions_item_type.adoc Co-authored-by: Lee Newson <[email protected]> * Update modules/ROOT/partials/configuration/mentions_fetch.adoc Co-authored-by: Lee Newson <[email protected]> * Update modules/ROOT/partials/configuration/mentions_menu_hover.adoc Co-authored-by: Lee Newson <[email protected]> * Update modules/ROOT/partials/configuration/mentions_item_type.adoc Co-authored-by: Lee Newson <[email protected]> * Update modules/ROOT/partials/configuration/mentions_select.adoc Co-authored-by: Lee Newson <[email protected]> * feature(Plugins/Premium Plugins/Powerpaste): fix a ToC isue as suggested in review Co-authored-by: Lee Newson <[email protected]>
1 parent 7e8901f commit 07c3d28

22 files changed

+83
-67
lines changed

modules/ROOT/pages/plugins/premium/formatpainter.adoc

Lines changed: 4 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ liveDemo::format-painter[]
1717

1818
== Basic setup
1919

20-
To add the {pluginname} plugin to the editor, add `+{plugincode}+` to the `plugins` option in the editor configuration.
20+
To add the {pluginname} plugin to the editor, add `{plugincode}` to the `plugins` option in the editor configuration.
2121

2222
For example:
2323

@@ -39,7 +39,7 @@ The format painter operates in two modes, one for retrieval and one for applicat
3939
*Usage with toolbar button*
4040

4141
. Position the cursor at the source content to retrieve the formatting.
42-
. Enable the *Format Painter* button to copy the formatting. The *Format Painter* toolbar button background color changes to _grey_ image:{baseurl}/images/icons/format-painter.svg[the Format Painter toolbar button icon].
42+
. Enable the *Format Painter* button to copy the formatting. The *Format Painter* toolbar button background color changes to _grey_ image:icons/format-painter.svg[the Format Painter toolbar button icon].
4343
. Select the goal content to apply the formatting.
4444

4545
*Result*: The formatting from the source content is applied to the goal content.
@@ -51,13 +51,11 @@ The format painter operates in two modes, one for retrieval and one for applicat
5151
. Select the goal content to apply the formatting.
5252
. Press the `Ctrl+Alt+V` keys to apply the formatting.
5353

54-
____
55-
The format painter retains the formatting after application making it possible to apply the same formatting multiple times by using the `Ctrl+Alt+V` keyboard shortcut.
56-
____
54+
NOTE: The format painter retains the formatting after application making it possible to apply the same formatting multiple times by using the `Ctrl+Alt+V` keyboard shortcut.
5755

5856
== Options
5957

60-
The format painter acts upon all link:{baseurl}/configure/content-formatting/#formats[`formats`] registered in the editor. In addition to any standard formatting, it will treat *lists* as a block format whenever the link:{baseurl}/plugins/opensource/lists/[`lists plugin`] is made available.
58+
The format painter acts upon all xref:configure/content-formatting.adoc#formats[`formats`] registered in the editor. In addition to any standard formatting, it will treat *lists* as a block format whenever the xref:plugins/opensource/lists.adoc[`lists plugin`] is made available.
6159

6260
include::partial$configuration/formatpainter_formats.adoc[]
6361

modules/ROOT/pages/plugins/premium/linkchecker.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ The Link Checker plugin relies on HTTP response status codes to determine if a l
1111

1212
== Cloud Instructions
1313

14-
If you are using link:{baseurl}/cloud-deployment-guide/editor-and-features/[{cloudname}], simply add `"linkchecker"` to your plugins list, and the service will be automatically configured.
14+
If you are using xref:cloud-deployment-guide/editor-and-features.adoc[{cloudname}], simply add `"linkchecker"` to your plugins list, and the service will be automatically configured.
1515

1616
=== Basic setup using Tiny Cloud
1717

modules/ROOT/pages/plugins/premium/pageembed.adoc

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -29,19 +29,19 @@ tinymce.init({
2929
});
3030
----
3131

32-
*Result*: The image:{baseurl}/images/icons/embed-page.svg[Page Embed](*Page Embed*) button appears in the toolbar menu.
32+
*Result*: The image:icons/embed-page.svg[Page Embed](*Page Embed*) button appears in the toolbar menu.
3333

3434
== Using Page Embed
3535

3636
Use the following procedure for embedding an iframe into the content:
3737

38-
. Click on the image:{baseurl}/images/icons/embed-page.svg[Page Embed](*Page Embed*) toolbar button.
38+
. Click on the image:icons/embed-page.svg[Page Embed](*Page Embed*) toolbar button.
3939
. The *InsertEdit Iframe* dialog box appears.
40-
image:{baseurl}/images/insert-iframes.png[InsertEdit Iframe]
41-
. In the *General* tab, enter the url in the *Source* field, or click on the image:{baseurl}/images/icons/browse.svg[Source](*Source*) icon to upload a file.
40+
image:insert-iframes.png[InsertEdit Iframe]
41+
. In the *General* tab, enter the url in the *Source* field, or click on the image:icons/browse.svg[Source](*Source*) icon to upload a file.
4242
. For setting the iframe size, select the preferred option from the *Size* drop-down menu.
4343
** *Inline Value* is used to insert an iframe within a line. To set the dimensions of an inline iframe, provide the values in pixels in the *Width* and *Height* input box.
44-
*** The default values are *Width* `350px` and *Height* `260px`. Click the image:{baseurl}/images/icons/lock.svg[Constrain Proportions](*Constrain Proportions*) lock icon to change the default values.
44+
*** The default values are *Width* `350px` and *Height* `260px`. Click the image:icons/lock.svg[Constrain Proportions](*Constrain Proportions*) lock icon to change the default values.
4545

4646
+
4747
NOTE: The *Width* and *Height* fields are only available if the *Inline Value* value option is selected.
@@ -55,7 +55,7 @@ NOTE: The *Width* and *Height* fields are only available if the *Inline Value* v
5555
NOTE: The *Responsive* option has pre-defined width and height values. The *Width* and *Height* fields are not available if one of the *Responsive* values are selected.
5656
. In the *Advanced* tab, provide a name and title for the iframe in the *Name* and *Title* fields.
5757
. The *Long description URL* field can be used to describe an iframe by including text in a separate resource when a short text alternative does not adequately convey the function or information provided in the iframe.
58-
** Click on the image:{baseurl}/images/icons/browse.svg[Source](*Long description URL*) icon to upload a description file.
58+
** Click on the image:icons/browse.svg[Source](*Long description URL*) icon to upload a description file.
5959
. Click on the *Show iframe border* radio button to display iframe borders.
6060
. Click on the *Scrollbar* radio button to add scrollbars to the iframe.
6161
. Click *Save* to save and exit or *Cancel* to dismiss and exit.
@@ -85,4 +85,4 @@ IMPORTANT: The following CSS script must be added to the webpage for the default
8585
include::partial$css-codeblock/pageembed-plugin-css.adoc[]
8686
----
8787

88-
For more information on configuring CSS, refer to the link:{baseurl}/configure/content-appearance/#content_css[content_css] section.
88+
For more information on configuring CSS, refer to the xref:configure/content-appearance.adoc#content_css[content_css] section.

modules/ROOT/pages/plugins/premium/permanentpen.adoc

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@ underline: false,
2929
strikethrough: false
3030
----
3131

32-
For more information on {productname} formats, refer to the link:{baseurl}/configure/content-formatting/#formats[formats] section.
32+
For more information on {productname} formats, refer to the xref:configure/content-formatting.adoc#formats[formats] section.
3333

3434
== Try our Permanent Pen demo
3535

@@ -39,25 +39,25 @@ liveDemo::permanent-pen[]
3939

4040
=== To enable Permanent Pen
4141

42-
. Click on the image:{baseurl}/images/icons/permanent-pen.svg[Permanent Pen](*Permanent Pen*) toolbar button to enable the Permanent Pen.
42+
. Click on the image:icons/permanent-pen.svg[Permanent Pen](*Permanent Pen*) toolbar button to enable the Permanent Pen.
4343
. Place the cursor in the desired text area and start typing.
4444

4545
*Result*:
46-
The *Permanent Pen* toolbar button background color changes to _grey_ image:{baseurl}/images/icons/permanent-pen.svg[Permanent Pen] and the text is entered using the default settings.
46+
The *Permanent Pen* toolbar button background color changes to _grey_ image:icons/permanent-pen.svg[Permanent Pen] and the text is entered using the default settings.
4747

4848
=== To disable Permanent Pen
4949

50-
To exit the Permanent Pen, click on the image:{baseurl}/images/icons/permanent-pen.svg[Permanent Pen](*Permanent Pen*) icon.
50+
To exit the Permanent Pen, click on the image:icons/permanent-pen.svg[Permanent Pen](*Permanent Pen*) icon.
5151

52-
The *Permanent Pen* toolbar button background color changes to _white_ image:{baseurl}/images/icons/permanent-pen.svg[Permanent Pen].
52+
The *Permanent Pen* toolbar button background color changes to _white_ image:icons/permanent-pen.svg[Permanent Pen].
5353

5454
=== Accessing the Permanent Pen properties
5555

5656
There are two ways to access the Permanent Pen properties:
5757

5858
==== From the menubar
5959

60-
Add the Permanent pen properties option to the menu bar with the link:{baseurl}/configure/editor-appearance/#menu[menu] configuration.
60+
Add the Permanent pen properties option to the menu bar with the xref:configure/editor-appearance.adoc#menu[menu] configuration.
6161

6262
[source, js]
6363
----
@@ -77,7 +77,7 @@ tinymce.init({
7777
. Right-click anywhere from inside the text area.
7878
. Choose the *Permanent Pen* option.
7979

80-
image::{baseurl}/images/right-click.png[Right-click]
80+
image::right-click.png[Right-click]
8181

8282
*Result*:
8383
The *Permanent Pen Properties* dialog box appears.
@@ -89,7 +89,7 @@ NOTE: The Permanent Pen has to be enabled to access the *Permanent Pen Propertie
8989
=== Using the UI
9090

9191
. Open the *Permanent Pen Properties* dialog box using any of the above methods.
92-
image:{baseurl}/images/ppprop.png[Permanent pen properties]
92+
image:ppprop.png[Permanent pen properties]
9393
. Select the desired settings from the *Font* and *Size* drop-down menus.
9494
. To select the desired *Styles*, click on the radio button next to *Bold*, *Italic*, *Strikethrough*, or *Underline*.
9595
. Choose the desired *Text color*.

modules/ROOT/pages/plugins/premium/powerpaste.adoc

Lines changed: 15 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -17,13 +17,13 @@ The *PowerPaste* plugin activates automatically when users paste content into th
1717

1818
To paste clipboard content as plain text, users can click the "Paste As Text" toolbar button or menu item, then paste the content normally. The {productname} *PowerPaste* plugin will convert the HTML on the clipboard into plain text.
1919

20-
If you configure *PowerPaste* to allow local images (see the <<powerpaste_allow_local_images,`powerpaste_allow_local_images`>> setting below), then images copied from Microsoft Word and other sources will appear in {productname} as Base64 encoded images. You can have {productname} automatically upload Base64 encoded images for reverting back to a standard image as described in the link:{baseurl}/advanced/handle-async-image-uploads/[image upload documentation].
20+
If you configure *PowerPaste* to allow local images (see the xref:powerpaste_allow_local_images[`powerpaste_allow_local_images`] setting below), then images copied from Microsoft Word and other sources will appear in {productname} as Base64 encoded images. You can have {productname} automatically upload Base64 encoded images for reverting back to a standard image as described in the xref:general-configuration-guide/upload-images.adoc[image upload documentation].
2121

2222
NOTE: PowerPaste (when configured to allow local images) will import images from pasted Microsoft Word and Microsoft Excel content. When doing this, *PowerPaste* extracts Base64 encoded images from the clipboard. Images larger than approximately 8.5MB may fail to import based on technical limitations of web browsers.
2323

2424
== Cloud Installation
2525

26-
To enable the {productname} *PowerPaste* plugin with link:{baseurl}/cloud-deployment-guide/editor-and-features/[{cloudname}]:
26+
To enable the {productname} *PowerPaste* plugin with xref:cloud-deployment-guide/editor-and-features.adoc[{cloudname}]:
2727

2828
. If you are currently using the `paste` plugin provided with {productname}, disable it by removing it from the `plugins` list.
2929
. Add `powerpaste` to the `plugins` list.
@@ -121,7 +121,8 @@ The event listeners are passed the same data objects as their equivalent configu
121121

122122
Example {productname} configuration:
123123

124-
```js
124+
[source, js]
125+
----
125126
const yourCustomFilter = function(content) {
126127
// Implement your custom filtering and return the filtered content
127128
return content;
@@ -139,14 +140,17 @@ tinymce.init({
139140
data.content = newContent;
140141
});
141142
142-
editor.on('PastePostProcess', function(data) {
143-
console.log(data.node, data.mode, data.source);
144-
// Apply custom filtering by mutating data.node
145-
// For example:
146-
const additionalNode = document.createElement('div');
147-
additionalNode.innerHTML = '<p>This will go before the pasted content.</p>';
148-
data.node.insertBefore(additionalNode, data.node.firstElementChild);
149-
}); } }); ```
143+
editor.on('PastePostProcess', function(data) {
144+
console.log(data.node, data.mode, data.source);
145+
// Apply custom filtering by mutating data.node
146+
// For example:
147+
const additionalNode = document.createElement('div');
148+
additionalNode.innerHTML = '<p>This will go before the pasted content.</p>';
149+
data.node.insertBefore(additionalNode, data.node.firstElementChild);
150+
});
151+
}
152+
});
153+
----
150154

151155
== Commands
152156

modules/ROOT/partials/configuration/formatpainter_formats.adoc

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
=== `formats`
22

3-
The format painter plugin will register many formats upon initialization. To override these formats, use the link:{baseurl}/configure/content-formatting/#exampleofusageoftheformatsoption[`formats`] option.
3+
The format painter plugin will register many formats upon initialization. To override these formats, use the xref:configure/content-formatting.adoc#exampleofusageoftheformatsoption[`formats`] option.
44

5-
The example below showcases the formats registered automatically by the plugin upon initialization. The `formatpainter_removeformat` is used to clear any existing formats before applying the new ones. It is similar to the link:{baseurl}/configure/content-formatting/#removingaformat[`removeformat`] format.
5+
The example below showcases the formats registered automatically by the plugin upon initialization. The `formatpainter_removeformat` is used to clear any existing formats before applying the new ones. It is similar to the xref:configure/content-formatting.adoc#removingaformat[`removeformat`] format.
66

77
*Type:* `Object`
88

modules/ROOT/partials/configuration/formats.adoc

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -393,6 +393,7 @@ tinymce.init({
393393
});
394394
----
395395

396+
[[exampleofusageoftheformatsoption]]
396397
=== Example of usage of the formats option
397398

398399
This example overrides some of the built-in formats and tells {productname} to apply classes instead of inline styles. It also includes a custom format that produced `h1` elements with a title attribute and a `red` CSS style.
@@ -448,6 +449,7 @@ tinymce.activeEditor.formatter.register('custom_format', { inline: 'span', style
448449
tinymce.activeEditor.formatter.apply('custom_format', { value: 'red' });
449450
----
450451

452+
[[removingaformat]]
451453
=== Removing a format
452454

453455
Use the `removeformat` option to specify how the `clear formatting` feature should work in the editor.

modules/ROOT/partials/configuration/image_file_types.adoc

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
=== `image_file_types`
22

3-
This option configures which image file formats will be recognized and placed in an `img` element by the <<smart_paste,`smart_paste`>> functionality when content is pasted into the editor.
3+
This option configures which image file formats will be recognized and placed in an `img` element by the xref:smart_paste[`smart_paste`] functionality when content is pasted into the editor.
44

55
*Type:* `String`
66

@@ -10,7 +10,7 @@ This option configures which image file formats will be recognized and placed in
1010

1111
==== Example: Using `image_file_types`
1212

13-
[source, js]
13+
[source, js, subs="attributes+"]
1414
----
1515
tinymce.init({
1616
selector: 'textarea', // change this value according to your HTML

modules/ROOT/partials/configuration/linkchecker_content_css.adoc

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,8 @@
22

33
After a link is checked for validity, a result of the validation is added to it via `data-mce-linkchecker-status` attribute. There are three possible outcomes of the validation: `valid`, `invalid` and `unknown`. Link Checker visually reflects `invalid` outcome by injecting the following CSS styles into the editor:
44

5-
```css
5+
[source, css]
6+
----
67
a[data-mce-linkchecker-status="invalid"] {
78
outline-color: rgba(231, 76, 60, 0.25);
89
background-color: rgba(231, 76, 60, 0.25)
@@ -11,7 +12,7 @@ a[data-mce-linkchecker-status="invalid"] {
1112
a[data-mce-linkchecker-focus="true"] {
1213
outline: 1px solid rgba(231, 76, 60, 0.75)
1314
}
14-
```
15+
----
1516

1617
`data-mce-linkchecker-focus` attribute is set to _true_ every time a dedicated context menu is shown on a link. This only happens for `invalid` links.
1718

modules/ROOT/partials/configuration/mentions_fetch.adoc

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
1+
[[mentions_fetch]]
12
=== `mentions_fetch`
23

3-
This option lets you request a list of users from your server that match a search query. The callback gets passed two parameters: one is the search query object, the other is the success callback to execute with the results. The query object has a term property that contains what the user has typed after the "@" sign. The success call should contain an array of users. For information on the user properties to pass the success callback for the available mentions item types (`mentions_item_type`), see: <<userproperties,User properties>>.
4+
This option lets you request a list of users from your server that match a search query. The callback gets passed two parameters: one is the search query object, the other is the success callback to execute with the results. The query object has a term property that contains what the user has typed after the "@" sign. The success call should contain an array of users. For information on the user properties to pass the success callback for the available mentions item types (`mentions_item_type`), see: xref:plugins/premium/mentions.adoc#userproperties[User properties].
45

56
*Type:* `Function`
67

0 commit comments

Comments
 (0)