-
Notifications
You must be signed in to change notification settings - Fork 220
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Browse files
Browse the repository at this point in the history
- Loading branch information
1 parent
21bb371
commit 141caa2
Showing
54 changed files
with
522 additions
and
445 deletions.
There are no files selected for viewing
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
File renamed without changes.
File renamed without changes.
3 changes: 2 additions & 1 deletion
3
...emplates/plugin-documentation-templates/ROOT/examples/live-demos/full-featured/index.html
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,5 +1,6 @@ | ||
<!-- | ||
Update tinymce-docs/modules/ROOT/examples/live-demos/full-featured/index.html to include the new plugin. | ||
Add necessary material to this file to make it possible for the | ||
full-featured-with-premium-plugins demo to demonstrate the new plugin. | ||
--> |
2 changes: 1 addition & 1 deletion
2
...-templates/plugin-documentation-templates/ROOT/examples/live-demos/full-featured/index.js
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,6 +1,6 @@ | ||
/* | ||
Update tinymce-docs/modules/ROOT/examples/live-demos/full-featured/index.js to include the new plugin. | ||
Add new plugin to this file’s extant configuration | ||
*/ | ||
|
15 changes: 10 additions & 5 deletions
15
-new-material-templates/plugin-documentation-templates/ROOT/nav.adoc
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,8 +1,13 @@ | ||
* xref:plugins.adoc[Plugins] | ||
** Premium plugins | ||
// If Premium plugin, place the following entry into Premium plugins list in alphabetical order by plugin name. | ||
*** xref:<plugincode>.adoc[<Plugin name>] | ||
// 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 Open source plugin, place the following entry into Open source plugins list in alphabetical order by plugin name. | ||
*** xref:<plugincode>.adoc[<Plugin name>] | ||
// 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>] | ||
// This file is instructional and is never included in the published name-space. |
13 changes: 10 additions & 3 deletions
13
...l-templates/plugin-documentation-templates/ROOT/pages/available-menu-items.adoc
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
13 changes: 10 additions & 3 deletions
13
...plates/plugin-documentation-templates/ROOT/pages/available-toolbar-buttons.adoc
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
12 changes: 7 additions & 5 deletions
12
...lates/plugin-documentation-templates/ROOT/pages/editor-command-identifiers.adoc
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
10 changes: 6 additions & 4 deletions
10
-new-material-templates/plugin-documentation-templates/ROOT/pages/events.adoc
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
62 changes: 62 additions & 0 deletions
62
...es/plugin-documentation-templates/ROOT/partials/commands/<plugincode>-cmds.adoc
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,62 @@ | ||
[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, { <key1>: '<value1>', <key2>: '<number2>', <key3>: '<value3>', <key4>: '<value4>' }); | ||
tinymce.activeEditor.execCommand('mceCommandThree'); | ||
tinymce.activeEditor.execCommand('mceCommandFour'); | ||
tinymce.activeEditor.execCommand('mceCommandFive'); | ||
tinymce.activeEditor.execCommand('mceCommandSix'); | ||
tinymce.activeEditor.execCommand('mceCommandSeven', true|false, { <key5>: '<value5>' }); | ||
---- | ||
|
||
// 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 | ||
|
||
|<key1> |`+'this'+` or `+'that'+` |<Not> [Rr]equired |Key-value description one. | ||
|<number1> |`+number+` |<Not> [Rr]equired |Key-value description two. | ||
|<key3> |`+'other'+`, `+'thing'+`, `+'doohickie'+`, or `+'widget'+` |<Not> [Rr]equired |Key-value description three. | ||
|<key4> |`+'word'+` or `+'notword'+` |<Not> [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 | ||
|
||
|<key5> |`+string+` |<Not> [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. |
33 changes: 0 additions & 33 deletions
33
...es/plugin-documentation-templates/ROOT/partials/commands/{plugincode}-cmds.adoc
This file was deleted.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
7 changes: 4 additions & 3 deletions
7
...lates/plugin-documentation-templates/ROOT/partials/configuration/icon_list.adoc
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,6 +1,7 @@ | ||
// 1. Replace <place-holder text> instances with appropriate material. | ||
// 2. Add the edited material to | ||
// tinymce-docs/modules/ROOT/partials/configuration/icon_list.adoc | ||
// 0. Replace <place-holder text> instances with appropriate material. | ||
// 1. 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+` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
6 changes: 4 additions & 2 deletions
6
...lugin-documentation-templates/ROOT/partials/index-pages/opensource-plugins.adoc
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,8 +1,10 @@ | ||
// Table row for an open-source plugin. | ||
// Place this row into the existing table in `partials/index-pages/opensource-plugins.adoc` in alphabetical order by <Plugin name>. | ||
// Place this row into the extant table in `partials/index-pages/opensource-plugins.adoc` in alphabetical order. | ||
|
||
a| | ||
[.lead] | ||
xref:<plugincode>.adoc[<Plugin name>] | ||
|
||
<One sentence plugin description.> | ||
<One sentence plugin description.> | ||
|
||
// This file is instructional and is never included in the published name-space. |
6 changes: 4 additions & 2 deletions
6
...s/plugin-documentation-templates/ROOT/partials/index-pages/premium-plugins.adoc
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,8 +1,10 @@ | ||
// Table row for a Premium plugin. | ||
// Place this row into the existing table in `partials/index-pages/premium-plugins.adoc` in alphabetical order by <Plugin name>. | ||
// Place this row into the extant table in `partials/index-pages/premium-plugins.adoc` in alphabetical order. | ||
|
||
a| | ||
[.lead] | ||
xref:<plugincode>.adoc[<Plugin name>] | ||
|
||
<One sentence plugin description.> | ||
<One sentence plugin description.> | ||
|
||
// This file is instructional and is never included in the published name-space. |
Oops, something went wrong.