Skip to content

Commit 6b230d8

Browse files
kemister85kemister85
committed
DOC-3243: Consolidate Export to PDF docs, improve clarity
- Merge exportpdf and exportpdf-v2 into single plugin page - Add backwards compatibility and conversion section - Add exportpdf_converter_options_combined partial (flat + nested formats) - Side-by-side demos (flat vs nested) in single exportpdf demo - Update JWT guides: remove v2 branding, add 8.4.0+ note, link to v1 for pre-8.4.0 - Add v1 JWT guides to nav (pre-8.4.0) - Rename HTML to PDF Converter API v2 to HTML to PDF Converter API - Fix exportpdf_converter_style example (invalid header structure) - Remove orphaned exportpdf_converter_options and exportpdf_converter_options_v2 partials
1 parent 2d6ca37 commit 6b230d8

13 files changed

+329
-293
lines changed

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

Lines changed: 88 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,7 @@
1-
<textarea id="exportpdf">
1+
<div style="display: flex; gap: 20px; width: 100%;">
2+
<div style="flex: 1; min-width: 0;">
3+
<h2>Flat format (backwards compatible)</h2>
4+
<textarea class="exportpdf-flat" style="width: 100%;">
25
<h1>Streamline - The Next-Gen Learning Management System (LMS)</h1>
36
<p>This document provides a comprehensive overview of the Streamline Learning Management System (LMS) project.</p>
47

@@ -75,4 +78,87 @@ <h2>Project Timeline</h2>
7578

7679
<h2>Conclusion</h2>
7780
<p>Streamline LMS is poised to become a game-changer in online education. By empowering educators and enhancing student experiences, it aims to make effective and accessible learning available to all.</p>
78-
</textarea>
81+
</textarea>
82+
</div>
83+
<div style="flex: 1; min-width: 0;">
84+
<h2>Nested format (v2)</h2>
85+
<textarea class="exportpdf-nested" style="width: 100%;">
86+
<h1>Streamline - The Next-Gen Learning Management System (LMS)</h1>
87+
<p>This document provides a comprehensive overview of the Streamline Learning Management System (LMS) project.</p>
88+
89+
<figure class="image">
90+
<img src="https://images.unsplash.com/photo-1522199755839-a2bacb67c546?q=80&amp;w=2072&amp;auto=format&amp;fit=crop&amp;ixlib=rb-4.0.3&amp;ixid=M3wxMjA3fDB8MHxwaG90by1wYWdlfHx8fGVufDB8fHx8fA%3D%3D"
91+
alt="A laptop on a polished wood table with a bronze cup, creating a warm workspace ambiance" width="573" height="429">
92+
<figcaption>An elegant workspace featuring a laptop on a polished wood table, accompanied by a bronze cup, creating a warm and productive atmosphere.</figcaption>
93+
</figure>
94+
95+
<p>Photo by <a href="https://unsplash.com/@anete_lusina">Anete Lūsiņa</a> on <a href="https://unsplash.com">Unsplash</a></p>
96+
97+
<h2>Project Goals</h2>
98+
<p>Streamline aims to revolutionize online learning by offering a robust and user-friendly platform for educators and learners. The primary goals include:</p>
99+
<ul>
100+
<li><strong>Empowering educators</strong> with intuitive tools for content creation, course management, and student assessment.</li>
101+
<li><strong>Enhancing the learning experience for students</strong> through engaging content delivery, interactive features, and personalized learning paths.</li>
102+
<li><strong>Increasing accessibility and scalability</strong> to cater to diverse learning needs and support a growing user base.</li>
103+
</ul>
104+
105+
<h2>System Features</h2>
106+
<p>Streamline is designed to enrich the learning process through a comprehensive set of features:</p>
107+
<ul>
108+
<li><strong>Content Management System (CMS)</strong>: An intuitive interface enabling educators to create and upload various learning materials, including videos, documents, presentations, and quizzes.</li>
109+
<li><strong>Course Management Tools</strong>: Structure courses with clear objectives, organize content modules, and manage student enrollments effectively.</li>
110+
<li><strong>Interactive Learning Activities</strong>: Includes gamification, discussion forums, collaborative assignments, and more to maintain student engagement.</li>
111+
<li><strong>Assessment & Analytics</strong>: Tools for creating quizzes, tracking student progress, generating reports, and identifying improvement areas.</li>
112+
<li><strong>Personalized Learning Paths</strong>: Machine learning algorithms provide tailored content recommendations based on student progress and needs.</li>
113+
</ul>
114+
115+
<h3>Table 1: Streamline - Target User Groups</h3>
116+
<table style="border-collapse: collapse; width: 100%;" border="1">
117+
<thead>
118+
<tr>
119+
<th style="text-align: left;">User Group</th>
120+
<th style="text-align: left;">Benefits</th>
121+
</tr>
122+
</thead>
123+
<tbody>
124+
<tr>
125+
<td><strong>Educators</strong></td>
126+
<td>Easy content creation, efficient course management, and valuable student insights.</td>
127+
</tr>
128+
<tr>
129+
<td><strong>Learners</strong></td>
130+
<td>Engaging learning experience, personalized learning paths, and interactive collaboration.</td>
131+
</tr>
132+
<tr>
133+
<td><strong>Administrators</strong></td>
134+
<td>Scalable platform management, user access control, and comprehensive reporting tools.</td>
135+
</tr>
136+
</tbody>
137+
</table>
138+
139+
<h2>Technology Stack</h2>
140+
<p>Streamline will leverage a robust technology stack to ensure performance, scalability, and security:</p>
141+
<ul>
142+
<li><strong>Front-End</strong>: ReactJS for a responsive and user-friendly interface.</li>
143+
<li><strong>Back-End</strong>: Node.js for efficient server-side operations.</li>
144+
<li><strong>Database</strong>: MongoDB for flexible and scalable data storage.</li>
145+
<li><strong>Cloud Platform</strong>: Amazon Web Services (AWS) for reliable hosting and infrastructure.</li>
146+
</ul>
147+
148+
<h2>Project Timeline</h2>
149+
<ul>
150+
<li><strong>Phase 1 (2 Months)</strong>: System design, core functionalities development, and front-end prototype creation.</li>
151+
<li><strong>Phase 2 (3 Months)</strong>: Integration of advanced features like personalized learning and assessment tools.</li>
152+
<li><strong>Phase 3 (1 Month)</strong>: Rigorous testing, bug fixing, and UI refinement.</li>
153+
<li><strong>Phase 4 (Ongoing)</strong>: Deployment, user feedback collection, and continuous iterative development.</li>
154+
</ul>
155+
156+
<blockquote>
157+
<p><em>This timeline is preliminary and may be subject to change.</em></p>
158+
</blockquote>
159+
160+
<h2>Conclusion</h2>
161+
<p>Streamline LMS is poised to become a game-changer in online education. By empowering educators and enhancing student experiences, it aims to make effective and accessible learning available to all.</p>
162+
</textarea>
163+
</div>
164+
</div>

‎modules/ROOT/examples/live-demos/exportpdf/index.js‎

Lines changed: 33 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
tinymce.init({
2-
selector: 'textarea#exportpdf',
2+
selector: 'textarea.exportpdf-flat',
33
height: '800px',
44
plugins: [
55
"exportpdf", "advlist", "anchor", "autolink", "charmap", "code", "codesample", "fullscreen",
@@ -16,3 +16,35 @@ tinymce.init({
1616
margin_left: '1in'
1717
}
1818
});
19+
20+
tinymce.init({
21+
selector: 'textarea.exportpdf-nested',
22+
height: '800px',
23+
plugins: [
24+
"exportpdf", "advlist", "anchor", "autolink", "charmap", "code", "codesample", "fullscreen",
25+
"help", "image", "insertdatetime", "link", "lists", "media",
26+
"preview", "searchreplace", "table", "visualblocks",
27+
],
28+
toolbar: "undo redo | exportpdf | styles | bold italic underline strikethrough | alignleft aligncenter alignright alignjustify | bullist numlist outdent indent | link image",
29+
image_caption: true,
30+
exportpdf_converter_options: {
31+
version: '2',
32+
document: {
33+
size: 'A4',
34+
orientation: 'portrait',
35+
margins: {
36+
top: '1in',
37+
right: '1in',
38+
bottom: '1in',
39+
left: '1in',
40+
enable_mirror_margins: true
41+
}
42+
},
43+
metadata: {
44+
title: 'Streamline LMS Overview',
45+
author: 'TinyMCE',
46+
subject: 'Learning Management System',
47+
keywords: [ 'LMS', 'education', 'Streamline' ]
48+
}
49+
}
50+
});

‎modules/ROOT/nav.adoc‎

Lines changed: 6 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -278,16 +278,13 @@
278278
**** xref:mediaembed-server-integration.adoc[Integrate Enhanced Media Embed Server]
279279
*** xref:advtable.adoc[Enhanced Tables]
280280
*** Export to PDF
281-
**** xref:exportpdf.adoc[Export to PDF v1]
282-
***** xref:html-to-pdf-converter-api.adoc[HTML to PDF Converter API]
281+
**** xref:exportpdf.adoc[Export to PDF]
282+
***** xref:html-to-pdf-converter-api-v2.adoc[HTML to PDF Converter API]
283283
***** JWT Authentication
284-
****** xref:export-to-pdf-with-jwt-authentication-nodejs.adoc[Node.js]
285-
****** xref:export-to-pdf-with-jwt-authentication-php.adoc[PHP]
286-
**** xref:exportpdf-v2.adoc[Export to PDF v2]
287-
***** xref:html-to-pdf-converter-api-v2.adoc[HTML to PDF Converter API v2]
288-
***** JWT Authentication
289-
****** xref:export-to-pdf-v2-with-jwt-authentication-nodejs.adoc[Node.js]
290-
****** xref:export-to-pdf-v2-with-jwt-authentication-php.adoc[PHP]
284+
****** xref:export-to-pdf-v2-with-jwt-authentication-nodejs.adoc[Node.js (8.4.0+)]
285+
****** xref:export-to-pdf-v2-with-jwt-authentication-php.adoc[PHP (8.4.0+)]
286+
****** xref:export-to-pdf-with-jwt-authentication-nodejs.adoc[Node.js (pre-8.4.0)]
287+
****** xref:export-to-pdf-with-jwt-authentication-php.adoc[PHP (pre-8.4.0)]
291288
*** xref:exportword.adoc[Export to Word]
292289
**** xref:html-to-docx-converter-api.adoc[HTML to DOCX Converter API]
293290
**** JWT Authentication

‎modules/ROOT/pages/8.4.0-release-notes.adoc‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -68,7 +68,7 @@ The {productname} {release-version} release includes an accompanying release of
6868

6969
`{productname}` `{release-version}` adds support for version `2` of the `exportpdf` API through `exportpdf_converter_options`. Version `1` remains the default for backward compatibility. The new nested structure organizes options under `document`, `headers`, `footers`, `metadata`, `security`, and `signature`, enabling per-page headers and footers, PDF metadata, password protection, and certificate-based signing.
7070

71-
For information on the **Export to PDF** plugin, see: xref:exportpdf-v2.adoc[Export to PDF v2] and xref:exportpdf.adoc[Export to PDF v1].
71+
For information on the **Export to PDF** plugin, see xref:exportpdf.adoc[Export to PDF].
7272

7373

7474
[[accompanying-premium-plugin-end-of-life-announcement]]

‎modules/ROOT/pages/export-to-pdf-v2-with-jwt-authentication-nodejs.adoc‎

Lines changed: 15 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,18 @@
1-
= {pluginname} with JWT authentication (Node.js) Guide – (v2)
1+
= {pluginname} with JWT authentication (Node.js) Guide
22
:plugincode: exportpdf
33
:pluginname: Export to PDF
4-
:navtitle: JWT Authentication setup for {pluginname} v2
5-
:description: Guide on how to setup JWT Authentication for exporting PDF files with {pluginname} (version 2)
6-
:keywords: jwt, authentication, exportpdf, pdf, node.js, v2
4+
:navtitle: JWT Authentication setup for {pluginname}
5+
:description: Guide on how to set up JWT authentication for exporting PDF files with {pluginname} using Node.js
6+
:keywords: jwt, authentication, exportpdf, pdf, node.js
77

88

99
include::partial$auth/document-converters/nodejs/intro-and-prerequisites.adoc[]
1010

11+
[NOTE]
12+
====
13+
This guide uses the nested format (`version: '2'`) for `exportpdf_converter_options`. Requires {productname} 8.4.0 or newer. For full option documentation, see xref:exportpdf.adoc[Export to PDF]. For integrators on older versions, see xref:export-to-pdf-with-jwt-authentication-nodejs.adoc[JWT Authentication setup for Export to PDF (Node.js) – flat format].
14+
====
15+
1116
include::partial$auth/document-converters/nodejs/initial-project-setup.adoc[]
1217

1318
== Setup
@@ -27,7 +32,7 @@ Inside the `public` folder where you created the `index.html` file add the HTML
2732
<!DOCTYPE html>
2833
<html>
2934
<head>
30-
<title>TinyMCE with Export to PDF v2</title>
35+
<title>TinyMCE with Export to PDF</title>
3136
<script
3237
src="https://cdn.tiny.cloud/1/no-api-key/tinymce/8/tinymce.min.js"
3338
referrerpolicy="origin"
@@ -62,7 +67,7 @@ Inside the `public` folder where you created the `index.html` file add the HTML
6267
</script>
6368
</head>
6469
<body>
65-
<h1>TinyMCE Export to PDF Demo (v2)</h1>
70+
<h1>TinyMCE Export to PDF Demo</h1>
6671
<textarea>
6772
Welcome to TinyMCE! Try the Export to PDF feature.
6873
</textarea>
@@ -71,3 +76,7 @@ Inside the `public` folder where you created the `index.html` file add the HTML
7176
----
7277

7378
include::partial$auth/document-converters/nodejs/configuration-steps.adoc[]
79+
80+
== Further configuration
81+
82+
For additional options such as per-page headers and footers, PDF metadata, and security settings, see the xref:exportpdf.adoc#exportpdf-converter-options[`exportpdf_converter_options`] section on the Export to PDF plugin page.

‎modules/ROOT/pages/export-to-pdf-v2-with-jwt-authentication-php.adoc‎

Lines changed: 15 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,17 @@
1-
= {pluginname} with JWT authentication (PHP) Guide – (v2)
2-
:navtitle: JWT Authentication setup for Export to PDF v2
3-
:description: Guide on how to setup JWT Authentication for exporting PDF files with {productname} (version 2)
4-
:keywords: jwt, authentication, exportpdf, pdf, php, v2
1+
= {pluginname} with JWT authentication (PHP) Guide
52
:pluginname: Export to PDF
63
:plugincode: exportpdf
4+
:navtitle: JWT Authentication setup for {pluginname}
5+
:description: Guide on how to set up JWT authentication for exporting PDF files with {pluginname} using PHP
6+
:keywords: jwt, authentication, exportpdf, pdf, php
77

88
include::partial$auth/document-converters/php/intro-and-prerequisites.adoc[]
99

10+
[NOTE]
11+
====
12+
This guide uses the nested format (`version: '2'`) for `exportpdf_converter_options`. Requires {productname} 8.4.0 or newer. For full option documentation, see xref:exportpdf.adoc[Export to PDF]. For integrators on older versions, see xref:export-to-pdf-with-jwt-authentication-php.adoc[JWT Authentication setup for Export to PDF (PHP) – flat format].
13+
====
14+
1015
include::partial$auth/document-converters/php/initial-project-setup.adoc[]
1116

1217
== Setup
@@ -26,7 +31,7 @@ Inside the `public` folder where you created the `index.html` file add the HTML
2631
<!DOCTYPE html>
2732
<html>
2833
<head>
29-
<title>TinyMCE with PDF Export (v2)</title>
34+
<title>TinyMCE with Export to PDF</title>
3035
<script
3136
src="https://cdn.tiny.cloud/1/no-api-key/tinymce/8/tinymce.min.js"
3237
referrerpolicy="origin"
@@ -60,7 +65,7 @@ Inside the `public` folder where you created the `index.html` file add the HTML
6065
</script>
6166
</head>
6267
<body>
63-
<h1>TinyMCE Export to PDF Demo (v2)</h1>
68+
<h1>TinyMCE Export to PDF Demo</h1>
6469
<textarea>
6570
Welcome to TinyMCE! Try the Export to PDF feature.
6671
</textarea>
@@ -69,3 +74,7 @@ Inside the `public` folder where you created the `index.html` file add the HTML
6974
----
7075

7176
include::partial$auth/document-converters/php/configuration-steps.adoc[]
77+
78+
== Further configuration
79+
80+
For additional options such as per-page headers and footers, PDF metadata, and security settings, see the xref:exportpdf.adoc#exportpdf-converter-options[`exportpdf_converter_options`] section on the Export to PDF plugin page.

‎modules/ROOT/pages/exportpdf-v2.adoc‎

Lines changed: 0 additions & 117 deletions
This file was deleted.

0 commit comments

Comments
 (0)