Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion antora.yml
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ asciidoc:
webcomponent_url: https://cdn.jsdelivr.net/npm/@tinymce/tinymce-webcomponent/dist/tinymce-webcomponent.min.js
jquery_url: https://cdn.jsdelivr.net/npm/@tinymce/tinymce-jquery@2/dist/tinymce-jquery.min.js
openai_proxy_url: https://openai.ai-demo-proxy.tiny.cloud/v1/chat/completions
openai_proxy_token: eyJhbGciOiJFUzM4NCJ9.eyJhdWQiOlsiaHR0cHM6Ly9vcGVuYWkuYWktZGVtby1wcm94eS50aW55LmNsb3VkLyJdLCJleHAiOjE3NTEzMjgwMDAsImh0dHBzOi8vb3BlbmFpLmFpLWRlbW8tcHJveHkudGlueS5jbG91ZC9yb2xlIjoicHVibGljLWRlbW8iLCJpc3MiOiJodHRwczovL2FpLWRlbW8tcHJveHkudGlueS5jbG91ZC8iLCJqdGkiOiJmOGFmY2EyNC1mN2FhLTQxMjktYTc2Yy02YThlZDU3YjAyZjYiLCJzdWIiOiJhaS1hc3Npc3RhbnQtZGVtbyJ9.Xu0apHCbxgmRQTeTqrTIDFFhh2CgKeARRXa3mCxSGoCwZqkoQaFRZBCzDo8Xz7DuUa5mW2XHl-HYcYiXJM9ly16d0oY7lJefHBeLlmJEBE1CSttHBkCRWZS8eFLCasL6
openai_proxy_token: eyJhbGciOiJFUzM4NCJ9.eyJhdWQiOlsiaHR0cHM6Ly9vcGVuYWkuYWktZGVtby1wcm94eS50aW55LmNsb3VkLyJdLCJleHAiOjE3ODI4NjQwMDAsImh0dHBzOi8vb3BlbmFpLmFpLWRlbW8tcHJveHkudGlueS5jbG91ZC9yb2xlIjoicHVibGljLWRlbW8iLCJpc3MiOiJodHRwczovL2FpLWRlbW8tcHJveHkudGlueS5jbG91ZC8iLCJqdGkiOiIxZWY3NjJiNi1mZDYyLTQ3ZWQtOGRkNS0yOGRmMzBkZDU4YmMiLCJzdWIiOiJhaS1hc3Npc3RhbnQtZGVtbyJ9.WC8GIY19MgZneDVZoA-Ttt9E7gNkD0Yl-pcM_5c2RT3RdV_zE0i4bPOGBJpg_g6wu_4ki2ery6_JZtk2Q9gXEBHH7fIu7hXDFS8uIV9qe8MyxEqqRncGFVDjSTldVXGS
default_meta_keywords: tinymce, documentation, docs, plugins, customizable skins, configuration, examples, html, php, java, javascript, image editor, inline editor, distraction-free editor, classic editor, wysiwyg
# product docker variables
dockerimageimportfromwordexporttoword: registry.containers.tiny.cloud/docx-converter-tiny
Expand Down
4 changes: 2 additions & 2 deletions modules/ROOT/pages/exportpdf.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -28,8 +28,8 @@ tinymce.init({
selector: 'textarea',
plugins: 'exportpdf',
toolbar: 'exportpdf',
// Below option is only required when using the cloud-based Export to PDF plugin from Tiny.Cloud.
// Avoid setting it up during the trial period.
// Required for the cloud-based Export to PDF plugin with Tiny Cloud
// Create a JWT key in the Customer Portal for trial functionality to enable watermark-free exports during the trial period
exportpdf_token_provider: () => {
return fetch('http://localhost:3000/jwt', { // specify your token endpoint
method: 'POST',
Expand Down
4 changes: 2 additions & 2 deletions modules/ROOT/pages/exportword.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -35,8 +35,8 @@ tinymce.init({
selector: 'textarea',
plugins: 'exportword',
toolbar: 'exportword',
// Below option is only required when using the cloud-based Export to Word plugin from Tiny.Cloud.
// Avoid setting it up during the trial period.
// Required for the cloud-based Export to Word plugin with Tiny Cloud
// Create a JWT key in the Customer Portal for trial functionality to enable watermark-free exports during the trial period
exportword_token_provider: () => {
return fetch('http://localhost:3000/jwt', { // specify your token endpoint
method: 'POST',
Expand Down
7 changes: 3 additions & 4 deletions modules/ROOT/pages/importword.adoc
Original file line number Diff line number Diff line change
@@ -1,4 +1,3 @@

= {pluginname} plugin
:plugincode: importword
:pluginname: Import from Word
Expand Down Expand Up @@ -30,9 +29,9 @@ tinymce.init({
selector: 'textarea',
plugins: 'importword',
toolbar: 'importword',
// Below option is only required when using the cloud-based Import from Word plugin from Tiny.Cloud.
// Avoid setting it up during the trial period.
importword_token_provider: () => { // required when using the Import from Word plugin with Tiny Cloud.
// Required for the cloud-based Import from Word plugin with Tiny Cloud
// Create a JWT key in the Customer Portal for trial functionality to enable watermark-free exports during the trial period
importword_token_provider: () => {
return fetch('http://localhost:3000/jwt', { // specify your token endpoint
method: 'POST',
headers: { 'Content-Type': 'application/json' },
Expand Down
2 changes: 1 addition & 1 deletion modules/ROOT/pages/understanding-editor-loads.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@
== Understanding editor loads for {productname}

[IMPORTANT]
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].
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 link:https://github.com/tinymce/tinymce/blob/release/{productmajorversion}/LICENSE.md[open source license].

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.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ Pull the Docker image:

[source, sh, subs="attributes+"]
----
docker pull registry.containers.tiny.cloud/{dockerimageexporttopdf}:[version]
docker pull {dockerimageexporttopdf}:[version]
----

[TIP]
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ If the `SECRET_KEY` is not setup during the installation, then {pluginname} On-P
* it is not issued in the future (e.i. the `iat` timestamp cannot be newer than the current time),
* it has not expired yet.

Tokens for the {pluginname} On-Premises do not require any additional claims such as the environment ID (which is specific for Collaboration Server On-Premises), the token can be created with an empty payload.
Tokens for the {pluginname} On-Premises do not require any additional claims such as the `aud` (which is specific to cloud-based document converters), so the token can be created with an empty payload.

If the specific use case involves sending requests from a backend server, then JWT tokens can be generated locally, as shown in the below request example.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ Pull the Docker image:

[source, sh, subs="attributes+"]
----
docker pull registry.containers.tiny.cloud/{dockerimageimportfromwordexporttoword}:[version]
docker pull {dockerimageimportfromwordexporttoword}:[version]
----

[TIP]
Expand Down
20 changes: 20 additions & 0 deletions modules/ROOT/partials/integrations/angular-tech-ref.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,7 @@
** xref:licensekey[`+licenseKey+`]
** xref:cloudchannel[`+cloudChannel+`]
** xref:disabled[`+disabled+`]
** xref:readonly[`+readonly+`]
** xref:id[`+id+`]
** xref:init[`+init+`]
** xref:initialvalue[`+initialValue+`]
Expand Down Expand Up @@ -97,6 +98,7 @@ The editor accepts the following properties:
apiKey="no-api-key"
cloudChannel="{productmajorversion}"
[disabled]="false"
[readonly]="false"
id=""
[init]="{ }"
initialValue=""
Expand Down Expand Up @@ -193,6 +195,24 @@ The `+disabled+` property can dynamically switch the editor between a "disabled"
<editor [disabled]="true" />
----

[[readonly]]
=== `+readonly+`

The `+readonly+` property can dynamically switch the editor between a "read-only" mode (`+true+`) and the standard editable mode (`+false+`).

*Type:* `+Boolean+`

*Default value:* `+false+`

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

==== Example: using `+readonly+`

[source,html]
----
<editor [readonly]="true" />
----

[[id]]
=== `+id+`

Expand Down
26 changes: 24 additions & 2 deletions modules/ROOT/partials/integrations/react-tech-ref.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,7 @@
** xref:licenseKey[`+licenseKey+`]
** xref:cloudchannel[`+cloudChannel+`]
** xref:disabled[`+disabled+`]
** xref:readonly[`+readonly+`]
** xref:id[`+id+`]
** xref:init[`+init+`]
** xref:initialvalue[`+initialValue+`]
Expand Down Expand Up @@ -143,7 +144,8 @@ xref:toolbar[`+toolbar+`]:: Specify the editor toolbar. This will *override* the

These props can be updated after the editor is initialized. Note that there are xref:event-binding[other events] not mentioned here.

xref:disabled[`+disabled+`]:: Should the editor be in read-only mode.
xref:disabled[`+disabled+`]:: Should the editor be disabled.
xref:readonly[`+readonly+`]:: Should the editor be in read-only mode.

xref:initialvalue[`+initialValue+`]:: The starting value of the editor. Changing this value after the editor has loaded will reset the editor (including the editor content).

Expand Down Expand Up @@ -240,7 +242,7 @@ For information {productname} development channels, see: xref:editor-plugin-vers
[[disabled]]
=== `+disabled+`

The `+disabled+` prop can dynamically switch the editor between a "disabled" (read-only) mode (`+true+`) and the standard editable mode (`+false+`).
The `+disabled+` prop can dynamically toggle the editor's disabled state.

*Type:* `Boolean`

Expand All @@ -257,6 +259,26 @@ The `+disabled+` prop can dynamically switch the editor between a "disabled" (re
/>
----

[[readonly]]
=== `+readonly+`

The `+readonly+` prop can dynamically switch the editor between a read-only mode (`+true+`) and the standard editable mode (`+false+`).

*Type:* `Boolean`

*Default value:* `+false+`

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

==== Example: using `+readonly+`

[source,jsx]
----
<Editor
readonly={true}
/>
----

[[id]]
=== `+id+`

Expand Down
22 changes: 21 additions & 1 deletion modules/ROOT/partials/integrations/svelte-tech-ref.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@ Covered in this section:
** xref:id[id]
** xref:inline[inline]
** xref:disabled[disabled]
** xref:readonly[readonly]
** xref:scriptsrc[scriptsrc]
** xref:conf[conf]
* xref:component-binding[Component binding]
Expand All @@ -25,6 +26,7 @@ The `+tinymce-svelte+` `+Editor+` component accepts the following properties:
id="uuid"
inline=false
disabled=false
readonly=false
scriptSrc=undefined
conf={}
modelEvents="input change undo redo"
Expand Down Expand Up @@ -134,7 +136,7 @@ Sets the editor to use inline mode.
[[disabled]]
=== `+disabled+`

Set the editor to readonly mode.
Set the editor to disabled.

*Type:* `+Boolean+`

Expand All @@ -149,6 +151,24 @@ Set the editor to readonly mode.
/>
----

[[readonly]]
=== `+readonly+`

Set the editor to readonly mode.

*Type:* `+Boolean+`

*Default value:* `+false+`

==== Example using `+readonly+`

[source,jsx]
----
<Editor
readonly=true
/>
----

[[scriptsrc]]
=== `+scriptSrc+`

Expand Down
22 changes: 22 additions & 0 deletions modules/ROOT/partials/integrations/vue-tech-ref.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@
** xref:license-key[`+licenseKey+`]
** xref:cloud-channel[`+cloud-channel+`]
** xref:disabled[`+disabled+`]
** xref:readonly[`+readonly+`]
** xref:id[`+id+`]
** xref:init[`+init+`]
** xref:initial-value[`+initial-value+`]
Expand Down Expand Up @@ -99,6 +100,7 @@ The editor accepts the following properties:
api-key="no-api-key"
cloud-channel="{productmajorversion}"
:disabled=false
:readonly=false
id="uuid"
:init= "{ }"
initial-value=""
Expand Down Expand Up @@ -205,6 +207,26 @@ The `+disabled+` property can dynamically switch the editor between a "disabled"
/>
----

[[readonly]]
=== `+readonly+`

The `+readonly+` property can dynamically switch the editor between a "read-only" mode (`+true+`) and the standard editable mode (`+false+`).

*Type:* `+Boolean+`

*Default value:* `+false+`

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

==== Example: using `+readonly+`

[source,html]
----
<editor
:readonly=true
/>
----

[[id]]
=== `+id+`

Expand Down
22 changes: 22 additions & 0 deletions modules/ROOT/partials/integrations/webcomponent-tech-ref.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,8 @@
** xref:loading-plugins[Loading plugins]
** xref:setting-the-editor-width[Setting the editor width]
** xref:setting-the-editor-height[Setting the editor height]
** xref:setting-readonly[Setting the editor to readonly]
** xref:setting-disabled[Setting the editor to disabled]
** xref:setting-the-toolbar[Setting the toolbar]
** xref:setting-the-toolbar-mode[Setting the toolbar mode]
** xref:setting-the-menu-bar[Setting the menu bar]
Expand Down Expand Up @@ -146,6 +148,26 @@ To set the height of the editor (content area and user interface), use the `+hei
<tinymce-editor height="15em"></tinymce-editor>
----


[[setting-readonly]]
=== Setting readonly mode

To set the editor's mode to `readonly`.

[source,html]
----
<tinymce-editor readonly></tinymce-editor>
----

[[setting-disaled-state]]
=== Setting disabled state
To set the editor to a disabled state.

[source,html]
----
<tinymce-editor disabled></tinymce-editor>
----

[[setting-the-toolbar]]
=== Setting the toolbar

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,17 +2,34 @@
====
The {pluginname} plugin **requires** JWT authentication when using the {companyname} Cloud service.

* Configure the `{plugincode}_token_provider` option to specify the endpoint for retrieving a valid JWT token.
**Authentication Setup:**

For more information on how to set up JWT authentication with {pluginname}, see examples:
. Create a JWT key in the Customer Portal
. Configure the `{plugincode}_token_provider` option to specify the endpoint for retrieving your JWT token

* xref:{pluginfilename}-with-jwt-authentication-nodejs.adoc[{pluginname} with JWT authentication (Node.js)]
* xref:{pluginfilename}-with-jwt-authentication-php.adoc[{pluginname} with JWT authentication (PHP)]
For more information on how to set up JWT authentication with {pluginname}, see examples: xref:{pluginfilename}-with-jwt-authentication-nodejs.adoc[{pluginname} with JWT authentication (Node.js)] or xref:{pluginfilename}-with-jwt-authentication-php.adoc[{pluginname} with JWT authentication (PHP)]

**Trial period behavior:**
**Trial period behavior**

* The {pluginname} plugin runs in evaluation mode and adds a watermark to exported content.
* The `{plugincode}_token_provider` option is "not required" during the trial period.
* If the trial period "expires" or the plugin lacks the necessary entitlement, it becomes _non-functional_.
* Attempting to use JWT authentication during the trial will result in an _error_.
ifeval::["{plugincode}" == "importword"]
* **Trial Period:**
** With JWT: Full functionality, unlimited usage, no watermarks.
** Without JWT: Full functionality with watermarks and page limits.

* **After Trial:**
** With {pluginname} add-on + JWT: Full functionality (subscription-based)
** Without add-on: Plugin entitlements are `disabled` and functionality is no longer available.
endif::[]

ifeval::["{plugincode}" != "importword"]
* **Trial Period:**
** With JWT: Full functionality, unlimited usage, no watermarks.
** Without JWT: Full functionality with watermarks.

* **After Trial:**
** With {pluginname} add-on + JWT: Full functionality (subscription-based)
** Without add-on: Plugin entitlements are `disabled` and functionality is no longer available.
endif::[]

Visit the link:https://www.tiny.cloud/auth/login/[account portal] to obtain your JWT key and test full functionality.
====