Skip to content

Commit 34bec60

Browse files
DOC-2240: add new understanding-editor-loads.adoc to how-to-guide section (#3047)
* DOC-2240: add new understanding-editor-loads.adoc to how-to-guide section. * Update modules/ROOT/pages/understanding-editor-loads.adoc * Update modules/ROOT/pages/understanding-editor-loads.adoc Co-authored-by: Andrew Herron <[email protected]> * Update modules/ROOT/pages/understanding-editor-loads.adoc Co-authored-by: Andrew Herron <[email protected]> * Update modules/ROOT/pages/understanding-editor-loads.adoc * Update modules/ROOT/pages/understanding-editor-loads.adoc removed this for future updates * Update changelog.md --------- Co-authored-by: Andrew Herron <[email protected]>
1 parent 6eca5cc commit 34bec60

File tree

3 files changed

+53
-0
lines changed

3 files changed

+53
-0
lines changed

changelog.md

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

99

10+
### 2024-01-30
11+
12+
- DOC-2240: add new `understanding-editor-loads.adoc` to `how-to-guide` section.
13+
1014
### 2023-01-15
1115

1216
- DOC-2235: changes and updates to `invalid-api-key.adoc` page.

modules/ROOT/nav.adoc

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -215,6 +215,7 @@
215215
** xref:migration-from-5x.adoc[Migrating from TinyMCE 5]
216216
** xref:migration-from-froala.adoc[Migrating from Froala]
217217
** xref:generate-rsa-key-pairs.adoc[Generate public key pairs]
218+
** xref:understanding-editor-loads.adoc[Understanding editor loads]
218219
* xref:examples.adoc[Examples]
219220
** xref:examples.adoc#general-examples[General examples]
220221
*** xref:basic-example.adoc[Basic example]
Lines changed: 48 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,48 @@
1+
= Understanding editor loads
2+
:navtitle: Understanding editor loads
3+
:description: Relevant information for Tiny Cloud users to help understand editor loads for {productname}.
4+
:keywords: invalid-api-key, API, {productname}, cloud, frequently asked questions
5+
6+
== Understanding editor loads for {productname}
7+
8+
[IMPORTANT]
9+
This information is only relevant to Tiny Cloud users. Users who self-host the open source version of {productname} are not subject to editor load restrictions, but must comply with the https://github.com/tinymce/tinymce/blob/master/LICENSE.TXT[open source license].
10+
11+
An editor load is the event that occurs each time {productname} is initialized in your application. The editor dispatches the 'init' event to indicate a successful load. For example, if 100 users load {productname} 10 times each, the result would be 1,000 editor loads.
12+
13+
The process of initializing an editor involves several steps.
14+
15+
. The integrator initializes one or more editors on the webpage, commonly accomplished through the `tinymce.init({ ... })` method.
16+
+
17+
. The `selector` property of the `init` method determines which elements should be replaced with editor instances. For example: if the selector is `textarea` and there are 5 textarea elements on the page, 5 editor instances will be created.
18+
+
19+
Each editor instance performs the same initialization sequence and then dispatches an `init` event. This event is dispatched even if the the editor is not visible.
20+
+
21+
. **The 'init' event serves as the conclusive indicator that the editor has completed its loading process**. At this point, the editor has been successfully initialized and is ready for user interaction.
22+
23+
== How are editor loads counted?
24+
25+
An editor load is counted each time a new {productname} editor instance completes the initialization sequence and dispatches an `init` event.
26+
27+
== What happens if I have multiple editors on a page?
28+
29+
Each individual editor instance on a page is counted as one editor load. For example, if a page has ten editors, a single refresh of that page results in ten editor loads.
30+
31+
== What can contribute to a high number of editor loads?
32+
33+
The most obvious scenario is using multiple editors on a single page (see above). For example:
34+
35+
* An email building app that has a {productname} editor embedded in multiple sections
36+
* A publicly available page on a high traffic website with multiple editor instances
37+
38+
== How can I get unlimited editor loads?
39+
40+
You can get unlimited editors loads one of three ways:
41+
42+
* The open-source version of {productname} can be self hosted, and is not subject to editor load restrictions.
43+
* The open-source version of {productname} is also available via third party-hosted CDNs and is not subject to editor load restrictions.
44+
* For the Enterprise version of Tiny MCE with Premium features, https://www.tiny.cloud/contact/[get in touch with our Sales team] for a custom quote.
45+
46+
== I have an annual plan. Are my editor loads calculated monthly or over the entire year?
47+
48+
If you have an annual plan, your editor loads are calculated on a monthly basis within the structure of your annual plan. Similar to our monthly plans, you have a set monthly editor load limit and are automatically charged $40 USD per every block of 1,000 editor loads over the plan limit.

0 commit comments

Comments
 (0)