User Tools

Site Tools


Processing PDFs with Icecite and the UnknownConverterPlugin

The contents of this page were originally created as the final section of the Greenstone 3 tutorial "Using the UnknownConverterPlugin to make unsupported document formats searchable", with that tutorial intended to appear officially in public with GS3.09. However this section has been removed from the tutorial for the following reasons:

  • the section replicates knowledge of UnknownConverterPlugin's use already covered in the first section
  • the intention was to teach users about configuring UnknownConverterPlugin to run Icecite so that Greenstone users could have another PDF to text conversion tool as resort for if PDFPlugin (and its pdfbox_conversion option) could not process some PDFs. However, now that GS3.09 introduces the new PDFv2Plugin, which makes use of XPDFTools and PDFBox, we think this plugin should now support PDFs not supported by the original plugin, possibly making the need for a tutorial covering configuring UnknownCoverter to use Icecite non-essential
  • the Icecite tool/project has been renamed to PdfAct, with the Icecite name being reused for another project by its author. This may confuse Greenstone 3.09+ users if they were to ever need a newer version of "Icecite"
  • With the project renamed, there may be newer incompatible code. On windows, Icecite required to be compiled up and we already had to work with a slightly older version as we couldn't successfully compile the most up-to-date version at the time

Using the Icecite's commandline tool to convert from PDF to text

PdfAct, formerly known as Icecite which is the name used for the software on the rest of this page, is an open-source tool that can do many PDF related tasks, including extracting text from a PDF. In this part of the tutorial, we're going to learn how to run Icecite's PDF to text conversion utility from the command line. Based on that command, we'll configure the UnknownConverterPlugin to launch Icecite from GLI, to do the conversion on a PDF document in a Greenstone collection. This ends up being a useful exercise in instances where certain PDFs aren't recognised by Greenstone's PDFPlugin, even when pdfbox_conversion option (which uses the PDFBox tool for the conversion) is switched on. In such cases, you can use what you learn here.

As Icecite needs Java 8, you need to have either a JDK8 or a JRE8 installed in order to proceed with this portion of the tutorial.

  1. Grab the pre-compiled Icecite zip file from (or from, if you prefer a tarball) and decompress it into your Greenstone installation's ext subfolder.
    Now you're ready to test Icecite's PDF to text conversion abilities manually, by running Icecite from the command line.
  2. Set up your environment for Java 8:
  3. You would need to run Icecite from the terminal wherein you set up the Java 8 environment. Run it on a PDF as follows, after first replacing the <PLACEHOLDERS> below.
    • The command will look as follows on Windows, note the use of double quotes around the classpath value and the use of semi-colon as the path separator on Windows:
      java -classpath "<DRIVE:\PATH-TO-GS-INSTALLATION>\ext\icecite\gs-installed-jars\*;<DRIVE:\PATH-TO-GS-INSTALLATION>\ext\icecite\pdf-cli\target\pdf-cli-0.0.1-SNAPSHOT-jar-with-dependencies.jar" cli.PdfParserCommandLine –format txt –feature paragraphs <DRIVE:\FULL\PATH\TO\YOUR.pdf> <DRIVE:\FULL\PATH\TO\CONVERTED.txt>
    • On Unix systems, the command will be of the following form, where single quotes are acceptable around the value for classpath and where colon is the path separator:
      java -classpath '/<PATH-TO-GS-INSTALLATION>/ext/icecite/gs-installed-jars/*:/<PATH-TO-GS-INSTALLATION>/ext/icecite/pdf-cli/target/pdf-cli-0.0.1-SNAPSHOT-jar-with-dependencies.jar' cli.PdfParserCommandLine –format txt –feature paragraphs </PATH/TO/YOUR.pdf> </PATH/TO/CONVERTED.txt>
  4. It can take a while for the PDF to get converted, but once it has finished, you can inspect the text file produced, denoted by the placeholder string </PATH/TO/CONVERTED.txt>
    You can experiment with using –feature words or –feature lines above, in place of –feature paragraphs, to find out the effect of such a change on the output file, particularly if –feature paragraphs does not produce the desired results for your PDFs.

Using the UnknownConverterPlugin to launch Icecite from GLI to do the PDF to text conversion

We're now ready to use the UnknownConverterPlugin to launch Icecite as the external tool to do the conversion, producing output that Greenstone's building scripts can ingest into Greenstone and index for searching.

  1. Run GLI
  2. Create a new collection called Icecite. In the Gather pane, drop in the sample PDF file into your collection.
  3. In the Design pane and select Document Plugins from the list on the left. Add the UnknownConverterPlugin. Having tried out the Icecite conversion command manually in the previous part of this tutorial, we're now ready to use it when configuring the UnknownConverterPlugin. Click <Configure Plugin…> and set up the plugin with the following settings:
    • set convert_to to the text option, this is the output format upon conversion
    • set mime_type to application/pdf
    • set srcicon to the iconpdf, since Greenstone already knows about this macro and already has an icon for PDFs and knows to associate the two
    • set process_extension to pdf, this is the input format of the files that this instance of the UnknownConverterPlugin will process
    • set the exec_cmd field as follows, depending on your operating system:
      • on Windows:
        DRIVE:\PATH\TO\YOUR-JAVA-8-HOME\bin\java -classpath "GSDL3SRCHOME\ext\icecite\gs-installed-jars\*:GSDL3SRCHOME\ext\icecite\pdf-cli\target\pdf-cli-0.0.1-SNAPSHOT-jar-with-dependencies.jar" cli.PdfParserCommandLine –format txt –feature paragraphs INPUT_FILE OUTPUT
      • on Unix systems:
        /PATH/TO/YOUR-JAVA-8-HOME/bin/java -classpath 'GSDL3SRCHOME/ext/icecite/gs-installed-jars/*:GSDL3SRCHOME/ext/icecite/pdf-cli/target/pdf-cli-0.0.1-SNAPSHOT-jar-with-dependencies.jar' cli.PdfParserCommandLine –format txt –feature paragraphs INPUT_FILE OUTPUT

Note: When filling in the exec_cmd field, leave the words with %% signs in front of them intact. They are placeholders for Greenstone to replace.

You will however need to adjust the above value for exec_cmd by finding out where your Java 8 is installed and replacing /PATH/TO/YOUR-JAVA-8-HOME with it. The reason you need to provide the full path to the Java 8 executable is because, at present, GLI binaries ship with Java 7, which is incompatible with the precompiled Icecite. And if you're running Greenstone from a source, you may have a different version of Java set up in your environment too. However, by providing the full path to the Java 8 executable above, you force Icecite's PDF conversion program to run with Java 8.

On Windows, if there are spaces in any filepaths in the command, other than in the parameter value to -classpath, remember to bookend those filepaths within double quotes escaped with a backslash, \".

The above command will use the java executable to run the java Icecite program that does the actual PDF to text conversion. Greenstone will run the command given after first filling in the GSDL3SRCHOME, INPUT_FILE and OUTPUT appropriately. GSDL3SRCHOME works out to be the Greenstone 3 installation directory, whereas INPUT_FILE is whichever matching PDF it's processing and OUTPUT is likewise the file (or folder of files) produced by the conversion process. In this case, the output type is txt, as that's what Icecite produces. Once the conversion to text has finished, Greenstone will be able to process it as usual, such as indexing the extracted contents to make the document searchable.

  1. Having sufficiently configured the UnknownConverterPlugin, click the <OK> button to close its configuration dialog.
  2. Select the UnknownConverterPlugin in the list of plugins and keep pressing the <Move Up> button to shift it upwards, until it appears in the plugin pipeline above the existing PDFPlugin, so that this instance of UnknownConverterPlugin, configured as it has now been to handle PDF files, will take precedence in processing such files.
  3. Move to the Create pane and build the collection. Once more, when Icecite conversion utility is called by Greenstone's building process, the conversion will take some time processing. But after a minute or so, the building will be done and you can Preview the collection. Search for some terms.

en/user_advanced/ice_cite.txt · Last modified: 2023/03/13 01:46 by