Skip to content

Commit

Permalink
[RELEASE_8.8.0 & RELEASE_8.7.0] Add new fields for `LibreOfficeBuilde…
Browse files Browse the repository at this point in the history
…r` (#97)
  • Loading branch information
StevenRenaux authored Jul 18, 2024
1 parent 560fd1a commit f160df5
Show file tree
Hide file tree
Showing 8 changed files with 905 additions and 18 deletions.
33 changes: 25 additions & 8 deletions docs/configuration.md
Original file line number Diff line number Diff line change
Expand Up @@ -130,14 +130,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
do_not_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
do_not_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
53 changes: 52 additions & 1 deletion docs/pdf/builders_api/LibreOfficePdfBuilder.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ Sets the paper orientation to landscape.
Page ranges to print, e.g., '1-4' - empty means all pages.
If multiple files are provided, the page ranges will be applied independently to each file.

* `exportFormFields(bool $bool)`:
* `doNotExportFormFields(bool $bool)`:
Set whether to export the form fields or to use the inputted/selected content of the fields.

* `singlePageSheets(bool $bool)`:
Expand All @@ -31,6 +31,57 @@ 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.

* `doNotExportBookmarks(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(Sensiolabs\GotenbergBundle\Enumeration\ImageResolutionDPI $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)`:

* `processor(Sensiolabs\GotenbergBundle\Processor\ProcessorInterface $processor)`:
Expand Down
Loading

0 comments on commit f160df5

Please sign in to comment.