Skip to content

Commit 8c17301

Browse files
Farzad Hayatkemister85
andauthored
DOC-2485: Improve docs for Menu option (#3478)
* DOC-2485: Improve wording of menu configuration options * DOC-2485: Improve wording of toolbar group labels * Revert "DOC-2485: Improve wording of toolbar group labels" This reverts commit 4f451dc. * Update modules/ROOT/partials/configuration/menu.adoc Co-authored-by: Karl Kemister-Sheppard <[email protected]> * Update modules/ROOT/partials/configuration/menu.adoc Co-authored-by: Karl Kemister-Sheppard <[email protected]> * Update modules/ROOT/partials/configuration/removed_menuitems.adoc Co-authored-by: Karl Kemister-Sheppard <[email protected]> * Improve wording for menu.adoc and menubar.adoc --------- Co-authored-by: Karl Kemister-Sheppard <[email protected]>
1 parent 358a588 commit 8c17301

File tree

3 files changed

+10
-11
lines changed

3 files changed

+10
-11
lines changed
Lines changed: 5 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,11 @@
11
[[menu]]
22
== `+menu+`
33

4-
This option allows you to specify which menus should appear on {productname}'s menu bar and the xref:available-menu-items.adoc[items] that should appear within the menus themselves.
4+
The `+menu+` option allows integrators to define the available menus for the xref:menus-configuration-options.adoc#menubar[menubar option] and specify the xref:available-menu-items.adoc[menu items] that appear within those menus.
55

6-
To specify the menus that should appear on {productname}'s menu bar, the menu option should be provided with a JavaScript object containing a property for each menu. These properties should contain a JavaScript object themselves with properties `+title+` and `+items+`.
6+
To configure the menus, provide a JavaScript object where each property represents a menu. Each menu object should contain `+title+` and `+items+` properties. The `+title+` property is a string that defines the display name, while the `+items+` property is a space-separated list of the xref:available-menu-items.adoc[menu items] that should populate the menu.
77

8-
The `+title+` property should contain a string with the name of the `+menu+`. The `+items+` field should contain a space separated list of the controls that should populate the `+menu+`.
9-
10-
If you would like to group these menu items, please insert a `+|+` pipe character between the menu items.
8+
To group certain menu items, insert a `+|+` pipe character between the menu items.
119

1210
*Type:* `+Object+`
1311

@@ -18,4 +16,5 @@ include::partial$configuration/defaultmenuitems.adoc[]
1816

1917
include::partial$misc/admon-different-default-for-mobile.adoc[]
2018

21-
If all you need is to control which menus are available and/or in what order, see the xref:menus-configuration-options.adoc#menubar[menubar parameter].
19+
[NOTE]
20+
This option alone does not control which menus appear in the menu bar or the order in which they appear. To control the menu bar and the order of the menus in the menu bar, see the xref:menus-configuration-options.adoc#menubar[menubar option].

modules/ROOT/partials/configuration/menubar.adoc

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,9 @@
11
[[menubar]]
22
== `+menubar+`
33

4-
This option allows you to specify which menus should appear and the order that they appear in the menu bar at the top of {productname}.
4+
This option specifies which menus appear and their order in the menu bar at the top of {productname}.
55

6-
To specify the menus that should appear on {productname}'s menu bar, the menubar option should be provided with a space separated list of menus.
6+
To define the menus on {productname}'s menu bar, provide the menubar option with a space-separated list of menus.
77

88
*Type:* `+String+` or `+Boolean+`
99

@@ -25,7 +25,7 @@ tinymce.init({
2525

2626
=== Example: disabling/removing the menu bar
2727

28-
To disable the menu bar, the menubar option should be provided a boolean value of `+false+`.
28+
To disable the menu bar, set the `+menubar+` option to `+false+`.
2929

3030
[source,js]
3131
----
@@ -35,4 +35,4 @@ tinymce.init({
3535
});
3636
----
3737

38-
If you need more control over the contents of the menus, see the xref:menus-configuration-options.adoc#menu[menu parameter].
38+
For more granular control over the contents of the menus, refer to the xref:menus-configuration-options.adoc#menu[menu option] documentation.

modules/ROOT/partials/configuration/removed_menuitems.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
[[removed_menuitems]]
22
== `+removed_menuitems+`
33

4-
This option allows you to remove items from {productname}'s drop down menus. This is useful if you are using the xref:menus-configuration-options.adoc#menubar[menubar] option to set your menus rather than the more specific xref:menus-configuration-options.adoc#menu[menu] option.
4+
This option enables the exclusion of items from {productname}'s menus. It is especially useful when configuring menus using only the xref:menus-configuration-options.adoc#menubar[menubar] option without defining custom menu items through the xref:menus-configuration-options.adoc#menu[menu] option.
55

66
*Type:* `+String+`
77

0 commit comments

Comments
 (0)