Skip to content

Commit 22be0a9

Browse files
kemister85Farzad Hayat
andauthored
DOC-2498: Improve Document Converter default value for <pluginname>converter-options (#3489)
* DOC-2498: Added default values for document converter plugins. * DOC-2498: Update default values in plugin.adoc pages. * Update modules/ROOT/partials/configuration/exportpdf.adoc Co-authored-by: Farzad Hayat <[email protected]> --------- Co-authored-by: Farzad Hayat <[email protected]>
1 parent dffd577 commit 22be0a9

File tree

4 files changed

+113
-5
lines changed

4 files changed

+113
-5
lines changed

modules/ROOT/pages/7.5-release-notes.adoc

Lines changed: 70 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -69,6 +69,76 @@ The {productname} {release-version} release includes an accompanying release of
6969

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

72+
=== Export to PDF
73+
74+
The {productname} {release-version} release includes an accompanying release of the **Export to PDF** premium plugin.
75+
76+
**Export to PDF** Premium plugin includes the following improvement.
77+
78+
=== Added a default value for the `exportpdf_converter_options` option.
79+
// #TINY-11396
80+
81+
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:
82+
83+
[source,js]
84+
----
85+
exportpdf_converter_options: {
86+
format: 'Letter',
87+
margin_top: '1in',
88+
margin_right: '1in',
89+
margin_bottom: '1in',
90+
margin_left: '1in'
91+
}
92+
----
93+
94+
For information on the **Export to PDF** plugin, see: xref:exportpdf.adoc[Export to PDF].
95+
96+
=== Export to Word
97+
98+
The {productname} {release-version} release includes an accompanying release of the **Export to Word** premium plugin.
99+
100+
**Export to Word** Premium plugin includes the following improvement.
101+
102+
=== Added a default value for the `exportword_converter_options` option.
103+
// #TINY-11396
104+
105+
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:
106+
107+
[source,js]
108+
----
109+
exportword_converter_options: {
110+
document: {
111+
size: 'letter'
112+
}
113+
}
114+
----
115+
116+
For information on the **Export to Word** plugin, see: xref:exportword.adoc[Export to Word].
117+
118+
=== Import from Word
119+
120+
The {productname} {release-version} release includes an accompanying release of the **Import from Word** premium plugin.
121+
122+
**Import from Word** Premium plugin includes the following improvement.
123+
124+
=== Added a default value for the `importword_converter_options` option.
125+
// #TINY-11396
126+
127+
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:
128+
129+
[source,js]
130+
----
131+
importword_converter_options: {
132+
formatting: {
133+
styles: 'inline',
134+
resets: 'inline',
135+
defaults: 'inline',
136+
}
137+
}
138+
----
139+
140+
For information on the **Import from Word** plugin, see: xref:importword.adoc[Import from Word].
141+
72142
=== Markdown
73143

74144
The {productname} {release-version} release includes an accompanying release of the **Markdown** premium plugin.
@@ -118,7 +188,6 @@ In {productname} {release-version}, the `tinycomments_author` and `tinycomments_
118188

119189
For information on the **Comments** plugin, see: xref:introduction-to-tiny-comments.adoc[Introduction to {companyname} Comments].
120190

121-
122191
[[accompanying-premium-plugin-end-of-life-announcement]]
123192
== Accompanying Premium plugin end-of-life announcement
124193

modules/ROOT/partials/configuration/exportpdf.adoc

Lines changed: 15 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -28,9 +28,22 @@ tinymce.init({
2828

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

31-
*Type:* `+Object+`
31+
**Type:** `+Object+`
3232

33-
*Default value:* `{}`
33+
[NOTE]
34+
As of {productname} 7.5.0, the `exportpdf_converter_options` setting now comes with a default value set to the following:
35+
36+
.**Default value:**
37+
[source,js]
38+
----
39+
exportpdf_converter_options: {
40+
format: 'Letter',
41+
margin_top: '1in',
42+
margin_right: '1in',
43+
margin_bottom: '1in',
44+
margin_left: '1in'
45+
}
46+
----
3447

3548
=== Example: using `exportpdf_converter_options`
3649

modules/ROOT/partials/configuration/exportword.adoc

Lines changed: 13 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -31,9 +31,20 @@ tinymce.init({
3131

3232
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.
3333

34-
*Type:* `+Object+`
34+
**Type:** `+Object+`
3535

36-
*Default value:* `{}`
36+
[NOTE]
37+
As of {productname} 7.5.0, the default value of the `exportword_converter_options` setting has been updated to the following:
38+
39+
.**Default value:**
40+
[source,js]
41+
----
42+
exportword_converter_options: {
43+
document: {
44+
size: 'letter'
45+
}
46+
}
47+
----
3748

3849
=== Example: using `exportword_converter_options`
3950

modules/ROOT/partials/configuration/importword-converter-options.adoc

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,21 @@
33

44
**Type:** `String`
55

6+
[NOTE]
7+
As of {productname} 7.5.0, the default value of the `importword_converter_options` setting has been updated to the following:
8+
9+
.**Default value:**
10+
[source,js]
11+
----
12+
importword_converter_options: {
13+
formatting: {
14+
styles: 'inline',
15+
resets: 'inline',
16+
defaults: 'inline',
17+
}
18+
}
19+
----
20+
621
The `importword_converter_options` setting allows you to customize the behavior of the {pluginname} plugin when converting Word documents to HTML.
722

823
.Example: using `importword_converter_options`

0 commit comments

Comments
 (0)