Skip to content

Commit a7d31ec

Browse files
kemister85kemister85
authored
Merge pull request #3023 from tinymce/staging/docs-6
DOC-2043: TinyMCE 6.8.1 release notes.
2 parents 413502b + f2f4ba4 commit a7d31ec

File tree

88 files changed

+1597
-585
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

88 files changed

+1597
-585
lines changed

‎-new-material-templates/configuration-options-templates/ROOT/pages/content.<appearance-behavior-filtering-or-formatting>.adoc‎

Lines changed: 43 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,43 @@
1+
// *New configuration options in the TinyMCE core*
2+
//
3+
// Configuration options are generally added to the documentation as
4+
// part of documenting a new plugin.
5+
//
6+
// Occasionally, however, a new configuration option is added to the
7+
// TinyMCE core.
8+
//
9+
// In such a case, a new partial file
10+
//
11+
// <configuration_option>.adoc
12+
//
13+
// (containing the configuration option documentation) is added to
14+
//
15+
// /modules/ROOT/partials/configuration/
16+
//
17+
//
18+
//
19+
//
20+
//
21+
// *Where the option appears in the docs*
22+
//
23+
// The include statement that places the partial file into the docs
24+
// proper is added to one of four extant files:
25+
//
26+
// 1. /modules/ROOT/pages/content-appearance.adoc
27+
// 2. /modules/ROOT/pages/content-behavior-options.adoc
28+
// 3. /modules/ROOT/pages/content-filtering.adoc
29+
// 4. /modules/ROOT/pages/content-formatting.adoc
30+
//
31+
// Which of these four depends on the configuration option’s properties.
32+
//
33+
// This is an editorial/engineering decision.
34+
//
35+
// With the decision made
36+
//
37+
// 1. Replace <configuration_option> with the option’s name in the
38+
// include:: statement, below
39+
// 2. Copy the edited include:: statement.
40+
// 3. Paste the statement into the chosen file in alphabetical order
41+
// by <configuration_option>.
42+
43+
include::partial$configuration/<configuration_option>.adoc[]

‎-new-material-templates/configuration-options-templates/ROOT/partials/configuration/<configuration_option>.adoc‎

Lines changed: 69 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,69 @@
1+
[[<configuration_option>]]
2+
== `<configuration_option>`
3+
4+
// Replace all instances of <configuration_option> with the
5+
// configuration option name then remove this comment.
6+
7+
// Add explanatory material as per the comment block below then remove
8+
// the block and this comment.
9+
10+
////
11+
What does the option do?
12+
Why use it?
13+
When use it?
14+
What values can it use?
15+
What do these values do?
16+
Are there risks?
17+
- Explain without using ‘risk’ or similar words.
18+
- Use NOTE or IMPORTANT admonitions if helpful.
19+
- For longer or more complicated scenarios, use the limitations section below.
20+
////
21+
22+
*Type:* `+String+`, `+Boolean+`, `+Number+`, `+Function+`, `+Object+`, `+Array+`, or `+Regexp+`
23+
24+
// Remove the *Possible values* line if there is no discrete set of possible values.
25+
*Possible values:* `'string1'`, `'string2'`, `false`
26+
27+
*Default value:* `false`, `1`, `'string1'`
28+
29+
=== Example: using `<configuration_option>`
30+
31+
// Add a working and tested configuration.
32+
[source,js]
33+
----
34+
tinymce.init({
35+
selector: 'textarea', // change this value according to your html
36+
<configuration_option>: '<value>'
37+
});
38+
----
39+
40+
// Add a working and tested configuration (edit as required)
41+
// or remove if not applicable.
42+
=== Example: disabling the <feature>
43+
44+
To disable <feature>, set `<configuration_option>` to `false`.
45+
46+
[source,js]
47+
----
48+
tinymce.init({
49+
selector: 'textarea', // change this value according to your HTML
50+
<configuration_option>: 'false'
51+
});
52+
----
53+
54+
// Remove if not applicable.
55+
// Edit the sub-head to singular or plural as required.
56+
=== Limitation(s) of the `<configuration_option>` option
57+
58+
The `<configuration_option>` option has the following limitations.
59+
60+
// Add explanatory material as per the comment block below then remove
61+
// the block and this comment.
62+
63+
////
64+
Known limitations.
65+
Complicated scenarios.
66+
Anything that warrants a CAUTION or WARNING admonition.
67+
///
68+
69+
// Remove all comment lines and comment blocks before publishing.

‎-new-material-templates/plugin-documentation-templates/ROOT/pages/available-menu-items.adoc‎

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
// 0. Set :plugincategory: to appropriate value
2+
// 1. premium; or
3+
// 2. opensource.
4+
// Note neither value is capitalised.
5+
// Note the second value has no space between the two words.
6+
// 1. Replace <place-holder text> instances with appropriate material.
7+
// 2. Add the edited material to
8+
// /tinymce-docs/modules/ROOT/pages/available-menu-items.adoc
9+
// in alphabetical order by <Plugin name>. (*not* <plugincode>).
10+
// 3. Do not bring these comments over with the edited material.
11+
12+
:plugincategory: <premium|opensource>
13+
:pluginname: <Plugin name>
14+
:plugincode: <plugincode>
15+
include::partial$misc/plugin-menu-item-id-boilerplate.adoc[]

‎-new-material-templates/plugin-documentation-templates/ROOT/pages/available-toolbar-buttons.adoc‎

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
// 0. Set :plugincategory: to appropriate value
2+
// 1. premium; or
3+
// 2. opensource.
4+
// Note neither value is capitalised.
5+
// Note the second value has no space between the two words.
6+
// 1. Replace <place-holder text> instances with appropriate material.
7+
// 2. Add the edited material to
8+
// /tinymce-docs/modules/ROOT/pages/available-toolbar-buttons.adoc
9+
// in alphabetical order by <Plugin name>. (*not* <plugincode>).
10+
// 3. Do not bring these comments over with the edited material.
11+
12+
:plugincategory: <premium|opensource>
13+
:pluginname: <Plugin name>
14+
:plugincode: <plugincode>
15+
include::partial$misc/plugin-toolbar-button-id-boilerplate.adoc[]

‎-new-material-templates/plugin-documentation-templates/ROOT/pages/pluginpage.adoc‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,9 @@
1919
// Remove the line below (and this comment) for open source plugins
2020
include::partial$misc/admon-premium-plugin.adoc[]
2121

22+
// Edit the line below to add the correct requires-<versionnumber> file from `/partials/misc`.
23+
include::partial$misc/admon-requires-<versionnumber>v.adoc
24+
2225
// Add an introduction. What does the plugin do? Why would I use this plugin? Keep it concise.
2326

2427
== Interactive example

‎changelog.md‎

Lines changed: 57 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,14 +7,66 @@ The format is loosely based on [Keep a Changelog](https://keepachangelog.com/en/
77
### Unreleased
88

99

10+
### 2023-12-06
11+
12+
- DOC-2181: add `new feature` documentation for TINY-10290 to the 6.8.1 release notes.
13+
- DOC-2181: add fix documentation for TINY-10385 to the 6.8.1 release notes.
14+
- DOC-2181: add improvement documentation for TINY-10141 to the 6.8.1 release notes.
15+
- DOC-2181: add improvement documentation for TINY-9287 to the 6.8.1 release notes.
16+
- DOC-2181: add fix documentation for TINY-9819 to the 6.8.1 release notes.
17+
- DOC-2181: add fix documentation for TINY-10282 to the 6.8.1 release notes.
18+
- DOC-2181: add fix documentation for TINY-10241 to the 6.8.1 release notes.
19+
- DOC-2181: add fix documentation for TINY-10292 to the 6.8.1 release notes.
20+
- DOC-2181: add fix documentation for TINY-10367 to the 6.8.1 release notes.
21+
- DOC-2181: add fix documentation for TINY-10291 to the 6.8.1 release notes.
22+
- DOC-2181: add fix documentation for TINY-10343 to the 6.8.1 release notes.
23+
- DOC-2181: add fix documentation for TINY-10174 to the 6.8.1 release notes.
24+
- DOC-2181: added fix documentation for TINY-10229 to the 6.8.1 release notes.
25+
- DOC-2181: add fix documentation for TINY-10172 to the 6.8.1 release notes.
26+
- DOC-2181: add fix documentation for TINY-9796 to the 6.8.1 release notes.
27+
- DOC-2181: add `new feature` documentation for TINY-10159 to the 6.8.1 release notes.
28+
- DOC-2181: add fix documentation for TINY-9393 to the 6.8.1 release notes.
29+
- DOC-2181: add improvement documentation for TINY-10348 & TINY-10349 to the 6.8.1 release notes, & added new `options` to `security/securing-embedded-external-resources.adoc` file.
30+
- DOC-2181: add fix documentation for TINY-10330 to the 6.8.1 release notes.
31+
- DOC-2181: add fix documentation for TINY-10173 to the 6.8.1 release notes.
32+
- DOC-2181: add fix documentation for TINY-10316 to the 6.8.1 release notes.
33+
- DOC-2181: add fix documentation for TINY-10285 to the 6.8.1 release notes.
34+
- DOC-2181: add fix documentation for TINY-10118 to the release notes.
35+
- DOC-2181: add fix documentation for TINY-10132 to the 6.8.1 release notes.
36+
- DOC-2181: add fix documentation for TINY-10139 to the release notes.
37+
- DOC-2181: fix documentation for TINY-10178 to the release notes.
38+
- DOC-2181: add fix documentation for TINY-10177 to the 6.8.1 release notes.
39+
- DOC-2181: add improvement documentation for TINY-10155 in the 6.8.1 release notes.
40+
- DOC-2181: add improvement documentation for TINY-10147 to the 6.8.1 release notes.
41+
- DOC-2181: fix documentation for TINY-10153 to the 6.8.1 release notes.
42+
- DOC-2181: add fix documentation for TINY-10289 in the 6.8.1 release notes.
43+
- DOC-2181: add change documentation for TINY-10237 to the 6.8.1 release notes.
44+
- DOC-2181: fix documentation for TINY-10209 in the 6.8.1 release notes.
45+
- DOC-2181: add improvement documentation for TINY-9963 to the release notes.
46+
- DOC-2181: add addition `new feature` documentation for TINY-9974 in the 6.8.1 release notes.
47+
- DOC-2181: add fix documentation for TINY-10088 to the 6.8.1 release notes.
48+
- DOC-2181: add fix documentation for TINY-10254 to the 6.8.1 release notes.
49+
- DOC-2181: add fix documentation for TINY-10133 to the 6.8.1 release notes.
50+
- DOC-2181: add fix documentation for TINY-10154 to the 6.8.1 release notes.
51+
- DOC-2181: the TinyMCE 6.8.1 release notes plus 6.8.1-specific changes to the TinyMCE documentation.
52+
- DOC-2075: remove `tinymcespellchecker` configuration workaround from full-featured-demo with Premium plugins examples: `/modules/ROOT/examples/live-demos/full-featured/example.js` and `/modules/ROOT/examples/live-demos/full-featured/index.js`.
53+
- DOC-2182: added file, `/modules/ROOT/partials/configuration/indent.adoc`, documenting the `indent` option. Added `include::` statement to `/modules/ROOT/pages/content-filtering.adoc` pointing to this file.
54+
- DOC-2189: added template files with instructions to `-new-material-templates/plugin-documentation-templates/ROOT/pages`. Added further boilerplate — a generic version-required include statement — and instructions regarding this boilerplate to `pluginpage.adoc`. Added new template file-and-folder infrastructure, `/-new-material-templates/configuration-options-templates`. Added boilerplate and documentation to the files in this new infrastructure. Also corrected markup typo in `modules/ROOT/pages/available-menu-items.adoc`.
55+
- DOC-2177: Added documentation of the `picker_text` property to the `urlinput` dialog component of `dialog-components.adoc`.
56+
- DOC-2228: Updates new bundling with `js` feature, `additional` copy edits to bundling with es6 vite documentation.
57+
- DOC-2215: add new feature `mce-clipboard` to 6.8.1 release project for AdvTemplate.
58+
- DOC-2216: add new single `js` bundling feature example for `Bundling an npm version of TinyMCE with ES6 and Vite`.
59+
- DOC-2202: add new `bespoke` button text updates to `events.adoc` file.
60+
- DOC-2209: add new default_font_stack `user-formatting-option.adoc` file.
61+
1062
### 2023-11-29
1163

1264
- DOC-2223: Added 6.8.1-specific entry to `changelog.adoc`.
1365
- DOC-2221: add new notification messages to `cloud-troubleshooting.adoc` file.
1466

1567
### 2023-11-22
1668

17-
- DOC-2180: Added 6.8-specific entry to `changelog.adoc`.
69+
- DOC-2180: Added 6.8.0-specific entry to `changelog.adoc`.
1870

1971
### 2023-11-15
2072

@@ -41,6 +93,9 @@ The format is loosely based on [Keep a Changelog](https://keepachangelog.com/en/
4193

4294
- DOC-2198: add 5x LTS important banner to the top of upgrading.adoc."
4395
- DOC-2185: added `6.7.1-release-notes.adoc` to project; updated `changelog.adoc`, `nav.adoc` and `release-notes.adoc` for the TinyMCE 6.7.1 release.
96+
97+
### 2023-09-20
98+
4499
- DOC-2191: updated both premium, non-premium and classic-mode feature demo UI issues.
45100

46101
### 2023-09-12
@@ -54,6 +109,7 @@ The format is loosely based on [Keep a Changelog](https://keepachangelog.com/en/
54109

55110
### 2023-09-13
56111

112+
- DOC-2171: the TinyMCE 6.7 release notes plus 6.7-specific changes to the TinyMCE documentation.
57113
- DOC-2027: added `/modules/ROOT/partials/configuration/help_accessibility.adoc`, documenting the `help_accessibility` option; edits, re-writes and re-structuring of `help.adoc`; plus copy-edits to `keyboard-shortcuts.adoc`, `tinymce-and-screenreaders.adoc` & `accessibility.adoc`.
58114
- DOC-2176: Removed references to which commercial plans Premium plugins are or are not available with.
59115
- DOC-2175: Update CODEOWNERS automatic reviewers upon opening new DOC-PRs.

‎modules/ROOT/examples/live-demos/advtemplate-mce-clipboard/index.html‎

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
<textarea id="advanced-template-mce-clipboard">
2+
<h3>Using the {{prefix}}mce-clipboard{{suffix}} Marker with Advanced Templates</h3>
3+
<h4>Before inserting the example template, <strong>type in your name</strong> to the editor, select and copy it to your clipboard by using <strong>Ctrl+C</strong> for Windows users, or <strong>⌘+C</strong> for Mac users</h4>
4+
<div>
5+
<ol>
6+
<li>
7+
Select <strong>Template…</strong> from the <strong>Insert</strong> menu or by selecting the <strong>Insert template</strong> toolbar button.
8+
</li>
9+
<li>
10+
Select a template to add to the TinyMCE document from the <strong>Templates</strong> dialog that presents.
11+
<ol>
12+
<li>
13+
<p>Click the <strong>Without an <code>{{prefix}}mce-clipboard{{suffix}}</code> marker</strong> template.</p>
14+
<p>The template should be inserted into the editor content regardless of any clipboard content./p>
15+
</li>
16+
<li>
17+
<p>Click the <strong>With a <code>{{prefix}}mce-clipboard{{suffix}}</code> marker</strong> template.</p>
18+
<p><em>When a template <strong>does</strong> contain a valid {{prefix}}mce-clipboard{{suffix}} marker, the current content saved in the users clipboard will <strong>replace</strong> the marker when the user inserts the template.</em></p>
19+
</li>
20+
</ol>
21+
</li>
22+
<li>
23+
Click <strong>Insert</strong> or press <strong>Return</strong>.
24+
</li>
25+
</ol>
26+
</div>
27+
</textarea>

‎modules/ROOT/examples/live-demos/advtemplate-mce-clipboard/index.js‎

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
tinymce.init({
2+
selector: "textarea#advanced-template-mce-clipboard",
3+
plugins: [ "advtemplate", "code", "help"],
4+
toolbar: "undo redo | inserttemplate",
5+
advtemplate_templates: [
6+
{
7+
title: 'Without an mce-clipboard marker',
8+
content: '<p>Hi , Thank you for visiting this page. We truly appreciate and value your feedback and any feature requests you may have While you are here, take a moment to explore mce-cursor, its another powerful tool designed for Advanced Templates</p>'
9+
},
10+
{
11+
title: 'With an mce-clipboard marker',
12+
content: '<p>Hi {{prefix}}mce-clipboard{{suffix}}, Thank you for visiting this page. We truly appreciate and value your feedback and any feature requests you may have While you are here, take a moment to explore mce-cursor {{prefix}}mce-clipboard{{suffix}}, its another powerful tool designed for Advanced Templates</p>'
13+
}
14+
],
15+
});

‎modules/ROOT/examples/live-demos/full-featured/example.js‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -98,7 +98,7 @@ tinymce.init({
9898
quickbars_selection_toolbar: 'bold italic | quicklink h2 h3 blockquote quickimage quicktable',
9999
noneditable_class: 'mceNonEditable',
100100
toolbar_mode: 'sliding',
101-
spellchecker_ignore_list: ['Ephox', 'Moxiecode', 'tinymce', 'TinyMCE', 'tm', 'TM'], // ‘tm’ and ‘TM’ are temporary spellchecker bug workarounds
101+
spellchecker_ignore_list: ['Ephox', 'Moxiecode', 'tinymce', 'TinyMCE'],
102102
tinycomments_mode: 'embedded',
103103
content_style: '.mymention{ color: gray; }',
104104
contextmenu: 'link image editimage table configurepermanentpen',

‎modules/ROOT/examples/live-demos/full-featured/index.js‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -247,7 +247,7 @@ tinymce.ScriptLoader.loadScripts(['https://cdn.jsdelivr.net/npm/faker@5/dist/fak
247247
quickbars_selection_toolbar: 'bold italic | quicklink h2 h3 blockquote quickimage quicktable',
248248
noneditable_class: 'mceNonEditable',
249249
toolbar_mode: 'sliding',
250-
spellchecker_ignore_list: ['Ephox', 'Moxiecode', 'tinymce', 'TinyMCE', 'tm', 'TM'], // ‘tm’ and ‘TM’ are temporary spellchecker bug workarounds
250+
spellchecker_ignore_list: ['Ephox', 'Moxiecode', 'tinymce', 'TinyMCE'],
251251
tinycomments_mode: 'embedded',
252252
content_style: '.mymention{ color: gray; }' +
253253
'body { font-family:Helvetica,Arial,sans-serif; font-size:16px }',

0 commit comments

Comments
 (0)