You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@pdfbox.apache.org by le...@apache.org on 2022/09/12 15:12:30 UTC
[pdfbox-docs] branch asf-site updated: Site checkin for project Apache PDFBox Website
This is an automated email from the ASF dual-hosted git repository.
lehmi pushed a commit to branch asf-site
in repository https://gitbox.apache.org/repos/asf/pdfbox-docs.git
The following commit(s) were added to refs/heads/asf-site by this push:
new 4227df42 Site checkin for project Apache PDFBox Website
4227df42 is described below
commit 4227df422b65533d59b9be947332a44b97050352
Author: Andreas Lehmkühler <an...@lehmi.de>
AuthorDate: Mon Sep 12 17:12:27 2022 +0200
Site checkin for project Apache PDFBox Website
---
content/1.8/architecture.html | 24 +++++-----
content/1.8/commandline.html | 24 +++++-----
content/1.8/cookbook/fill-form-field.html | 33 ++++++++------
content/1.8/cookbook/pdfacreation.html | 3 +-
content/1.8/cookbook/rendering.html | 63 +++++++++++++++------------
content/1.8/cookbook/workingwithmetadata.html | 5 ++-
content/1.8/dependencies.html | 24 +++++-----
content/1.8/faq.html | 24 +++++-----
content/2.0/dependencies.html | 3 +-
content/building.html | 18 +++++---
content/siteupdate.html | 9 ++--
11 files changed, 126 insertions(+), 104 deletions(-)
diff --git a/content/1.8/architecture.html b/content/1.8/architecture.html
index 4221e232..bdd6257d 100644
--- a/content/1.8/architecture.html
+++ b/content/1.8/architecture.html
@@ -100,33 +100,29 @@
<a href="/1.8/cookbook/encryption.html" >
Encrypting a File
</a>
- </li><li>
- <a href="/1.8/cookbook/documentcreation.html" >
- Document Creation
- </a>
</li><li>
<a href="/1.8/cookbook/fill-form-field.html" >
Fill a Form Field
</a>
</li><li>
- <a href="/1.8/cookbook/pdfacreation.html" >
- PDF/A Creation
+ <a href="/1.8/cookbook/documentcreation.html" >
+ Document Creation
</a>
</li><li>
- <a href="/1.8/cookbook/pdfavalidation.html" >
- PDF/A Validation
+ <a href="/1.8/cookbook/rendering.html" >
+ Document Rendering
</a>
</li><li>
- <a href="/1.8/cookbook/textextraction.html" >
- Text Extraction
+ <a href="/1.8/cookbook/pdfacreation.html" >
+ PDF/A Creation
</a>
</li><li>
<a href="/1.8/cookbook/workingwithattachments.html" >
Working with Attachments
</a>
</li><li>
- <a href="/1.8/cookbook/rendering.html" >
- Document Rendering
+ <a href="/1.8/cookbook/pdfavalidation.html" >
+ PDF/A Validation
</a>
</li><li>
<a href="/1.8/cookbook/workingwithfonts.html" >
@@ -136,6 +132,10 @@
<a href="/1.8/cookbook/workingwithmetadata.html" >
Working with Metadata
</a>
+ </li><li>
+ <a href="/1.8/cookbook/textextraction.html" >
+ Text Extraction
+ </a>
</li></ul>
</li><li>
<a href="/1.8/commandline.html" >
diff --git a/content/1.8/commandline.html b/content/1.8/commandline.html
index 19438474..9c7204ee 100644
--- a/content/1.8/commandline.html
+++ b/content/1.8/commandline.html
@@ -100,33 +100,29 @@
<a href="/1.8/cookbook/encryption.html" >
Encrypting a File
</a>
- </li><li>
- <a href="/1.8/cookbook/documentcreation.html" >
- Document Creation
- </a>
</li><li>
<a href="/1.8/cookbook/fill-form-field.html" >
Fill a Form Field
</a>
</li><li>
- <a href="/1.8/cookbook/pdfacreation.html" >
- PDF/A Creation
+ <a href="/1.8/cookbook/documentcreation.html" >
+ Document Creation
</a>
</li><li>
- <a href="/1.8/cookbook/pdfavalidation.html" >
- PDF/A Validation
+ <a href="/1.8/cookbook/rendering.html" >
+ Document Rendering
</a>
</li><li>
- <a href="/1.8/cookbook/textextraction.html" >
- Text Extraction
+ <a href="/1.8/cookbook/pdfacreation.html" >
+ PDF/A Creation
</a>
</li><li>
<a href="/1.8/cookbook/workingwithattachments.html" >
Working with Attachments
</a>
</li><li>
- <a href="/1.8/cookbook/rendering.html" >
- Document Rendering
+ <a href="/1.8/cookbook/pdfavalidation.html" >
+ PDF/A Validation
</a>
</li><li>
<a href="/1.8/cookbook/workingwithfonts.html" >
@@ -136,6 +132,10 @@
<a href="/1.8/cookbook/workingwithmetadata.html" >
Working with Metadata
</a>
+ </li><li>
+ <a href="/1.8/cookbook/textextraction.html" >
+ Text Extraction
+ </a>
</li></ul>
</li><li>
<a href="/1.8/commandline.html" >
diff --git a/content/1.8/cookbook/fill-form-field.html b/content/1.8/cookbook/fill-form-field.html
index ec164750..e2df384d 100644
--- a/content/1.8/cookbook/fill-form-field.html
+++ b/content/1.8/cookbook/fill-form-field.html
@@ -174,35 +174,40 @@
Form there individual fields can be accessed. Fields might be organized in a tree structure so it might
be neccessary to walk through the tree to get an individual field.</p>
<p>Load the PDF document.</p>
-<p>:::java
+<pre><code>:::java
// load the document
-PDDocument pdfDocument = PDDocument.loadNonSeq(new File(... ), null);</p>
+PDDocument pdfDocument = PDDocument.loadNonSeq(new File(... ), null);
+</code></pre>
<p>Get the docoument catalog and the AcroForm which might be contained within.</p>
-<p>:::java
+<pre><code>:::java
// get the document catalog
PDDocumentCatalog docCatalog = pdfDocument.getDocumentCatalog();
-PDAcroForm acroForm = docCatalog.getAcroForm();</p>
+PDAcroForm acroForm = docCatalog.getAcroForm();
+</code></pre>
<p>Retrieve an individual field and set its value.</p>
-<p>:::java
+<pre><code>:::java
// as there might not be an AcroForm entry a null check is necessary
if (acroForm != null)
{
-PDField field = (PDField) acroForm.getField( "fieldName" );
-field.setValue("new field value");
-}</p>
+ PDField field = (PDField) acroForm.getField( "fieldName" );
+ field.setValue("new field value");
+}
+</code></pre>
<p>If a field is nested within the form tree a fully qualified name might be provided
to access the field.</p>
-<p>:::java
+<pre><code>:::java
// as there might not be an AcroForm entry a null check is neccessary
if (acroForm != null)
{
-PDField field = (PDField) acroForm.getField( "fieldsParentName.fieldName" );
-field.setValue("new field value");
-}</p>
+ PDField field = (PDField) acroForm.getField( "fieldsParentName.fieldName" );
+ field.setValue("new field value");
+}
+</code></pre>
<p>Save and close the filled out form.</p>
-<p>:::java
+<pre><code>:::java
doc.save(filledForm);
-doc.close();</p>
+doc.close();
+</code></pre>
</div>
</div>
diff --git a/content/1.8/cookbook/pdfacreation.html b/content/1.8/cookbook/pdfacreation.html
index c5f27337..3fb80d4f 100644
--- a/content/1.8/cookbook/pdfacreation.html
+++ b/content/1.8/cookbook/pdfacreation.html
@@ -189,7 +189,8 @@ example takes one present in pdfbox:</p>
<pre class="language-java"><code class="language-java"><span class="token comment">// Create output intent</span><br><span class="token class-name">InputStream</span> colorProfile <span class="token operator">=</span> <span class="token class-name">CreatePDFA</span><span class="token punctuation">.</span><span class="token keyword">class</span><span class="token punctuation">.</span><span class="token function">getResourceAsStream</span><span class="token punctuation">(</span><span class [...]
<h2 id="complete-example" tabindex="-1">Complete example</h2>
<p>The complete example can be found in pdfbox-example. The source file is</p>
-<p>src/main/java/org/apache/pdfbox/examples/pdfa/CreatePDFA.java</p>
+<pre><code>src/main/java/org/apache/pdfbox/examples/pdfa/CreatePDFA.java
+</code></pre>
</div>
</div>
diff --git a/content/1.8/cookbook/rendering.html b/content/1.8/cookbook/rendering.html
index cc391f6b..1e0cd485 100644
--- a/content/1.8/cookbook/rendering.html
+++ b/content/1.8/cookbook/rendering.html
@@ -172,34 +172,41 @@
<h1 id="document-rendering" tabindex="-1">Document Rendering</h1>
<h2 id="convert-a-document-to-images" tabindex="-1">Convert a Document to Images</h2>
<p>This small sample shows how to render (convert to images) a PDF document using PDFBox.</p>
-<p>:::java
-String filename = "YOURFILENAMEHERE.pdf";</p>
-<p>// open the document
-PDDocument doc = PDDocument.loadNonSeq(new File(filename), null);</p>
-<p>boolean b;
-List<PDPage> pages = doc.getDocumentCatalog().getAllPages();
-for (int p = 0; p < pages.size(); ++p)
-{
-// RGB image with 300 dpi
-BufferedImage bim = pages.get(p).convertToImage(BufferedImage.TYPE_INT_RGB, 300);</p>
-<p>// save as PNG with default metadata
-b = ImageIO.write(bim, "png", new File("rgbpage" + (p+1) + ".png"));
-if (!b)
-{
-// error handling
-}</p>
-<p>// B/W image with 300 dpi
-bim = pages.get(p).convertToImage(BufferedImage.TYPE_BYTE_BINARY, 300);</p>
-<p>// save as TIF with dpi in the metadata
-// PDFBox will choose the best compression for you - here: CCITT G4
-// you need to add jai_imageio.jar to your classpath for this to work
-b = ImageIOUtil.writeImage(bim, "bwpage-" + (p+1) + ".tif", 300);
-if (!b)
-{
-// error handling
-}
-}</p>
-<p>doc.close();</p>
+<pre><code>:::java
+ String filename = "YOURFILENAMEHERE.pdf";
+
+ // open the document
+ PDDocument doc = PDDocument.loadNonSeq(new File(filename), null);
+
+ boolean b;
+ List<PDPage> pages = doc.getDocumentCatalog().getAllPages();
+ for (int p = 0; p < pages.size(); ++p)
+ {
+ // RGB image with 300 dpi
+ BufferedImage bim = pages.get(p).convertToImage(BufferedImage.TYPE_INT_RGB, 300);
+
+ // save as PNG with default metadata
+ b = ImageIO.write(bim, "png", new File("rgbpage" + (p+1) + ".png"));
+ if (!b)
+ {
+ // error handling
+ }
+
+ // B/W image with 300 dpi
+ bim = pages.get(p).convertToImage(BufferedImage.TYPE_BYTE_BINARY, 300);
+
+ // save as TIF with dpi in the metadata
+ // PDFBox will choose the best compression for you - here: CCITT G4
+ // you need to add jai_imageio.jar to your classpath for this to work
+ b = ImageIOUtil.writeImage(bim, "bwpage-" + (p+1) + ".tif", 300);
+ if (!b)
+ {
+ // error handling
+ }
+ }
+
+ doc.close();
+</code></pre>
</div>
</div>
diff --git a/content/1.8/cookbook/workingwithmetadata.html b/content/1.8/cookbook/workingwithmetadata.html
index c9bfc900..4b056de8 100644
--- a/content/1.8/cookbook/workingwithmetadata.html
+++ b/content/1.8/cookbook/workingwithmetadata.html
@@ -185,11 +185,12 @@ See example: AddMetadataFromDocInfo<br>
See Adobe Documentation: XMP Specification</p>
<p>PDF documents can have XML metadata associated with certain objects within a PDF document.
For example, the following PD Model objects have the ability to contain metadata:</p>
-<p>PDDocumentCatalog
+<pre><code>PDDocumentCatalog
PDPage
PDXObject
PDICCBased
-PDStream</p>
+PDStream
+</code></pre>
<p>The metadata that is stored in PDF objects conforms to the XMP specification, it is
recommended that you review that specification. Currently there is no high level API for
managing the XML metadata, PDFBox uses standard java InputStream/OutputStream to retrieve
diff --git a/content/1.8/dependencies.html b/content/1.8/dependencies.html
index e8873263..e25110f0 100644
--- a/content/1.8/dependencies.html
+++ b/content/1.8/dependencies.html
@@ -100,33 +100,29 @@
<a href="/1.8/cookbook/encryption.html" >
Encrypting a File
</a>
- </li><li>
- <a href="/1.8/cookbook/documentcreation.html" >
- Document Creation
- </a>
</li><li>
<a href="/1.8/cookbook/fill-form-field.html" >
Fill a Form Field
</a>
</li><li>
- <a href="/1.8/cookbook/pdfacreation.html" >
- PDF/A Creation
+ <a href="/1.8/cookbook/documentcreation.html" >
+ Document Creation
</a>
</li><li>
- <a href="/1.8/cookbook/pdfavalidation.html" >
- PDF/A Validation
+ <a href="/1.8/cookbook/rendering.html" >
+ Document Rendering
</a>
</li><li>
- <a href="/1.8/cookbook/textextraction.html" >
- Text Extraction
+ <a href="/1.8/cookbook/pdfacreation.html" >
+ PDF/A Creation
</a>
</li><li>
<a href="/1.8/cookbook/workingwithattachments.html" >
Working with Attachments
</a>
</li><li>
- <a href="/1.8/cookbook/rendering.html" >
- Document Rendering
+ <a href="/1.8/cookbook/pdfavalidation.html" >
+ PDF/A Validation
</a>
</li><li>
<a href="/1.8/cookbook/workingwithfonts.html" >
@@ -136,6 +132,10 @@
<a href="/1.8/cookbook/workingwithmetadata.html" >
Working with Metadata
</a>
+ </li><li>
+ <a href="/1.8/cookbook/textextraction.html" >
+ Text Extraction
+ </a>
</li></ul>
</li><li>
<a href="/1.8/commandline.html" >
diff --git a/content/1.8/faq.html b/content/1.8/faq.html
index ba9ceefd..9cc1cd32 100644
--- a/content/1.8/faq.html
+++ b/content/1.8/faq.html
@@ -100,33 +100,29 @@
<a href="/1.8/cookbook/encryption.html" >
Encrypting a File
</a>
- </li><li>
- <a href="/1.8/cookbook/documentcreation.html" >
- Document Creation
- </a>
</li><li>
<a href="/1.8/cookbook/fill-form-field.html" >
Fill a Form Field
</a>
</li><li>
- <a href="/1.8/cookbook/pdfacreation.html" >
- PDF/A Creation
+ <a href="/1.8/cookbook/documentcreation.html" >
+ Document Creation
</a>
</li><li>
- <a href="/1.8/cookbook/pdfavalidation.html" >
- PDF/A Validation
+ <a href="/1.8/cookbook/rendering.html" >
+ Document Rendering
</a>
</li><li>
- <a href="/1.8/cookbook/textextraction.html" >
- Text Extraction
+ <a href="/1.8/cookbook/pdfacreation.html" >
+ PDF/A Creation
</a>
</li><li>
<a href="/1.8/cookbook/workingwithattachments.html" >
Working with Attachments
</a>
</li><li>
- <a href="/1.8/cookbook/rendering.html" >
- Document Rendering
+ <a href="/1.8/cookbook/pdfavalidation.html" >
+ PDF/A Validation
</a>
</li><li>
<a href="/1.8/cookbook/workingwithfonts.html" >
@@ -136,6 +132,10 @@
<a href="/1.8/cookbook/workingwithmetadata.html" >
Working with Metadata
</a>
+ </li><li>
+ <a href="/1.8/cookbook/textextraction.html" >
+ Text Extraction
+ </a>
</li></ul>
</li><li>
<a href="/1.8/commandline.html" >
diff --git a/content/2.0/dependencies.html b/content/2.0/dependencies.html
index e7896492..e2bfa3c0 100644
--- a/content/2.0/dependencies.html
+++ b/content/2.0/dependencies.html
@@ -166,7 +166,8 @@ included in the Java platform.</p>
<pre class="language-xml"><code class="language-xml"><span class="token tag"><span class="token tag"><span class="token punctuation"><</span>dependency</span><span class="token punctuation">></span></span><br> <span class="token tag"><span class="token tag"><span class="token punctuation"><</span>groupId</span><span class="token punctuation">></span></span>org.bouncycastle<span class="token tag"><span class="token tag"><span class="token punctuation"></</span>groupId</span><s [...]
<h3 id="java-cryptography-extension-(jce)" tabindex="-1">Java Cryptography Extension (JCE)</h3>
<p>256-bit AES encryption requires a JDK with "unlimited strength" cryptography, which requires extra files to be installed. For JDK 7, see <a href="http://www.oracle.com/technetwork/java/javase/downloads/jce-7-download-432124.html">Java Cryptography Extension (JCE)</a>. If these files are not installed, building PDFBox will throw an exception with the following message:</p>
-<p>JCE unlimited strength jurisdiction policy files are not installed</p>
+<pre><code>JCE unlimited strength jurisdiction policy files are not installed
+</code></pre>
<h2 id="dependencies-for-ant-builds" tabindex="-1">Dependencies for Ant Builds</h2>
<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.
diff --git a/content/building.html b/content/building.html
index 7bb9223b..5442d2a0 100644
--- a/content/building.html
+++ b/content/building.html
@@ -173,17 +173,19 @@
<p>Building PDFBox from source is only necessary if you're wanting to contribute code to the PDFBox project. Most users should use the <a href="http://pdfbox.apache.org/download.cgi">binary releases</a> instead.</p>
<h2 id="obtaining-the-source" tabindex="-1">Obtaining the Source</h2>
<p>You can obtain the latest source of PDFBox from our <a href="http://svn.apache.org/repos/asf/pdfbox/">SVN repo</a>. The current trunk is 3.0.0-SNAPSHOT. There is a separate branch for the 1.8.x and the 2.0.x series. You can fetch the latest trunk version using Subversion:</p>
-<p>svn checkout http://svn.apache.org/repos/asf/pdfbox/trunk/
-cd trunk</p>
+<pre><code>svn checkout http://svn.apache.org/repos/asf/pdfbox/trunk/
+cd trunk
+</code></pre>
<p>You can also browse the Subversion repository using <a href="https://svn.apache.org/viewvc/pdfbox/">ViewVC</a>.</p>
<p>We also have a read-only <a href="https://git.apache.org/">Git mirror</a> which is further mirrored to GitHub as <a href="https://github.com/apache/pdfbox">apache/pdfbox</a>.</p>
<p>The sources for the <strong>Java ImageIO plugin for the JBIG2 image format</strong> are available in the <a href="https://gitbox.apache.org/repos/asf/pdfbox-jbig2.git">Apache Git Repository</a> or can be loaded from <a href="https://github.com/apache/pdfbox-jbig2">GitHub</a>:</p>
-<p>git clone https://gitbox.apache.org/repos/asf/pdfbox-jbig2.git
-cd pdfbox-jbig2</p>
+<pre><code>git clone https://gitbox.apache.org/repos/asf/pdfbox-jbig2.git
+cd pdfbox-jbig2
+</code></pre>
<h2 id="build-dependencies" tabindex="-1">Build dependencies</h2>
<h3 id="pdfbox-1.8" tabindex="-1">PDFBox 1.8</h3>
<ul>
-<li>JDK 5 or 6</li>
+<li>JDK 8 (build only)</li>
<li><a href="http://maven.apache.org/">Maven 3</a></li>
</ul>
<h3 id="pdfbox-2.0" tabindex="-1">PDFBox 2.0</h3>
@@ -199,10 +201,12 @@ cd pdfbox-jbig2</p>
</ul>
<h3 id="java-cryptography-extension-(jce)" tabindex="-1">Java Cryptography Extension (JCE)</h3>
<p>Building PDFBox 2.0 requires a JDK with "unlimited strength" cryptography, which requires extra files to be installed. For JDK 7, see <a href="http://www.oracle.com/technetwork/java/javase/downloads/jce-7-download-432124.html">Java Cryptography Extension (JCE)</a>. If these files are not installed, building PDFBox will fail the following test:</p>
-<p>TestPublicKeyEncryption.setUp:70 JCE unlimited strength jurisdiction policy files are not installed</p>
+<pre><code>TestPublicKeyEncryption.setUp:70 JCE unlimited strength jurisdiction policy files are not installed
+</code></pre>
<h2 id="building-with-maven" tabindex="-1">Building with Maven</h2>
<p>In the root directory of PDFBox:</p>
-<p>mvn clean install</p>
+<pre><code>mvn clean install
+</code></pre>
<hr>
<h2 id="building-with-ant-(deprecated%2C-removed-in-2.0.0)" tabindex="-1">Building with Ant (Deprecated, removed in 2.0.0)</h2>
<p>The old Ant build is still available, and can be used especially for
diff --git a/content/siteupdate.html b/content/siteupdate.html
index e34b96de..e7341027 100644
--- a/content/siteupdate.html
+++ b/content/siteupdate.html
@@ -252,7 +252,8 @@ those tools on your host then. The binaries are added to the local project sourc
build errors due to incompatible versions of <code>node.js</code> tooling installed on your machine.</p>
<h3 id="preparing-maven" tabindex="-1">Preparing Maven</h3>
<p>Make sure that you have Maven installed.</p>
-<p>$ mvn --version</p>
+<pre><code>$ mvn --version
+</code></pre>
<p>If this command fails with an error, you do not have Maven installed.</p>
<p>Please install Maven using your favorite package manager (like <a href="https://brew.sh/">Homebrew</a>) or from
official <a href="https://maven.apache.org/install.html">Maven binaries</a></p>
@@ -264,14 +265,16 @@ official <a href="https://maven.apache.org/install.html">Maven binaries</a></p>
<li>Build the website content using Eleventy</li>
</ul>
<p>You can do all of this with one single command:</p>
-<p>$ mvn package</p>
+<pre><code>$ mvn package
+</code></pre>
<p>The whole process takes up to five minutes (time to grab some coffee!)</p>
<p>When the build is finished you should see the generated website in the <code>public</code> directory.</p>
<h3 id="clean-build" tabindex="-1">Clean build</h3>
<p>When rebuilding the website the process uses some cached content.
If you want to start from scratch for some reason you can simply add the <code>clean</code> operation to the build which removes
all generated sources in the project first.</p>
-<p>$ mvn clean package</p>
+<pre><code>$ mvn clean package
+</code></pre>
</div>
</div>