Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

DOC-2498: Improve Document Converter default value for <pluginname>converter-options #3489

Open
wants to merge 2 commits into
base: feature/7.5/DOC-2498
Choose a base branch
from
+112 −4
Open

DOC-2498: Improve Document Converter default value for <pluginname>converter-options #3489

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
b517d51
DOC-2498: Added default values for document converter plugins.
kemister85 Oct 24, 2024
0a9023a
DOC-2498: Update default values in plugin.adoc pages.
kemister85 Oct 24, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
69 changes: 69 additions & 0 deletions modules/ROOT/pages/7.5-release-notes.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -69,6 +69,75 @@ The {productname} {release-version} release includes an accompanying release of

For information on the **<Premium plugin name 1>** plugin, see: xref:<plugincode>.adoc[<Premium plugin name 1>].

=== Export to PDF

The {productname} {release-version} release includes an accompanying release of the **Export to PDF** premium plugin.

**Export to PDF** Premium plugin includes the following improvement.

=== Added a default value for the `exportpdf_converter_options` option.
// #TINY-11396

As of {productname} {release-version}, the **Export to PDF** Plugin now defaults to U.S. letter page size and applies standard 1-inch margins, ensuring consistency in document formatting out of the box for integrators. The following settings have been applied:

[source,js]
----
exportpdf_converter_options: {
format: 'Letter',
margin_top: '1in',
margin_right: '1in',
margin_bottom: '1in',
margin_left: '1in'
}
----

For information on the **Export to PDF** plugin, see: xref:exportpdf.adoc[Export to PDF].

=== Export to Word

The {productname} {release-version} release includes an accompanying release of the **Export to Word** premium plugin.

**Export to Word** Premium plugin includes the following improvement.

=== Added a default value for the `exportword_converter_options` option.
// #TINY-11396

As of {productname} {release-version}, the **Export to Word** Plugin has been updated to default to the U.S. letter page size, improving compatibility with standard document formats, providing a better out-of-the-box experience for integrators. The following setting has been applied:

[source,js]
----
exportword_converter_options: {
document: {
size: 'letter'
}
}
----

For information on the **Export to Word** plugin, see: xref:exportword.adoc[Export to Word].

=== Import from Word

The {productname} {release-version} release includes an accompanying release of the **Import from Word** premium plugin.

**Import from Word** Premium plugin includes the following improvement.

=== Added a default value for the `importword_converter_options` option.
// #TINY-11396

As of {productname} {release-version}, the **Import from Word** Plugin now defaults to retaining as much original Word document styling as possible, using the following settings:

[source,js]
----
importword_converter_options: {
formatting: {
styles: 'inline',
resets: 'inline',
defaults: 'inline',
}
}
----

For information on the **Import from Word** plugin, see: xref:importword.adoc[Import from Word].

[[accompanying-premium-plugin-end-of-life-announcement]]
== Accompanying Premium plugin end-of-life announcement
Expand Down
17 changes: 15 additions & 2 deletions modules/ROOT/partials/configuration/exportpdf.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,9 +28,22 @@ tinymce.init({

This option allows the editor to download a PDF document containing its content, along with the specified options defined in the `exportpdf_converter_options`.

*Type:* `+Object+`
**Type:** `+Object+`

*Default value:* `{}`
[NOTE]
As of {productname} 7.5.0, the default value of the `exportpdf_converter_options` setting has been updated to the following:
Copy link
Contributor

@FarzadHayat FarzadHayat Oct 28, 2024 •
edited
Loading

Choose a reason for hiding this comment

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

Might be useful to hint at the fact that there was pretty much no previous default value (i.e. {}), for anyone who might be looking at docs and wondering what the default value was before TinyMCE 7.5.0. Would need to do the same for the other two converters.

Suggested change
As of {productname} 7.5.0, the default value of the `exportpdf_converter_options` setting has been updated to the following:
As of {productname} 7.5.0, the `exportpdf_converter_options` setting now comes with a default value set to the following:


.**Default value:**
[source,js]
----
exportpdf_converter_options: {
format: 'Letter',
margin_top: '1in',
margin_right: '1in',
margin_bottom: '1in',
margin_left: '1in'
}
----

=== Example: using `exportpdf_converter_options`

Expand Down
15 changes: 13 additions & 2 deletions modules/ROOT/partials/configuration/exportword.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,9 +31,20 @@ tinymce.init({

The `exportword_converter_options` option, is used to specify and configure various options related to the process of converting and exporting content from the editor to `.docx` Word file.

*Type:* `+Object+`
**Type:** `+Object+`

*Default value:* `{}`
[NOTE]
As of {productname} 7.5.0, the default value of the `exportword_converter_options` setting has been updated to the following:

.**Default value:**
[source,js]
----
exportword_converter_options: {
document: {
size: 'letter'
}
}
----

=== Example: using `exportword_converter_options`

Expand Down
15 changes: 15 additions & 0 deletions modules/ROOT/partials/configuration/importword-converter-options.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,21 @@

**Type:** `String`

[NOTE]
As of {productname} 7.5.0, the default value of the `importword_converter_options` setting has been updated to the following:

.**Default value:**
[source,js]
----
importword_converter_options: {
formatting: {
styles: 'inline',
resets: 'inline',
defaults: 'inline',
}
}
----

The `importword_converter_options` setting allows you to customize the behavior of the {pluginname} plugin when converting Word documents to HTML.

.Example: using `importword_converter_options`
Expand Down
Loading