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 2008/09/18 01:55:03 UTC
svn commit: r696519 [8/8] - in /incubator/pdfbox/trunk: ./ pdfbox.war/
src/main/java/org/apache/ src/main/java/org/apache/pdfbox/
src/main/java/org/apache/pdfbox/ant/ src/main/java/org/apache/pdfbox/cos/
src/main/java/org/apache/pdfbox/encoding/ src/ma...
Modified: incubator/pdfbox/trunk/website/src/documentation/content/xdocs/userguide/index.xml
URL: http://svn.apache.org/viewvc/incubator/pdfbox/trunk/website/src/documentation/content/xdocs/userguide/index.xml?rev=696519&r1=696518&r2=696519&view=diff
==============================================================================
--- incubator/pdfbox/trunk/website/src/documentation/content/xdocs/userguide/index.xml (original)
+++ incubator/pdfbox/trunk/website/src/documentation/content/xdocs/userguide/index.xml Wed Sep 17 16:54:53 2008
@@ -32,15 +32,16 @@
</section>
<section>
<title>Examples</title>
- <p>A variety of examples can be found in the src/org/pdfbox/examples folder. This guide will refer to
- specific examples as needed.
+ <p>A variety of examples can be found in the
+ src/main/java/org/apache/pdfbox/examples folder.
+ This guide will refer to specific examples as needed.
</p>
</section>
<section>
<title>PDF File Format Overview</title>
<p>
A PDF document is a stream of basic object types. The low level objects are represented in PDFBox
- in the <i>org.pdfbox.cos</i> package. The basic types in a PDF are:
+ in the <i>org.apache.pdfbox.cos</i> package. The basic types in a PDF are:
</p>
<table>
<tr>
@@ -53,13 +54,13 @@
<td>Array</td>
<td>An ordered list of items</td>
<td>[1 2 3]</td>
- <td>org.pdfbox.cos.COSArray</td>
+ <td>org.apache.pdfbox.cos.COSArray</td>
</tr>
<tr>
<td>Boolean</td>
<td>Standard True/False values</td>
<td>true</td>
- <td>org.pdfbox.cos.COSBoolean</td>
+ <td>org.apache.pdfbox.cos.COSBoolean</td>
</tr>
<tr>
<td>Dictionary</td>
@@ -70,19 +71,19 @@
/Size 1<br/>
>>
</td>
- <td>org.pdfbox.cos.COSDictionary</td>
+ <td>org.apache.pdfbox.cos.COSDictionary</td>
</tr>
<tr>
<td>Number</td>
<td>Integer and Floating point numbers</td>
<td>1 2.3</td>
- <td>org.pdfbox.cos.COSFloat<br />org.pdfbox.cos.COSInteger</td>
+ <td>org.apache.pdfbox.cos.COSFloat<br />org.apache.pdfbox.cos.COSInteger</td>
</tr>
<tr>
<td>Name</td>
<td>A predefined value in a PDF document, typically used as a key in a dictionary</td>
<td>/Type</td>
- <td>org.pdfbox.cos.COSName</td>
+ <td>org.apache.pdfbox.cos.COSName</td>
</tr>
<tr>
<td>Object</td>
@@ -91,7 +92,7 @@
the generation number will be zero unless the object got replaced later in the stream.
</td>
<td>12 0 obj << /Type /XObject >> endobj</td>
- <td>org.pdfbox.cos.COSObject</td>
+ <td>org.apache.pdfbox.cos.COSObject</td>
</tr>
<tr>
<td>Stream</td>
@@ -99,14 +100,14 @@
embedded font streams.
</td>
<td>12 0 obj << /Type /XObject >> stream 030004040404040404 endstream</td>
- <td>org.pdfbox.cos.COSStream</td>
+ <td>org.apache.pdfbox.cos.COSStream</td>
</tr>
<tr>
<td>String</td>
<td>A sequence of characters
</td>
<td>(This is a string)</td>
- <td>org.pdfbox.cos.COSString</td>
+ <td>org.apache.pdfbox.cos.COSString</td>
</tr>
</table>
<p>
Modified: incubator/pdfbox/trunk/website/src/documentation/content/xdocs/userguide/metadata.xml
URL: http://svn.apache.org/viewvc/incubator/pdfbox/trunk/website/src/documentation/content/xdocs/userguide/metadata.xml?rev=696519&r1=696518&r2=696519&view=diff
==============================================================================
--- incubator/pdfbox/trunk/website/src/documentation/content/xdocs/userguide/metadata.xml (original)
+++ incubator/pdfbox/trunk/website/src/documentation/content/xdocs/userguide/metadata.xml Wed Sep 17 16:54:53 2008
@@ -24,8 +24,8 @@
<section>
<title>Accessing Metadata</title>
<p>
- See class:<a href="../javadoc/org/pdfbox/pdmodel/common/PDMetadata.html">org.pdfbox.pdmodel.common.PDMetadata</a> <br/>
- See example:<a href="../javadoc/org/pdfbox/examples/pdmodel/AddMetadataFromDocInfo.html">AddMetadataFromDocInfo</a> <br/>
+ See class:<a href="../javadoc/org/apache/pdfbox/pdmodel/common/PDMetadata.html">org.apache.pdfbox.pdmodel.common.PDMetadata</a> <br/>
+ See example:<a href="../javadoc/org/apache/pdfbox/examples/pdmodel/AddMetadataFromDocInfo.html">AddMetadataFromDocInfo</a> <br/>
See Adobe Documentation:<a href="http://partners.adobe.com/public/developer/en/xmp/sdk/xmpspecification.pdf">XMP Specification</a>
</p>
<p>
Modified: incubator/pdfbox/trunk/website/src/documentation/content/xdocs/userguide/text_extraction.xml
URL: http://svn.apache.org/viewvc/incubator/pdfbox/trunk/website/src/documentation/content/xdocs/userguide/text_extraction.xml?rev=696519&r1=696518&r2=696519&view=diff
==============================================================================
--- incubator/pdfbox/trunk/website/src/documentation/content/xdocs/userguide/text_extraction.xml (original)
+++ incubator/pdfbox/trunk/website/src/documentation/content/xdocs/userguide/text_extraction.xml Wed Sep 17 16:54:53 2008
@@ -24,14 +24,14 @@
<section>
<title>Extracting Text</title>
<p>
- See class:<a href="../javadoc/org/pdfbox/util/PDFTextStripper.html">org.pdfbox.util.PDFTextStripper</a> <br/>
- See class:<a href="../javadoc/org/pdfbox/searchengine/lucene/LucenePDFDocument.html">org.pdfbox.searchengine.lucene.LucenePDFDocument</a> <br/>
+ See class:<a href="../javadoc/org/apache/pdfbox/util/PDFTextStripper.html">org.apache.pdfbox.util.PDFTextStripper</a> <br/>
+ See class:<a href="../javadoc/org/apache/pdfbox/searchengine/lucene/LucenePDFDocument.html">org.apache.pdfbox.searchengine.lucene.LucenePDFDocument</a> <br/>
See command line app:<a href="../commandlineutilities/ExtractText.html">ExtractText</a> <br/>
</p>
<p>
One of the main features of PDFBox is its ability to quickly and accurately extract text from a variety of PDF documents.
- This functionality is encapsulated in the <a href="../javadoc/org/pdfbox/util/PDFTextStripper.html">org.pdfbox.util.PDFTextStripper</a> and
- can be easily executed on the command line with <a href="../javadoc/org/pdfbox/ExtractText.html">org.pdfbox.ExtractText</a>.
+ This functionality is encapsulated in the <a href="../javadoc/org/apache/pdfbox/util/PDFTextStripper.html">org.apache.pdfbox.util.PDFTextStripper</a> and
+ can be easily executed on the command line with <a href="../javadoc/org/apache/pdfbox/ExtractText.html">org.apache.pdfbox.ExtractText</a>.
</p>
<section>
<title>Lucene Integration</title>
@@ -44,7 +44,7 @@
<p>
Now that you hava a Lucene Document object, you can add it to the Lucene index just like you would if it had been
created from a text or HTML file.
- The <a href="../javadoc/org/pdfbox/searchengine/lucene/LucenePDFDocument.html">LucenePDFDocument</a> automatically extracts
+ The <a href="../javadoc/org/apache/pdfbox/searchengine/lucene/LucenePDFDocument.html">LucenePDFDocument</a> automatically extracts
a variety of metadata fields from the PDF to be added to the index, the javadoc shows details on those fields.
This approach is very simple and should be sufficient for most users, if not then you can use some of the advanced text extraction
techniques described in the next section.
@@ -54,7 +54,7 @@
<title>Advanced Text Extraction</title>
<p>Some applications will have complex text extraction requiments and neither the command line application nor the LucenePDFDocument
will be able to fulfill those requirements. It is possible for users to utilize or extend the
- <a href="../javadoc/org/pdfbox/util/PDFTextStripper.html">PDFTextStripper</a> class to meet some of these requirements.</p>
+ <a href="../javadoc/org/apache/pdfbox/util/PDFTextStripper.html">PDFTextStripper</a> class to meet some of these requirements.</p>
<section>
<title>Limiting The Extracted Text</title>
<p>