Skip to content

Commit d5bee33

Browse files
DOC-3172: Update Full Screen plugin documentation to clarify classic mode requirement. (#3658)
* DOC-3172: Update Full Screen plugin documentation to clarify classic mode requirement. * Update modules/ROOT/pages/editor-command-identifiers.adoc Co-authored-by: tiny-ben-tran <[email protected]> * Update modules/ROOT/pages/fullscreen.adoc Co-authored-by: tiny-ben-tran <[email protected]> * Update modules/ROOT/partials/commands/fullscreen-cmds.adoc Co-authored-by: tiny-ben-tran <[email protected]> * Update modules/ROOT/partials/index-pages/opensource-plugins.adoc Co-authored-by: tiny-ben-tran <[email protected]> * Update modules/ROOT/partials/commands/fullscreen-cmds.adoc * Update modules/ROOT/partials/index-pages/opensource-plugins.adoc --------- Co-authored-by: tiny-ben-tran <[email protected]>
1 parent 7cf4307 commit d5bee33

File tree

5 files changed

+12
-6
lines changed

5 files changed

+12
-6
lines changed

modules/ROOT/pages/editor-command-identifiers.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -372,7 +372,7 @@ include::partial$commands/formatpainter-cmds.adoc[leveloffset=+3]
372372
[[fullscreen]]
373373
==== Full Screen
374374

375-
The following command requires the xref:fullscreen.adoc[Full Screen (`+fullscreen+`)] plugin.
375+
The following command requires the xref:fullscreen.adoc[Full Screen (`+fullscreen+`)] plugin and is **only** applicable when the editor is in classic mode.
376376

377377
include::partial$commands/fullscreen-cmds.adoc[leveloffset=+3]
378378

modules/ROOT/pages/fullscreen.adoc

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -5,12 +5,12 @@
55
:pluginname: Full Screen
66
:plugincode: fullscreen
77

8-
This plugin adds full screen editing capabilities to {productname}. When the toolbar button is pressed the editable area will fill the browser's viewport. The plugin adds a toolbar button and a menu item `+Fullscreen+` under the `+View+` menu.
8+
The {pluginname} plugin enables fullscreen editing in {productname} when using classic mode. Activating the toolbar button expands the editable area to fill the browser viewport. The plugin adds a `+Fullscreen+` toolbar button and a corresponding menu item under the `+View+` menu.
99

10-
Full screen mode can be toggled using the following keyboard shortcuts:
10+
Fullscreen mode can be toggled using the following keyboard shortcuts:
1111

1212
* macOS: Command+Shift+F
13-
* Most other operating systems (such as Windows or Linux): Ctrl+Shift+F
13+
* Windows or Linux: Ctrl+Shift+F
1414
1515
== Basic setup
1616

@@ -23,6 +23,9 @@ tinymce.init({
2323
});
2424
----
2525

26+
[NOTE]
27+
This feature is supported only when {productname} is operating in classic mode. It is **not supported** in inline mode. For details on the differences between editing modes, refer to xref:use-tinymce-classic.adoc[Classic editing mode].
28+
2629
== Options
2730

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

modules/ROOT/partials/commands/fullscreen-cmds.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
[cols="1,3",options="header"]
22
|===
33
|Command |Description
4-
|mceFullScreen |Toggles full screen mode.
4+
|mceFullScreen |Toggles fullscreen mode.
55
|===
66

77
.Example

modules/ROOT/partials/configuration/fullscreen_native.adoc

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,9 @@ The `+fullscreen_native+` option allows the editor to use the browser full scree
1313

1414
*Possible values:* `+true+`, `+false+`
1515

16+
[NOTE]
17+
This option is only supported when {productname} is in classic mode. It is not supported in inline mode.
18+
1619
=== Example: using `+fullscreen_native+`
1720

1821
To use the browser-native full screen mode for the {productname} editor, set `+fullscreen_native+` to `+true+`. For example:

modules/ROOT/partials/index-pages/opensource-plugins.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -67,7 +67,7 @@ a|
6767
[.lead]
6868
xref:fullscreen.adoc[Full Screen]
6969

70-
Zoom {productname} up to the whole screen.
70+
Expand {productname} to fill the entire screen.
7171

7272
a|
7373
[.lead]

0 commit comments

Comments
 (0)