DOC-2394: Publish antora 3 docs

Author: MitchC1999

-new-material-templates/configuration-options-templates/ROOT/pages/content.<appearance-behavior-filtering-or-formatting>.adoc

@@ -0,0 +1,43 @@
+// *New configuration options in the TinyMCE core*
+//
+// Configuration options are generally added to the documentation as
+// part of documenting a new plugin.
+//
+// Occasionally, however, a new configuration option is added to the
+// TinyMCE core.
+//
+// In such a case, a new partial file
+// 
+// <configuration_option>.adoc
+// 
+// (containing the configuration option documentation) is added to
+//
+// /modules/ROOT/partials/configuration/
+//
+//
+//
+//
+//
+// *Where the option appears in the docs*
+//
+// The include statement that places the partial file into the docs
+// proper is added to one of four extant files:
+// 
+// 1. /modules/ROOT/pages/content-appearance.adoc
+// 2. /modules/ROOT/pages/content-behavior-options.adoc
+// 3. /modules/ROOT/pages/content-filtering.adoc
+// 4. /modules/ROOT/pages/content-formatting.adoc
+//
+// Which of these four depends on the configuration option’s properties.
+// 
+// This is an editorial/engineering decision.
+//
+// With the decision made
+//
+// 1. Replace <configuration_option> with the option’s name in the
+//    include:: statement, below
+// 2. Copy the edited include:: statement.
+// 3. Paste the statement into the chosen file in alphabetical order
+//    by <configuration_option>.
+
+include::partial$configuration/<configuration_option>.adoc[]

-new-material-templates/configuration-options-templates/ROOT/partials/configuration/<configuration_option>.adoc

@@ -0,0 +1,69 @@
+[[<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?
+When use it?
+What values can it use?
+What do these values do?
+Are there risks?
+  - Explain without using ‘risk’ or similar words.
+  - Use NOTE or IMPORTANT admonitions if helpful.
+  - For longer or more complicated scenarios, use the limitations section below.
+////
+
+*Type:* `+String+`, `+Boolean+`, `+Number+`, `+Function+`, `+Object+`, `+Array+`, or `+Regexp+`
+
+// Remove the *Possible values* line if there is no discrete set of possible values.
+*Possible values:* `'string1'`, `'string2'`, `false`
+
+*Default value:* `false`, `1`, `'string1'`
+
+=== Example: using `<configuration_option>`
+
+// Add a working and tested configuration.
+[source,js]
+----
+tinymce.init({
+  selector: 'textarea',  // change this value according to your html
+  <configuration_option>: '<value>'
+});
+----
+
+// Add a working and tested configuration (edit as required)
+// or remove if not applicable.
+=== Example: disabling the <feature>
+
+To disable <feature>, set `<configuration_option>` to `false`.
+
+[source,js]
+----
+tinymce.init({
+  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
+
+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.

-new-material-templates/integration-example-(ie)-templates/ROOT/examples/live-demos/ie-<hyphen-delimited-descriptor>/index.html

@@ -0,0 +1,15 @@
+<textarea id="<hyphen-delimited-descriptor>">
+  {{logofordemoshtml}}
+
+<!-- example html here -->
+
+  <h2>Found a bug?</h2>
+
+  <p>If you believe you have found a bug please create an issue on the <a href="https://github.com/tinymce/tinymce/issues">GitHub repo</a> to report it to the developers.</p>
+
+  <h2>Finally…</h2>
+
+  <p>Don’t forget to check out <a href="http://www.plupload.com" target="_blank">Plupload</a>, the upload solution featuring HTML5 upload support.</p>
+  <p>Thanks for supporting TinyMCE. We hope it helps you and your users create great content.</p>
+  <p>All the best from the TinyMCE team.</p>
+</textarea>

-new-material-templates/integration-example-(ie)-templates/ROOT/examples/live-demos/ie-<hyphen-delimited-descriptor>/index.js

@@ -0,0 +1,26 @@
+const content_style= `
+
+// In a more typical environment this constant would be a file, style.css,
+// referenced in the tinymce.init configuration with the content_css option.
+
+<css for the demo goes here>
+
+`;
+
+tinymce.init({
+  selector: 'textarea#<hyphen-delimited-descriptor>',
+// below is a basic 6.x working configuration.
+// Do not assume it is suitable for demonstrating the plugin to be documented.
+  height: 600,
+  plugins: [
+    'advlist', 'autolink', 'lists', 'link', 'image', 'charmap', 'preview',
+    'anchor', 'searchreplace', 'visualblocks', 'code', 'fullscreen',
+    'insertdatetime', 'media', 'table', 'help', 'wordcount'
+  ],
+  toolbar: 'undo redo | blocks | ' +
+  'bold italic backcolor | alignleft aligncenter ' +
+  'alignright alignjustify | bullist numlist outdent indent | ' +
+  'removeformat | help',
+  content_style, // must be here if you have <css for the demo> above.
+  newdocument_content // required — with actual material here — if your demo involves creating new documents.
+});

-new-material-templates/integration-example-(ie)-templates/ROOT/images/put-images-for-demos-here.adoc

@@ -0,0 +1,12 @@
+// The location of a given `index.html` file relative to this file’s
+// parent directory is not pertinent to the `<img>` tags’ `src`
+// attribute.
+// 
+// When a file, `image.png`, is placed in the `images` folder, the
+// `<img>` tag in a demo’s `index.html` file has the following structure:
+// 
+// <img src="{{imagesdir}}/ie-<hyphen-delimited-descriptor>/image.png" alt="<alt text>">
+// 
+// This file is instructional and is never included in the published
+// name-space.
+

-new-material-templates/integration-example-(ie)-templates/ROOT/nav.adoc

@@ -0,0 +1,5 @@
+* xref:examples.adoc[Examples]
+** xref:examples.adoc#integration-examples[Integration examples]
+// Replace the boilerplate below with the file-name of the new IE example.
+// Also, place this new IE example into alphabetical place within the Use case examples sub-section.
+*** xref:uce-<hyphen-delimited-descriptor>.adoc

-new-material-templates/integration-example-(ie)-templates/ROOT/pages/ie-<hyphen-delimited-descriptor>.adoc

@@ -0,0 +1,58 @@
+= Interactive integration example
+:navtitle: <descriptor>
+:description_short: <description-short>
+:description: <description>
+:keywords: example, demo, custom, <keyword1>, <keyword2>, <keywordn>
+
+{logofordemoshtml}
+
+== <descriptor>
+
+This interactive example demonstrates a basic working example of {productname} being used as a <descriptor>.
+
+It includes numerous plugins and configuration settings but highlights the following {productname} plugins and configuration options in particular:
+
+[cols="1,1"]
+|===
+
+a|
+[.lead]
+xref:<plugincode>.adoc[<Plugin name>]
+
+<plugin descriptor pulled from <plugincode>.adoc>
+
+a|
+[.lead]
+xref:<plugincode2>.adoc[<Plugin name 2>]
+
+<plugin descriptor pulled from <plugincode2>.adoc>
+
+a|
+[.lead]
+xref:content-behavior-options.adoc#<configuration_option>[`<configuration_option`]
+
+<configuration descriptor pulled from content-behavior-options.adoc#<configuration_option>.
+
+a|
+[.lead]
+xref:content-behavior-options.adoc#<configuration_option2>[`configuration_option2`]
+
+<configuration descriptor pulled from content-behavior-options.adoc#<configuration_option2>.
+
+a|
+[.lead]
+xref:content-behavior-options.adoc#<configuration_option3>[`configuration_option3`]
+
+<configuration descriptor pulled from content-behavior-options.adoc#<configuration_option3>.
+
+// Dummy table cell.
+// 1. Remove the inline comment markup pre-pending this
+//    element when the number of cells in the table is
+//    odd.
+// 2. Prepend the inline comment markup to this element
+//    when the number of cells in the table is even.
+//a|
+
+|===
+
+liveDemo::<ie-hyphen-delimited-descriptor>[]

-new-material-templates/integration-example-(ie)-templates/ROOT/partials/index-pages/integration-examples.adoc

@@ -0,0 +1,10 @@
+// Table row for an integration example.
+// Place this row into the extant table in `partials/index-pages/integration-examples.adoc` in alphabetical order.
+
+a|
+[.lead]
+ie-<hyphen-delimited-descriptor>.adoc[<descriptor>]
+
+<One sentence integration example description.>
+
+// This file is instructional and is never included in the published name-space.

-new-material-templates/plugin-documentation-templates/ROOT/examples/live-demos/<plugincode>/example.js

@@ -0,0 +1,30 @@
+/*
+
+This file is not normally required.
+
+Sometimes, however, a plugin, or a particular feature of a plugin,
+requires a back-end service.
+
+In these cases, creating a working demo requires setting up an
+emulated version of this service.
+
+And `example.js` is part of this emulation.
+
+`index.js` still runs the live demo.
+
+But `example.js` is what is displayed in the *js* tab of the
+live-demo interface on the built docs site.
+
+So `example.js` has to be a working equivalent to `index.js` *if*
+`index.js` was wired up in a standard way, to its required back-end
+service.
+
+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
+will almost certainly include significant initial input from the
+plugin’s developer.
+
+*/

-new-material-templates/plugin-documentation-templates/ROOT/examples/live-demos/<plugincode>/index.html

@@ -0,0 +1,15 @@
+<textarea id="<plugincode>">
+  {{logofordemoshtml}}
+
+<!-- example html here -->
+
+  <h2>Found a bug?</h2>
+
+  <p>If you believe you have found a bug please create an issue on the <a href="https://github.com/tinymce/tinymce/issues">GitHub repo</a> to report it to the developers.</p>
+
+  <h2>Finally…</h2>
+
+  <p>Don’t forget to check out <a href="http://www.plupload.com" target="_blank">Plupload</a>, the upload solution featuring HTML5 upload support.</p>
+  <p>Thanks for supporting TinyMCE. We hope it helps you and your users create great content.</p>
+  <p>All the best from the TinyMCE team.</p>
+</textarea>