Skip to content

DOC-3243: Add new exportpdf v2 converter documentation.#4005

Open
kemister85 wants to merge 4 commits intofeature/8/DOC-3243from
feature/8/DOC-3243_TINY-13700
Open

DOC-3243: Add new exportpdf v2 converter documentation.#4005
kemister85 wants to merge 4 commits intofeature/8/DOC-3243from
feature/8/DOC-3243_TINY-13700

Conversation

@kemister85
Copy link
Contributor

@kemister85 kemister85 commented Mar 6, 2026

Ticket: DOC-3243 (TINY-13700)

Site: Staging branch

Changes:

Export to PDF plugin

  • Single plugin page with backwards compatibility and conversion section (flat vs nested formats, same v2 API endpoint)
  • exportpdf_converter_options_combined.adoc – documents both flat and nested formats with "Which format to use" guide
  • Side-by-side demo (flat format | nested format) in single exportpdf demo, modeled on advcode

JWT guides

  • Node.js and PHP guides for 8.4.0+ (nested format)
  • Nav includes JWT guides for 8.4.0+ and pre-8.4.0 (flat format)
  • "Further configuration" section linking to converter options

HTML to PDF Converter API

  • Standalone service page for the current API (nested format, per-page headers, metadata)

Fixes

  • exportpdf_converter_style example: corrected invalid header structure to header_html / header_and_footer_css
  • Grammar: "allow" → "allows" in exportpdf_converter_style

On-premises

  • IMPORTANT notes: Docker image must support v2 API for 8.4.0+
  • Locations: exportpdf_service_url, export-to-pdf-overview, exportpdf_converter_options_combined

Pre-checks:

  • Branch prefixed with feature/<version>/, hotfix/<version>/, staging/<version>/, or release/<version>/.
  • modules/ROOT/nav.adoc has been updated (if applicable).
  • Included a release note entry for any New product features.
  • If this is a minor release, updated productminorversion in antora.yml and added new supported versions entry in modules/ROOT/partials/misc/supported-versions.adoc.

Review:

  • Documentation Team Lead has reviewed

@kemister85 kemister85 added this to the TinyMCE 8.4.0 milestone Mar 6, 2026
@kemister85 kemister85 added the upcoming release Documentation for features currently under development/QA label Mar 6, 2026
@kemister85 kemister85 requested review from a team, TheSpyder, lorenzo-pomili, ltrouton, metricjs and tiny-ben-tran and removed request for a team March 6, 2026 07:38
cdnurl: https://cdn.tiny.cloud/1/no-api-key/tinymce/8/tinymce.min.js
tdcdnurl: https://cdn.tiny.cloud/1/_your_api_key_/tinydrive/8/tinydrive.min.js
tinymce_live_demo_url: https://cdn.tiny.cloud/1/qagffr3pkuv17a8on1afax661irst1hbr4e6tbv888sz91jc/tinymce/8/tinymce.min.js
tinymce_live_demo_url: https://cdn.tiny.cloud/1/qagffr3pkuv17a8on1afax661irst1hbr4e6tbv888sz91jc/tinymce/8-dev/tinymce.min.js
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

  • Revert before merging- only used for demo testing
Suggested change
tinymce_live_demo_url: https://cdn.tiny.cloud/1/qagffr3pkuv17a8on1afax661irst1hbr4e6tbv888sz91jc/tinymce/8-dev/tinymce.min.js
tinymce_live_demo_url: https://cdn.tiny.cloud/1/qagffr3pkuv17a8on1afax661irst1hbr4e6tbv888sz91jc/tinymce/8/tinymce.min.js

@kemister85 kemister85 marked this pull request as ready for review March 6, 2026 07:40
@kemister85 kemister85 requested review from a team and soritaheng as code owners March 6, 2026 07:40
@kemister85 kemister85 requested review from EkimChau, MitchC1999 and tiny-james and removed request for a team March 6, 2026 07:40
Copy link
Contributor

@lorenzo-pomili lorenzo-pomili left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

do we have any note about on-premises that say that they need to upgrade their docker to a version that supports v2 of the API?

right: '1in',
bottom: '1in',
left: '1in',
enable_mirror_margins: true
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

the effect of this one would be more clear if the margin right and left are different, with the same margin this does nothing

- 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
- exportpdf_service_url: IMPORTANT note about v2-compatible Docker image
- export-to-pdf-overview: IMPORTANT note with changelog link
- exportpdf_converter_options_combined: Expand NOTE for on-premises
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

upcoming release Documentation for features currently under development/QA

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants