Skip to content

Commit 18b4deb

Browse files
committed
DOC-3329: re-factor enhanced skins and icon pack page, partials and update references for NPM.
1 parent 4935be6 commit 18b4deb

File tree

5 files changed

+89
-59
lines changed

5 files changed

+89
-59
lines changed

modules/ROOT/pages/editor-skin.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@
88
====
99
*Skins vs Content CSS:*
1010
11-
Skins change both the look of {productname}'s UI and the editable area. To change only the look of the editable area, use xref:add-css-options.adoc#content_css[`+content_css+`].
11+
Skins change both the look of {productname}'s UI and the editable area (when the skin includes both `+skin.css+` and `+content.css+` files). The `+content_css+` option only styles the editable area. If both `+skin+` and `+content_css+` are used, `+content_css+` will override the skin's content styles, allowing mixing and matching of UI and content styles.
1212
====
1313

1414
The default skin does not require any configuration, though it must be imported when bundling for deployment:

modules/ROOT/pages/enhanced-skins-and-icon-packs.adoc

Lines changed: 61 additions & 51 deletions
Original file line numberDiff line numberDiff line change
@@ -1,79 +1,99 @@
11
= Enhanced Skins & Icon Packs
22
:navtitle: Enhanced Skins & Icon Packs
3-
:description: Quickly give TinyMCE a new look.
3+
:description: Premium skins and icon packs for TinyMCE.
44
:keywords: skin, skins, icon, icons, material, bootstrap, customize, theme
55

6-
The {prem_skins_icons} lets you quickly give {productname} a new look. Just choose one of our pre-made skins and icon packs.
6+
NOTE: Enhanced skins are only available with a link:{pricingpage}/[paid {productname} subscription].
77

8-
== How to use a Enhanced skins
8+
The {prem_skins_icons} provide pre-made skins and icon packs to quickly customize {productname}'s appearance. These premium options allow integrators to match {productname} to their application's design system.
99
10-
NOTE: Enhanced skins are only available with a link:{pricingpage}/[paid {productname} subscriptions].
10+
== Available premium skins
1111
12-
Use the xref:editor-skin.adoc#skin[skin] option, in combination with the xref:add-css-options.adoc#content_css[content_css] option and the values listed below.
12+
The following premium skins are available for {productname}:
1313
14-
Available values for xref:editor-skin.adoc#skin[skins]:
14+
* `material-classic`
15+
* `material-outline`
16+
* `bootstrap`
17+
* `fabric`
18+
* `fluent`
19+
* `borderless`
20+
* `small`
21+
* `jam`
22+
* `naked`
23+
* `outside`
24+
* `snow`
1525
16-
* material-classic
17-
* material-outline
18-
* bootstrap
19-
* fabric
20-
* fluent
21-
* borderless
22-
* small
23-
* jam
24-
* naked
25-
* outside
26-
* snow
26+
For information on configuring skins, see: xref:editor-skin.adoc[Skin options].
2727
28-
Available values for xref:add-css-options.adoc#content_css[content_css]:
28+
Some skins include both UI styles (`+skin.css+`) and content styles (`+content.css+`). When a skin includes both files, using the `+skin+` option will apply both UI and content styles. The `+content_css+` option is not required in this case.
2929
30-
* material-classic
31-
* material-outline
32-
* fabric
33-
* fluent
30+
For styling only the editable area (without changing the UI), separate content-only CSS files are available. These files are located in the content folder and may differ from the content styles included with skins. Available content-only options:
3431
35-
=== Example: using a Enhanced skin
32+
* `material-classic`
33+
* `material-outline`
34+
* `fabric`
35+
* `fluent`
36+
37+
Use the xref:add-css-options.adoc#content_css[`+content_css+`] option to apply content-only styles.
38+
39+
Skins can include both UI styles (`+skin.css+`) and content styles (`+content.css+`). Using the `+skin+` option applies both automatically when both files are present.
40+
41+
For styling only the editable area (without changing the UI), separate content-only CSS files are available. These files are located in the content folder and may differ from the content styles included with skins. Available content-only options:
42+
43+
* `material-classic`
44+
* `material-outline`
45+
* `fabric`
46+
* `fluent`
47+
48+
Use the xref:add-css-options.adoc#content_css[`+content_css+`] option to apply content-only styles.
49+
50+
=== Example: using a premium skin
3651
3752
[source,js]
3853
----
3954
tinymce.init({
40-
selector: 'textarea', // change this value according to your HTML
41-
skin: 'fabric', // Name of the skin
42-
content_css: 'fabric' // Name of the content skin
55+
selector: 'textarea',
56+
skin: 'fabric' // Applies both UI and content styles (if both files are included)
4357
});
4458
----
4559

46-
== How to use an icon pack
60+
[NOTE]
61+
====
62+
*Mixing skins and content_css:*
63+
64+
The `+content_css+` option is not required when using skins that include content styles. However, if both `+skin+` and `+content_css+` are specified, `+content_css+` will override the skin's content styles, allowing mixing and matching of UI and content styles.
65+
====
66+
67+
== Available premium icon packs
4768

48-
Use the xref:editor-icons.adoc#icons[icons] option with any of the values listed below.
69+
The following premium icon packs are available for {productname}:
4970

50-
Available values for xref:editor-icons.adoc#icons[icon] packs:
71+
* `bootstrap`
72+
* `material`
73+
* `small`
74+
* `jam`
75+
* `thin`
5176

52-
* bootstrap
53-
* material
54-
* small
55-
* jam
56-
* thin
77+
For information on configuring icon packs, see: xref:editor-icons.adoc[Icon options].
5778

5879
=== Example: using a premium icon pack
5980

6081
[source,js]
6182
----
6283
tinymce.init({
63-
selector: 'textarea', // change this value according to your HTML
84+
selector: 'textarea',
6485
icons: 'material' // Name of icon pack
6586
});
6687
----
6788

68-
For information on using the `+icons+` option, see: xref:editor-icons.adoc#icons[User interface options - `+icons+`].
89+
[[icon-pack-compatibility-matrix]]
90+
== Icon pack compatibility matrix
6991

70-
=== Icon pack compatibility matrix
71-
72-
Due to different toolbar button sizes, some icon packs fit better with some skins. Use the below matrix as a guide.
92+
Due to different toolbar button sizes, some icon packs fit better with some skins. Use the compatibility matrix below as a guide when selecting combinations.
7393

7494
[cols="1,3",options="header"]
7595
|===
76-
|Skin |Compatible Icon pack
96+
|Skin |Compatible Icon packs
7797
|material-classic |bootstrap, material, jam, small, thin
7898
|material-outline |bootstrap, material, jam, small, thin
7999
|bootstrap |bootstrap, material, jam, small, thin
@@ -89,7 +109,7 @@ Due to different toolbar button sizes, some icon packs fit better with some skin
89109

90110
== Examples
91111

92-
Below are some recommended combinations of skins and icon packs:
112+
Below are interactive demos showing recommended combinations of skins and icon packs:
93113

94114
* xref:bootstrap-demo.adoc[Bootstrap skin]
95115
* xref:material-outline-demo.adoc[Material Outline skin with Material icon pack]
@@ -103,13 +123,3 @@ Below are some recommended combinations of skins and icon packs:
103123
* xref:outside-demo.adoc[Outside editor]
104124
* xref:snow-demo.adoc[Snow editor]
105125
* xref:custom-icon-pack-demo.adoc[Custom Icon Pack Demo]
106-
107-
////
108-
:pluginname: Tiny Skins and Icon
109-
:pluginminimumplan: tiertwo
110-
:extensionType: Packs
111-
:pluralExtensionType: true
112-
include::partial$misc/purchase-premium-plugins.adoc[]
113-
:!extensionType:
114-
:!pluralExtensionType:
115-
////

modules/ROOT/partials/configuration/language_url.adoc

Lines changed: 22 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,9 +3,29 @@
33

44
When using the xref:ui-localization.adoc#language[`+language+`] option to set the user interface language you can place language pack(s) in a directory other than the default. If you do this, however, you must add the `language_url` option to your configuration and set this option to a path pointing to the language file(s) location.
55

6-
We recommend the path URL be relative to the web applications root. That is, begin with the absolute path reference character `+/+`. Avoid relying on application context for safe path resolution of language packs.
6+
We recommend the path URL be relative to the web application's root. That is, begin with the absolute path reference character `+/+`. Avoid relying on application context for safe path resolution of language packs.
77

8-
Also, the `+language+` option must also be set and must be set to the name of the language pack file being loaded.
8+
[IMPORTANT]
9+
====
10+
*Understanding `language_url` and `language` Together:*
11+
12+
When using `language_url`, you must also specify the `language` option:
13+
14+
* `language_url` - Tells {productname} *where* to find the language pack file.
15+
* `language` - Tells {productname} *which* language pack to use from the loaded file.
16+
17+
*Example:*
18+
19+
[source,js]
20+
----
21+
tinymce.init({
22+
selector: 'textarea',
23+
language_url: '/path/to/language_pack/fi.js', // Where to find it
24+
language: 'fi', // Which language pack to use
25+
// ... other options
26+
});
27+
----
28+
====
929

1030
*Type:* `+String+`
1131

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
There are two options for changing the language of the {productname} user interfaces: `+language+` and `+language_url+`.
1+
There are two options for changing the language of the {productname} user interfaces: `+language+` and `+language_url+`.
22

33
* Use the `+language+` option when language packs are in the default location (for {cloudname} deployments, ZIP bundles, or when using NPM packages with bundling or file layering).
4-
* Use the `+language_url+` option to specify a custom path to language packs, which is useful for community translations, custom language packs, or when using NPM packages without bundling.
4+
* Use the `+language_url+` option to specify a custom path to language packs, which is useful for community translations, custom language packs, or when using NPM packages without bundling. When using `+language_url+`, the `+language+` option is also required.

modules/ROOT/partials/misc/skin-or-skin_url.adoc

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -17,12 +17,12 @@ To load skins from another location, integrators must specify that location usin
1717
====
1818
*Understanding the skins folder structure:*
1919
20-
The **skins** folder in the `+tinymce-premium+` NPM package and ZIP bundles contains both a **ui** folder and a **content** folder. The files within the **content** folder are for use with the xref:add-css-options.adoc#content_css[`+content_css+`] option, and only affect the editable area. They do not work with the `+skin+` or `+skin_url+` options.
20+
The **skins** folder in the `+tinymce-premium+` NPM package and ZIP bundles contains both a **ui** folder and a **content** folder. Skins in the **ui** folder can include both `+skin.css+` (for UI styling) and `+content.css+` (for editable area styling). When a skin includes both files, using the `+skin+` option will apply both UI and content styles. The files in the **content** folder can also be used independently with the xref:add-css-options.adoc#content_css[`+content_css+`] option to style only the editable area.
2121
====
2222

2323
[NOTE]
2424
====
25-
*Content CSS Override:*
25+
*Using skins and content_css together:*
2626
27-
`+content_css+` will override any content styles set by UI skins.
27+
Skins that include both `+skin.css+` and `+content.css+` files will style both the UI and the editable area. The `+content_css+` option is not required when using such skins. However, if both `+skin+` and `+content_css+` are specified, `+content_css+` will override the skin's content styles, allowing mixing and matching of UI and content styles.
2828
====

0 commit comments

Comments
 (0)