Skip to content

Commit

Permalink
DOC-2511: TinyMCE 7.4 Release Documentation. (#3433)
Browse files Browse the repository at this point in the history
* DOC-2511: TinyMCE 7.4 Release Documentation.

* DOC-2524: Comments Premium Plugin Documentation Improvements (#3453)

* DOC-2524: EPIC branch initial commit.

* DOC-2524: Update: Commands, Events and APIs (Comments) (#3462)

* DOC-2524: Update: Embedded Mode (Comments). (#3459)

* DOC-2524: Update: Introduction (Comments) (#3456)

* DOC-2524: Update: Toolbar Buttons and Menu Items (Comments) (#3460)

* DOC-2524: New `tinycomments` option: Comments can be made and read, but the editor is in a readonly state. (#3461)

* DOC-2524: New comments option: Comments can be made and read, but the editor is in a readonly state.

* DOC-2524: revert live_demo testing url.

* Update modules/ROOT/examples/live-demos/comments-readonly-mode/index.js

Co-authored-by: Mitchell Crompton <[email protected]>

* Update modules/ROOT/examples/live-demos/comments-readonly-mode/index.js

Co-authored-by: Mitchell Crompton <[email protected]>

* Update modules/ROOT/partials/configuration/comments-tinycomments_access.adoc

Co-authored-by: Mitchell Crompton <[email protected]>

* Update modules/ROOT/partials/configuration/comments-tinycomments_access.adoc

Co-authored-by: shirqa <[email protected]>

* Update modules/ROOT/pages/comments-options.adoc

Co-authored-by: shirqa <[email protected]>

* Update modules/ROOT/examples/live-demos/comments-readonly-mode/index.js

Co-authored-by: Mitchell Crompton <[email protected]>

* Update modules/ROOT/partials/configuration/comments-tinycomments_access.adoc

Co-authored-by: shirqa <[email protected]>

* DOC-2524: file name change, remove button from demo and update headers.

* Update modules/ROOT/partials/configuration/comments-tinycomments_access.adoc

Co-authored-by: Shan <[email protected]>

* DOC-2524: Restructured tinycomments_access.adoc, removed basic config.

* Update modules/ROOT/partials/configuration/comments-tinycomments_access.adoc

Co-authored-by: Mitchell Crompton <[email protected]>

* Update modules/ROOT/partials/configuration/comments-tinycomments_access.adoc

Co-authored-by: Mitchell Crompton <[email protected]>

* Update modules/ROOT/partials/configuration/comments-tinycomments_access.adoc

Co-authored-by: Mitchell Crompton <[email protected]>

* Update modules/ROOT/partials/configuration/comments-tinycomments_access.adoc

Co-authored-by: Mitchell Crompton <[email protected]>

* Update modules/ROOT/partials/configuration/comments-tinycomments_access.adoc

Co-authored-by: shirqa <[email protected]>

* Update modules/ROOT/partials/configuration/comments-tinycomments_access.adoc

Co-authored-by: shirqa <[email protected]>

* Update modules/ROOT/partials/configuration/comments-tinycomments_access.adoc

Co-authored-by: Mitchell Crompton <[email protected]>

* Update modules/ROOT/partials/configuration/comments-tinycomments_access.adoc

Co-authored-by: Mitchell Crompton <[email protected]>

* Update modules/ROOT/partials/configuration/comments-tinycomments_access.adoc

Co-authored-by: Mitchell Crompton <[email protected]>

* Update modules/ROOT/examples/live-demos/comments-ui-mode/index.html

Co-authored-by: tiny-ben-tran <[email protected]>

---------

Co-authored-by: Mitchell Crompton <[email protected]>
Co-authored-by: shirqa <[email protected]>
Co-authored-by: Shan <[email protected]>
Co-authored-by: tiny-ben-tran <[email protected]>

* DOC-2524: Update: Callback Mode (Comments) (#3458)

* DOC-2524: Callback Mode (Comments)

* Revert live_demo_url from testing.

* Update modules/ROOT/examples/live-demos/comments-callback/example.js

Co-authored-by: Hamza Benkhaldoun <[email protected]>

* Update modules/ROOT/examples/live-demos/comments-callback/index.js

Co-authored-by: Hamza Benkhaldoun <[email protected]>

* Update modules/ROOT/partials/configuration/tinycomments_delete_comment.adoc

Co-authored-by: Hamza Benkhaldoun <[email protected]>

* Update modules/ROOT/partials/configuration/tinycomments_fetch.adoc

Co-authored-by: Hamza Benkhaldoun <[email protected]>

* Update modules/ROOT/pages/comments-callback-mode.adoc

* Update modules/ROOT/pages/comments-callback-mode.adoc

* DOC-2524: move tinycomments_fetch to optional options, updated examples to reflect optional callback.

* DOC-2524: fix optional options header level.

* Update modules/ROOT/partials/configuration/tinycomments_lookup.adoc

Co-authored-by: tiny-ben-tran <[email protected]>

* Update modules/ROOT/examples/live-demos/comments-callback/example.js

* Update modules/ROOT/examples/live-demos/comments-callback/index.js

* Update modules/ROOT/partials/configuration/tinycomments_resolve.adoc

Co-authored-by: tiny-ben-tran <[email protected]>

* DOC-2524: Update comments callback demo

* Update modules/ROOT/partials/configuration/tinycomments_reply.adoc

Co-authored-by: Karl Kemister-Sheppard <[email protected]>

* Update modules/ROOT/pages/comments-callback-mode.adoc

Co-authored-by: tiny-ben-tran <[email protected]>

* Update modules/ROOT/pages/comments-callback-mode.adoc

Co-authored-by: tiny-ben-tran <[email protected]>

* DOC-2524: update example.js and tinycomments_fetch example to match demo updates.

* Update modules/ROOT/pages/comments-callback-mode.adoc

Co-authored-by: Farzad Hayat <[email protected]>

* Update modules/ROOT/pages/comments-callback-mode.adoc

Co-authored-by: Farzad Hayat <[email protected]>

* DOC-2524: Add initial comments to callback demo

* DOC-2524: Fix initialDB structure

* Update modules/ROOT/examples/live-demos/comments-callback/index.js

Co-authored-by: Farzad Hayat <[email protected]>

* Update modules/ROOT/examples/live-demos/comments-callback/example.js

Co-authored-by: Farzad Hayat <[email protected]>

---------

Co-authored-by: Hamza Benkhaldoun <[email protected]>
Co-authored-by: tiny-ben-tran <[email protected]>
Co-authored-by: Farzad Hayat <[email protected]>

* DOC-2524: Update: Using Comments (Comments) (#3457)

* DOC-2524: Update: Using Comments (Comments)

* DOC-2524: update png files.

* Update modules/ROOT/pages/comments-using-comments.adoc

Co-authored-by: Farzad Hayat <[email protected]>

* Update modules/ROOT/pages/comments-using-comments.adoc

Co-authored-by: Farzad Hayat <[email protected]>

* DOC-2524: Relocate .png in delete-a-comment.

* DOC-2524: remove comment-edit-comment-ellipsis.png duplicate.

* DOC-2524: add guide to replying to comment and supporting screenshots.

* Update modules/ROOT/pages/comments-using-comments.adoc

Co-authored-by: Farzad Hayat <[email protected]>

* DOC-2524: Replace png files with hi-res.

---------

Co-authored-by: Farzad Hayat <[email protected]>

---------

Co-authored-by: Mitchell Crompton <[email protected]>
Co-authored-by: shirqa <[email protected]>
Co-authored-by: Shan <[email protected]>
Co-authored-by: tiny-ben-tran <[email protected]>
Co-authored-by: Hamza Benkhaldoun <[email protected]>
Co-authored-by: Farzad Hayat <[email protected]>

* DOC-2513: TinyMCE 7.4 Release notes & community release. (#3434)

* DOC-2513: TinyMCE 7.4 Release notes & community changelog.

* DOC-2513: Sidebar could not be toggled until the skin was loaded.

* Revert "DOC-2513: Sidebar could not be toggled until the skin was loaded."

This reverts commit 847c9a9.

* DOC-2513: New option  to opt-in to keep math annotations with specific encodings. (#3447)

* DOC-2513: New option  to opt-in to keep math annotations with specific encodings.

* Update modules/ROOT/pages/7.4-release-notes.adoc

Co-authored-by: Farzad Hayat <[email protected]>

* Update modules/ROOT/pages/7.4-release-notes.adoc

---------

Co-authored-by: Farzad Hayat <[email protected]>

* DOC-2513: Dialog list dropdown menus now close when the browser window resizes. (#3443)

* DOC-2513: Formatter would not remove empty lines. (#3442)

* DOC-2513: Formatter would not remove empty lines.

* DOC-2513: copy edits.

* Update modules/ROOT/pages/7.4-release-notes.adoc

Co-authored-by: Farzad Hayat <[email protected]>

---------

Co-authored-by: Farzad Hayat <[email protected]>

* DOC-2513: Formatting indent size would be different than CodeMirror indent size. (#3441)

* DOC-2513: Formatting indent size would be different than CodeMirror indent size.

* DOC-2513: correct paragraph styling.

* Update modules/ROOT/pages/7.4-release-notes.adoc

* DOC-2513: Caret would unexpectedly shift to the `non-editable` table row above when pressing Enter. (#3437)

* DOC-2513: Caret would unexpectedly go to a not editable table row above when user pressed enter.

* DOC-2513: fix type in title.

* DOC-2513: Mouse hover on partially visible dialog collection elements no longer scrolls. (#3435)

* DOC-2513: Mouse hover on partially visible dialog collection elements no longer scrolls

* Update modules/ROOT/pages/7.4-release-notes.adoc

Co-authored-by: Farzad Hayat <[email protected]>

* Update modules/ROOT/pages/7.4-release-notes.adoc

---------

Co-authored-by: Farzad Hayat <[email protected]>

* DOC-2513: Sidebar could not be toggled until the skin was loaded. (#3439)

* DOC-2513: Pasting a table now places the cursor after the table instead of into the last table cell. (#3438)

* DOC-2513: Pasting a table now places the cursor after the table instead of into the last table cell.

* DOC-2513: move to improvements sections.

* DOC-2513: Format button would lose focus after action while navigating through keyboard. (#3440)

* DOC-2513: Format button would lose focus after action while navigating through keyboard.

* Update modules/ROOT/pages/7.4-release-notes.adoc

* Update modules/ROOT/pages/7.4-release-notes.adoc

* DOC-2513: Copying tables to the clipboard did not correctly separate cells and rows for the "text/plain" MIME type. (#3449)

* DOC-2513: Copying tables to the clipboard did not correctly separate cells and rows for the text/plain MIME type.

* Update modules/ROOT/pages/7.4-release-notes.adoc

Co-authored-by: ltrouton <[email protected]>

---------

Co-authored-by: ltrouton <[email protected]>

* DOC-2513: New `importword_converter_options` option that allows customizing the conversion. (#3448)

* DOC-2513: New importword_converter_options option that allows customizing the conversion.

* Update modules/ROOT/partials/configuration/importword.adoc

Co-authored-by: Farzad Hayat <[email protected]>

* Update modules/ROOT/partials/configuration/importword.adoc

* DOC-2513: Copy edits, fixes and seperation of partials.

---------

Co-authored-by: Farzad Hayat <[email protected]>

* DOC-2513: The editor resize handle was incorrectly rendered when all components were removed from the status bar. (#3450)

* DOC-2513: Add TINY-11257 release note entry

* Fix grammer

* Update modules/ROOT/pages/7.4-release-notes.adoc

Co-authored-by: Karl Kemister-Sheppard <[email protected]>

---------

Co-authored-by: Karl Kemister-Sheppard <[email protected]>

* DOC-2513: The image dialog lost focus after closing an image upload error alert. (#3446)

* Placing the cursor after a table with a `<br>` element would misplace added newlines before the table instead of after it. (#3445)

* Placing the cursor after a table with a BR element would misplace added newlines before the table instead of after it.

* Update modules/ROOT/pages/7.4-release-notes.adoc

* DOC-2513: Deleting a selection in a list element would sometimes prevent the input event from being dispatched. (#3444)

* DOC-2513: Insert lists will no longer unexpectedly generate indented lists. (#3466)

* DOC-2513: Insert lists will no longer unexpectedly generate indented lists.

* DOC-2513: update to reflect fix rather than improvement.

* DOC-2513: Cursor would jump to the previous line after pressing `shift + enter` if the annotation was applied. (#3464)

* DOC-2513: Cursor would jump to the previous line after pressing shift + enter if the annotation was applied.

* DOC-2513: add header and link to plugin doc in release notes.

* DOC-2513: As you type spellchecking did not update when scrolling with the `autoresize` plugin active. (#3465)

* DOC-2513: As you type spellchecking did not update when scrolling with the  plugin active.

* Update modules/ROOT/pages/7.4-release-notes.adoc

* Update modules/ROOT/pages/7.4-release-notes.adoc

Co-authored-by: tiny-ben-tran <[email protected]>

---------

Co-authored-by: tiny-ben-tran <[email protected]>

* DOC-2513: Made importword_service_url, exportword_service_url and exportpdf_service_url option more fault tolerant. (#3451)

* DOC-2513: In read-only mode the editor now allows normal cursor movement and block element selection, including video playback & New  property for all ui components. (#3463)

* DOC-2513: In read-only mode the editor now allows normal cursor movement and block element selection, including video playback & New  property for all ui components.

* DOC-2513: Add state update section

* DOC-2513: Fix including admon in tables

* DOC-2513: Copy edits.

* DOC-2513: Add `context` property to Custom Dialog Components and Custom Dialog Footer Buttons.

* Update modules/ROOT/pages/dialog-components.adoc

* Update modules/ROOT/pages/dialog-components.adoc

* Update modules/ROOT/pages/dialog-components.adoc

* Update modules/ROOT/pages/dialog-footer-buttons.adoc

* Update modules/ROOT/pages/dialog-footer-buttons.adoc

---------

Co-authored-by: shanmen-tiny <[email protected]>
Co-authored-by: Farzad Hayatbakhsh <[email protected]>

* DOC-2513: Added changelog for TinyMCE 7.4 core changes.

* DOC-2513: Categories can now be declared as `locked`, making them readonly. (#3467)

* DOC-2513: Categories can now be declared as locked, making them readonly.

* Update modules/ROOT/pages/advanced-templates.adoc

* Update modules/ROOT/examples/live-demos/advtemplate-readonly-template/example.js

Co-authored-by: tiny-ben-tran <[email protected]>

* Update modules/ROOT/examples/live-demos/advtemplate-readonly-template/example.js

Co-authored-by: tiny-ben-tran <[email protected]>

* Update modules/ROOT/examples/live-demos/advtemplate-readonly-template/index.js

Co-authored-by: tiny-ben-tran <[email protected]>

* Update modules/ROOT/examples/live-demos/advtemplate-readonly-template/index.js

Co-authored-by: tiny-ben-tran <[email protected]>

* Update modules/ROOT/pages/advanced-templates.adoc

Co-authored-by: Farzad Hayat <[email protected]>

* Update modules/ROOT/pages/advanced-templates.adoc

Co-authored-by: tiny-ben-tran <[email protected]>

* DOC-2513: Add advtemplate commands to editor-command-identifiers.adoc

* DOC-2513: fix store variable declaration issue, add missing semicolons and added advtemplate_get_template throw error.

* Update modules/ROOT/pages/7.4-release-notes.adoc

* Update modules/ROOT/pages/advanced-templates.adoc

Co-authored-by: Farzad Hayat <[email protected]>

* Update modules/ROOT/pages/7.4-release-notes.adoc

* Update modules/ROOT/pages/advanced-templates.adoc

Co-authored-by: Farzad Hayat <[email protected]>

* Update modules/ROOT/pages/advanced-templates.adoc

Co-authored-by: Farzad Hayat <[email protected]>

* Add missing semi colons and replace double quotes with single qoutes

---------

Co-authored-by: tiny-ben-tran <[email protected]>
Co-authored-by: Farzad Hayat <[email protected]>

* DOC-2513: copy edits, template cleanup.

* DOC-2513: remove Added focus function to view button api, as duplicate.

* DOC-2513: Add known issues to 7.4 release notes.

---------

Co-authored-by: Farzad Hayatbakhsh <[email protected]>
Co-authored-by: ltrouton <[email protected]>
Co-authored-by: tiny-ben-tran <[email protected]>
Co-authored-by: shanmen-tiny <[email protected]>

---------

Co-authored-by: Mitchell Crompton <[email protected]>
Co-authored-by: shirqa <[email protected]>
Co-authored-by: Shan <[email protected]>
Co-authored-by: tiny-ben-tran <[email protected]>
Co-authored-by: Hamza Benkhaldoun <[email protected]>
Co-authored-by: Farzad Hayat <[email protected]>
Co-authored-by: ltrouton <[email protected]>
  • Loading branch information
8 people authored Oct 9, 2024
1 parent c4d4193 commit 22f23a4
Show file tree
Hide file tree
Showing 88 changed files with 2,023 additions and 254 deletions.
2 changes: 1 addition & 1 deletion antora.yml
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ asciidoc:
# product variables
productname: TinyMCE
productmajorversion: 7
productminorversion: '7.3'
productminorversion: '7.4'
##### product name in codeblock
prodnamecode: tinymce
#### more names
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,102 @@
const headers = {
'Accept': 'application/json',
'Content-Type': 'application/json',
};

const handleResponse = (message) => (response) => {
if (!response.ok) {
return response.text().then((error) => {
console.error(error);
throw new Error(message);
});
}
return response.json();
};

const advtemplate_list = () =>
fetch('/categories', {
method: 'GET',
headers,
}).then(handleResponse('Failed to get template list'));

const advtemplate_get_template = (id) =>
fetch(`/templates/${id}`, {
method: 'GET',
headers,
}).then(handleResponse('Failed to get template'));

const advtemplate_create_category = (title) =>
fetch('/categories', {
method: 'POST',
body: JSON.stringify({ title }),
headers,
}).then(handleResponse('Failed to create category'));

const advtemplate_create_template = (title, content, categoryId) =>
fetch('/templates', {
method: 'POST',
body: JSON.stringify({ title, content, categoryId }),
headers,
}).then(handleResponse('Failed to create template'));

const advtemplate_rename_category = (id, title) =>
fetch(`/categories/${id}`, {
method: 'PUT',
body: JSON.stringify({ title }),
headers,
}).then(handleResponse('Failed to rename category'));

const advtemplate_rename_template = (id, title) =>
fetch(`/templates/${id}`, {
method: 'PUT',
body: JSON.stringify({ title }),
headers,
}).then(handleResponse('Failed to rename template'));

const advtemplate_delete_template = (id) =>
fetch(`/templates/${id}`, {
method: 'DELETE',
headers,
}).then(handleResponse('Failed to delete template'));

const advtemplate_delete_category = (id) =>
fetch(`/categories/${id}`, {
method: 'DELETE',
headers,
}).then(handleResponse('Failed to delete category'));

const advtemplate_move_template = (id, categoryId) =>
fetch(`/templates/${id}`, {
method: 'PATCH',
body: JSON.stringify({ categoryId }),
headers,
}).then(handleResponse('Failed to move template'));

const advtemplate_move_category_items = (id, categoryId) =>
fetch(`/categories/${id}`, {
method: 'PATCH',
body: JSON.stringify({ categoryId }),
headers,
}).then(handleResponse('Failed to move all templates to new category'));

tinymce.init({
selector: 'textarea#readonly-locked-template',
plugins: [
'advlist', 'anchor', 'autolink', 'charmap', 'code', 'fullscreen',
'help', 'image', 'insertdatetime', 'link', 'lists', 'media',
'preview', 'searchreplace', 'table', 'visualblocks', 'advtemplate'
],
contextmenu: 'advtemplate',
toolbar: 'addtemplate inserttemplate | undo redo | styles | bold italic underline strikethrough | alignleft aligncenter alignright alignjustify | bullist numlist outdent indent | link image',

advtemplate_list,
advtemplate_get_template,
advtemplate_create_category,
advtemplate_create_template,
advtemplate_rename_category,
advtemplate_move_category_items,
advtemplate_delete_category,
advtemplate_rename_template,
advtemplate_move_template,
advtemplate_delete_template,
});
Original file line number Diff line number Diff line change
@@ -0,0 +1,52 @@
<textarea id="readonly-locked-template">
<h3 style="font-size: 1.5em; margin: 20px 0;">Working with Templates</h3>

<h4 style="font-size: 1.25em; margin: 15px 0;">Inserting a template</h4>
<p style="margin: 10px 0;">To insert a template:</p>
<ol style="margin-left: 20px;">
<li>Click the <strong>Insert template</strong> toolbar button or select <strong>Insert template...</strong> from the <strong>Insert</strong> menu.</li>
<li>In the <strong>Templates</strong> dialog, you'll see different categories:
<ul style="margin-left: 20px;">
<li>Regular categories with editable templates</li>
<li>Locked categories (marked with a 🔒 icon) containing read-only templates</li>
</ul>
</li>
<li>Select any template to preview its content.</li>
<li>Click <strong>Insert</strong> or press <strong>Return</strong> to add the template to your document.</li>
</ol>

<div style="margin: 15px 0; padding: 10px 15px; border-left: 4px solid #3498db; background-color: #f0f7fb;">
<p><strong>Note:</strong> Templates in locked categories cannot be modified, but they can still be inserted into your document.</p>
</div>

<h4 style="font-size: 1.25em; margin: 15px 0;">Adding a new template</h4>
<p style="margin: 10px 0;">To add a new template:</p>
<ol style="margin-left: 20px;">
<li>Select the content in your document that you want to save as a template.</li>
<li>Click the <strong>Save as template</strong> toolbar button or select <strong>Save as template…</strong> from the <strong>Tools</strong> menu.</li>
<li>In the <strong>New template</strong> dialog:
<ol style="margin-left: 20px;">
<li>Enter a name for your template in the <strong>Template name</strong> field.</li>
<li>Choose a category from the <strong>Category</strong> dropdown menu.
<div style="margin: 15px 0; padding: 10px 15px; border-left: 4px solid #e74c3c; background-color: #fdf7f7;">
<p><strong>Important:</strong> Locked categories (marked with a 🔒 icon) are read-only. You cannot save new templates to these categories.</p>
</div>
</li>
<li>Click <strong>Save</strong> or press <strong>Return</strong>.</li>
</ol>
</li>
</ol>

<h4 style="font-size: 1.25em; margin: 15px 0;">Managing Templates</h4>
<p style="margin: 10px 0;">When working with templates, keep in mind:</p>
<ul style="margin-left: 20px;">
<li>Templates in regular categories can be edited, renamed, or deleted.</li>
<li>Templates in locked categories (🔒) are read-only and cannot be:
<ul style="margin-left: 20px;">
<li>Modified or renamed</li>
<li>Deleted</li>
<li>Moved to different categories</li>
</ul>
</li>
</ul>
</textarea>
Loading

0 comments on commit 22f23a4

Please sign in to comment.