Skip to content

Commit 5027e07

Browse files
kemister85kemister85
committed
DOC-3264: New feature documentation for fullpagehtml.
1 parent 942ba64 commit 5027e07

File tree

14 files changed

+192
-0
lines changed

14 files changed

+192
-0
lines changed

‎modules/ROOT/examples/live-demos/fullpage/demo.js‎

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
tinymce.init({
2+
selector: 'textarea#fullpage',
3+
height: '800px',
4+
plugins: [
5+
"fullpage", "advlist", "anchor", "autolink", "charmap", "code", "fullscreen",
6+
"help", "image", "insertdatetime", "link", "lists", "media",
7+
"preview", "searchreplace", "table", "visualblocks",
8+
],
9+
menubar: 'file',
10+
toolbar: "undo redo | fullpage | styles | bold italic underline strikethrough | alignleft aligncenter alignright alignjustify | bullist numlist outdent indent | link image",
11+
// Full Page Plugin Configuration Options
12+
fullpage_default_doctype: '<!DOCTYPE html>', // Has default in source code
13+
fullpage_default_title: 'Full Page Plugin Demo Document', // No default in source code
14+
fullpage_default_encoding: 'UTF-8', // No default in source code
15+
fullpage_default_body_style: 'margin: 20px; padding: 15px; font-family: Georgia, Times, serif; font-size: 16px; color: #2c3e50;' // No default in source code
16+
});

‎modules/ROOT/examples/live-demos/fullpage/index.html‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
<textarea id="fullpage">
2+
<h1>Full Page Plugin Demo</h1>
3+
</textarea>

‎modules/ROOT/nav.adoc‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -315,6 +315,7 @@
315315
**** JWT Authentication
316316
***** xref:export-to-word-with-jwt-authentication-nodejs.adoc[Node.js]
317317
***** xref:export-to-word-with-jwt-authentication-php.adoc[PHP]
318+
*** xref:fullpage.adoc[Full Page]
318319
*** xref:footnotes.adoc[Footnotes]
319320
*** xref:formatpainter.adoc[Format Painter]
320321
*** xref:importword.adoc[Import from Word]

‎modules/ROOT/pages/available-menu-items.adoc‎

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -100,6 +100,12 @@ include::partial$misc/plugin-menu-item-id-boilerplate.adoc[]
100100
:plugincode: emoticons
101101
include::partial$misc/plugin-menu-item-id-boilerplate.adoc[]
102102

103+
:plugincategory: premium
104+
:pluginname: Full Page
105+
:plugincode: fullpage
106+
:pluginpage: fullpage.adoc
107+
include::partial$misc/plugin-menu-item-id-boilerplate.adoc[]
108+
103109
:plugincategory: premium
104110
:pluginname: Export to PDF
105111
:plugincode: exportpdf

‎modules/ROOT/pages/available-toolbar-buttons.adoc‎

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -112,6 +112,12 @@ include::partial$misc/plugin-toolbar-button-id-boilerplate.adoc[]
112112
:plugincode: emoticons
113113
include::partial$misc/plugin-toolbar-button-id-boilerplate.adoc[]
114114

115+
:plugincategory: premium
116+
:pluginname: Full Page
117+
:plugincode: fullpage
118+
:pluginpage: fullpage.adoc
119+
include::partial$misc/plugin-toolbar-button-id-boilerplate.adoc[]
120+
115121
:plugincategory: premium
116122
:pluginname: Export to PDF
117123
:plugincode: exportpdf

‎modules/ROOT/pages/fullpage.adoc‎

Lines changed: 54 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,54 @@
1+
= Full Page Plugin
2+
:navtitle: Full Page
3+
:description: Edit metadata and document properties including title, keywords, and description via a dialog box, with HTML structure exposure in source code view.
4+
:description_short: Edit document metadata and properties with dialog interface and source code exposure.
5+
:keywords: full page, metadata, document properties, title, keywords, description, HTML structure, source code
6+
:pluginname: Full Page
7+
:plugincode: fullpage
8+
:plugincategory: premium
9+
10+
include::partial$misc/admon-premium-plugin.adoc[]
11+
12+
The {pluginname} plugin provides comprehensive control over document metadata and properties. It enables users to edit HTML document metadata such as title, keywords, and description through an intuitive dialog interface. When combined with the code plugin, it also exposes the complete HTML structure including `<head>`, `<body>`, and various meta tags in the source code view.
13+
14+
15+
== Interactive example
16+
17+
18+
liveDemo::{plugincode}[]
19+
20+
== Basic setup
21+
22+
To add the {pluginname} plugin to the editor, add `{plugincode}` to the `plugins` option in the editor configuration.
23+
24+
For example:
25+
26+
[source,js]
27+
----
28+
tinymce.init({
29+
selector: 'textarea', // change this value according to your HTML
30+
plugins: 'fullpage',
31+
toolbar: 'fullpage',
32+
fullpage_default_doctype: '<!DOCTYPE html>'
33+
});
34+
----
35+
36+
== Options
37+
38+
The following configuration options affect the behavior of the {pluginname} plugin.
39+
40+
include::partial$configuration/fullpage-default-doctype.adoc[leveloffset=+1]
41+
42+
include::partial$configuration/fullpage-default-title.adoc[leveloffset=+1]
43+
44+
include::partial$configuration/fullpage-default-encoding.adoc[leveloffset=+1]
45+
46+
include::partial$configuration/fullpage-default-body-style.adoc[leveloffset=+1]
47+
48+
include::partial$misc/plugin-toolbar-button-id-boilerplate.adoc[]
49+
50+
include::partial$toolbar-button-ids/{plugincode}-toolbar-buttons.adoc[leveloffset=+1]
51+
52+
include::partial$misc/plugin-menu-item-id-boilerplate.adoc[]
53+
54+
include::partial$menu-item-ids/{plugincode}-menu-items.adoc[leveloffset=+1]

‎modules/ROOT/pages/how-to-guides.adoc‎

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -91,6 +91,12 @@ xref:events.adoc[Available Events]
9191

9292
List of common editor events
9393

94+
a|
95+
[.lead]
96+
xref:fullpage.adoc[Full Page Plugin]
97+
98+
Edit document metadata and properties including title, keywords, and description via dialog interface.
99+
94100
a|
95101
[.lead]
96102
xref:keyboard-shortcuts.adoc[Keyboard shortcuts]

‎modules/ROOT/partials/configuration/fullpage-default-body-style.adoc‎

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
[[fullpage-default-body-style]]
2+
== `+fullpage_default_body_style+`
3+
4+
This option enables you to specify the default CSS styles for the body element.
5+
6+
*Type:* `+String+`
7+
8+
*Possible values:* Any valid CSS style string
9+
10+
*Default value:* No default value (empty string)
11+
12+
=== Example: using `+fullpage_default_body_style+`
13+
14+
[source,js]
15+
----
16+
tinymce.init({
17+
selector: 'textarea',
18+
plugins: 'fullpage',
19+
fullpage_default_body_style: 'margin: 20px; padding: 10px; font-family: Arial, sans-serif;'
20+
});
21+
----

‎modules/ROOT/partials/configuration/fullpage-default-doctype.adoc‎

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
[[fullpage-default-doctype]]
2+
== `+fullpage_default_doctype+`
3+
4+
This option enables you to specify the default doctype for the output HTML.
5+
6+
*Type:* `+String+`
7+
8+
*Possible values:* `+'<!DOCTYPE html>'+`
9+
10+
*Default value:* `+'<!DOCTYPE html>'+`
11+
12+
=== Example: using `+fullpage_default_doctype+`
13+
14+
[source,js]
15+
----
16+
tinymce.init({
17+
selector: 'textarea',
18+
plugins: 'fullpage',
19+
fullpage_default_doctype: '<!DOCTYPE html>'
20+
});
21+
----

‎modules/ROOT/partials/configuration/fullpage-default-encoding.adoc‎

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
[[fullpage-default-encoding]]
2+
== `+fullpage_default_encoding+`
3+
4+
This option enables you to specify the default encoding for the output HTML.
5+
6+
*Type:* `+String+`
7+
8+
*Possible values:* Any string value representing a character encoding
9+
10+
*Default value:* No default value (empty string)
11+
12+
=== Example: using `+fullpage_default_encoding+`
13+
14+
[source,js]
15+
----
16+
tinymce.init({
17+
selector: 'textarea',
18+
plugins: 'fullpage',
19+
fullpage_default_encoding: 'ISO-8859-1'
20+
});
21+
----

0 commit comments

Comments
 (0)