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.

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

[RELEASE_8.8.0 & RELEASE_8.7.0] Add new fields for LibreOfficeBuilder #97

Merged
Merged
Show file tree
Hide file tree
Changes from 2 commits
Commits
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
17 changes: 9 additions & 8 deletions docs/Pdf/HtmlPdfBuilder.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,12 @@ HtmlPdfBuilder
* `contentFile(string $path)`:
The HTML file to convert into PDF.

* `cookies(array $cookies)`:

* `setCookie(string $key, Symfony\Component\HttpFoundation\Cookie|array $cookie)`:

* `forwardCookie(string $name)`:

* `singlePage(bool $bool)`:
Define whether to print the entire content in one single page.
If the singlePage form field is set to true, it automatically overrides the values from the paperHeight and nativePageRanges form fields.
Expand Down Expand Up @@ -89,14 +95,6 @@ For instance: "window.status === 'ready'".
* `emulatedMediaType(Sensiolabs\GotenbergBundle\Enumeration\EmulatedMediaType $mediaType)`:
Forces Chromium to emulate, either "screen" or "print". (default "print").

* `cookies(array $cookies)`:
Cookies to store in the Chromium cookie jar. (overrides any previous cookies).

* `setCookie(string $key, array $cookie)`:

* `addCookies(array $cookies)`:
Add cookies to store in the Chromium cookie jar.

* `extraHttpHeaders(array $headers)`:
Sets extra HTTP headers that Chromium will send when loading the HTML
document. (default None). (overrides any previous headers).
Expand Down Expand Up @@ -129,3 +127,6 @@ The metadata to write.

* `fileName(string $fileName, string $headerDisposition)`:

* `addCookies(array $cookies)`:
Add cookies to store in the Chromium cookie jar.

51 changes: 51 additions & 0 deletions docs/Pdf/LibreOfficePdfBuilder.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,5 +32,56 @@ Resets the metadata.
* `addMetadata(string $key, string $value)`:
The metadata to write.

* `allowDuplicateFieldNames(bool $bool)`:
Specify whether multiple form fields exported are allowed to have the same field name.

* `exportBookmarks(bool $bool)`:
Specify if bookmarks are exported to PDF.

* `exportBookmarksToPdfDestination(bool $bool)`:
Specify that the bookmarks contained in the source LibreOffice file should be exported to the PDF file as Named Destination.

* `exportPlaceholders(bool $bool)`:
Export the placeholders fields visual markings only. The exported placeholder is ineffective.

* `exportNotes(bool $bool)`:
Specify if notes are exported to PDF.

* `exportNotesPages(bool $bool)`:
Specify if notes pages are exported to PDF. Notes pages are available in Impress documents only.

* `exportOnlyNotesPages(bool $bool)`:
Specify, if the form field exportNotesPages is set to true, if only notes pages are exported to PDF.

* `exportNotesInMargin(bool $bool)`:
Specify if notes in margin are exported to PDF.

* `convertOooTargetToPdfTarget(bool $bool)`:
Specify that the target documents with .od[tpgs] extension, will have that extension changed to .pdf when the link is exported to PDF. The source document remains untouched.

* `exportLinksRelativeFsys(bool $bool)`:
Specify that the file system related hyperlinks (file:// protocol) present in the document will be exported as relative to the source document location.

* `exportHiddenSlides(bool $bool)`:
Export, for LibreOffice Impress, slides that are not included in slide shows.

* `skipEmptyPages(bool $bool)`:
Specify that automatically inserted empty pages are suppressed. This option is active only if storing Writer documents.

* `addOriginalDocumentAsStream(bool $bool)`:
Specify that a stream is inserted to the PDF file which contains the original document for archiving purposes.

* `losslessImageCompression(bool $bool)`:
Specify if images are exported to PDF using a lossless compression format like PNG or compressed using the JPEG format.

* `quality(int $quality)`:
Specify the quality of the JPG export. A higher value produces a higher-quality image and a larger file. Between 1 and 100.

* `reduceImageResolution(bool $bool)`:
Specify if the resolution of each image is reduced to the resolution specified by the form field maxImageResolution.

* `maxImageResolution(int $resolution)`:
If the form field reduceImageResolution is set to true, tell if all images will be reduced to the given value in DPI. Possible values are: 75, 150, 300, 600 and 1200.

* `fileName(string $fileName, string $headerDisposition)`:

17 changes: 9 additions & 8 deletions docs/Pdf/MarkdownPdfBuilder.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,12 @@ The HTML file that wraps the markdown content.

* `files(string $paths)`:

* `cookies(array $cookies)`:

* `setCookie(string $key, Symfony\Component\HttpFoundation\Cookie|array $cookie)`:

* `forwardCookie(string $name)`:

* `singlePage(bool $bool)`:
Define whether to print the entire content in one single page.
If the singlePage form field is set to true, it automatically overrides the values from the paperHeight and nativePageRanges form fields.
Expand Down Expand Up @@ -92,14 +98,6 @@ For instance: "window.status === 'ready'".
* `emulatedMediaType(Sensiolabs\GotenbergBundle\Enumeration\EmulatedMediaType $mediaType)`:
Forces Chromium to emulate, either "screen" or "print". (default "print").

* `cookies(array $cookies)`:
Cookies to store in the Chromium cookie jar. (overrides any previous cookies).

* `setCookie(string $key, array $cookie)`:

* `addCookies(array $cookies)`:
Add cookies to store in the Chromium cookie jar.

* `extraHttpHeaders(array $headers)`:
Sets extra HTTP headers that Chromium will send when loading the HTML
document. (default None). (overrides any previous headers).
Expand Down Expand Up @@ -132,3 +130,6 @@ The metadata to write.

* `fileName(string $fileName, string $headerDisposition)`:

* `addCookies(array $cookies)`:
Add cookies to store in the Chromium cookie jar.

17 changes: 9 additions & 8 deletions docs/Pdf/UrlPdfBuilder.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,12 @@ URL of the page you want to convert into PDF.

* `route(string $name, array $parameters)`:

* `cookies(array $cookies)`:

* `setCookie(string $key, Symfony\Component\HttpFoundation\Cookie|array $cookie)`:

* `forwardCookie(string $name)`:

* `singlePage(bool $bool)`:
Define whether to print the entire content in one single page.
If the singlePage form field is set to true, it automatically overrides the values from the paperHeight and nativePageRanges form fields.
Expand Down Expand Up @@ -91,14 +97,6 @@ For instance: "window.status === 'ready'".
* `emulatedMediaType(Sensiolabs\GotenbergBundle\Enumeration\EmulatedMediaType $mediaType)`:
Forces Chromium to emulate, either "screen" or "print". (default "print").

* `cookies(array $cookies)`:
Cookies to store in the Chromium cookie jar. (overrides any previous cookies).

* `setCookie(string $key, array $cookie)`:

* `addCookies(array $cookies)`:
Add cookies to store in the Chromium cookie jar.

* `extraHttpHeaders(array $headers)`:
Sets extra HTTP headers that Chromium will send when loading the HTML
document. (default None). (overrides any previous headers).
Expand Down Expand Up @@ -131,3 +129,6 @@ The metadata to write.

* `fileName(string $fileName, string $headerDisposition)`:

* `addCookies(array $cookies)`:
Add cookies to store in the Chromium cookie jar.

19 changes: 10 additions & 9 deletions docs/Screenshot/HtmlScreenshotBuilder.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,12 @@ HtmlScreenshotBuilder
* `contentFile(string $path)`:
The HTML file to convert into Screenshot.

* `cookies(array $cookies)`:

* `setCookie(string $key, Symfony\Component\HttpFoundation\Cookie|array $cookie)`:

* `forwardCookie(string $name)`:

* `width(int $width)`:
The device screen width in pixels. (Default 800).

Expand Down Expand Up @@ -37,17 +43,9 @@ Sets the JavaScript expression to wait before converting an HTML
document to screenshot until it returns true. (default None).
For instance: "window.status === 'ready'".

* `emulatedMediaType(string $mediaType)`:
* `emulatedMediaType(Sensiolabs\GotenbergBundle\Enumeration\EmulatedMediaType $mediaType)`:
Forces Chromium to emulate, either "screen" or "print". (default "print").

* `cookies(array $cookies)`:
Cookies to store in the Chromium cookie jar. (overrides any previous cookies).

* `setCookie(string $key, array $cookie)`:

* `addCookies(array $cookies)`:
Add cookies to store in the Chromium cookie jar.

* `extraHttpHeaders(array $headers)`:
Sets extra HTTP headers that Chromium will send when loading the HTML
document. (default None). (overrides any previous headers).
Expand All @@ -74,3 +72,6 @@ Adds a file, like an image, font, stylesheet, and so on.

* `fileName(string $fileName, string $headerDisposition)`:

* `addCookies(array $cookies)`:
Add cookies to store in the Chromium cookie jar.

19 changes: 10 additions & 9 deletions docs/Screenshot/MarkdownScreenshotBuilder.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,12 @@ The HTML file that wraps the markdown content.

* `files(string $paths)`:

* `cookies(array $cookies)`:

* `setCookie(string $key, Symfony\Component\HttpFoundation\Cookie|array $cookie)`:

* `forwardCookie(string $name)`:

* `width(int $width)`:
The device screen width in pixels. (Default 800).

Expand Down Expand Up @@ -40,17 +46,9 @@ Sets the JavaScript expression to wait before converting an HTML
document to screenshot until it returns true. (default None).
For instance: "window.status === 'ready'".

* `emulatedMediaType(string $mediaType)`:
* `emulatedMediaType(Sensiolabs\GotenbergBundle\Enumeration\EmulatedMediaType $mediaType)`:
Forces Chromium to emulate, either "screen" or "print". (default "print").

* `cookies(array $cookies)`:
Cookies to store in the Chromium cookie jar. (overrides any previous cookies).

* `setCookie(string $key, array $cookie)`:

* `addCookies(array $cookies)`:
Add cookies to store in the Chromium cookie jar.

* `extraHttpHeaders(array $headers)`:
Sets extra HTTP headers that Chromium will send when loading the HTML
document. (default None). (overrides any previous headers).
Expand All @@ -77,3 +75,6 @@ Adds a file, like an image, font, stylesheet, and so on.

* `fileName(string $fileName, string $headerDisposition)`:

* `addCookies(array $cookies)`:
Add cookies to store in the Chromium cookie jar.

22 changes: 12 additions & 10 deletions docs/Screenshot/UrlScreenshotBuilder.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,10 +4,16 @@ UrlScreenshotBuilder
* `setRequestContext(?Symfony\Component\Routing\RequestContext $requestContext)`:

* `url(string $url)`:
URL of the page you want to convert into PDF.
URL of the page you want to screenshot.

* `route(string $name, array $parameters)`:

* `cookies(array $cookies)`:

* `setCookie(string $key, Symfony\Component\HttpFoundation\Cookie|array $cookie)`:

* `forwardCookie(string $name)`:

* `width(int $width)`:
The device screen width in pixels. (Default 800).

Expand Down Expand Up @@ -39,17 +45,9 @@ Sets the JavaScript expression to wait before converting an HTML
document to screenshot until it returns true. (default None).
For instance: "window.status === 'ready'".

* `emulatedMediaType(string $mediaType)`:
* `emulatedMediaType(Sensiolabs\GotenbergBundle\Enumeration\EmulatedMediaType $mediaType)`:
Forces Chromium to emulate, either "screen" or "print". (default "print").

* `cookies(array $cookies)`:
Cookies to store in the Chromium cookie jar. (overrides any previous cookies).

* `setCookie(string $key, array $cookie)`:

* `addCookies(array $cookies)`:
Add cookies to store in the Chromium cookie jar.

* `extraHttpHeaders(array $headers)`:
Sets extra HTTP headers that Chromium will send when loading the HTML
document. (default None). (overrides any previous headers).
Expand All @@ -75,3 +73,7 @@ Adds additional files, like images, fonts, stylesheets, and so on (overrides any
Adds a file, like an image, font, stylesheet, and so on.

* `fileName(string $fileName, string $headerDisposition)`:

* `addCookies(array $cookies)`:
Add cookies to store in the Chromium cookie jar.

33 changes: 25 additions & 8 deletions docs/configuration.md
Original file line number Diff line number Diff line change
Expand Up @@ -127,14 +127,31 @@ sensiolabs_gotenberg:
pdf_universal_access: null # false
metadata: null # None
office:
landscape: null # false
native_page_ranges: null # All pages
export_form_fields: null # true
single_page_sheets: null # false
merge: null # false
pdf_format: null # None
pdf_universal_access: null # false
metadata: null # None
landscape: null # false
native_page_ranges: null # All pages
export_form_fields: null # true
single_page_sheets: null # false
merge: null # false
pdf_format: null # None
pdf_universal_access: null # false
metadata: null # None
allow_duplicate_field_names: null # false
export_bookmarks: null # true
export_bookmarks_to_pdf_destination: null # false
export_placeholders: null # false
export_notes: null # false
export_notes_pages: null # false
export_only_notes_pages: null # false
export_notes_in_margin: null # false
convert_ooo_target_to_pdf_target: null # false
export_links_relative_fsys: null # false
export_hidden_slides: null # false
skip_empty_pages: null # false
add_original_document_as_stream: null # false
lossless_image_compression: null # false
quality: null # 90
reduce_image_resolution: null # false
max_image_resolution: null # 300
merge:
pdf_format: null # None
pdf_universal_access: null # false
Expand Down
Loading