Skip to content

Commit

Permalink
DOC-2463: Sync with release/7.3 (#3424)
Browse files Browse the repository at this point in the history
* DOC-2435: Updated Angular quick start guides (#3332)

* DOC-2425: Update migration guide and 7.0 release notes regarding force_hex_colour (#3350)

* DOC-2460: Update the supported versions table in misc/supported-versions.adoc. (#3370)

* DOC-2475: Remove old link to Tiny Blog - How to use TinyMCE premium plugins in WordPress 5. (#3377)

* DOC-2471: Update inline-demo to support toolbar_sticky_offset, to correct visual issue. (#3374)

* DOC-2471_2: Revert toolbar_sticky_offset fix. (#3378)

* DOC-2465: TinyMCE 7.2.1 Release Documentation (#3367)

* DOC-2465: TinyMCE 7.2.1 Release Documentation

* DOC-2466: TinyMCE 7.2.1 Release notes & community changelog (#3368)

* DOC-2466: TinyMCE 7.2.1 Release notes & community changelog

* DOC-2466: Add TINY-10127 release note entry (#3372)

* DOC-2466: update changelog.adoc for TinyMCE 7.2.1.

* DOC-2466: `Open Link` button was disabled when selection partially covered a link or when multiple links were selected. (#3379)

* DOC-2466: Open Link button was disabled when selection partially covered a link or when multiple links were selected.

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

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

---------

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

* DOC-2466: Long translations of the bottom help text would cause minor graphical issues. (#3376)

* DOC-2466: Long translations of the bottom help text would cause minor graphical issues.

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

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

---------

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

* DOC-2466: Text content could move unexpectedly when deleting a paragraph. (#3375)

* Update modules/ROOT/pages/changelog.adoc

---------

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

---------

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

* DOC-2467: api-version bump for TinyMCE 7.2.1. (#3382)

* DOC-2477: Update OpenAI Proxy Token (#3384)

* DOC-2469: Windows Repo Folder Compatibility and Template Updates (#3373)

* DOC-2469: Replace <> in file names with {}

* DOCS-2469: Clean up and improve templates

* Update {productminorversion} in antora.yml and its template version

* Fix the correct instance of supported-versions.adoc

* Update -new-material-templates/release-notes-template/ROOT/partials/misc/supported-versions.adoc

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

* DOC-2469: Delete template files for antora.yml and supported-versions.adoc

---------

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

* DOC-2469: Fix release-notes.adoc table (#3387)

* DOC-2486: Add requires 7.1v admon to Revision History Diff API (#3391)

* DOC-2480: Update `svelte-quick-start.adoc` to use Vite v5 (#3388)

* DOC-2480: Update svelte-quick-start.adoc to use Vite v5

* DOC-2480: Improve wording on the "replace src/App.svelte contents" step

* DOC-2489: update code block for importword basic-setup. (#3396)

* DOC-2487: Replace 'en' with 'en_US' in Spellchecker docs and demo (#3392)

* DOC-2488: Remove reference of `Cloud Service` from various plugin pages. (#3397)

* DOC-2488: Remove reference of Cloud Service from various plugin pages.

* DOC-2488: remove mention of option from importword_service_url.

* Update modules/ROOT/pages/exportpdf.adoc

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

* Update modules/ROOT/pages/exportword.adoc

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

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

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

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

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

* DOC-2488: update description for IFW ETW and ETPDF regarding self-hosting.

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

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

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

---------

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

* DOC-2492: Remove IMPORTANT mention regarding prefix and suffix cannot match in config. (#3404)

* DOC-2151: Improve events.adoc explanation event handling (#3394)

* DOC-2151: Improve events.adoc explanation event handling

* DOC-2151: Expand upon the "`+setup+` and `+init_instance_callback+` options" section

* DOC-2440: Document Converters Self-Hosted Advert Pages. (#3323)

* DOC-2440: Document Converters SService.

* DOC-2438: `Docx to HTML` and `HTML to Docx` converter api documentation. (#3381)

* DOC-2438: Docx to HTML and HTML to Docx converter api documentation.

* Update modules/ROOT/pages/html-to-docx-converter-api.adoc

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

* Update modules/ROOT/pages/html-to-docx-converter-api.adoc

* Update modules/ROOT/pages/docx-to-html-converter-api.adoc

* Update modules/ROOT/pages/docx-to-html-converter-api.adoc

---------

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

* DOC-2439: Export to PDF Standalone Service. (#3338)

* DOC-2439: Export to PDF Standalone Service.

* DOC-2439: RE-write, removal of curl examples, and more simplified documentation.

* DOC-2439: add demo, restructure nav.adoc, update content.

* DOC-2439: Remove index.html page, add raw demo and update placeholder content.

* DOC-2439: fix container alignment and margins.

* Update modules/ROOT/pages/html-to-pdf-converter-api.adoc

* Update modules/ROOT/pages/html-to-pdf-converter-api.adoc

Link update

* Update modules/ROOT/pages/html-to-pdf-converter-api.adoc

Update link text.

* Update modules/ROOT/pages/html-to-pdf-converter-api.adoc

Open link in new tab.

* DOC-2439: Copy edits, and replacing string with variables.

* DOC-2439: remove Options Available for HTML to PDF Conversion, Demo and Export to PDF Plugin reference and rename the API Reference to PDF Converter API reference.

---------

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

* DOC-2440: console error fix.

---------

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

* DOC-2499: 7x Remove UI Bundle Cache (#3421)

* DOC-2499: Remove UI Bundle Cache

* DOC-2499: Use production UI Bundle

* DOC-2462: TinyMCE 7.3 Release Documentation

* Update export to  Word config options to support v2 improved flexibility, and plugin descriptions. (#3390)

* Update export to  Word config options to support v2 improved flexibility, and plugin descriptions

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

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

* DOC-2482: update links and Import from Word and Export to Word service server-side component using Docker sub-section config changes to support v2.

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

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

* Update modules/ROOT/partials/individually-licensed-components/import-from-word-and-export-to-word/import-from-word-and-export-to-word-logs-on-premises.adoc

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

* Update modules/ROOT/pages/importword.adoc

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

* DOC-2482: update link, add note regarding header and footer styling.

---------

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

* DOC-2463: TinyMCE 7.3 Release notes & community changelog (#3366)

* DOC-2463: TinyMCE 7.3 Release notes & community changelog

* By default, code is now formatted automatically when the Enhanced Code Editor view is opened. (#3401)

* By default, code is now formatted automatically when the Enhanced Code Editor view is opened.

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

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

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

---------

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

* DOC-2463: Notifications didn't position and resize properly when resizing the editor or toggling views. (#3409)

* DOC-2463: Notifications didn't position and resize properly when resizing the editor or toggling views.

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

* DOC-2463: Unnecessary nbsp entities were inserted when typing at the edges of inline elements. (#3398)

* DOC-2463: Double-clicking on a math element now opens the Math dialog. (#3410)

* DOC-2463: Added new option `advcode_prettify_getcontent` to Enhanced Code Editor. (#3400)

* DOC-2463: Added new option advcode_prettify_getcontent to Enhanced Code Editor.

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

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

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

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

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

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

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

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

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

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

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

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

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

---------

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

* DOC-2463: TINY-10973 Split button popup positioning in fullscreen (#3411)

* DOC-2463: The pattern commands would execute even if the command was not enabled. (#3403)

* Fix typo in TINY-10894 entry

* DOC-2463:Add Translate options to AI Assistant default shortcuts. (#3399)

* DOC-2463: Fixed JavaScript error when inserting a table using the context menu by adjusting the event order in `renderInsertTableMenuItem`. (#3406)

* DOC-2463: Fixed JavaScript error when inserting a table using the context menu by adjusting the event order in renderInsertTableMenuItem.

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

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

---------

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

* DOC-2463: Markdown will now respect the 'Paste as Text' menu option. (#3414)

* DOC-2463: Attempting to use focus commands on an editor where the cursor had last been in certain contentEditable=true elements would fail. (#3417)

* DOC-2463: The listbox component had a fixed width and was not a responsive ui element. (#3408)

* DOC-2463: The listbox component had a fixed width and was not a responsive ui element.

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

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

---------

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

* DOC-2463: Colorpicker number input fields now show an error tooltip and error icon when invalid text has been entered. (#3413)

* DOC-2463: Colorpicker number input fields now show an error tooltip and error icon when invalid text has been entered.

* DOC-2463: update png files to reflect recent color change, included note for read aloud variations.

* DOC-2463: Added success notification when all misspellings are resolved. (#3416)

* DOC-2463: Sequential html comments would in some cases generate unwanted elements. (#3415)

* DOC-2463: Sequential html comments would in some cases generate unwanted elements.

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

---------

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

* Update 7.3 release date to 2024-08-07

* Remove the following unused template sections: enhanced skins/icon packs, changes, removed, security fixes, known issues.

* DOC-2463: `preventDefault` on mousedown on toolbar buttons was causing misplaced focus bugs. (#3412)

* DOC-2463: preventDefault on mousedown on toolbar buttons was causing misplaced focus bugs.

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

Co-authored-by: Arvin(Jintao) Han <[email protected]>

---------

Co-authored-by: Arvin(Jintao) Han <[email protected]>

* DOC-2463: When a full document was loaded as editor content the head elements were added to the body. (#3402)

* DOC-2463: When a full document was loaded as editor content the head elements were added to the body.

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

* DOC-2463: changelog entries for 7.3.0.

* DOC-2481: 7.3 Revision History changes - update plugin page and add release notes (#3407)

* DOC-2481: Add revisionhistory_author.adoc

* DOC-2481: Add revisionhistory_display_author.adoc

* DOC-2481: Update "Understanding types of versions" section and replace 'current' with 'draft' when referring to the version

* DOC-2481: Note that "Restore this version" button is disabled for `initial` and `draft` versions.

* DOC-2481: Extract Revision object and Author object into separate subheadings in plugin page

* DOC-2481: Replace `version` with `revision` and add `author` property to Revision object

* DOC-2481: Live demo add author options to init and author object in revisions lists.

* DOC-2481: Two release note entries for TINY-11014

* DOC-2481: TINY-11042 "Restore this version" button is now disabled when a draft or initial revision is selected.

* DOC-2481: TINY-11045 Enhance the appearance of the Revision History sidebar.

* DOC-2481: TINY-11073 Add labels to the `initial` and `draft` revisions.

* DOC-2481: TINY-11079 New `revisionhistory_display_author` option that determines whether the author is displayed.

* DOC-2481: TINY-11090 It is easier to identify the selected revision.

* DOC-2481: Fix diff API heading in revisionhistory-apis.adoc

* DOC-2481: Add new options and features to revision history page

* DOC-2481: Update descriptions and minor changes to the options

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

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

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

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

* Update modules/ROOT/pages/revisionhistory.adoc

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

* Update modules/ROOT/partials/plugin-apis/revisionhistory-apis.adoc

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

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

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

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

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

* Update modules/ROOT/pages/revisionhistory.adoc

* Update modules/ROOT/pages/revisionhistory.adoc

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

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

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

* Update modules/ROOT/pages/revisionhistory.adoc

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

* Update modules/ROOT/pages/revisionhistory.adoc

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

* Update modules/ROOT/pages/revisionhistory.adoc

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

* Update modules/ROOT/pages/revisionhistory.adoc

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

* Update modules/ROOT/pages/revisionhistory.adoc

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

* Update modules/ROOT/pages/revisionhistory.adoc

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

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

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

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

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

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

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

* DOC-2481: Clean up code example

* DOC-2481: remove duplicate admonition

* Fix revisionhistory author xref

* Add "for more info" for revisionhistory_display_author in release notes

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

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

* Update modules/ROOT/pages/revisionhistory.adoc

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

* DOC-2481: Add revisionhistory_display_author to revisionhistory_author partial

* DOC-2481: Move Spell Checker below Revision History

* DOC-2481: Update the release notes

* DOC-2481: Update demos

---------

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

* DOC-2463: typo correction.

---------

Co-authored-by: Karl Kemister-Sheppard <[email protected]>
Co-authored-by: ltrouton <[email protected]>
Co-authored-by: Arvin(Jintao) Han <[email protected]>
Co-authored-by: Ben Tran <[email protected]>
Co-authored-by: shirqa <[email protected]>

---------

Co-authored-by: Daniel Oakman <[email protected]>
Co-authored-by: Farzad Hayat <[email protected]>
Co-authored-by: Karl Kemister-Sheppard <[email protected]>
Co-authored-by: Mitchell Crompton <[email protected]>
Co-authored-by: shirqa <[email protected]>
Co-authored-by: ltrouton <[email protected]>
Co-authored-by: Ky Eltis <[email protected]>
Co-authored-by: Arvin(Jintao) Han <[email protected]>
9 people authored Aug 7, 2024
1 parent 141caa2 commit 09d57a1
Showing 65 changed files with 678 additions and 541 deletions.
Original file line number Diff line number Diff line change
@@ -1,6 +1,5 @@
<!--
Add necessary material to this file to make it possible for the
full-featured-with-premium-plugins demo to demonstrate the new plugin.
Update tinymce-docs/modules/ROOT/examples/live-demos/full-featured/index.html to include the new plugin.
-->
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
/*
Add new plugin to this file’s extant configuration
Update tinymce-docs/modules/ROOT/examples/live-demos/full-featured/index.js to include the new plugin.
*/

Original file line number Diff line number Diff line change
@@ -23,7 +23,7 @@ NB: there is one UX consequence of setting up demos to work in
these cases. The *Edit on CodePen* tab does not — and cannot —
present in the documentation.
The initial setup of these ‘inclues-an-emulated-back-end’ examples
The initial setup of these ‘includes-an-emulated-back-end’ examples
will almost certainly include significant initial input from the
plugin’s developer.
Original file line number Diff line number Diff line change
@@ -1,13 +1,8 @@
* xref:plugins.adoc[Plugins]
** Premium plugins
// If the new plugin is a Premium plugin
// Replace the boilerplate below with the file-name of the new Premium plugin.
// Also, place this new Premium plugin into alphabetical place within the Premium plugin sub-section.
*** xref:<plugincode>.adoc[<pluginname>]
** Open source plugins
// If the new plugin is an open source plugin
// Replace the boilerplate below with the file-name of the new open source plugin.
// Also, place this new open source plugin into alphabetical place within the open source plugin sub-section.
*** xref:<plugincode>.adoc[<pluginname>]
// If Premium plugin, place the following entry into Premium plugins list in alphabetical order by plugin name.
*** xref:<plugincode>.adoc[<Plugin name>]
// This file is instructional and is never included in the published name-space.
** Open source plugins
// If Open source plugin, place the following entry into Open source plugins list in alphabetical order by plugin name.
*** xref:<plugincode>.adoc[<Plugin name>]
Original file line number Diff line number Diff line change
@@ -1,13 +1,6 @@
// 0. Set :plugincategory: to appropriate value
// 1. premium; or
// 2. opensource.
// Note neither value is capitalised.
// Note the second value has no space between the two words.
// 1. Replace <place-holder text> instances with appropriate material.
// 2. Add the edited material to
// /tinymce-docs/modules/ROOT/pages/available-menu-items.adoc
// in alphabetical order by <Plugin name>. (*not* <plugincode>).
// 3. Do not bring these comments over with the edited material.
// Add the edited material to
// tinymce-docs/modules/ROOT/pages/available-menu-items.adoc
// in alphabetical order by <Plugin name>. (*not* <plugincode>).

:plugincategory: <premium|opensource>
:pluginname: <Plugin name>
Original file line number Diff line number Diff line change
@@ -1,13 +1,6 @@
// 0. Set :plugincategory: to appropriate value
// 1. premium; or
// 2. opensource.
// Note neither value is capitalised.
// Note the second value has no space between the two words.
// 1. Replace <place-holder text> instances with appropriate material.
// 2. Add the edited material to
// /tinymce-docs/modules/ROOT/pages/available-toolbar-buttons.adoc
// in alphabetical order by <Plugin name>. (*not* <plugincode>).
// 3. Do not bring these comments over with the edited material.
// Add the edited material to
// tinymce-docs/modules/ROOT/pages/available-toolbar-buttons.adoc
// in alphabetical order by <Plugin name>. (*not* <plugincode>).

:plugincategory: <premium|opensource>
:pluginname: <Plugin name>
Original file line number Diff line number Diff line change
@@ -1,16 +1,14 @@
// 0. Replace <place-holder text> instances with appropriate material.
// 1. Add the edited material to
// /tinymce-docs/modules/ROOT/pages/editor-command-identifiers.adoc
// in alphabetical order by <Plugin name>. (*not* <plugincode>).
// 2. Do not bring these comments over with the edited material.
// Add the edited material to
// tinymce-docs/modules/ROOT/pages/editor-command-identifiers.adoc
// in alphabetical order by <Plugin name>. (*not* <plugincode>).

// add an xref in alphabetical order to the summary list that is below the following lines:
// add an xref in alphabetical order by <Plugin name> to the summary list that is below the following lines:
// [[plugin-commands]]
// === Plugin Commands

* xref:<plugincode>[<Plugin name>]
// add the include in alphabetical order to the body of the "Plugin Commands" section
// add the include in alphabetical order by <Plugin name> to the body of the "Plugin Commands" section

[[<plugincode>]]
==== <Plugin name>
Original file line number Diff line number Diff line change
@@ -1,15 +1,13 @@
// 0. Replace <place-holder text> instances with appropriate material.
// 1. Add the edited material to
// /tinymce-docs/modules/ROOT/pages/events.adoc
// in alphabetical order by <Plugin name>. (*not* <plugincode>).
// 2. Do not bring these comments over with the edited material.
// Add the edited material to
// tinymce-docs/modules/ROOT/pages/events.adoc
// in alphabetical order by <Plugin name>. (*not* <plugincode>).

// add the xref in alphabetical order to the summary list that is below the following line:
// == Plugin events

* xref:<plugincode>-events[<Plugin name> events]
// add the include in alphabetical order to the body of the "Plugin events" section
// add the include in alphabetical order by <Plugin name> to the body of the "Plugin events" section

[[<plugincode>-events]]
=== <Plugin name> events
Original file line number Diff line number Diff line change
@@ -1,6 +1,3 @@
// Replace <place-holder text> instances with material then remove this, and other comments.

// <Plugin name>: the product name. Reference on this page with the {pluginname} variable.
= <Plugin name> plugin
:navtitle: <Plugin name>
:description: <What does this plugin do? What is the benefit? (One sentence description)>.
@@ -11,25 +8,22 @@
// opensource plugin = tieroneplan
// premium plugin = tiertwoplan or tierthreeplan or enterpriseplan
:pluginminimumplan: <tier>
// <plugincode>: adds the plugin to an editor configuration.
// Reference on this page with the {plugincode} variable
:plugincode: <plugincode>
:plugincategory: premium|opensource
:plugincategory: <premium|opensource>

// Remove the line below (and this comment) for open source plugins
include::partial$misc/admon-premium-plugin.adoc[]

// Edit the line below to add the correct requires-<versionnumber> file from `/partials/misc`.
// Edit the line below to add the correct requires-<versionnumber> file from `tinymce-docs/modules/ROOT/partials/misc`.
include::partial$misc/admon-requires-<versionnumber>v.adoc

// Add an introduction. What does the plugin do? Why would I use this plugin? Keep it concise.

== Interactive example

// No Lorem Ipsum. Add test material, or, at least, a description of how end-users use the feature.
liveDemo::{plugincode}[]

// Logic for customising what presents from this included file relies on
// Logic for customizing what presents from this included file relies on
// the :pluginminimumplan: attribute value above.
//
// 2023-09-06 addendum: the logic in purchase-premium-plugins.adoc needs
@@ -49,9 +43,9 @@ For example:
----
tinymce.init({
selector: 'textarea', // change this value according to your HTML
plugins: '{{plugincode}}',
plugins: '<plugincode>',
toolbar: '<toolbar-button(s)>',
an_essential_option: false
<an_essential_option>: false
});
----

@@ -65,9 +59,7 @@ The following configuration options affect the behavior of the {pluginname} plug
// The template file for each such file is
// -new-material-templates/partials/commands/<configuration_option>.adoc
// Add one include:: statement for each added file as per the example immediately below.
include::partial$configuration/<setting_name>.adoc[][leveloffset=+1]


include::partial$configuration/<configuration_name>.adoc[leveloffset=+1]

// If the plugin offers toolbar buttons
// 1. Add an entry to /pages/available-toolbar-buttons.adoc
@@ -131,6 +123,4 @@ include::partial$events/{plugincode}-events.adoc[]

The {pluginname} plugin provides the following APIs.

include::partial$plugin-apis/{plugincode}-apis.adoc[]

// Remove all comment lines and comment blocks before publishing.
include::partial$plugin-apis/{plugincode}-apis.adoc[]

This file was deleted.

Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@
[cols="1,3",options="header"]
|===
|Command |Description

|<mceCommandOne> |<Description one.>
// Boilerplate for commands that require further documentation
|<mceCommandTwo> |Description two. For details, see xref:using-<mcecommandtwo>[Using `+<mceCommandTwo>+`].
|===

.Examples
[source,js]
----
tinymce.activeEditor.execCommand('<mceCommandOne>');
tinymce.activeEditor.execCommand('<mceCommandTwo>', <true|false>, { <key1>: '<value1>', <key2>: '<number>' });
----

// Boilerplate for further documentation of commands that require it.
[[using-<mcecommandtwo>]]
== Using `+<mceCommandTwo>+`

`+<mceCommandTwo>+` accepts an object with the following key-value pairs:

[cols="1,,1,2",options="header"]
|===
|Name |Value |Requirement |Description

|<key1> |`+'<value1>'+` or `+'<value2>'+` |<Not r|R>equired |<Key-value description one.>
|<key2> |`+<number>+` |<Not r|R>equired |<Key-value description two.>
|===

// Further notes as required. Delete this comment once notes are added or if they are not required.

// Remove all comment lines and comment blocks before publishing.
Original file line number Diff line number Diff line change
@@ -1,7 +1,6 @@
// 0. Replace <place-holder text> instances with appropriate material.
// 1. Add the edited material to
// /tinymce-docs/modules/ROOT/partials/configuration/icon_list.adoc
// 1. Replace <place-holder text> instances with appropriate material.
// 2. Add the edited material to
// tinymce-docs/modules/ROOT/partials/configuration/icon_list.adoc
// in alphabetical order by <icon-identifier>. (*not* <icon-file-name>).
// 2. Do not bring these comments over with the edited material.

| `+<icon-identifier>+` | image:icons/<icon-file-name>.svg[<icon-file-name>.svg] | `+<icon-file-name>.svg+`
Original file line number Diff line number Diff line change
@@ -1,12 +1,6 @@
[[<configuration_option>]]
== `<configuration_option>`

// Replace all instances of <configuration_option> with the
// configuration option name then remove this comment.

// Add explanatory material as per the comment block below then remove
// the block and this comment.

////
What does the option do?
Why use it?
@@ -32,7 +26,7 @@ Are there risks?
[source,js]
----
tinymce.init({
selector: 'textarea', // change this value according to your html
selector: 'textarea', // Change this value according to your HTML
<configuration_option>: '<value>'
});
----
@@ -46,24 +40,18 @@ To disable <feature>, set `<configuration_option>` to `false`.
[source,js]
----
tinymce.init({
selector: 'textarea', // change this value according to your HTML
selector: 'textarea', // Change this value according to your HTML
<configuration_option>: 'false'
});
----

// Remove if not applicable.
// Edit the sub-head to singular or plural as required.
=== Limitation(s) of the `<configuration_option>` option
=== Limitation<s> of the `<configuration_option>` option

The `<configuration_option>` option has the following limitations.

// Add explanatory material as per the comment block below then remove
// the block and this comment.

////
Known limitations.
Complicated scenarios.
Anything that warrants a CAUTION or WARNING admonition.
////

// Remove all comment lines and comment blocks before publishing.
////
Original file line number Diff line number Diff line change
@@ -3,8 +3,6 @@ The following events are provided by the xref:<plugincode>.adoc[<Plugin name> pl
[cols="1,1,2",options="header"]
|===
|Name |Data |Description

// Five boilerplate rows.
|EventOne |`+{ <key1>: <value1> }+` |Fired when event one description.
|EventTwo |`+{ <key2>: <value2>, <key3>: <value3> }+` |Fired when event two description.
|EventThree |N/A |Fired when event three description.
@@ -16,6 +14,4 @@ The following events are provided by the xref:<plugincode>.adoc[<Plugin name> pl
include::partial$misc/admon-requires-<version.version>v.adoc[]
|EventFour |`+{ <key6>: <value6> }+` |Fired when the event seven description.
|EventEn |`+{ <key4>: <value4>, <key5>: <value5> }+` |Fired when event en description.
|===

// Remove all comment lines and comment blocks before publishing.
|===
Original file line number Diff line number Diff line change
@@ -1,10 +1,8 @@
// Table row for an open-source plugin.
// Place this row into the extant table in `partials/index-pages/opensource-plugins.adoc` in alphabetical order.
// Place this row into the existing table in `partials/index-pages/opensource-plugins.adoc` in alphabetical order by <Plugin name>.

a|
[.lead]
xref:<plugincode>.adoc[<Plugin name>]

<One sentence plugin description.>

// This file is instructional and is never included in the published name-space.
<One sentence plugin description.>
Original file line number Diff line number Diff line change
@@ -1,10 +1,8 @@
// Table row for a Premium plugin.
// Place this row into the extant table in `partials/index-pages/premium-plugins.adoc` in alphabetical order.
// Place this row into the existing table in `partials/index-pages/premium-plugins.adoc` in alphabetical order by <Plugin name>.

a|
[.lead]
xref:<plugincode>.adoc[<Plugin name>]

<One sentence plugin description.>

// This file is instructional and is never included in the published name-space.
<One sentence plugin description.>
Loading

0 comments on commit 09d57a1

Please sign in to comment.