Skip to content

Commit a2f6074

Browse files
DOC-1020: add language_load option to ui-localization.adoc page. (#3027)
* DOC-1020: add option to page that configures whether additional plugin/theme languages are loaded when bundling. * DOC-1020: updates to language_load options and admons. * DOC-1020: copy edits and improvements. * Update modules/ROOT/partials/configuration/language_load.adoc Co-authored-by: Mitchell Crompton <[email protected]> * Update changelog.md * Update modules/ROOT/partials/configuration/language_load.adoc Co-authored-by: Mitchell Crompton <[email protected]> * Update modules/ROOT/partials/configuration/language_load.adoc Co-authored-by: Mitchell Crompton <[email protected]> --------- Co-authored-by: Mitchell Crompton <[email protected]>
1 parent 0623f5d commit a2f6074

File tree

3 files changed

+34
-4
lines changed

3 files changed

+34
-4
lines changed

changelog.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,10 @@ The format is loosely based on [Keep a Changelog](https://keepachangelog.com/en/
66

77
### Unreleased
88

9+
### 2023-12-20
10+
11+
- DOC-1020: add `language_load` option to `ui-localization.adoc` page that configures whether additional plugin/theme languages are loaded when bundling.
12+
913
### 2023-12-19
1014

1115
- DOC-2220: add generation of `latest` and `6` documentation in parallel.

modules/ROOT/pages/ui-localization.adoc

Lines changed: 1 addition & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,4 @@ include::partial$configuration/language.adoc[]
88

99
include::partial$configuration/language_url.adoc[]
1010

11-
////
12-
undocumented
13-
include::partial$configuration/language_load.adoc[]
14-
////
11+
include::partial$configuration/language_load.adoc[]
Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
[[language_load]]
2+
== `+language_load+`
3+
4+
This option determines whether additional plugin or theme languages are loaded during {productname} editor initialization. By default, plugins which have support for languages other than English will automatically load the additional language packs.
5+
6+
*Type:* `+boolean+`
7+
8+
*Default value:* `+true+`
9+
10+
* When the `+language_load+` option is set to `+true+`, any available language packs can be loaded and used by {productname} and plugins that support multiple-languages.
11+
* When set to `+false+`, only explicitly configured language packs will load.
12+
13+
[IMPORTANT]
14+
Setting `+language_load+` option to `+false+` is not recommended unless loading local language packs.
15+
16+
=== Example: using `+language_load+`
17+
18+
[source,js]
19+
----
20+
tinymce.init({
21+
selector: 'textarea', // Change this value according to your HTML
22+
language_load: true, // Disables the automatic loading of additional plugin and theme language files.
23+
});
24+
----
25+
26+
[TIP]
27+
When bundling, it is advisable for plugins that support multiple languages to load the additional language packs locally, and to set this option to `+false+`. This will ensure that all required languages are available for the editor, and that no additional language packs will be retrieved by the plugins.
28+
29+
You can find and download languages link:{gettiny}/language-packages/[here].

0 commit comments

Comments
 (0)