You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@pdfbox.apache.org by bu...@apache.org on 2014/10/13 22:30:01 UTC

svn commit: r925660 - in /websites/staging/pdfbox/trunk/content: ./ dependencies.html

Author: buildbot
Date: Mon Oct 13 20:30:00 2014
New Revision: 925660

Log:
Staging update by buildbot for pdfbox

Modified:
    websites/staging/pdfbox/trunk/content/   (props changed)
    websites/staging/pdfbox/trunk/content/dependencies.html

Propchange: websites/staging/pdfbox/trunk/content/
------------------------------------------------------------------------------
--- cms:source-revision (original)
+++ cms:source-revision Mon Oct 13 20:30:00 2014
@@ -1 +1 @@
-1627509
+1631535

Modified: websites/staging/pdfbox/trunk/content/dependencies.html
==============================================================================
--- websites/staging/pdfbox/trunk/content/dependencies.html (original)
+++ websites/staging/pdfbox/trunk/content/dependencies.html Mon Oct 13 20:30:00 2014
@@ -157,14 +157,21 @@
             <div class="span9">
                  <h2 id="pdfbox-dependencies">PDFBox Dependencies</h2>
 <p>PDFBox consists of a three related components and depends on a few external libraries. This page describes what these libraries are and how to include them in your application.</p>
+<p class="alert alert-info">This information is for the current stable 1.8.x branch. The 2.0 development branch will have different dependencies.</p>
+
 <h3 id="core-components">Core components</h3>
-<p>The three PDFBox components are named pdfbox, fontbox and jempbox. The Maven groupId of all PDFBox components is org.apache.pdfbox.</p>
-<p>The fontbox and jempbox components are standalone libraries for handling font information and XMP metadata. These components have no external dependencies and can be
-used simply by adding the respective jar files to the classpath of your application.</p>
-<p>The main PDFBox component, pdfbox, has hard dependencies on the fontbox and jempbox components and the <a href="http://commons.apache.org/logging/">commons-logging</a> library.
+<p class="alert alert-info">These components are needed during runtime, development and testing dependent on the details below.</p>
+
+<p>The three PDFBox components are named <code>pdfbox</code>, <code>fontbox</code> and <code>jempbox</code>. The Maven groupId of all PDFBox components is org.apache.pdfbox.</p>
+<h4 id="minimum-requirement">Minimum Requirement</h4>
+<p>The main PDFBox component, pdfbox, has a hard dependency on the <a href="http://commons.apache.org/logging/">commons-logging</a> library.
 Commons Logging is a generic wrapper around different logging frameworks, so you'll either need to also use a logging library like <a href="http://logging.apache.org/log4j/">log4j</a>
 or let commons-logging fall back to the standard <a href="http://java.sun.com/j2se/1.4.2/docs/guide/util/logging/overview.html">java.util.logging API</a>
 included in the Java platform.</p>
+<h4 id="font-handling">Font Handling</h4>
+<p>For font handling the fontbox component is needed.</p>
+<h4 id="xmp-metadata">XMP Metadata</h4>
+<p>To support XMP metadata the jembox component is needed.</p>
 <p>To add the pdfbox, fontbox, jempbox and commons-logging jars to your application, the easiest thing is to declare the Maven dependency shown below. This gives you the main
 pdfbox library directly and the other required jars as transitive dependencies.</p>
 <div class="codehilite"><pre><span class="nt">&lt;dependency&gt;</span>
@@ -178,6 +185,14 @@ pdfbox library directly and the other re
 <p>Set the version field to the latest stable PDFBox version.</p>
 <h3 id="optional-dependencies">Optional dependencies</h3>
 <p>Some features in PDFBox depend on optional external libraries. You can enable these features simply by including the required libraries in the classpath of your application.</p>
+<h4 id="extented-image-format-support">Extented Image Format Support</h4>
+<p>To support JPEG2000 and writing TIF images additional libraries are needed. </p>
+<p class="alert alert-warning">The image plugins described below are not part of the PDFBox distribution because of incompatible licensing terms. Please make sure to check if the licensing terms are compatible to your usage.</p>
+
+<p>For <strong>JPEG2000</strong> support a Java ImageIO Plugin such as the <a href="https://github.com/levigo/jbig2-imageio">Levigo Plugin</a> or <a href="https://github.com/Borisvl/JBIG2-Image-Decoder">JBIG2-Image-Decoder
+</a> will be needed. </p>
+<p>To write <strong>TIFF</strong> images a JAI ImageIO Core library will be needed. </p>
+<h4 id="pdf-encryption-and-signing">PDF Encryption and Signing</h4>
 <p>The most notable such optional feature is support for PDF encryption. Instead of implementing its own encryption algorithms, PDFBox uses libraries from the 
 <a href="http://www.bouncycastle.org/">Legion of the Bouncy Castle</a>. Both the bcprov and bcmail libraries are needed and can be included using the Maven dependencies shown below.</p>
 <div class="codehilite"><pre><span class="nt">&lt;dependency&gt;</span>
@@ -193,6 +208,7 @@ pdfbox library directly and the other re
 </pre></div>
 
 
+<h4 id="support-for-bidirectional-languages">Support for bidirectional languages</h4>
 <p>Another important optional feature is support for bidirectional languages like Arabic. PDFBox uses the ICU4J library from the 
 <a href="http://site.icu-project.org/">International Components for Unicode</a> (ICU) project to support such languages in PDF documents. To add the ICU4J jar to your project, 
 use the following Maven dependency.</p>