Link
Hierarchy
In this section

Microservice Settings

The BuildVu Microservice has a number of settings that can be applied to grant better control of your conversion. These settings are detailed below.

Available Settings

  1. org.jpedal.pdf2html.completeDocument
  2. org.jpedal.pdf2html.compressImages
  3. org.jpedal.pdf2html.compressSVG
  4. org.jpedal.pdf2html.containerId
  5. org.jpedal.pdf2html.convertSpacesToNbsp
  6. org.jpedal.pdf2html.disableComments
  7. org.jpedal.pdf2html.embedImagesAsBase64Stream
  8. org.jpedal.pdf2html.generateSearchFile
  9. org.jpedal.pdf2html.imageScale
  10. org.jpedal.pdf2html.includedFonts
  11. org.jpedal.pdf2html.inlineSVG
  12. org.jpedal.pdf2html.keepGlyfsSeparate
  13. org.jpedal.pdf2html.logicalPageRange
  14. org.jpedal.pdf2html.outputThumbnails
  15. org.jpedal.pdf2html.realPageRange
  16. org.jpedal.pdf2html.scaling
  17. org.jpedal.pdf2html.separateTextToWords
  18. org.jpedal.pdf2html.svgMode
  19. org.jpedal.pdf2html.textMode
  20. org.jpedal.pdf2html.useLegacyImageFileType
  21. org.jpedal.pdf2html.viewerUI
  22. org.jpedal.pdf2html.viewMode

org.jpedal.pdf2html.completeDocument

This will output html files with head and body tags. This mode is recommened if content will be displayed within iframes. This flag does nothing for SVG conversion

Required? No

Accepted Values

  • true
  • false

Default false

org.jpedal.pdf2html.compressImages

Compress PNG images to reduce file size

Required? No

Accepted Values

  • true
  • false

Default false

org.jpedal.pdf2html.compressSVG

Generates compressed .svgz files rather than .svg

Required? No

Accepted Values

  • true
  • false

Default false

org.jpedal.pdf2html.containerId

Set the id to use for the page container div

Required? No

Accepted Values

Any string

Default jpedal

org.jpedal.pdf2html.convertSpacesToNbsp

Convert spaces into Non-breaking Spaces ( ) in the output

Required? No

Accepted Values

  • true
  • false

Default false

org.jpedal.pdf2html.disableComments

Disable comments inserted into the HTML output for clarity

Required? No

Accepted Values

  • true
  • false

Default false

org.jpedal.pdf2html.embedImagesAsBase64Stream

Insert the images directly into the file as a base64 stream instead of referencing an external file

Required? No

Accepted Values

  • true
  • false

Default false

org.jpedal.pdf2html.generateSearchFile

Generates search.json which is used in the Viewer to search text in the Viewer. This value is ignored and the file created if viewerUI is set to complete which is the default setting.

Required? No

Accepted Values

  • true
  • false

Default false

org.jpedal.pdf2html.imageScale

Write out larger images to allow higher quality zooming. Value is a float from 0.1 to 10 where 1 is 100%.

Required? No

Possible Values

Any float value from 0.1 to 10

Default 1

org.jpedal.pdf2html.includedFonts

Set font type to convert to and include in HTML and CSS output.

Required? No

Accepted Values

  • woff
  • otf
  • woff_base64
  • otf_base64

Default woff

org.jpedal.pdf2html.inlineSVG

Inlines the SVG within HTML so that there is no separate .svg file. This flag only has an affect in SVG text modes.

Required? No

Possible Values

  • true
  • false

Default false

org.jpedal.pdf2html.keepGlyfsSeparate

Position each glyph individually for more accurate text positioning

Required? No

Accepted Values

  • true
  • false

Default false

org.jpedal.pdf2html.logicalPageRange

Set a page range to convert using logical page numbering.

Required? No

Possible Values

A string of comma separated values including ranges

e.g. “1,3,5-8,10”

Default null

org.jpedal.pdf2html.outputThumbnails

Output thumbnails of pages in /thumbnails/. Thumbnails are always generate if viewerUI is set to complete which is the default setting

Required? No

Accepted Values

  • true
  • false

Default false

org.jpedal.pdf2html.realPageRange

Set a page range to convert using real page numbering. Value is a string of comma separated values including ranges.

Required? No

Possible Values A string of comma separated values including ranges

e.g. “1,3,5-8,10”

Default null

org.jpedal.pdf2html.scaling

Sets the Scaling value of the converted content. There are four types of value,a float multiplier (e.g. 1)best fit of width(e.g. fitWidth1000)height(e.g. fitHeight1000)or both(e.g. 1000x1000)

Required? No

Possible Values

  • a float multiplier (e.g. 1)
  • best fit for width (e.g. fitWidth1000)
  • best fit for height (e.g. fitHeight1000)
  • best fit for width and height (e.g. 1000x1000)

Default 1

org.jpedal.pdf2html.separateTextToWords

Improve text position accuracy by dividing text chunks into words based on spaces

Required? No

Accepted Values

  • true
  • false

Default false

org.jpedal.pdf2html.svgMode

When enabled, BuildVu-SVG will be used. Otherwise, BuildVu-HTML will be used.

Available only for the combined version of BuildVu (not for BuildVu-HTML or BuildVu-SVG).

Required? No

Accepted Values

  • true
  • false

Default false

org.jpedal.pdf2html.textMode

Text mode controls how text is rendered in the html output

Required? No

Accepted Values

  • svg_realtext
  • svg_shapetext_selectable
  • svg_shapetext_nonselectable
  • image_realtext
  • image_shapetext_selectable
  • image_shapetext_nonselectable

Default svg_realtext

org.jpedal.pdf2html.useLegacyImageFileType

Output all images as PNGs

Required? No

Accepted Values

  • true
  • false

Default false

org.jpedal.pdf2html.viewerUI

Sets the user interface to use for the viewer

Required? No

Accepted Values

  • complete
  • clean
  • simple
  • slideshow
  • custom

Default complete

org.jpedal.pdf2html.viewMode

Specify if the content should be converted in content mode, outputting just the converted pages, no viewer.

Required? No

Accepted Values

content

Default null

Still need help? Send us your questions.