Skip to content

Commit 520e5e8

Browse files
kemister85lorenzo-pomilitiny-ben-tranTheSpyderMitchC1999
authored
DOC-3216: TinyMCE 8.0.0 Documentation (#3732)
* DOC-3216: replace TinyMCE with productname var. * DOC-3220: Update the `README.md` file for `tinymce/docs` project to include updated information. (#3733) * DOC-3220: Update the README.md file for tinymce/docs to include updated information. * Update README.md * Update README.md * DOC-3228: Cherry pick `tinymce/7` latest changes into `tinymce/8 >> release/8.0.0` branch. (#3754) * TINY-11909: Add `readonly` prop to Svelte tech ref (#3738) * TINY-11909: Add `readonly` prop to Svelte tech ref * TINY-11909: typo * TINY-11906: Add readonly prop to React tech ref (#3736) * TINY-11907: Add new readonly prop to Angular integration. (#3741) * TINY-11911: Add disabled and readonly to the web component tech ref (#3739) * TINY-11908: Add new readonly prop to Vue integration. (#3740) * DOC-3227: Update Document Converter JWT authentication requirements and plugin descriptions. (#3755) * DOC-3227: Update Document Converter JWT authentication requirements and plugin descriptions for clarity. * Update modules/ROOT/partials/misc/admon-jwt-authentication-requirements.adoc * DOC-3227: Update JWT authentication requirements for trial period clarity, add ifeval condition. * DOC-3239: Update ai proxy. (#3782) * DOC-3240: Remove registry URL from Docker pull commands in installation guides for export-to-pdf and import-from-word components. * DOC-3244: Fix typo in JWT token claims description for On-Premises documentation (#3796) * DOC-3244: Fix typo in JWT token claims description for On-Premises documentation. * Update modules/ROOT/partials/individually-licensed-components/import-from-word-and-export-to-word/import-from-word-and-export-to-word-autorization-on-premises.adoc Co-authored-by: Andrew Herron <[email protected]> --------- Co-authored-by: Andrew Herron <[email protected]> * DOC-3245:Update license link for Tiny Cloud users in understanding editor loads documentation. (#3797) --------- Co-authored-by: lorenzo-pomili <[email protected]> Co-authored-by: tiny-ben-tran <[email protected]> Co-authored-by: Andrew Herron <[email protected]> * DOC-3221: Refine language and structure in CONTRIBUTING.md for clarity and consistency. (#3735) * DOC-3246: Suggested Edits and User Lookup API documentation (#3798) * Initial setup * add live demo template * Update API sections * Add description of plugin and examples for API options * Comment out note about stacked changes and minor copy edits * add live demo * rename plugin to Suggested Edits * replace all instanes of plugin name and code * Update docs to include Review Permissions V1 * Fix demo for Review Permissions * Add Suggestions section and demo * Revise Suggestions content * Initial setup * add live demo template * Update API sections * Add description of plugin and examples for API options * Comment out note about stacked changes and minor copy edits * add live demo * rename plugin to Suggested Edits * replace all instanes of plugin name and code * Update docs to include Review Permissions V1 * Fix demo for Review Permissions * Add Suggestions section and demo * Revise Suggestions content * DOC-3174: Updating suggestedits docs * DOC-3174: Remove unused options * Update explanation of plugin and add UID options * fix UID options * Update interactive demo * Update suggestededits_access demo * fix UID options * Update option and api examples * Fix UID options * DOC-3174: Adding icons * DOC-3174: Add `Using the User Lookup API` page * Update UID options partials * DOC-3174: Some edits * DOC-3174: Add `UserLookup` partials to `revisionhistory` and `tinycomments` pages * DOC-3174: Replace reference to `userDb` with `userinfos` * DOC-3174: Remove usage of `uid` in `suggestededits` * DOC-3174: Fix indentations within `Types of suggestions` * DOC-3174: Update interactive demos and examples for `embedded` mode in `tinycomments` * DOC-3174: Update interactive demos and examples for `revisionhistory` * DOC-3174: Rewrite suggested edits * DOC-3174: Edits * DOC-3246: More docs * DOC-3246: Fixed, premium-plugin table, removed template material, fixed whitespace, added missing available-toolbar-buttons. * DOC-3246: Add deprecation messaging to `tinycomments_fetch_author_info` option * DOC-3246: Update interactive examples on `comments-with-mentions` page * DOC-3246: Include `user_id` and `fetch_users` options in `Required Comments options for embedded mode` section * DOC-3246: Update `tinycomments_mentions_enabled` to include `user_id` and `fetch_users` * DOC-3246: Demo updates * Apply suggestions from code review Co-authored-by: Andrew Herron <[email protected]> * DOC-3246: Use lookup over `find` in `fetch_users` * DOC-3246: Updates to `fetch_users` partial * DOC-3246: Improve examples and access option * DOC-3246: Update fetch_users option across other plugin examples * DOC-3246: Single quotes only * Apply suggestions from code review Co-authored-by: Andrew Herron <[email protected]> Co-authored-by: Karl Kemister-Sheppard <[email protected]> * DOC-3246: Improve API examples * DOC-3246: Improvements * Apply suggestions from code review Co-authored-by: Karl Kemister-Sheppard <[email protected]> Co-authored-by: Shan <[email protected]> * DOC-3246: Final edits * DOC-3246: Final final edit * DOC-3246: Docs tweaks * DOC-3246: userlookup api docs restructure and organisation update. * Apply suggestions from code review Co-authored-by: Andrew Herron <[email protected]> * DOC-3246: Final improvements --------- Co-authored-by: Sorita Heng <[email protected]> Co-authored-by: kimwoodfield <[email protected]> Co-authored-by: Karl Kemister-Sheppard <[email protected]> Co-authored-by: Andrew Herron <[email protected]> Co-authored-by: Shan <[email protected]> * DOC-3147: TinyMCE 8.0.0 Release notes and community changelog. (#3734) * DOC-3147: TinyMCE 8.0.0 Release notes and community changelog. * DOC-3147: HTML schema did not treat colgroup or col elements as block elements. (#3790) * DOC-3147: Decorative images would lose their decorative properties when the subtoolbar was closed using the confirmation button. (#3774) Co-authored-by: Karl Kemister-Sheppard <[email protected]> * DOC-3147: Word import of lists with a lighter level failed parsing. (#3765) * DOC-3147: It wasn't possible to navigate out of a using the left and right arrow keys in Firefox. (#3773) Co-authored-by: Karl Kemister-Sheppard <[email protected]> * DOC-3147: Using arrow navigation between buttons when a button had the mouse over could stop the navigation. (#3772) Co-authored-by: Karl Kemister-Sheppard <[email protected]> * DOC-3147: Resize handles are more accessible with and attributes. (#3749) * DOC-3147: Toolbar drawer now closes when the editor loses focus. (#3750) Co-authored-by: Karl Kemister-Sheppard <[email protected]> * DOC-3147: Instructions on how to navigate the color swatch, image select and insert (#3788) table widget are now announced by the screen readers. Co-authored-by: Karl Kemister-Sheppard <[email protected]> * DOC-3147: Default value for `pagebreak_separator` option to better suit modern standards. (#3780) * DOC-3147: Default value for option to better suit modern standards. * DOC-3147: Fixed syntax issue. * Update modules/ROOT/partials/configuration/pagebreak_separator.adoc * Update modules/ROOT/partials/configuration/pagebreak_separator.adoc * Update modules/ROOT/pages/8.0-release-notes.adoc --------- Co-authored-by: Karl Kemister-Sheppard <[email protected]> * The `contextform` subtoolbar is no longer dismissed when using the back button in inline editors. (#3770) * The subtoolbar is no longer dismissed when using the back button in inline editors. * Update modules/ROOT/pages/8.0-release-notes.adoc --------- Co-authored-by: Karl Kemister-Sheppard <[email protected]> * DOC-3147: Deleting a whole element would sometimes modify nearby content (#3752) * DOC-3147: Deleting a whole element would sometimes modify nearby content. * copy edits. * Update modules/ROOT/pages/8.0-release-notes.adoc * DOC-3147: Removed undocumented documentBaseUrl property from Editor instances. documentBaseURI is the supported property now. (#3787) * DOC-3147: The translate API now automatically replaces three dots in a row with an ellipsis character. (#3792) * DOC-3147: Strikethrough format could be added outside font size format, which renders incorrectly in some browsers. (#3778) * DOC-3147: Strikethrough format could be added outside font size format, which renders incorrectly in some browsers. * Update modules/ROOT/pages/8.0-release-notes.adoc Co-authored-by: CODE:AG <[email protected]> --------- Co-authored-by: CODE:AG <[email protected]> * DOC-3147: Accessibility: Enhanced image accessibility checks & rules in `a11ychecker` plugin. (#3794) * DOC-3147: Accessibility: Enhanced image accessibility checks in a11ychecker plugin. * DOC-3147: Add a11ychecker_alt_text_max_length new option to the release notes. * DOC-3147: Fix lvl heading issues for TOC. * DOC-3147: Update accessibility rules and configuration options for image handling * Update modules/ROOT/partials/configuration/a11ychecker_allow_decorative_images.adoc Co-authored-by: CODE:AG <[email protected]> --------- Co-authored-by: Arvin Han <[email protected]> Co-authored-by: CODE:AG <[email protected]> * DOC-3231: Refactor documentation for server-side components to support Docker deployment. (#3757) * DOC-3231: Refactor documentation for server-side components to support Docker deployment - Removed the deprecated logging services configuration documentation. - Updated references from WAR file deployment to Docker container deployment across multiple documents. - Revised installation and configuration instructions for spellchecking, image proxy, and media embed services to reflect Docker usage. - Added new sections for Docker image retrieval, configuration, and requirements. - Clarified system requirements and troubleshooting steps for Dockerized services. - Adjusted custom dictionaries and Hunspell dictionaries path requirements to remove references to Java services. - Updated supported application servers section to emphasize Docker as the primary deployment method. * DOC-3231: Remove deprecated server-side component installation documentation duplication page. * File cleanup, removal of files not used during copy edits. * Update modules/ROOT/partials/misc/custom-dictionaries-path.adoc Co-authored-by: Tim Dettrick <[email protected]> * Update modules/ROOT/partials/misc/hunspell-dictionaries-path.adoc Co-authored-by: Tim Dettrick <[email protected]> * Update modules/ROOT/partials/misc/supported-application-servers.adoc Co-authored-by: Tim Dettrick <[email protected]> * Update modules/ROOT/pages/support.adoc Co-authored-by: Tim Dettrick <[email protected]> * Update modules/ROOT/pages/support.adoc Co-authored-by: Tim Dettrick <[email protected]> * Update modules/ROOT/partials/misc/supported-application-servers.adoc --------- Co-authored-by: Tim Dettrick <[email protected]> * DOC-3147: Attempting to add a newline directly after a element such as an image would cause an error. (#3737) Co-authored-by: Karl Kemister-Sheppard <[email protected]> * DOC-3147: Language code standardization to RFC5646/BCP47 format. (#3771) * DOC-3147: Deprecated `editor.selection.setContent` API (#3789) * DOC-3147: Deprecated API. * Update modules/ROOT/pages/8.0-release-notes.adoc * DOC-3147: New `allow_html_in_comments` option to allow HTML-like content inside comment data (#3791) * DOC-3147: New allow_html_in_comments option to allow HTML-like content inside comment data. * Update modules/ROOT/partials/configuration/allow_html_in_comments.adoc Co-authored-by: michalnieruchalski-tiugo <[email protected]> * Update modules/ROOT/pages/8.0-release-notes.adoc Co-authored-by: michalnieruchalski-tiugo <[email protected]> --------- Co-authored-by: michalnieruchalski-tiugo <[email protected]> * DOC-3147: The default value of `pagebreak_split_block` is now `true` to match the new `pagebreak_separator` default. (#3795) * DOC-3147: The default value of pagebreak_split_block is now true to match the new pagebreak_separator default. * Update modules/ROOT/pages/8.0-release-notes.adoc Co-authored-by: shirqa <[email protected]> * Update modules/ROOT/pages/8.0-release-notes.adoc Co-authored-by: shirqa <[email protected]> * Update modules/ROOT/pages/8.0-release-notes.adoc Co-authored-by: Hamza Benkhaldoun <[email protected]> * Update modules/ROOT/pages/8.0-release-notes.adoc Co-authored-by: Hamza Benkhaldoun <[email protected]> --------- Co-authored-by: shirqa <[email protected]> Co-authored-by: Hamza Benkhaldoun <[email protected]> * DOC-3147: Tooltips can now be closed by pressing the escape key. (#3785) Co-authored-by: Karl Kemister-Sheppard <[email protected]> * DOC-3147: Long tooltips could overflow narrow browser windows. (#3769) * DOC-3147: Tab to create a new row in tables with a non-editable final row would freeze the editor. (#3768) * DOC-3147: Tab to create a new row in tables with a non-editable final row would freeze the editor. * Update modules/ROOT/pages/8.0-release-notes.adoc * DOC-3147: Nested font sizes no longer cause excessive line spacing. (#3761) * DOC-3147: Nested font sizes no longer cause excessive line spacing. * Update modules/ROOT/pages/8.0-release-notes.adoc * DOC-3147: DomParser no longer tries to fix some nodes when parsed with a context, and Improved structure retention when inserting invalid HTML fragments. (#3779) * DOC-3147: Input label for misspelled word was not announced by screen readers. (#3758) * DOC-3147: Input label for misspelled word was not announced by screen readers. * Update modules/ROOT/pages/8.0-release-notes.adoc * DOC-3147: Content marked with lang attributes was sometimes not spellchecked correctly. (#3777) * DOC-3147: Codesample dialog would not disable spellcheck as expected. (#3767) * DOC-3147: Codesample dialog would not disable spellcheck as expected. * Update modules/ROOT/pages/8.0-release-notes.adoc * DOC-3147: New list_max_depth option to limit list indentation. (#3766) * DOC-3147: New list_max_depth option to limit list indentation. * Update modules/ROOT/partials/configuration/list_max_depth.adoc * Update modules/ROOT/pages/8.0-release-notes.adoc * DOC-12102: New list item was not inserted correctly when existing list item had a block element inside. (#3759) * DOC-3147: Cutting a whole HTML element would add an empty paragraph. (#3756) Co-authored-by: Karl Kemister-Sheppard <[email protected]> * DOC-3147: Focus is now restored to a dialog after closing an alert, confirmation or another dialog (#3751) * DOC-3147: Focus is now restored to a dialog after closing an alert, confirmation or another dialog. * Update modules/ROOT/pages/8.0-release-notes.adoc Co-authored-by: Zuzanna Tomaszyk <[email protected]> --------- Co-authored-by: Zuzanna Tomaszyk <[email protected]> * DOC-3147: The ToggleToolbarDrawer command's skipFocus option has been deprecated. (#3748) * DOC-3147: Removed unused Mentions plugin stylesheet. (#3747) * DOC-3147: Mentions username not updating with skin changes in dark mode. (#3746) * DOC-3147: Removed unused `css/tinycomments.css` and `css/tinycomments.js` files. (#3745) * DOC-3147: Removed unused css/tinycomments.css and css/tinycomments.js files. * minor copy edits. * Update modules/ROOT/pages/8.0-release-notes.adoc * DOC-3147: Discontinue advertised support for Medical English (UK) in TinyMCE features. (#3742) * DOC-3147: Tabbing when a was selected didn't move the selection on the `figcaption` correctly. (#3776) * DOC-3147: Tabbing when a was selected didn't move the selection on the correctly. * Update modules/ROOT/pages/8.0-release-notes.adoc * Update modules/ROOT/pages/8.0-release-notes.adoc --------- Co-authored-by: Karl Kemister-Sheppard <[email protected]> * Revert "DOC-3147: Default value for `pagebreak_separator` option to better suit modern standards. (#3780)" This reverts commit b2a8207. * Revert "DOC-3147: The default value of `pagebreak_split_block` is now `true` to match the new `pagebreak_separator` default. (#3795)" This reverts commit 7ad29fd. * DOC-3147: Updated documentation related to a11y (#3799) * DOC-3147: Add I1 url * DOC-3147: Update accessibility documentation: Adjust alt text length limit to 150 characters, enhance descriptions for decorative images, and clarify filtering behavior for empty alt attributes. * Update modules/ROOT/partials/a11y-rules/i1.adoc Co-authored-by: Karl Kemister-Sheppard <[email protected]> * Update modules/ROOT/partials/a11y-rules/i3.adoc * Apply suggestion from @ArvinJ-H --------- Co-authored-by: Karl Kemister-Sheppard <[email protected]> * DOC-3147: Update split button documentation (#3793) * DOC-3147: Update split button tooltips and documentation * Update modules/ROOT/pages/8.0-release-notes.adoc Co-authored-by: Karl Kemister-Sheppard <[email protected]> * Update modules/ROOT/pages/8.0-release-notes.adoc Co-authored-by: Karl Kemister-Sheppard <[email protected]> * Update modules/ROOT/pages/8.0-release-notes.adoc Co-authored-by: Karl Kemister-Sheppard <[email protected]> * Update modules/ROOT/pages/8.0-release-notes.adoc Co-authored-by: tiny-ben-tran <[email protected]> * Update modules/ROOT/pages/custom-split-toolbar-button.adoc Co-authored-by: tiny-ben-tran <[email protected]> * Update modules/ROOT/pages/custom-split-toolbar-button.adoc Co-authored-by: tiny-ben-tran <[email protected]> * Update modules/ROOT/pages/custom-split-toolbar-button.adoc Co-authored-by: tiny-ben-tran <[email protected]> * DOC-3147: Refactor split button documentation and CSS classes for clarity and consistency * DOC-3147: Update split button notes to reflect structural changes. * DOC-3147: Remove CSS classes section and related file for split buttons * Update modules/ROOT/pages/creating-a-skin.adoc * Update modules/ROOT/pages/8.0-release-notes.adoc * Update modules/ROOT/pages/8.0-release-notes.adoc --------- Co-authored-by: Karl Kemister-Sheppard <[email protected]> Co-authored-by: tiny-ben-tran <[email protected]> * DOC-3147: draft changelog. * DOC-3147: New User Lookup API for retrieving and caching user details. (#3801) * DOC-3147: New User Lookup API for retrieving and caching user details. * Update modules/ROOT/pages/8.0-release-notes.adoc * DOC-3226: Update licensing information and examples for TinyMCE 8 (#3753) * DOC-3226: Update licensing information and examples for TinyMCE 8, including T8LK: prefix requirements for self-hosted deployments across various integrations and documentation. * Enhance license key documentation for TinyMCE 8, clarifying T8LK prefix usage and client-side JWT validation across various integration references and examples. * DOC-3226: Update license key format across documentation and examples to include T8LK prefix for TinyMCE 8 compatibility and included release notes entry. * Update Blazor integration example to include T8LK prefix in LicenseKey for compliance with TinyMCE 8. * Update Blazor integration example to include T8LK prefix in LicenseKey for TinyMCE 8 compliance. * DOC-3226: Technical and readabilty adjustments * DOC-3226: Enhance license key documentation for TinyMCE 8, clarifying T8LK prefix requirements and updating integration references across various frameworks. * DOC-3226: Update license key documentation for TinyMCE 8, clarifying API key usage, T8LK prefix requirements, and adding common error messages with solutions. * Update modules/ROOT/pages/8.0-release-notes.adoc * Update modules/ROOT/partials/integrations/webcomponent-tech-ref.adoc * Update modules/ROOT/partials/integrations/webcomponent-quick-start.adoc Co-authored-by: tiny-ben-tran <[email protected]> * Update modules/ROOT/partials/integrations/webcomponent-tech-ref.adoc Co-authored-by: tiny-ben-tran <[email protected]> * Update modules/ROOT/partials/integrations/webcomponent-tech-ref.adoc Co-authored-by: tiny-ben-tran <[email protected]> * Update modules/ROOT/partials/integrations/webcomponent-tech-ref.adoc Co-authored-by: tiny-ben-tran <[email protected]> * DOC-3226: Change readonly to disabled. Add new messages. * Update modules/ROOT/partials/integrations/common/license-key-property.adoc * Update modules/ROOT/partials/integrations/vue-quick-start.adoc Co-authored-by: Tim Dettrick <[email protected]> * Update modules/ROOT/partials/integrations/vue-quick-start.adoc Co-authored-by: Tim Dettrick <[email protected]> * Update modules/ROOT/partials/integrations/blazor-postinstall.adoc * Update modules/ROOT/partials/integrations/blazor-tech-ref.adoc Co-authored-by: Tim Dettrick <[email protected]> * Update modules/ROOT/partials/integrations/react-bundling.adoc * Update modules/ROOT/partials/integrations/svelte-quick-start.adoc Co-authored-by: tiny-ben-tran <[email protected]> * Update modules/ROOT/partials/module-loading/bundling-vite-es6-npm_editor.adoc * Update modules/ROOT/partials/integrations/react-quick-start.adoc * Apply suggestions from code review * DOC-3147: Update key information for self-hosted for licensekeymanager addon. --------- Co-authored-by: ltrouton <[email protected]> Co-authored-by: tiny-ben-tran <[email protected]> Co-authored-by: Tim Dettrick <[email protected]> * DOC-3147: Add `crossorigin` attribute to all script tags for CORS compliance. (#3762) * DOC-3147: Add crossorigin attribute to script tags for CORS compliance. * DOC-3233: Add release notes entry for new crossorigin option, and updated script_crossorigin.adoc partial to provide examples. * DOC-3233:Refactor CORS documentation: replace script_crossorigin.adoc with crossorigin.adoc for improved clarity and organization. * DOC-3233: Update crossorigin function in release notes to match new implementaiton standard. * DOC-3147: Refactor crossorigin examples in documentation to clarify attribute handling and provide options for omitting the attribute. * DOC-3147: Fix indent issues. * DOC-3147: Update scripttag.png file to include crossorigin. * Update modules/ROOT/partials/configuration/crossorigin.adoc * Update modules/ROOT/partials/configuration/crossorigin.adoc * Update modules/ROOT/partials/configuration/crossorigin.adoc * Update modules/ROOT/partials/configuration/crossorigin.adoc * Update modules/ROOT/pages/8.0-release-notes.adoc * Update modules/ROOT/pages/editor-and-features.adoc * DOC-3147: Cleanup pre-release. * DOC-3147: Add fire() method, update changelog to include license key message. * DOC-3147: Migration guide from TinyMCE 7 to TinyMCE 8. (#3781) * DOC-3147: Migration guide from TinyMCE 7 to TinyMCE 8. * DOC-3238: Enhance migration guide with detailed checklists and improves crossorigin entry. * Update modules/ROOT/pages/migration-from-7x.adoc Co-authored-by: Andrew Herron <[email protected]> * Update modules/ROOT/pages/migration-from-7x.adoc Co-authored-by: Andrew Herron <[email protected]> * Update modules/ROOT/pages/migration-from-7x.adoc Co-authored-by: Andrew Herron <[email protected]> * Update modules/ROOT/pages/migration-from-7x.adoc Co-authored-by: Andrew Herron <[email protected]> * Update modules/ROOT/pages/migration-from-7x.adoc Co-authored-by: Andrew Herron <[email protected]> * Update modules/ROOT/pages/migration-from-7x.adoc Co-authored-by: Andrew Herron <[email protected]> * Update modules/ROOT/pages/migration-from-7x.adoc Co-authored-by: Andrew Herron <[email protected]> * Update modules/ROOT/pages/migration-from-7x.adoc Co-authored-by: Andrew Herron <[email protected]> * Update modules/ROOT/pages/migration-from-7x.adoc * DOC-3147: document structure changes, to include various suggestions, edits, improvements. * DOC-3147: Update migration guide to clarify license key manager directory and initialization steps. * DOC-2147: Add pagebreak_split_block breaking change. * DOC-3146: downgrade pagebreak_split_block lvl to Low. * Update modules/ROOT/pages/migration-from-7x.adoc Co-authored-by: Andrew Herron <[email protected]> * Update modules/ROOT/pages/migration-from-7x.adoc * Update modules/ROOT/pages/migration-from-7x.adoc * Update modules/ROOT/pages/migration-from-7x.adoc * Update modules/ROOT/pages/migration-from-7x.adoc * Update modules/ROOT/pages/migration-from-7x.adoc * DOC-3147: Update migration guide and security documentation for DOMPurify changes, and fix for ref numbers. * DOC-3147: Remove content handling updates from migration guide, not breaking change. * DOC-3147: Update migration quick ref table to reflect changes in DOMPurify sanitization. * DOC-3147: Fix broken table link. * DOC-3147: Update documentBaseUrl to include updated information. * DOC-3147: Refine migration guide for TinyMCE 8.0: update breaking change descriptions, enhance license key system details, and clarify DOMPurify sanitization impacts. * Update modules/ROOT/pages/migration-from-7x.adoc Co-authored-by: michalnieruchalski-tiugo <[email protected]> * Update modules/ROOT/pages/migration-from-7x.adoc * DOC-3147: Remove reverted pagebreak_split_block, updated Split button CSS structure updates, general doc structural changes. * Update modules/ROOT/pages/migration-from-7x.adoc * Update modules/ROOT/pages/migration-from-7x.adoc * DOC-2147: fix table, and add ask-ai-widget png file. * Update modules/ROOT/pages/migration-from-7x.adoc * Apply suggestions from code review Co-authored-by: Shan <[email protected]> * Update modules/ROOT/pages/migration-from-7x.adoc * Update modules/ROOT/pages/migration-from-7x.adoc --------- Co-authored-by: Andrew Herron <[email protected]> Co-authored-by: michalnieruchalski-tiugo <[email protected]> Co-authored-by: Shan <[email protected]> * DOC-3147: Add suggestededits to new premium plugin section in release notes. * DOC-3147: Add suggestededits to full-feature demo. * DOC-3147: Remove model, and linkchecker from full feature demo as its not currently ignored. * Update modules/ROOT/partials/configuration/crossorigin.adoc * Update modules/ROOT/examples/live-demos/a11ychecker/index.js Co-authored-by: tiny-ben-tran <[email protected]> * Update modules/ROOT/examples/live-demos/full-featured/index.js * Update modules/ROOT/partials/configuration/list_max_depth.adoc * Update modules/ROOT/partials/misc/ui-languages.adoc * DOC-3147: api-version bump to 8.0.0 and update CDN version. --------- Co-authored-by: CODE:AG <[email protected]> Co-authored-by: Arvin Han <[email protected]> Co-authored-by: Tim Dettrick <[email protected]> Co-authored-by: michalnieruchalski-tiugo <[email protected]> Co-authored-by: shirqa <[email protected]> Co-authored-by: Hamza Benkhaldoun <[email protected]> Co-authored-by: Zuzanna Tomaszyk <[email protected]> Co-authored-by: tiny-ben-tran <[email protected]> Co-authored-by: ltrouton <[email protected]> Co-authored-by: Andrew Herron <[email protected]> Co-authored-by: Shan <[email protected]> --------- Co-authored-by: lorenzo-pomili <[email protected]> Co-authored-by: tiny-ben-tran <[email protected]> Co-authored-by: Andrew Herron <[email protected]> Co-authored-by: Mitchell Crompton <[email protected]> Co-authored-by: Sorita Heng <[email protected]> Co-authored-by: kimwoodfield <[email protected]> Co-authored-by: Shan <[email protected]> Co-authored-by: CODE:AG <[email protected]> Co-authored-by: Arvin Han <[email protected]> Co-authored-by: Tim Dettrick <[email protected]> Co-authored-by: michalnieruchalski-tiugo <[email protected]> Co-authored-by: shirqa <[email protected]> Co-authored-by: Hamza Benkhaldoun <[email protected]> Co-authored-by: Zuzanna Tomaszyk <[email protected]> Co-authored-by: ltrouton <[email protected]>
1 parent 97cb18f commit 520e5e8

File tree

208 files changed

+6317
-1324
lines changed

Some content is hidden

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

208 files changed

+6317
-1324
lines changed

.api-version

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
7.9.0
1+
8.0.0

CONTRIBUTING.md

Lines changed: 83 additions & 85 deletions
Large diffs are not rendered by default.

README.md

Lines changed: 59 additions & 77 deletions
Original file line numberDiff line numberDiff line change
@@ -1,119 +1,101 @@
1-
# TinyMCE documentation
1+
# TinyMCE Documentation
22

3-
This project maintains the documentation for TinyMCE at
4-
[https://www.tiny.cloud/docs](https://www.tiny.cloud/docs). If you have any
5-
modifications you wish to contribute, fork this project, make the changes
6-
and submit a pull request. You will need to sign the contributor’s license
7-
agreement, which will be emailed to you upon creating the pull request.
3+
This project maintains the official documentation for TinyMCE, available at [https://www.tiny.cloud/docs](https://www.tiny.cloud/docs). If you have modifications or improvements to contribute, fork this repository, make the necessary changes, and submit a pull request (PR). A contributor's license agreement (CLA) must be signed before your contribution can be merged. This agreement will be sent via email when you create a PR.
84

9-
This project is built using [Antora](https://antora.org/).
5+
This project is built using [Antora](https://antora.org/), a powerful documentation site generator that supports multi-repository collaboration, content modularization, and flexible versioning.
106

117
## Contributing to the TinyMCE Documentation
128

13-
If you would like to contribute to the TinyMCE project please read the TinyMCE Documentation Contributor’s Guide at either:
9+
To contribute to the TinyMCE documentation project, please review the following resources:
1410

15-
- [TinyMCE Documentation - Contributor's Guide](https://www.tiny.cloud/docs/configure/contributing-docs/).
16-
- [GitHub - How to contribute to TinyMCE’s documentation](https://github.com/tinymce/tinymce-docs/blob/release/docs-6/CONTRIBUTING.md#how-to-contribute-to-tinymces-documentation).
11+
- [GitHub - How to contribute to TinyMCE’s documentation](https://github.com/tinymce/tinymce-docs/blob/main/CONTRIBUTING.md#how-to-contribute-to-tinymces-documentation)
1712

18-
## Working on TinyMCE documentation
13+
These guides cover contribution guidelines, project structure, style conventions, and best practices for submitting changes.
1914

20-
### Compiling or building the documentation
15+
## Setting Up Your Development Environment
2116

22-
The following procedure assists with building (or compiling) the documentation locally. Tiny recommends testing and reviewing changes locally prior to submitting a pull request.
17+
To contribute effectively, you should set up a local development environment. This allows you to preview and test your changes before submitting a PR.
2318

24-
#### Installing Prerequisites
19+
### Prerequisites
2520

26-
##### Linux users
21+
Ensure the following software is installed:
2722

28-
You need the following programs installed on your computer:
23+
- [Node.js](https://nodejs.org/en/) (version 22.9 or lower)
24+
- [Yarn](https://yarnpkg.com/)
25+
- Git
2926

30-
#### First time set up
27+
### Cloning the Repository
3128

32-
Once you have installed any missing prerequisites, in a terminal or on a command prompt:
29+
Clone the TinyMCE documentation repository:
3330

34-
1. Clone the git repository:
35-
```
36-
git clone [email protected]:tinymce/tinymce-docs.git
37-
```
38-
39-
2. Change directory into the cloned git repository:
40-
```
41-
cd tinymce-docs
42-
```
43-
44-
3. Run yarn install
45-
```
46-
yarn install
47-
```
31+
```bash
32+
git clone [email protected]:tinymce/tinymce-docs.git
33+
cd tinymce-docs
34+
yarn
35+
```
4836

49-
#### Run the development version of the documentation
37+
### Running the Development Server
5038

51-
To create a development version of the documentation, run:
39+
To build and serve the documentation locally:
5240

53-
```
41+
```bash
5442
yarn build
55-
yarn serve
43+
yarn start-dev
5644
```
5745

46+
Visit [http://127.0.0.1:4000](http://127.0.0.1:4000) to view the documentation. The server supports hot-reloading, so changes will automatically reflect when you save your work.
5847

59-
To view the documentation; in a web browser, navigate to [http://127.0.0.1:4000](http://127.0.0.1:4000).
60-
61-
> **Note**: The development version of the documentation will update automatically when you save changes locally.
48+
> **Note:** The `yarn build` command generates the API reference documentation from the TinyMCE source code. To adjust the API version, edit the `API_VERSION` variable in the `scripts/api-reference.sh` file. Alternatively, use `yarn build-local` to build using a local TinyMCE instance:
6249
63-
The `yarn build` step will download the latest TinyMCE package and generate new API reference content from source code. To change the version of TinyMCE API, open the `-scripts/api-reference.sh` file and edit the API_VERSION to the TinyMCE version you would like to generate API docs for. Alternatively, to build using a local version of TinyMCE, `yarn build-local ../path/to/local/TinyMCE`.
50+
Example:
6451

65-
> **Note**: The development server does not need to be stopped prior to running the `yarn build` command, antora should pick up the new changes generated by the build step.
52+
```bash
53+
yarn build-local ../path/to/local/tinymce
54+
```
6655

67-
#### TinyMCE API documentation
56+
### API Documentation
6857

69-
The TinyMCE API documentation is maintained within the [TinyMCE project repository](https://github.com/tinymce/tinymce) and compiled for the documentation site using [MoxieDoc](https://github.com/tinymce/moxiedoc).
58+
The TinyMCE API documentation is compiled and generated using [MoxieDoc](https://github.com/tinymce/moxiedoc) from the core [TinyMCE project repository](https://github.com/tinymce/tinymce). To update the published API docs:
7059

71-
To update the published API documentation:
60+
1. Update the `.api-version` file.
61+
2. Run `yarn build`:
7262

73-
1. Change the version in `.api-version`.
74-
2. Run `yarn build`.
63+
* Running `yarn build` downloads the TinyMCE package specified in `.api-version` and generates new API reference content from source.
7564
3. Commit the changes.
7665

77-
Running `yarn build` downloads the TinyMCE package specified in `.api-version` and generates new API reference content from source.
66+
> **Warning:** The API documentation should not be edited manually. Always generate it from source to ensure accuracy.
7867
79-
**Note:** The API documentation should never be edited manually.
68+
## Live Demos
8069

81-
##### Prerequisites
70+
Live demos can be added to the `modules/ROOT/examples/live-demos` directory. Reference them in your documentation with:
8271

83-
- [Node.js](https://nodejs.org/en/).
84-
85-
86-
### Live Demos
72+
```asciidoc
73+
liveDemo::{sub-directory-name}[]
74+
```
8775

88-
New live demos can be added to the [modules/ROOT/examples/live-demos directory](modules/ROOT/examples/live-demos). It then can be referenced in your doc with the following code:
76+
### Overriding the tinymce URL in Live Demos
8977

90-
```
91-
liveDemo::{sub-directory-name}[]
92-
```
78+
By default, live demos load TinyMCE from the URL specified in the `tinymce_live_demo_url` attribute in the `antora.yml` file. This can be overridden for specific use cases:
9379

94-
#### Overriding the tinymce URL in live demos
80+
* Testing a new feature on the `dev` channel.
81+
* Running the site locally while testing live demos on a different channel.
9582
96-
All live demos usually get their `tinymce.min.js` URL from the `tinymce_live_demo_url` setting in the `antora.yml` file.
97-
However, there are some instances where you wish to override this, e.g.
83+
To help with this, there are two mechanisms for overriding the `tinymce.min.js` URL:
9884

99-
- You want to push/deploy a branch for a new feature that's only on the 'dev' channel.
100-
- You want to run the site locally, but test out the live demos in a different channel.
85+
1. **Global Override:**
86+
To change the TinyMCE URL for all live demos, modify the `tinymce_live_demo_url` attribute in `antora-playbook-dev.yml`:
10187
102-
To help with this, there are two mechanisms for overriding the `tinymce.min.js` URL.
88+
```yaml
89+
asciidoc:
90+
attributes:
91+
tinymce_live_demo_url: https://your-custom-url.com/tinymce.min.js
92+
```
10393
104-
1. Change the URL for all live demos by setting the `tinymce_live_demo_url` attribute in `antora-playbook-dev.yml`. For example:
105-
```
106-
asciidoc
107-
attributes:
108-
tinymce_live_demo_url: URL_to_script_file
109-
```
94+
2. **Per-Demo Override:** Use the `script_url_override` attribute:
95+
To override the URL for a specific live demo:
11096
111-
2. Change the URL for an individual live demo by setting `script_url_override` attribute in the live demo markup. For example:
112-
```
113-
liveDemo::{sub-directory-name}[script_url_override='URL_to_script_file']
114-
```
97+
```asciidoc
98+
liveDemo::{sub-directory-name}[script_url_override='https://your-custom-url.com/tinymce.min.js']
99+
```
115100
116-
- This is useful if you want to deploy the develop branch for a feature only in the 'dev' channel.
117-
- This only overrides the URL for one live demo.
118-
- Don't use this in more than one live demo on a page.
119-
- Don't use this long-term - when the feature is fully rolled-out, use the standard channel.
101+
> **Caution:** Use this sparingly. Avoid using different URLs for multiple demos on the same page, and remember to revert these changes once the feature is fully released.

antora-playbook.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ content:
88
branches: HEAD
99
start_path: ./
1010
- url: https://github.com/tinymce/tinymce-docs.git
11-
branches: [ tinymce/5, tinymce/6, tinymce/7]
11+
branches: [ tinymce/5, tinymce/6, tinymce/7 ]
1212
urls:
1313
html_extension_style: indexify
1414
latest_version_segment: latest

antora.yml

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -8,14 +8,14 @@ asciidoc:
88
idseparator: '-@'
99
# generic variables
1010
companyurl: https://www.tiny.cloud
11-
cdnurl: https://cdn.tiny.cloud/1/no-api-key/tinymce/7/tinymce.min.js
12-
tdcdnurl: https://cdn.tiny.cloud/1/_your_api_key_/tinydrive/7/tinydrive.min.js
13-
tinymce_live_demo_url: https://cdn.tiny.cloud/1/qagffr3pkuv17a8on1afax661irst1hbr4e6tbv888sz91jc/tinymce/7/tinymce.min.js
14-
tinydrive_live_demo_url: https://cdn.tiny.cloud/1/qagffr3pkuv17a8on1afax661irst1hbr4e6tbv888sz91jc/tinydrive/7/tinydrive.min.js
11+
cdnurl: https://cdn.tiny.cloud/1/no-api-key/tinymce/8/tinymce.min.js
12+
tdcdnurl: https://cdn.tiny.cloud/1/_your_api_key_/tinydrive/8/tinydrive.min.js
13+
tinymce_live_demo_url: https://cdn.tiny.cloud/1/qagffr3pkuv17a8on1afax661irst1hbr4e6tbv888sz91jc/tinymce/8/tinymce.min.js
14+
tinydrive_live_demo_url: https://cdn.tiny.cloud/1/qagffr3pkuv17a8on1afax661irst1hbr4e6tbv888sz91jc/tinydrive/8/tinydrive.min.js
1515
webcomponent_url: https://cdn.jsdelivr.net/npm/@tinymce/tinymce-webcomponent/dist/tinymce-webcomponent.min.js
1616
jquery_url: https://cdn.jsdelivr.net/npm/@tinymce/tinymce-jquery@2/dist/tinymce-jquery.min.js
1717
openai_proxy_url: https://openai.ai-demo-proxy.tiny.cloud/v1/chat/completions
18-
openai_proxy_token: eyJhbGciOiJFUzM4NCJ9.eyJhdWQiOlsiaHR0cHM6Ly9vcGVuYWkuYWktZGVtby1wcm94eS50aW55LmNsb3VkLyJdLCJleHAiOjE3NTEzMjgwMDAsImh0dHBzOi8vb3BlbmFpLmFpLWRlbW8tcHJveHkudGlueS5jbG91ZC9yb2xlIjoicHVibGljLWRlbW8iLCJpc3MiOiJodHRwczovL2FpLWRlbW8tcHJveHkudGlueS5jbG91ZC8iLCJqdGkiOiJmOGFmY2EyNC1mN2FhLTQxMjktYTc2Yy02YThlZDU3YjAyZjYiLCJzdWIiOiJhaS1hc3Npc3RhbnQtZGVtbyJ9.Xu0apHCbxgmRQTeTqrTIDFFhh2CgKeARRXa3mCxSGoCwZqkoQaFRZBCzDo8Xz7DuUa5mW2XHl-HYcYiXJM9ly16d0oY7lJefHBeLlmJEBE1CSttHBkCRWZS8eFLCasL6
18+
openai_proxy_token: eyJhbGciOiJFUzM4NCJ9.eyJhdWQiOlsiaHR0cHM6Ly9vcGVuYWkuYWktZGVtby1wcm94eS50aW55LmNsb3VkLyJdLCJleHAiOjE3ODI4NjQwMDAsImh0dHBzOi8vb3BlbmFpLmFpLWRlbW8tcHJveHkudGlueS5jbG91ZC9yb2xlIjoicHVibGljLWRlbW8iLCJpc3MiOiJodHRwczovL2FpLWRlbW8tcHJveHkudGlueS5jbG91ZC8iLCJqdGkiOiIxZWY3NjJiNi1mZDYyLTQ3ZWQtOGRkNS0yOGRmMzBkZDU4YmMiLCJzdWIiOiJhaS1hc3Npc3RhbnQtZGVtbyJ9.WC8GIY19MgZneDVZoA-Ttt9E7gNkD0Yl-pcM_5c2RT3RdV_zE0i4bPOGBJpg_g6wu_4ki2ery6_JZtk2Q9gXEBHH7fIu7hXDFS8uIV9qe8MyxEqqRncGFVDjSTldVXGS
1919
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
2020
# product docker variables
2121
dockerimageimportfromwordexporttoword: registry.containers.tiny.cloud/docx-converter-tiny

modules/ROOT/examples/live-demos/a11ychecker/index.js

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,8 +2,10 @@ tinymce.init({
22
selector: 'textarea#a11ychecker',
33
plugins: 'a11ychecker advcode table advlist lists image media anchor link autoresize',
44
toolbar: 'a11ycheck | blocks bold forecolor backcolor | bullist numlist | link image media anchor | table | code',
5+
max_height: 500,
56
a11y_advanced_options: true,
67
a11ychecker_html_version: 'html5',
78
a11ychecker_level: 'aaa',
9+
a11ychecker_allow_decorative_images: true,
810
content_style: 'body { font-family:Helvetica,Arial,sans-serif; font-size:16px }'
911
});

modules/ROOT/examples/live-demos/comments-callback-with-mentions/index.js

Lines changed: 32 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -1,18 +1,23 @@
11
import ('https://cdn.jsdelivr.net/npm/@faker-js/faker@9/dist/index.min.js').then(({ faker }) => {
2+
/* This represents a database of users on the server */
23
const userDb = {
34
'michaelcook': {
45
id: 'michaelcook',
56
name: 'Michael Cook',
6-
fullName: 'Michael Cook',
7-
description: 'Product Owner',
8-
image: "{{imagesdir}}/avatars/michaelcook.png"
7+
avatar: '{{imagesdir}}/avatars/michaelcook.png',
8+
custom: {
9+
fullName: 'Michael Cook',
10+
description: 'Product Owner'
11+
}
912
},
1013
'kalebwilson': {
1114
id: 'kalebwilson',
1215
name: 'Kaleb Wilson',
13-
fullName: 'Kaleb Wilson',
14-
description: 'Marketing Director',
15-
image: "{{imagesdir}}/avatars/kalebwilson.png"
16+
avatar: '{{imagesdir}}/avatars/kalebwilson.png',
17+
custom: {
18+
fullName: 'Kaleb Wilson',
19+
description: 'Marketing Director',
20+
}
1621
}
1722
};
1823

@@ -35,7 +40,7 @@ import ('https://cdn.jsdelivr.net/npm/@faker-js/faker@9/dist/index.min.js').then
3540
const getAuthorInfo = (uid) => {
3641
const user = userDb[uid];
3742
if (user) {
38-
return fillAuthorInfo(user.id, user.fullName, user.image);
43+
return fillAuthorInfo(user.id, user.custom.fullName, user.avatar);
3944
}
4045
return {
4146
author: uid,
@@ -85,8 +90,8 @@ import ('https://cdn.jsdelivr.net/npm/@faker-js/faker@9/dist/index.min.js').then
8590
const resolvedConversationDb = {};
8691

8792
const setupFakeServer = () => {
88-
const images = [ adminUser.image, currentUser.image ];
89-
const userNames = [ adminUser.fullName, currentUser.fullName ];
93+
const images = [ adminUser.avatar, currentUser.avatar ];
94+
const userNames = [ adminUser.custom.fullName, currentUser.custom.fullName ];
9095

9196
for (let i = 0; i < numberOfUsers; i++) {
9297
images.push(faker.image.avatar());
@@ -99,14 +104,16 @@ import ('https://cdn.jsdelivr.net/npm/@faker-js/faker@9/dist/index.min.js').then
99104
[currentUser.id]: currentUser
100105
};
101106
userNames.map((fullName) => {
102-
if ((fullName !== currentUser.fullName) && (fullName !== adminUser.fullName)) {
107+
if ((fullName !== currentUser.custom.fullName) && (fullName !== adminUser.custom.fullName)) {
103108
const id = fullName.toLowerCase().replace(/ /g, '');
104109
userDb[id] = {
105110
id,
106111
name: fullName,
107-
fullName,
108-
description: faker.person.jobTitle(),
109-
image: images[Math.floor(images.length * Math.random())]
112+
avatar: images[Math.floor(images.length * Math.random())],
113+
custom: {
114+
fullName,
115+
description: faker.person.jobTitle(),
116+
}
110117
};
111118
}
112119
});
@@ -118,8 +125,8 @@ import ('https://cdn.jsdelivr.net/npm/@faker-js/faker@9/dist/index.min.js').then
118125
const users = Object.keys(userDb).map((id) => ({
119126
id,
120127
name: userDb[id].name,
121-
image: userDb[id].image,
122-
description: userDb[id].description
128+
image: userDb[id].avatar,
129+
description: userDb[id].custom.description
123130
}));
124131
resolve(users);
125132
}, fakeDelay);
@@ -320,9 +327,6 @@ import ('https://cdn.jsdelivr.net/npm/@faker-js/faker@9/dist/index.min.js').then
320327
});
321328
setTimeout(() => done({ conversations: fetchedConversations }), fakeDelay);
322329
};
323-
324-
// Read the above `getAuthorInfo` function to see how this could be implemented
325-
const tinycomments_fetch_author_info = (done) => done(getAuthorInfo(currentUid));
326330

327331
tinymce.init({
328332
selector: 'textarea#comments-callback-with-mentions',
@@ -350,9 +354,16 @@ import ('https://cdn.jsdelivr.net/npm/@faker-js/faker@9/dist/index.min.js').then
350354
mentions_select,
351355

352356
tinycomments_mode: 'callback',
353-
tinycomments_author: currentUser.id,
354-
tinycomments_author_name: currentUser.fullName,
355-
tinycomments_avatar: currentUser.image,
357+
user_id: currentUser.id,
358+
fetch_users: (userIds) => {
359+
return Promise.all(
360+
userIds.map(
361+
(userId) => new Promise(
362+
(resolve) => resolve(userDb[userId] || { id: userId })
363+
)
364+
)
365+
)
366+
},
356367
tinycomments_create,
357368
tinycomments_reply,
358369
tinycomments_delete,
@@ -362,6 +373,5 @@ import ('https://cdn.jsdelivr.net/npm/@faker-js/faker@9/dist/index.min.js').then
362373
tinycomments_delete_comment,
363374
tinycomments_edit_comment,
364375
tinycomments_fetch,
365-
tinycomments_fetch_author_info
366376
});
367377
});

0 commit comments

Comments
 (0)