Product DocsMenu

Installing the Enhanced Quick View Components

Generating enhanced Quick Views is done using third-party components. Before you can build or rebuild sources to include enhanced Quick Views in the index, you must install these components on your Coveo server.

To install the enhanced Quick View components

  1. Using an administrator account, connect to the Coveo server where converters are running.

    By default, the converters are running on the Coveo Master server, but they can also be running on Coveo Mirror servers and dedicated Coveo Remote Converter servers. You must perform this procedure for each Coveo server where converters running.

  2. Install LibreOffice:

    1. Download the LibreOffice installer (version 4.1+ is required).

    2. Run the LibreOffice installer, and then note the path where it is installed.

  3. Install PDF2HTMLEx:

    1. Download the PDF2HTMLEx archive file.

    2. Decompress the PDF2HTMLEx archive file on the Coveo server in a path accessible to the user that runs the CES service.

      Example: Decompress the PDF2HTMLEx archive in the C:\Program Files\PDF2HTMLEx\ folder.

  4. Access the CES Administration Tool (see Opening the Administration Tool).

  5. Select Configuration > Converters.

  6. In the navigation panel on the left, select Converter Managers.

  7. In the Converter Managers page, in the Converter Managers list, click the converter for which you want to configure the enhanced Quick View.

  8. In the page for the selected converter, in the Enhanced Quick View section:

    1. In the LibreOffice Path box, specify the path to the LibreOffice executable in the form: 

      [LibreOffice_Path]\program\soffice.exe

      Example: When LibreOffice 4.x.x win32 is installed in the default location, the path is:

       C:\Program Files (x86)\LibreOffice 4\program\soffice.exe

    2. In the PDF2HTMLEx Path box, specify the path to the PDF2HTMLEx executable in the form: 

      [PDF2HTMLEx_Path]\PDF2HTMLEx.exe

      Example:

       C:\Program Files (x86)\PDF2HTMLEx\PDF2HTMLEx.exe

    3. Optionally, when you want to customize how the PDF2HTMLEx component operates, in the PDF2HTMLEx parameters box, change the command-line parameters that are passed to the PDF2HTMLEx executable for the Quick View conversion.

      The recommended parameters are: --hdpi 48 --vdpi 48 --embed-external-font 0

      Tip: To reduce the enhanced Quick View index footprint:

      • Try adding --embed-font 0 to disable font embedding and save about 100 KB per document. In the best case you may loose markup such as bold and italic, but in the case of a foreign language the whole document could be unreadable if the end-user computer does not have an appropriate font.

      • Try adding --hdpi 36 --vdpi 36 to further reduce the horizontal and vertical image resolutions expressed in dot per inch (DPI) when you can accept a little loss of image rendering quality.

      • Try adding --process-outline 0 --optimize-text 1 --embed-outline 0 --printing 0 to save about 20 KB per document.

      Leaving the PDF2HTMLEx Options box empty will use the default values for all PDF2HTMLEx options. You can get the complete list of command-line options by running PDF2HTMLEx.exe -h in a Command Prompt window.

      The following table provides a subset of PDF2HTMLEx command-line options that you can use to optimize the Quick View rendering quality versus file size.

      Parameter Description
      --zoom <fp> zoom ratio
      --fit-width <fp> fit width to <fp> pixels
      --fit-height <fp> fit height to <fp> pixels
      --hdpi <fp> horizontal resolution for graphics in DPI (default: 144)
      --vdpi <fp> vertical resolution for graphics in DPI (default: 144)
      --embed <string> specify which elements should be embedded into output
      --embed-css <int> embed CSS files into output (default: 1)
      --embed-font <int> embed font files into output (default: 1)
      --embed-image <int> embed image files into output (default: 1)
      --embed-javascript <int> embed JavaScript files into output (default: 1)
      --embed-outline <int> embed outlines into output (default: 1)
      --split-pages <int> split pages into separate files (default: 0)
      --process-nontext <int> render graphics in addition to text (default: 1)
      --printing <int> enable printing support (default: 1)
      --fallback <int> output in fallback mode (default: 0)
      --embed-external-font <int> embed local match for external fonts (default: 1)
      --font-format <string> suffix for embedded font files (ttf,otf,woff,svg) (default: "woff")
      --override-fstype <int> clear the fstype bits in TTF/OTF fonts (default: 0)
      --heps <fp> horizontal threshold for merging text, in pixels (default: 1)
      --veps <fp> vertical threshold for merging text, in pixels (default: 1)
      --font-size-multiplier <fp> a value greater than 1 increases the rendering accuracy (default:4)
      --space-as-offset <int> treat space characters as offsets (default: 0)
      --tounicode <int> how to handle TsoUnicode CMaps (0=auto, 1=force, -1=ignore) (default: 0)
      --optimize-text <int> try to reduce the number of HTML elements used for text (default:0)
      --bg-format <string> specify background image format (default: "png")
      --clean-tmp <int> remove temporary files after conversion (default: 1)
      --data-dir <string> specify data directory (default: " ")
      -h,--help print usage information
    4. Click Apply Changes.

What's Next?

People who viewed this topic also viewed