How to Run Examples Leave feedback

Warning

Before running an example make sure that GroupDocs.Parser has been installed successfully.

We offer multiple solutions on how you can run GroupDocs.Parser examples, by building your own or using our examples out-of-the-box.

Please choose one from the following list:

• Open your IDE (for example, IntelliJ IDEA) and create a new Maven or Gradle project;

• Install GroupDocs.Parser for Java from the GroupDocs Repository or official GroupDocs website following this guide;

• Code your first application with GroupDocs.Parser for Java like this:

  // Create an instance of Parser class
  try (Parser parser = new Parser("c:\\documents\\sample.docx")) { // NOTE: Put here actual path for your document
      // Extract a text to the reader
      try (TextReader reader = parser.getText()) {
          // Print an extracted text (or "not supported" message)
          System.out.println(reader == null ? "Text extraction isn't supported" : reader.readToEnd());
      }
  }
  

• Build and Run your project;

• Extracted text will appear on the console.

The complete examples package of GroupDocs.Parser is hosted on GitHub. You can either download the ZIP file from here or clone the repository of GitHub using your favorite git client.

In case you download the ZIP file, extract the folders on your local disk. The extracted files and folders will look like following image:

The Examples folder contains a Maven project (Examples/pom.xml) that references GroupDocs.Parser for Java from the GroupDocs Repository, so Maven downloads the library automatically. The Examples/Resources/SampleFiles folder contains all the sample documents used in the examples.

RunExamples.java is the entry point of the project. Every example is a class with a static run method, and RunExamples.main calls them one by one. Un-comment the example you want to run and comment the rest.

From the Examples directory run:

mvn compile exec:java -Dexec.mainClass=com.groupdocs.parser.examples.RunExamples

The sample documents are resolved relative to the working directory (see Constants.SamplesPath), so run the examples with the Examples directory as the working directory.

Open IntelliJ IDEA and import the project to get started with it: select File -> Open and choose the Examples/pom.xml file, then open it as a project. Maven resolves the GroupDocs.Parser dependency automatically.

If you installed GroupDocs.Parser for Java from a downloaded JAR instead, add it to the module dependencies:

• Click file from the toolbar
• Open project structure using (CTRL + SHIFT + ALT + S on Windows/Linux, ⌘ + ; on Mac OS X)
• Select Modules at the left panel
• Open Dependencies tab
• Click ‘+’ and click JARs or directories

Then run RunExamples.main with Examples as the working directory.

Without a license the examples run in evaluation mode (see Evaluation Limitations and Licensing). If you have a license:

1. Open Constants.java and set the LicensePath constant to your license file’s path;
2. Call SetLicenseFromFile.run() from RunExamples.java before any other example.

The examples of the using_ocr package additionally require an Aspose.OCR for Java license; set its path in the Constants.AsposeOcrLicensePath constant.

If you like to add or improve an example, we encourage you to contribute to the project. All examples in this repository are open source and can be freely used in your own applications.

To contribute, you can fork the repository, edit the code example and create a pull request. We will review the changes and include it in the repository if found helpful.