From 1f46d5b5f124658279eb2dc078f1686ccefd7527 Mon Sep 17 00:00:00 2001 From: Farzad Hayat Date: Fri, 5 Jul 2024 15:32:39 +1000 Subject: [PATCH] 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 * DOC-2469: Delete template files for antora.yml and supported-versions.adoc --------- Co-authored-by: Karl Kemister-Sheppard --- ...ce-behavior-filtering-or-formatting}.adoc} | 0 ...tion>.adoc => {configuration_option}.adoc} | 0 .../index.html | 0 .../index.js | 0 ... => ie-{hyphen-delimited-descriptor}.adoc} | 0 .../live-demos/full-featured/index.html | 3 +- .../live-demos/full-featured/index.js | 2 +- .../{ => {plugincode}}/example.js | 2 +- .../{ => {plugincode}}/index.html | 0 .../{ => {plugincode}}/index.js | 0 .../ROOT/nav.adoc | 15 ++-- .../ROOT/pages/available-menu-items.adoc | 13 +-- .../ROOT/pages/available-toolbar-buttons.adoc | 13 +-- .../pages/editor-command-identifiers.adoc | 12 ++- .../ROOT/pages/events.adoc | 10 +-- .../ROOT/pages/pluginpage.adoc | 24 ++---- .../partials/commands/-cmds.adoc | 62 -------------- .../partials/commands/{plugincode}-cmds.adoc | 33 ++++++++ .../partials/configuration/icon_list.adoc | 7 +- ...tion>.adoc => {configuration_option}.adoc} | 20 +---- ...>-events.adoc => {plugincode}-events.adoc} | 6 +- .../index-pages/opensource-plugins.adoc | 6 +- .../partials/index-pages/premium-plugins.adoc | 6 +- .../-menu-items.adoc | 10 --- .../{plugincode}-menu-items.adoc | 7 ++ ...code>-apis.adoc => {plugincode}-apis.adoc} | 17 +--- .../-toolbar-buttons.adoc | 11 --- .../{plugincode}-toolbar-buttons.adoc | 7 ++ .../release-notes-template/ROOT/nav.adoc | 6 +- .../ROOT/pages/release-notes.adoc | 15 +--- ...otes.adoc => {x.y[.z]}-release-notes.adoc} | 41 ++++----- .../partials/misc/supported-versions.adoc | 32 ------- .../release-notes-template/antora.yml | 83 ------------------- antora.yml | 2 +- modules/ROOT/pages/release-notes.adoc | 12 +-- 35 files changed, 118 insertions(+), 359 deletions(-) rename -new-material-templates/configuration-options-templates/ROOT/pages/{content..adoc => content.{appearance-behavior-filtering-or-formatting}.adoc} (100%) rename -new-material-templates/configuration-options-templates/ROOT/partials/configuration/{.adoc => {configuration_option}.adoc} (100%) rename -new-material-templates/integration-example-(ie)-templates/ROOT/examples/live-demos/{ie- => ie-{hyphen-delimited-descriptor}}/index.html (100%) rename -new-material-templates/integration-example-(ie)-templates/ROOT/examples/live-demos/{ie- => ie-{hyphen-delimited-descriptor}}/index.js (100%) rename -new-material-templates/integration-example-(ie)-templates/ROOT/pages/{ie-.adoc => ie-{hyphen-delimited-descriptor}.adoc} (100%) rename -new-material-templates/plugin-documentation-templates/ROOT/examples/live-demos/{ => {plugincode}}/example.js (91%) rename -new-material-templates/plugin-documentation-templates/ROOT/examples/live-demos/{ => {plugincode}}/index.html (100%) rename -new-material-templates/plugin-documentation-templates/ROOT/examples/live-demos/{ => {plugincode}}/index.js (100%) delete mode 100644 -new-material-templates/plugin-documentation-templates/ROOT/partials/commands/-cmds.adoc create mode 100644 -new-material-templates/plugin-documentation-templates/ROOT/partials/commands/{plugincode}-cmds.adoc rename -new-material-templates/plugin-documentation-templates/ROOT/partials/configuration/{.adoc => {configuration_option}.adoc} (66%) rename -new-material-templates/plugin-documentation-templates/ROOT/partials/events/{-events.adoc => {plugincode}-events.adoc} (90%) delete mode 100644 -new-material-templates/plugin-documentation-templates/ROOT/partials/menu-item-ids/-menu-items.adoc create mode 100644 -new-material-templates/plugin-documentation-templates/ROOT/partials/menu-item-ids/{plugincode}-menu-items.adoc rename -new-material-templates/plugin-documentation-templates/ROOT/partials/plugin-apis/{-apis.adoc => {plugincode}-apis.adoc} (58%) delete mode 100644 -new-material-templates/plugin-documentation-templates/ROOT/partials/toolbar-button-ids/-toolbar-buttons.adoc create mode 100644 -new-material-templates/plugin-documentation-templates/ROOT/partials/toolbar-button-ids/{plugincode}-toolbar-buttons.adoc rename -new-material-templates/release-notes-template/ROOT/pages/{-release-notes.adoc => {x.y[.z]}-release-notes.adoc} (72%) delete mode 100644 -new-material-templates/release-notes-template/ROOT/partials/misc/supported-versions.adoc delete mode 100644 -new-material-templates/release-notes-template/antora.yml diff --git a/-new-material-templates/configuration-options-templates/ROOT/pages/content..adoc b/-new-material-templates/configuration-options-templates/ROOT/pages/content.{appearance-behavior-filtering-or-formatting}.adoc similarity index 100% rename from -new-material-templates/configuration-options-templates/ROOT/pages/content..adoc rename to -new-material-templates/configuration-options-templates/ROOT/pages/content.{appearance-behavior-filtering-or-formatting}.adoc diff --git a/-new-material-templates/configuration-options-templates/ROOT/partials/configuration/.adoc b/-new-material-templates/configuration-options-templates/ROOT/partials/configuration/{configuration_option}.adoc similarity index 100% rename from -new-material-templates/configuration-options-templates/ROOT/partials/configuration/.adoc rename to -new-material-templates/configuration-options-templates/ROOT/partials/configuration/{configuration_option}.adoc diff --git a/-new-material-templates/integration-example-(ie)-templates/ROOT/examples/live-demos/ie-/index.html b/-new-material-templates/integration-example-(ie)-templates/ROOT/examples/live-demos/ie-{hyphen-delimited-descriptor}/index.html similarity index 100% rename from -new-material-templates/integration-example-(ie)-templates/ROOT/examples/live-demos/ie-/index.html rename to -new-material-templates/integration-example-(ie)-templates/ROOT/examples/live-demos/ie-{hyphen-delimited-descriptor}/index.html diff --git a/-new-material-templates/integration-example-(ie)-templates/ROOT/examples/live-demos/ie-/index.js b/-new-material-templates/integration-example-(ie)-templates/ROOT/examples/live-demos/ie-{hyphen-delimited-descriptor}/index.js similarity index 100% rename from -new-material-templates/integration-example-(ie)-templates/ROOT/examples/live-demos/ie-/index.js rename to -new-material-templates/integration-example-(ie)-templates/ROOT/examples/live-demos/ie-{hyphen-delimited-descriptor}/index.js diff --git a/-new-material-templates/integration-example-(ie)-templates/ROOT/pages/ie-.adoc b/-new-material-templates/integration-example-(ie)-templates/ROOT/pages/ie-{hyphen-delimited-descriptor}.adoc similarity index 100% rename from -new-material-templates/integration-example-(ie)-templates/ROOT/pages/ie-.adoc rename to -new-material-templates/integration-example-(ie)-templates/ROOT/pages/ie-{hyphen-delimited-descriptor}.adoc diff --git a/-new-material-templates/plugin-documentation-templates/ROOT/examples/live-demos/full-featured/index.html b/-new-material-templates/plugin-documentation-templates/ROOT/examples/live-demos/full-featured/index.html index 4896337a72..18c2f7c5fb 100644 --- a/-new-material-templates/plugin-documentation-templates/ROOT/examples/live-demos/full-featured/index.html +++ b/-new-material-templates/plugin-documentation-templates/ROOT/examples/live-demos/full-featured/index.html @@ -1,6 +1,5 @@ \ No newline at end of file diff --git a/-new-material-templates/plugin-documentation-templates/ROOT/examples/live-demos/full-featured/index.js b/-new-material-templates/plugin-documentation-templates/ROOT/examples/live-demos/full-featured/index.js index 962b99b07b..27f5ea1887 100644 --- a/-new-material-templates/plugin-documentation-templates/ROOT/examples/live-demos/full-featured/index.js +++ b/-new-material-templates/plugin-documentation-templates/ROOT/examples/live-demos/full-featured/index.js @@ -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. */ diff --git a/-new-material-templates/plugin-documentation-templates/ROOT/examples/live-demos//example.js b/-new-material-templates/plugin-documentation-templates/ROOT/examples/live-demos/{plugincode}/example.js similarity index 91% rename from -new-material-templates/plugin-documentation-templates/ROOT/examples/live-demos//example.js rename to -new-material-templates/plugin-documentation-templates/ROOT/examples/live-demos/{plugincode}/example.js index 30d2613ffa..6b8e2b18e0 100644 --- a/-new-material-templates/plugin-documentation-templates/ROOT/examples/live-demos//example.js +++ b/-new-material-templates/plugin-documentation-templates/ROOT/examples/live-demos/{plugincode}/example.js @@ -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. diff --git a/-new-material-templates/plugin-documentation-templates/ROOT/examples/live-demos//index.html b/-new-material-templates/plugin-documentation-templates/ROOT/examples/live-demos/{plugincode}/index.html similarity index 100% rename from -new-material-templates/plugin-documentation-templates/ROOT/examples/live-demos//index.html rename to -new-material-templates/plugin-documentation-templates/ROOT/examples/live-demos/{plugincode}/index.html diff --git a/-new-material-templates/plugin-documentation-templates/ROOT/examples/live-demos//index.js b/-new-material-templates/plugin-documentation-templates/ROOT/examples/live-demos/{plugincode}/index.js similarity index 100% rename from -new-material-templates/plugin-documentation-templates/ROOT/examples/live-demos//index.js rename to -new-material-templates/plugin-documentation-templates/ROOT/examples/live-demos/{plugincode}/index.js diff --git a/-new-material-templates/plugin-documentation-templates/ROOT/nav.adoc b/-new-material-templates/plugin-documentation-templates/ROOT/nav.adoc index a91d9c153d..a36b79c6e7 100644 --- a/-new-material-templates/plugin-documentation-templates/ROOT/nav.adoc +++ b/-new-material-templates/plugin-documentation-templates/ROOT/nav.adoc @@ -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:.adoc[] -** 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:.adoc[] +// If Premium plugin, place the following entry into Premium plugins list in alphabetical order by plugin name. +*** xref:.adoc[] -// 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:.adoc[] diff --git a/-new-material-templates/plugin-documentation-templates/ROOT/pages/available-menu-items.adoc b/-new-material-templates/plugin-documentation-templates/ROOT/pages/available-menu-items.adoc index b25859f6a6..79b053e32e 100644 --- a/-new-material-templates/plugin-documentation-templates/ROOT/pages/available-menu-items.adoc +++ b/-new-material-templates/plugin-documentation-templates/ROOT/pages/available-menu-items.adoc @@ -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 instances with appropriate material. -// 2. Add the edited material to -// /tinymce-docs/modules/ROOT/pages/available-menu-items.adoc -// in alphabetical order by . (*not* ). -// 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 . (*not* ). :plugincategory: :pluginname: diff --git a/-new-material-templates/plugin-documentation-templates/ROOT/pages/available-toolbar-buttons.adoc b/-new-material-templates/plugin-documentation-templates/ROOT/pages/available-toolbar-buttons.adoc index 564aeb501e..f4864cd218 100644 --- a/-new-material-templates/plugin-documentation-templates/ROOT/pages/available-toolbar-buttons.adoc +++ b/-new-material-templates/plugin-documentation-templates/ROOT/pages/available-toolbar-buttons.adoc @@ -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 instances with appropriate material. -// 2. Add the edited material to -// /tinymce-docs/modules/ROOT/pages/available-toolbar-buttons.adoc -// in alphabetical order by . (*not* ). -// 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 . (*not* ). :plugincategory: :pluginname: diff --git a/-new-material-templates/plugin-documentation-templates/ROOT/pages/editor-command-identifiers.adoc b/-new-material-templates/plugin-documentation-templates/ROOT/pages/editor-command-identifiers.adoc index cbc92854c5..dd4ba23052 100644 --- a/-new-material-templates/plugin-documentation-templates/ROOT/pages/editor-command-identifiers.adoc +++ b/-new-material-templates/plugin-documentation-templates/ROOT/pages/editor-command-identifiers.adoc @@ -1,16 +1,14 @@ -// 0. Replace instances with appropriate material. -// 1. Add the edited material to -// /tinymce-docs/modules/ROOT/pages/editor-command-identifiers.adoc -// in alphabetical order by . (*not* ). -// 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 . (*not* ). -// add an xref in alphabetical order to the summary list that is below the following lines: +// add an xref in alphabetical order by to the summary list that is below the following lines: // [[plugin-commands]] // === Plugin Commands * xref:[] -// add the include in alphabetical order to the body of the "Plugin Commands" section +// add the include in alphabetical order by to the body of the "Plugin Commands" section [[]] ==== diff --git a/-new-material-templates/plugin-documentation-templates/ROOT/pages/events.adoc b/-new-material-templates/plugin-documentation-templates/ROOT/pages/events.adoc index b71e0f83d6..8898c1f2f8 100644 --- a/-new-material-templates/plugin-documentation-templates/ROOT/pages/events.adoc +++ b/-new-material-templates/plugin-documentation-templates/ROOT/pages/events.adoc @@ -1,15 +1,13 @@ -// 0. Replace instances with appropriate material. -// 1. Add the edited material to -// /tinymce-docs/modules/ROOT/pages/events.adoc -// in alphabetical order by . (*not* ). -// 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 . (*not* ). // add the xref in alphabetical order to the summary list that is below the following line: // == Plugin events * xref:-events[ events] -// add the include in alphabetical order to the body of the "Plugin events" section +// add the include in alphabetical order by to the body of the "Plugin events" section [[-events]] === events diff --git a/-new-material-templates/plugin-documentation-templates/ROOT/pages/pluginpage.adoc b/-new-material-templates/plugin-documentation-templates/ROOT/pages/pluginpage.adoc index 7ecc5c616f..398444a855 100644 --- a/-new-material-templates/plugin-documentation-templates/ROOT/pages/pluginpage.adoc +++ b/-new-material-templates/plugin-documentation-templates/ROOT/pages/pluginpage.adoc @@ -1,6 +1,3 @@ -// Replace instances with material then remove this, and other comments. - -// : the product name. Reference on this page with the {pluginname} variable. = plugin :navtitle: :description: . @@ -11,25 +8,22 @@ // opensource plugin = tieroneplan // premium plugin = tiertwoplan or tierthreeplan or enterpriseplan :pluginminimumplan: -// : adds the plugin to an editor configuration. -// Reference on this page with the {plugincode} variable :plugincode: -:plugincategory: premium|opensource +:plugincategory: // 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- file from `/partials/misc`. +// Edit the line below to add the correct requires- file from `tinymce-docs/modules/ROOT/partials/misc`. include::partial$misc/admon-requires-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: '', toolbar: '', - an_essential_option: false + : 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/.adoc // Add one include:: statement for each added file as per the example immediately below. -include::partial$configuration/.adoc[][leveloffset=+1] - - +include::partial$configuration/.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[] \ No newline at end of file diff --git a/-new-material-templates/plugin-documentation-templates/ROOT/partials/commands/-cmds.adoc b/-new-material-templates/plugin-documentation-templates/ROOT/partials/commands/-cmds.adoc deleted file mode 100644 index 33fcc82704..0000000000 --- a/-new-material-templates/plugin-documentation-templates/ROOT/partials/commands/-cmds.adoc +++ /dev/null @@ -1,62 +0,0 @@ -[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+`]. -|mceCommandThree |Description three. -|mceCommandFour |Description four. -|mceCommandFive |Description five. -|mceCommandSix |Description six. -// Boilerplate for commands that require further documentation -|mceCommandSeven |Description seven. For details, see xref:using-mcecommandseven[Using `+mcecommandtwo+`]. -|mceCommandEn |Description en. -|=== - -.Examples -[source,js] ----- -tinymce.activeEditor.execCommand('mceCommandOne'); -tinymce.activeEditor.execCommand('mceCommandTwo', true|false, { : '', : '', : '', : '' }); -tinymce.activeEditor.execCommand('mceCommandThree'); -tinymce.activeEditor.execCommand('mceCommandFour'); -tinymce.activeEditor.execCommand('mceCommandFive'); -tinymce.activeEditor.execCommand('mceCommandSix'); -tinymce.activeEditor.execCommand('mceCommandSeven', true|false, { : '' }); ----- - -// Boilerplate for further documentation of commands that require it. -[[using-mcecommmandtwo]] -== Using `+mcecommandtwo+` - -`+mceCommandTwo+` accepts an object with the following key-value pairs: - -[cols="1,,1,2",options="header"] -|=== -|Name |Value |Requirement |Description - -| |`+'this'+` or `+'that'+` | [Rr]equired |Key-value description one. -| |`+number+` | [Rr]equired |Key-value description two. -| |`+'other'+`, `+'thing'+`, `+'doohickie'+`, or `+'widget'+` | [Rr]equired |Key-value description three. -| |`+'word'+` or `+'notword'+` | [Rr]equired |Key-value description four. -|=== - -// Further notes as required. Delete this comment once notes are added or if they are not required. - -// Boilerplate for further documentation of commands that require it. -[[using-mcetabletoggleseries]] -== Using `+mceTableToggleSeries+` - -`+mceCommandSeven+` accepts an object with the following key-value pair: - -[cols="1,1,1,2",options="header"] -|=== -|Name |Value |Requirement |Description - -| |`+string+` | [Rr]equired |Key-value description five. -|=== - -// 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. diff --git a/-new-material-templates/plugin-documentation-templates/ROOT/partials/commands/{plugincode}-cmds.adoc b/-new-material-templates/plugin-documentation-templates/ROOT/partials/commands/{plugincode}-cmds.adoc new file mode 100644 index 0000000000..9d61f6860b --- /dev/null +++ b/-new-material-templates/plugin-documentation-templates/ROOT/partials/commands/{plugincode}-cmds.adoc @@ -0,0 +1,33 @@ +[cols="1,3",options="header"] +|=== +|Command |Description + +| | +// Boilerplate for commands that require further documentation +| |Description two. For details, see xref:using-[Using `++`]. +|=== + +.Examples +[source,js] +---- +tinymce.activeEditor.execCommand(''); +tinymce.activeEditor.execCommand('', , { : '', : '' }); +---- + +// Boilerplate for further documentation of commands that require it. +[[using-]] +== Using `++` + +`++` accepts an object with the following key-value pairs: + +[cols="1,,1,2",options="header"] +|=== +|Name |Value |Requirement |Description + +| |`+''+` or `+''+` |equired | +| |`++` |equired | +|=== + +// 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. diff --git a/-new-material-templates/plugin-documentation-templates/ROOT/partials/configuration/icon_list.adoc b/-new-material-templates/plugin-documentation-templates/ROOT/partials/configuration/icon_list.adoc index 692ae906f5..531b26502b 100644 --- a/-new-material-templates/plugin-documentation-templates/ROOT/partials/configuration/icon_list.adoc +++ b/-new-material-templates/plugin-documentation-templates/ROOT/partials/configuration/icon_list.adoc @@ -1,7 +1,6 @@ -// 0. Replace instances with appropriate material. -// 1. Add the edited material to -// /tinymce-docs/modules/ROOT/partials/configuration/icon_list.adoc +// 1. Replace instances with appropriate material. +// 2. Add the edited material to +// tinymce-docs/modules/ROOT/partials/configuration/icon_list.adoc // in alphabetical order by . (*not* ). -// 2. Do not bring these comments over with the edited material. | `++` | image:icons/.svg[.svg] | `+.svg+` diff --git a/-new-material-templates/plugin-documentation-templates/ROOT/partials/configuration/.adoc b/-new-material-templates/plugin-documentation-templates/ROOT/partials/configuration/{configuration_option}.adoc similarity index 66% rename from -new-material-templates/plugin-documentation-templates/ROOT/partials/configuration/.adoc rename to -new-material-templates/plugin-documentation-templates/ROOT/partials/configuration/{configuration_option}.adoc index 05bc7e93ea..391b450c3b 100644 --- a/-new-material-templates/plugin-documentation-templates/ROOT/partials/configuration/.adoc +++ b/-new-material-templates/plugin-documentation-templates/ROOT/partials/configuration/{configuration_option}.adoc @@ -1,12 +1,6 @@ [[]] == `` -// Replace all instances of 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 : '' }); ---- @@ -46,24 +40,18 @@ To disable , set `` to `false`. [source,js] ---- tinymce.init({ - selector: 'textarea', // change this value according to your HTML + selector: 'textarea', // Change this value according to your HTML : 'false' }); ---- // Remove if not applicable. -// Edit the sub-head to singular or plural as required. -=== Limitation(s) of the `` option +=== Limitation of the `` option The `` 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. +//// \ No newline at end of file diff --git a/-new-material-templates/plugin-documentation-templates/ROOT/partials/events/-events.adoc b/-new-material-templates/plugin-documentation-templates/ROOT/partials/events/{plugincode}-events.adoc similarity index 90% rename from -new-material-templates/plugin-documentation-templates/ROOT/partials/events/-events.adoc rename to -new-material-templates/plugin-documentation-templates/ROOT/partials/events/{plugincode}-events.adoc index 245d8f32a5..2ac4644b64 100644 --- a/-new-material-templates/plugin-documentation-templates/ROOT/partials/events/-events.adoc +++ b/-new-material-templates/plugin-documentation-templates/ROOT/partials/events/{plugincode}-events.adoc @@ -3,8 +3,6 @@ The following events are provided by the xref:.adoc[ pl [cols="1,1,2",options="header"] |=== |Name |Data |Description - -// Five boilerplate rows. |EventOne |`+{ : }+` |Fired when event one description. |EventTwo |`+{ : , : }+` |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:.adoc[ pl include::partial$misc/admon-requires-v.adoc[] |EventFour |`+{ : }+` |Fired when the event seven description. |EventEn |`+{ : , : }+` |Fired when event en description. -|=== - -// Remove all comment lines and comment blocks before publishing. +|=== \ No newline at end of file diff --git a/-new-material-templates/plugin-documentation-templates/ROOT/partials/index-pages/opensource-plugins.adoc b/-new-material-templates/plugin-documentation-templates/ROOT/partials/index-pages/opensource-plugins.adoc index ee3711a78f..92e47189f3 100644 --- a/-new-material-templates/plugin-documentation-templates/ROOT/partials/index-pages/opensource-plugins.adoc +++ b/-new-material-templates/plugin-documentation-templates/ROOT/partials/index-pages/opensource-plugins.adoc @@ -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 . a| [.lead] xref:.adoc[] - - -// This file is instructional and is never included in the published name-space. + \ No newline at end of file diff --git a/-new-material-templates/plugin-documentation-templates/ROOT/partials/index-pages/premium-plugins.adoc b/-new-material-templates/plugin-documentation-templates/ROOT/partials/index-pages/premium-plugins.adoc index 472431f303..d8905d4459 100644 --- a/-new-material-templates/plugin-documentation-templates/ROOT/partials/index-pages/premium-plugins.adoc +++ b/-new-material-templates/plugin-documentation-templates/ROOT/partials/index-pages/premium-plugins.adoc @@ -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 . a| [.lead] xref:.adoc[] - - -// This file is instructional and is never included in the published name-space. + \ No newline at end of file diff --git a/-new-material-templates/plugin-documentation-templates/ROOT/partials/menu-item-ids/-menu-items.adoc b/-new-material-templates/plugin-documentation-templates/ROOT/partials/menu-item-ids/-menu-items.adoc deleted file mode 100644 index c6cc961a91..0000000000 --- a/-new-material-templates/plugin-documentation-templates/ROOT/partials/menu-item-ids/-menu-items.adoc +++ /dev/null @@ -1,10 +0,0 @@ -[cols="1,1,2",options="header"] -|=== -|Menu item identifier |xref:menus-configuration-options.adoc#example-the-tinymce-default-menu-items[Default Menu Location] |Description - -|`+menu-identifier-1+` | |Description one. -|`+menu-identifier-2+` | |Description two. -|`+menu-identifier-n+` | |Description en. -|=== - -// Remove all comment lines and comment blocks before publishing. diff --git a/-new-material-templates/plugin-documentation-templates/ROOT/partials/menu-item-ids/{plugincode}-menu-items.adoc b/-new-material-templates/plugin-documentation-templates/ROOT/partials/menu-item-ids/{plugincode}-menu-items.adoc new file mode 100644 index 0000000000..f7bc1b666e --- /dev/null +++ b/-new-material-templates/plugin-documentation-templates/ROOT/partials/menu-item-ids/{plugincode}-menu-items.adoc @@ -0,0 +1,7 @@ +[cols="1,1,2",options="header"] +|=== +|Menu item identifier |xref:menus-configuration-options.adoc#example-the-tinymce-default-menu-items[Default Menu Location] |Description + +|`+menu-item-id-1+` | | +|`+menu-item-id-2+` | | +|=== \ No newline at end of file diff --git a/-new-material-templates/plugin-documentation-templates/ROOT/partials/plugin-apis/-apis.adoc b/-new-material-templates/plugin-documentation-templates/ROOT/partials/plugin-apis/{plugincode}-apis.adoc similarity index 58% rename from -new-material-templates/plugin-documentation-templates/ROOT/partials/plugin-apis/-apis.adoc rename to -new-material-templates/plugin-documentation-templates/ROOT/partials/plugin-apis/{plugincode}-apis.adoc index 29c7a14c12..6ed4b64b52 100644 --- a/-new-material-templates/plugin-documentation-templates/ROOT/partials/plugin-apis/-apis.adoc +++ b/-new-material-templates/plugin-documentation-templates/ROOT/partials/plugin-apis/{plugincode}-apis.adoc @@ -2,18 +2,14 @@ |=== |Name |Arguments |Description -// Four boilerplate rows. | | | -| | | -| | | // Markup to add a ‘requires this version of TinyMCE’ admonition into its own row // immediately above the event requiring such a notice. // If not needed, remove the markup and this comment. // If needed, edit the file-name and remove this comment. 3+| include::partial$misc/admon-requires-v.adoc[] -| | | -| | | +| | | |=== .Examples @@ -24,15 +20,4 @@ tinymce.activeEditor.plugins..(); // what this example does tinymce.activeEditor.plugins..(); - -// what this example does -tinymce.activeEditor.plugins..(); - -// what this example does -tinymce.activeEditor.plugins..(); - -// what this example does -tinymce.activeEditor.plugins..(); ---- - -// Remove all comment lines and comment blocks before publishing. diff --git a/-new-material-templates/plugin-documentation-templates/ROOT/partials/toolbar-button-ids/-toolbar-buttons.adoc b/-new-material-templates/plugin-documentation-templates/ROOT/partials/toolbar-button-ids/-toolbar-buttons.adoc deleted file mode 100644 index 8d7d27663a..0000000000 --- a/-new-material-templates/plugin-documentation-templates/ROOT/partials/toolbar-button-ids/-toolbar-buttons.adoc +++ /dev/null @@ -1,11 +0,0 @@ -[cols="1,3",options="header"] -|=== -|Toolbar button identifier |Description - -|`+ai-button-1+` |Description one. -|`+ai-button-2+` |Description two. -|`+ai-button-3+` |Description three. -|`+ai-button-n+` |Description en. -|=== - -// Remove all comment lines and comment blocks before publishing. diff --git a/-new-material-templates/plugin-documentation-templates/ROOT/partials/toolbar-button-ids/{plugincode}-toolbar-buttons.adoc b/-new-material-templates/plugin-documentation-templates/ROOT/partials/toolbar-button-ids/{plugincode}-toolbar-buttons.adoc new file mode 100644 index 0000000000..3a8f5f30be --- /dev/null +++ b/-new-material-templates/plugin-documentation-templates/ROOT/partials/toolbar-button-ids/{plugincode}-toolbar-buttons.adoc @@ -0,0 +1,7 @@ +[cols="1,3",options="header"] +|=== +|Toolbar button identifier |Description + +|`+toolbar-button-id-1+` | +|`+toolbar-button-id-2+` | +|=== \ No newline at end of file diff --git a/-new-material-templates/release-notes-template/ROOT/nav.adoc b/-new-material-templates/release-notes-template/ROOT/nav.adoc index c04931033b..839dc79e6d 100644 --- a/-new-material-templates/release-notes-template/ROOT/nav.adoc +++ b/-new-material-templates/release-notes-template/ROOT/nav.adoc @@ -1,4 +1,4 @@ -// The following two lines are already extant in `nav.adoc` and are here as a guidepost. +// The following two lines already exist in `nav.adoc` and are here as a guidepost. // The new navigation material is added immediately below these lines. * Release information ** xref:release-notes.adoc[Release notes for {productname} {productmajorversion}] @@ -18,6 +18,4 @@ **** xref:-release-notes.adoc#bug-fixes[Bug fixes] **** xref:-release-notes.adoc#security-fixes[Security fixes] **** xref:-release-notes.adoc#deprecated[Deprecated] -**** xref:-release-notes.adoc#known-issues[Known issues] - -// This file is instructional and is never included in the published name-space. +**** xref:-release-notes.adoc#known-issues[Known issues] \ No newline at end of file diff --git a/-new-material-templates/release-notes-template/ROOT/pages/release-notes.adoc b/-new-material-templates/release-notes-template/ROOT/pages/release-notes.adoc index 969edeb032..0b66f575d4 100644 --- a/-new-material-templates/release-notes-template/ROOT/pages/release-notes.adoc +++ b/-new-material-templates/release-notes-template/ROOT/pages/release-notes.adoc @@ -5,17 +5,4 @@ xref:-release-notes.adoc#overview[{productname} ] Release notes for {productname} -//rest of extant table here - -// Dummy table cell. -// 1. When the number of cells in the table is odd: -// * remove the inline comment markup pre-pending this -// element. -// -// 2. When the number of cells in the table is even: -// * prepend the inline comment markup to this -// element. -//a| - -|=== - +// Remember to uncomment the dummy cell when the number of cells in the table is odd to ensure the table renders correctly. diff --git a/-new-material-templates/release-notes-template/ROOT/pages/-release-notes.adoc b/-new-material-templates/release-notes-template/ROOT/pages/{x.y[.z]}-release-notes.adoc similarity index 72% rename from -new-material-templates/release-notes-template/ROOT/pages/-release-notes.adoc rename to -new-material-templates/release-notes-template/ROOT/pages/{x.y[.z]}-release-notes.adoc index aac899c021..fd60f60040 100644 --- a/-new-material-templates/release-notes-template/ROOT/pages/-release-notes.adoc +++ b/-new-material-templates/release-notes-template/ROOT/pages/{x.y[.z]}-release-notes.adoc @@ -1,15 +1,17 @@ -= TinyMCE -:navtitle: TinyMCE -:description: Release notes for TinyMCE += {productname} {release-version} +:release-version: +:navtitle: {productname} {release-version} +:description: Release notes for {productname} {release-version} :keywords: releasenotes, new, changes, bugfixes :page-toclevels: 1 include::partial$misc/admon-releasenotes-for-stable.adoc[] + [[overview]] == Overview -{productname} was released for {enterpriseversion} and {cloudname} on ,
^^, . These release notes provide an overview of the changes for {productname} , including: +{productname} {release-version} was released for {enterpriseversion} and {cloudname} on ,
^^, . These release notes provide an overview of the changes for {productname} {release-version}, including: // Remove sections and section boilerplates as necessary. // Pluralise as necessary or remove the placeholder plural marker. @@ -31,7 +33,7 @@ include::partial$misc/admon-releasenotes-for-stable.adoc[] [[new-premium-plugin]] New Premium plugin -The following new Premium plugin was released alongside {productname} . +The following new Premium plugin was released alongside {productname} {release-version}. === @@ -43,7 +45,7 @@ For information on the **** plugin, see xref:.a [[new-open-source-plugin]] == New Open Source plugin -The following new Open Source plugin was released alongside {productname} . +The following new Open Source plugin was released alongside {productname} {release-version}. === @@ -51,14 +53,15 @@ The new open source plugin, **** // description here. For information on the **** plugin, see xref:.adoc[]. + [[accompanying-premium-plugin-changes]] == Accompanying Premium plugin changes -The following premium plugin updates were released alongside {productname} . +The following premium plugin updates were released alongside {productname} {release-version}. === -The {productname} release includes an accompanying release of the **** premium plugin. +The {productname} {release-version} release includes an accompanying release of the **** premium plugin. **** includes the following . @@ -92,13 +95,13 @@ The following open source plugin has been announced as reaching its end-of-life: [[accompanying-enhanced-skins-and-icon-packs-changes]] == Accompanying Enhanced Skins & Icon Packs changes -The {productname} release includes an accompanying release of the **Enhanced Skins & Icon Packs**. +The {productname} {release-version} release includes an accompanying release of the **Enhanced Skins & Icon Packs**. === Enhanced Skins & Icon Packs The **Enhanced Skins & Icon Packs** release includes the following updates: -The **Enhanced Skins & Icon Packs** were rebuilt to pull in the changes also incorporated into the default {productname} skin, Oxide. +The **Enhanced Skins & Icon Packs** were rebuilt to pull in the changes also incorporated into the default {productname} {release-version} skin, Oxide. For information on using Enhanced Skins & Icon Packs, see: xref:enhanced-skins-and-icon-packs.adoc[Enhanced Skins & Icon Packs]. @@ -106,7 +109,7 @@ For information on using Enhanced Skins & Icon Packs, see: xref:enhanced-skins-a [[improvements]] == Improvements -{productname} also includes the following improvement: +{productname} {release-version} also includes the following improvement: === // #TINY-vwxyz1 @@ -117,7 +120,7 @@ For information on using Enhanced Skins & Icon Packs, see: xref:enhanced-skins-a [[additions]] == Additions -{productname} also includes the following addition: +{productname} {release-version} also includes the following addition: === // #TINY-vwxyz1 @@ -128,7 +131,7 @@ For information on using Enhanced Skins & Icon Packs, see: xref:enhanced-skins-a [[changes]] == Changes -{productname} also includes the following change: +{productname} {release-version} also includes the following change: === // #TINY-vwxyz1 @@ -139,7 +142,7 @@ For information on using Enhanced Skins & Icon Packs, see: xref:enhanced-skins-a [[removed]] == Removed -{productname} also includes the following removal: +{productname} {release-version} also includes the following removal: === // #TINY-vwxyz1 @@ -150,7 +153,7 @@ For information on using Enhanced Skins & Icon Packs, see: xref:enhanced-skins-a [[bug-fixes]] == Bug fixes -{productname} also includes the following bug fix: +{productname} {release-version} also includes the following bug fix: === // #TINY-vwxyz1 @@ -161,7 +164,7 @@ For information on using Enhanced Skins & Icon Packs, see: xref:enhanced-skins-a [[security-fixes]] == Security fixes -{productname} includes : +{productname} {release-version} includes : === // #TINY-vwxyz1 @@ -172,7 +175,7 @@ For information on using Enhanced Skins & Icon Packs, see: xref:enhanced-skins-a [[deprecated]] == Deprecated -{productname} includes the following deprecation: +{productname} {release-version} includes the following deprecation: === The `` configuration property, ``, has been deprecated @@ -182,9 +185,9 @@ For information on using Enhanced Skins & Icon Packs, see: xref:enhanced-skins-a [[known-issues]] == Known issues -This section describes issues that users of {productname} may encounter and possible workarounds for these issues. +This section describes issues that users of {productname} {release-version} may encounter and possible workarounds for these issues. -There known issue in {productname} . +There known issue in {productname} {release-version}. === // #TINY-vwxyz1 diff --git a/-new-material-templates/release-notes-template/ROOT/partials/misc/supported-versions.adoc b/-new-material-templates/release-notes-template/ROOT/partials/misc/supported-versions.adoc deleted file mode 100644 index cce8334762..0000000000 --- a/-new-material-templates/release-notes-template/ROOT/partials/misc/supported-versions.adoc +++ /dev/null @@ -1,32 +0,0 @@ -[[supported-tinymce-versions]] -== Supported {productname} versions - -Supported versions of {productname}: - -[cols="^,^,^",options="header"] -|=== -|Version |Release Date |End of Support -// add new row with version, release date, and end-of-support date. -// use the internal spreadsheet to calculate the end-of-support date from the release date. -|6.6 |2023-07-19 |2025-01-19 -|6.5 |2023-06-21 |2024-12-21 -|6.4 |2023-03-29 |2024-09-29 -|6.3 |2022-12-08 |2024-06-08 -|6.2 |2022-09-26 |2024-03-26 -|6.1 |2022-07-13 |2024-01-13 -|6.0 |2022-04-07 |2023-10-07 -|=== - - - - - -To view our Software License Agreements, visit: - -* link:{legalpages}/cloud-use-subscription-agreement/[The {cloudname} Services Subscription Agreement]. -* link:{legalpages}/tiny-self-hosted-enterprise-agreement/[The {companyname} Self-Hosted Software License Agreement - (Enterprise Users)]. -* link:{legalpages}/tiny-self-hosted-oem-saas-agreement/[The {companyname} Self-Hosted Software License Agreement - (OEM & SaaS Users)]. - -Support for Partner Plugins is provided by Partner companies and is not the responsibility of {companynameformal}. For information on Partner Plugins, see: link:{companyurl}/partners/[https://www.tiny.cloud/partners/]. - -// This file is instructional and is never included in the published name-space. diff --git a/-new-material-templates/release-notes-template/antora.yml b/-new-material-templates/release-notes-template/antora.yml deleted file mode 100644 index f382848b8e..0000000000 --- a/-new-material-templates/release-notes-template/antora.yml +++ /dev/null @@ -1,83 +0,0 @@ -name: tinymce -title: TinyMCE Documentation -# update the version value if required. Almost certainly *not* required. -version: '6' -asciidoc: - attributes: - # anchor configuration (the @ allows it to be overridden if required) - idprefix: '@' - idseparator: '-@' - # generic variables - companyurl: https://www.tiny.cloud - cdnurl: https://cdn.tiny.cloud/1/no-api-key/tinymce/7/tinymce.min.js - tdcdnurl: https://cdn.tiny.cloud/1/_your_api_key_/tinydrive/7/tinydrive.min.js - tinymce_live_demo_url: https://cdn.tiny.cloud/1/qagffr3pkuv17a8on1afax661irst1hbr4e6tbv888sz91jc/tinymce/7/tinymce.min.js - tinydrive_live_demo_url: https://cdn.tiny.cloud/1/qagffr3pkuv17a8on1afax661irst1hbr4e6tbv888sz91jc/tinydrive/7/tinydrive.min.js - webcomponent_url: https://cdn.jsdelivr.net/npm/@tinymce/tinymce-webcomponent@2/dist/tinymce-webcomponent.min.js - jquery_url: https://cdn.jsdelivr.net/npm/@tinymce/tinymce-jquery@2/dist/tinymce-jquery.min.js - 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 - # product variables - productname: TinyMCE - productmajorversion: 6 - # update the productminorversion value if required. Likely required. - # Note: this value is not changed for .z updates. - # For example, an update from 6.6.0 to 6.6.1 does not require a change to this variable’s value. - productminorversion: '6.6' - ##### product name in codeblock - prodnamecode: tinymce - #### more names - companyname: Tiny - companynameformal: Tiny Technologies, Inc. - cloudname: Tiny Cloud - cloudfilemanager: Tiny Drive - enterpriseversion: TinyMCE Enterprise - communityname: TinyMCE Community - accountpage: Tiny Account - supportname: Tiny Support - betaprogram: Tiny Insights Program - #### some plugin names - prem_skins_icons: Enhanced Skins & Icon Packs - #### Plan names - tieroneplan: Tiny Cloud Core Plan - tiertwoplan: Tiny Cloud Essential Plan - tierthreeplan: Tiny Cloud Professional Plan - enterpriseplan: Tiny Custom Plans - ## common tiny.cloud URLs - supporturl: https://support.tiny.cloud - plugindirectory: https://www.tiny.cloud/tinymce/features/ - gettiny: https://www.tiny.cloud/get-tiny - blogurl: https://www.tiny.cloud/blog - download-community: https://www.tiny.cloud/get-tiny/self-hosted/ - download-enterprise: https://www.tiny.cloud/my-account/downloads/ - accountpageurl: https://www.tiny.cloud/my-account - accountkeyurl: https://www.tiny.cloud/my-account/key-manager/ - accountjwturl: https://www.tiny.cloud/my-account/jwt/ - accountsignup: https://www.tiny.cloud/auth/signup - pricingpage: https://www.tiny.cloud/pricing - contactpage: https://www.tiny.cloud/contact - legalpages: https://www.tiny.cloud/legal - communitysupporturl: https://stackoverflow.com/questions/tagged/tinymce - betaprogramurl: https://www.tiny.cloud/insights-program/ - # plugin-specific tiny.cloud URLs - aipricingurl: https://www.tiny.cloud/tinymce/features/ai-integration/ - revisionhistorypricingurl: https://www.tiny.cloud/tinymce/features/revision-history/ - importwordpricingurl: https://www.tiny.cloud/tinymce/features/import-from-word/ - exportwordpricingurl: https://www.tiny.cloud/tinymce/features/export-word/ - exportpdfpricingurl: https://www.tiny.cloud/tinymce/features/export-pdf/ - # HTML entities - tick: '✔' - cross: '✖' - tab: '  ' - newline: '
' - virt_ellps: '⋮' - ellps: '…' - # Demo logos - logofordemos: 'https://www.tiny.cloud/docs/images/logos/android-chrome-256x256.png' - logofordemoshtml: '

TinyMCE Logo

' - logofordemoshtmlright: '

TinyMCE Logo

' - -nav: -- modules/ROOT/nav.adoc -- modules/ROOT/moxiedoc_nav.adoc - -# This file is instructional and is never included in the published name-space. diff --git a/antora.yml b/antora.yml index 78dcaf5b4e..a2461636df 100644 --- a/antora.yml +++ b/antora.yml @@ -26,7 +26,7 @@ asciidoc: # product variables productname: TinyMCE productmajorversion: 7 - productminorversion: '7.0' + productminorversion: '7.2' ##### product name in codeblock prodnamecode: tinymce #### more names diff --git a/modules/ROOT/pages/release-notes.adoc b/modules/ROOT/pages/release-notes.adoc index 6cc767b351..6a63389db0 100644 --- a/modules/ROOT/pages/release-notes.adoc +++ b/modules/ROOT/pages/release-notes.adoc @@ -21,7 +21,6 @@ xref:7.2-release-notes.adoc#overview[{productname} 7.2] Release notes for {productname} 7.2 - a| [.lead] xref:7.1.2-release-notes.adoc#overview[{productname} 7.1.2] @@ -52,14 +51,7 @@ xref:7.0-release-notes.adoc#overview[{productname} 7.0] Release notes for {productname} 7.0 -// Dummy table cell. -// 1. When the number of cells in the table is odd: -// * remove the inline comment markup pre-pending this -// element. -// -// 2. When the number of cells in the table is even: -// * prepend the inline comment markup to this -// element. -a| +// Uncomment this dummy cell when the number of cells above is odd to ensure the table renders correctly. +// a| |===