You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@pdfbox.apache.org by ju...@apache.org on 2010/06/21 00:49:36 UTC
svn commit: r956424 - in /pdfbox/site: publish/dependencies.html
src/site/xdoc/dependencies.xml
Author: jukka
Date: Sun Jun 20 22:49:36 2010
New Revision: 956424
URL: http://svn.apache.org/viewvc?rev=956424&view=rev
Log:
PDFBOX-689: Documentation of dependencies is incorrect
Add a custom dependencies page to replace the Maven-generated one
Added:
pdfbox/site/publish/dependencies.html (with props)
pdfbox/site/src/site/xdoc/dependencies.xml
Added: pdfbox/site/publish/dependencies.html
URL: http://svn.apache.org/viewvc/pdfbox/site/publish/dependencies.html?rev=956424&view=auto
==============================================================================
--- pdfbox/site/publish/dependencies.html (added)
+++ pdfbox/site/publish/dependencies.html Sun Jun 20 22:49:36 2010
@@ -0,0 +1,316 @@
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+<!-- Generated by Apache Maven Doxia -->
+<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
+ <head>
+ <meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
+ <title>Apache PDFBox -
+ PDFBox - Dependencies</title>
+ <style type="text/css" media="all">
+ @import url("./css/maven-base.css");
+ @import url("./css/maven-theme.css");
+ @import url("./css/site.css");
+ </style>
+ <link rel="stylesheet" href="./css/print.css" type="text/css" media="print" />
+ <meta http-equiv="Content-Language" content="en" />
+
+ </head>
+ <body class="composite">
+ <div id="banner">
+ <a href="" id="bannerLeft" title="Apache PDFBox">
+ <img src="images/Logo.gif" alt="Apache PDFBox" />
+ </a>
+ <a href="http://www.apache.org/" id="bannerRight" title="The Apache Software Foundation">
+ <img src="http://www.apache.org/images/asf_logo.gif" alt="The Apache Software Foundation" />
+ </a>
+ <div class="clear">
+ <hr/>
+ </div>
+ </div>
+ <div id="breadcrumbs">
+
+
+ <div class="xright">
+
+ </div>
+ <div class="clear">
+ <hr/>
+ </div>
+ </div>
+ <div id="leftColumn">
+ <div id="navcolumn">
+
+
+ <h5>About</h5>
+ <ul>
+ <li class="none">
+ <a href="index.html" title="Welcome">Welcome</a>
+ </li>
+ <li class="none">
+ <a href="download.html" title="Download">Download</a>
+ </li>
+ <li class="none">
+ <a href="http://www.apache.org/licenses/LICENSE-2.0" class="externalLink" title="License">License</a>
+ </li>
+ <li class="none">
+ <a href="mail-lists.html" title="Mailing Lists">Mailing Lists</a>
+ </li>
+ <li class="none">
+ <a href="https://issues.apache.org/jira/browse/PDFBOX" class="externalLink" title="Issue Tracker">Issue Tracker</a>
+ </li>
+ <li class="none">
+ <a href="references.html" title="References">References</a>
+ </li>
+ <li class="none">
+ <a href="http://www.apache.org/foundation/sponsorship.html" class="externalLink" title="ASF Sponsorship Program">ASF Sponsorship Program</a>
+ </li>
+ <li class="none">
+ <a href="http://www.apache.org/foundation/thanks.html" class="externalLink" title="ASF Thanks">ASF Thanks</a>
+ </li>
+ </ul>
+ <h5>Command Line Utilities</h5>
+ <ul>
+ <li class="none">
+ <a href="commandlineutilities/index.html" title="Index">Index</a>
+ </li>
+ <li class="none">
+ <a href="commandlineutilities/ConvertColorspace.html" title="ConvertColorspace">ConvertColorspace</a>
+ </li>
+ <li class="none">
+ <a href="commandlineutilities/Decrypt.html" title="Decrypt">Decrypt</a>
+ </li>
+ <li class="none">
+ <a href="commandlineutilities/Encrypt.html" title="Encrypt">Encrypt</a>
+ </li>
+ <li class="none">
+ <a href="commandlineutilities/ExtractText.html" title="ExtractText">ExtractText</a>
+ </li>
+ <li class="none">
+ <a href="commandlineutilities/Overlay.html" title="Overlay">Overlay</a>
+ </li>
+ <li class="none">
+ <a href="commandlineutilities/PrintPDF.html" title="PrintPDF">PrintPDF</a>
+ </li>
+ <li class="none">
+ <a href="commandlineutilities/PDFDebugger.html" title="PDFDebugger">PDFDebugger</a>
+ </li>
+ <li class="none">
+ <a href="commandlineutilities/PDFMerger.html" title="PDFMerger">PDFMerger</a>
+ </li>
+ <li class="none">
+ <a href="commandlineutilities/PDFReader.html" title="PDFReader">PDFReader</a>
+ </li>
+ <li class="none">
+ <a href="commandlineutilities/PDFSplit.html" title="PDFSplit">PDFSplit</a>
+ </li>
+ <li class="none">
+ <a href="commandlineutilities/PDFToImage.html" title="PDFToImage">PDFToImage</a>
+ </li>
+ <li class="none">
+ <a href="commandlineutilities/TextToPDF.html" title="TextToPDF">TextToPDF</a>
+ </li>
+ </ul>
+ <h5>Developers Guide</h5>
+ <ul>
+ <li class="none">
+ <a href="userguide/index.html" title="Index">Index</a>
+ </li>
+ <li class="none">
+ <a href="userguide/bookmarks.html" title="Bookmarks">Bookmarks</a>
+ </li>
+ <li class="none">
+ <a href="userguide/building_pdfbox.html" title="Building PDFBox">Building PDFBox</a>
+ </li>
+ <li class="none">
+ <a href="userguide/tutorials.html" title="Tutorials">Tutorials</a>
+ </li>
+ <li class="none">
+ <a href="userguide/cookbook.html" title="Cookbook">Cookbook</a>
+ </li>
+ <li class="none">
+ <a href="userguide/faq.html" title="FAQ">FAQ</a>
+ </li>
+ <li class="none">
+ <a href="userguide/file_references.html" title="File References">File References</a>
+ </li>
+ <li class="none">
+ <a href="userguide/fonts.html" title="Fonts">Fonts</a>
+ </li>
+ <li class="none">
+ <a href="userguide/highlighting.html" title="Highlighting">Highlighting</a>
+ </li>
+ <li class="none">
+ <a href="userguide/metadata.html" title="Metadata">Metadata</a>
+ </li>
+ <li class="none">
+ <a href="userguide/redistribution.html" title="Redistribution">Redistribution</a>
+ </li>
+ <li class="none">
+ <a href="userguide/dot_net.html" title=".NET Version">.NET Version</a>
+ </li>
+ <li class="none">
+ <a href="userguide/text_extraction.html" title="Text Extraction">Text Extraction</a>
+ </li>
+ </ul>
+ <h5>Project Documentation</h5>
+ <ul>
+ <li class="collapsed">
+ <a href="project-info.html" title="Project Information">Project Information</a>
+ </li>
+ </ul>
+ <a href="http://maven.apache.org/" title="Built by Maven" class="poweredBy">
+ <img class="poweredBy" alt="Built by Maven" src="./images/logos/maven-feather.png" />
+ </a>
+
+
+ </div>
+ </div>
+ <div id="bodyColumn">
+ <div id="contentBox">
+ <!-- ! Licensed to the Apache Software Foundation (ASF) under one or more
+ ! contributor license agreements. See the NOTICE file distributed with
+ ! this work for additional information regarding copyright ownership.
+ ! The ASF licenses this file to You under the Apache License, Version 2.0
+ ! (the "License"); you may not use this file except in compliance with
+ ! the License. You may obtain a copy of the License at
+ !
+ ! http://www.apache.org/licenses/LICENSE-2.0
+ !
+ ! Unless required by applicable law or agreed to in writing, software
+ ! distributed under the License is distributed on an "AS IS" BASIS,
+ ! WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ ! See the License for the specific language governing permissions and
+ ! limitations under the License.
+ ! -->
+
+ <div class="section"><h2>PDFBox Dependencies<a name="PDFBox_Dependencies"></a></h2>
+ <p>
+ PDFBox consists of a three related componets and depends on a
+ few external libraries. This page describes what these libraries
+ are and how to include them in your application.
+ </p>
+ </div>
+ <div class="section"><h2>Core components<a name="Core_components"></a></h2>
+ <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 class="externalLink" 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 class="externalLink" href="http://logging.apache.org/log4j/">log4j</a>
+ or let commons-logging fall back to the standard
+ <a class="externalLink" 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>
+ <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><pre>
+ <dependency>
+ <groupId>org.apache.pdfbox</groupId>
+ <artifactId>pdfbox</artifactId>
+ <version>...</version>
+ </dependency>
+</pre></div>
+ <p>
+ Set the version field to the latest stable PDFBox version.
+ </p>
+ </div>
+ <div class="section"><h2>Optional dependencies<a name="Optional_dependencies"></a></h2>
+ <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>
+ <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 class="externalLink" 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><pre>
+ <dependency>
+ <groupId>org.bouncycastle</groupId>
+ <artifactId>bcprov-jdk15</artifactId>
+ <version>1.44</version>
+ </dependency>
+ <dependency>
+ <groupId>org.bouncycastle</groupId>
+ <artifactId>bcmail-jdk15</artifactId>
+ <version>1.44</version>
+ </dependency>
+</pre></div>
+ <p>
+ Another important optional feature is support for bidirectional
+ languages like Arabic. PDFBox uses the ICU4J library from the
+ <a class="externalLink" 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>
+<div><pre>
+ <dependency>
+ <groupId>com.ibm.icu</groupId>
+ <artifactId>icu4j</artifactId>
+ <version>3.8</version>
+ </dependency>
+</pre></div>
+ <p>
+ PDFBox also contains extra support for use with the
+ <a class="externalLink" href="http://lucene.apache.org/">Lucene</a> and
+ <a class="externalLink" href="http://ant.apache.org/">Ant</a> projects. Since in these
+ cases PDFBox is just an add-on feature to these projects, you should
+ first set up your application to use Lucene or Ant and then add
+ PDFBox support as described on this page.
+ </p>
+ </div>
+ <div class="section"><h2>Dependencies for Ant builds<a name="Dependencies_for_Ant_builds"></a></h2>
+ <p>
+ The above instructions expect that you're using
+ <a class="externalLink" href="http://maven.apache.org">Maven</a> or another build tool
+ like <a class="externalLink" href="http://ant.apache.org/ivy/">Ivy</a> that supports
+ Maven dependencies. If you instead use tools like
+ <a class="externalLink" href="http://ant.apache.org/">Ant</a> where you need to
+ explicitly include all the required library jars in your application,
+ you'll need to do something different.
+ </p>
+ <p>
+ The easiest approach is to run
+ "<tt>mvn dependency:copy-dependencies</tt>" inside the
+ pdfbox directory of the latest PDFBox source release. This will
+ copy all the required and optional libraries discussed above into
+ the pdfbox/target/dependencies directory. You can then simply copy
+ all the libraries you need from this directory to your application.
+ </p>
+ </div>
+
+
+ </div>
+ </div>
+ <div class="clear">
+ <hr/>
+ </div>
+ <div id="footer">
+ <div class="xright">Copyright © 2008-2010
+ <a href="http://www.apache.org/">The Apache Software Foundation</a>.
+ All Rights Reserved.
+
+ </div>
+ <div class="clear">
+ <hr/>
+ </div>
+ </div>
+ </body>
+</html>
Propchange: pdfbox/site/publish/dependencies.html
------------------------------------------------------------------------------
svn:eol-style = native
Propchange: pdfbox/site/publish/dependencies.html
------------------------------------------------------------------------------
svn:executable = *
Added: pdfbox/site/src/site/xdoc/dependencies.xml
URL: http://svn.apache.org/viewvc/pdfbox/site/src/site/xdoc/dependencies.xml?rev=956424&view=auto
==============================================================================
--- pdfbox/site/src/site/xdoc/dependencies.xml (added)
+++ pdfbox/site/src/site/xdoc/dependencies.xml Sun Jun 20 22:49:36 2010
@@ -0,0 +1,141 @@
+<!--
+ ! Licensed to the Apache Software Foundation (ASF) under one or more
+ ! contributor license agreements. See the NOTICE file distributed with
+ ! this work for additional information regarding copyright ownership.
+ ! The ASF licenses this file to You under the Apache License, Version 2.0
+ ! (the "License"); you may not use this file except in compliance with
+ ! the License. You may obtain a copy of the License at
+ !
+ ! http://www.apache.org/licenses/LICENSE-2.0
+ !
+ ! Unless required by applicable law or agreed to in writing, software
+ ! distributed under the License is distributed on an "AS IS" BASIS,
+ ! WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ ! See the License for the specific language governing permissions and
+ ! limitations under the License.
+ !-->
+<document xmlns="http://maven.apache.org/XDOC/2.0"
+ xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+ xsi:schemaLocation="http://maven.apache.org/XDOC/2.0
+ http://maven.apache.org/xsd/xdoc-2.0.xsd">
+ <head>
+ <title>PDFBox - Dependencies</title>
+ </head>
+ <body>
+ <section name="PDFBox Dependencies">
+ <p>
+ PDFBox consists of a three related componets and depends on a
+ few external libraries. This page describes what these libraries
+ are and how to include them in your application.
+ </p>
+ </section>
+ <section name="Core components">
+ <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. 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>
+ <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>
+<pre>
+ <dependency>
+ <groupId>org.apache.pdfbox</groupId>
+ <artifactId>pdfbox</artifactId>
+ <version>...</version>
+ </dependency>
+</pre>
+ <p>
+ Set the version field to the latest stable PDFBox version.
+ </p>
+ </section>
+ <section name="Optional dependencies">
+ <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>
+ <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>
+<pre>
+ <dependency>
+ <groupId>org.bouncycastle</groupId>
+ <artifactId>bcprov-jdk15</artifactId>
+ <version>1.44</version>
+ </dependency>
+ <dependency>
+ <groupId>org.bouncycastle</groupId>
+ <artifactId>bcmail-jdk15</artifactId>
+ <version>1.44</version>
+ </dependency>
+</pre>
+ <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>
+<pre>
+ <dependency>
+ <groupId>com.ibm.icu</groupId>
+ <artifactId>icu4j</artifactId>
+ <version>3.8</version>
+ </dependency>
+</pre>
+ <p>
+ PDFBox also contains extra support for use with the
+ <a href="http://lucene.apache.org/">Lucene</a> and
+ <a href="http://ant.apache.org/">Ant</a> projects. Since in these
+ cases PDFBox is just an add-on feature to these projects, you should
+ first set up your application to use Lucene or Ant and then add
+ PDFBox support as described on this page.
+ </p>
+ </section>
+ <section name="Dependencies for Ant builds">
+ <p>
+ The above instructions expect that you're using
+ <a href="http://maven.apache.org">Maven</a> or another build tool
+ like <a href="http://ant.apache.org/ivy/">Ivy</a> that supports
+ Maven dependencies. If you instead use tools like
+ <a href="http://ant.apache.org/">Ant</a> where you need to
+ explicitly include all the required library jars in your application,
+ you'll need to do something different.
+ </p>
+ <p>
+ The easiest approach is to run
+ "<code>mvn dependency:copy-dependencies</code>" inside the
+ pdfbox directory of the latest PDFBox source release. This will
+ copy all the required and optional libraries discussed above into
+ the pdfbox/target/dependencies directory. You can then simply copy
+ all the libraries you need from this directory to your application.
+ </p>
+ </section>
+ </body>
+</document>