Site checkin for project Apache PDFBox Website
Project: http://git-wip-us.apache.org/repos/asf/pdfbox-docs/repo Commit: http://git-wip-us.apache.org/repos/asf/pdfbox-docs/commit/9434dd0c Tree: http://git-wip-us.apache.org/repos/asf/pdfbox-docs/tree/9434dd0c Diff: http://git-wip-us.apache.org/repos/asf/pdfbox-docs/diff/9434dd0c Branch: refs/heads/asf-site Commit: 9434dd0cf6c57dd62e42e177928eed5f23ab223c Parents: d1eeb0f Author: Maruan Sahyoun <sahy...@fileaffairs.de> Authored: Mon Feb 6 18:40:51 2017 +0100 Committer: Maruan Sahyoun <sahy...@fileaffairs.de> Committed: Mon Feb 6 18:40:51 2017 +0100 ---------------------------------------------------------------------- content/1.8/architecture.html | 10 +- content/1.8/commandline.html | 92 ++++++++--------- content/1.8/cookbook/documentcreation.html | 12 +-- content/1.8/cookbook/encryption.html | 22 ++-- content/1.8/cookbook/fill-form-field.html | 8 +- content/1.8/cookbook/pdfacreation.html | 25 ++--- content/1.8/cookbook/pdfavalidation.html | 8 +- content/1.8/cookbook/rendering.html | 10 +- content/1.8/cookbook/textextraction.html | 20 ++-- .../1.8/cookbook/workingwithattachments.html | 8 +- content/1.8/cookbook/workingwithfonts.html | 18 ++-- content/1.8/cookbook/workingwithmetadata.html | 18 ++-- content/1.8/dependencies.html | 62 ++++++------ content/1.8/faq.html | 18 ++-- content/2.0/commandline.html | 100 ++++++++++--------- content/2.0/cookbook/encryption.html | 20 ++-- content/2.0/dependencies.html | 62 ++++++------ content/2.0/examples.html | 8 +- content/2.0/faq.html | 20 ++-- content/2.0/getting-started.html | 28 +++--- content/2.0/migration.html | 10 +- content/building.html | 8 +- content/codingconventions.html | 42 ++++---- content/download.html | 8 +- content/errors/403.html | 8 +- content/errors/404.html | 8 +- content/ideas.html | 24 ++--- content/index.html | 10 +- content/mailinglists.html | 8 +- .../2015/10/19/pdfbox-2.0.0-RC1-released.html | 8 +- .../2015/11/22/pdfbox-2.0.0-RC2-released.html | 8 +- .../2016/01/15/pdfbox-2.0.0-RC3-released.html | 8 +- .../news/2016/01/18/pdfbox-1.8.11-released.html | 8 +- .../news/2016/03/18/pdfbox-2.0.0-released.html | 8 +- .../news/2016/04/26/new-pdfbox-releases.html | 8 +- content/news/2016/05/27/CVE-2016-2175.html | 8 +- .../news/2016/06/09/pdfbox-2.0.2-released.html | 8 +- .../news/2016/09/17/pdfbox-2.0.3-released.html | 8 +- .../news/2016/12/09/pdfbox-1.8.13-released.html | 8 +- .../news/2016/12/16/pdfbox-2.0.4-released.html | 8 +- content/references.html | 10 +- content/siteupdate.html | 46 ++++----- content/support.html | 51 +++++----- content/team.html | 8 +- 44 files changed, 453 insertions(+), 445 deletions(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/pdfbox-docs/blob/9434dd0c/content/1.8/architecture.html ---------------------------------------------------------------------- diff --git a/content/1.8/architecture.html b/content/1.8/architecture.html index b6d1c82..36b1891 100644 --- a/content/1.8/architecture.html +++ b/content/1.8/architecture.html @@ -23,7 +23,7 @@ <meta charset="utf-8"> <meta http-equiv="X-UA-Compatible" content="IE=edge"> <meta name="viewport" content="width=device-width, initial-scale=1"> - <meta name="description" content="The Apache PDFBox⢠library is an open source Java tool for working with PDF documents. This project allows creation of new PDF documents, manipulation of existing documents and the ability to extract content from documents. Apache PDFBox also includes several command line utilities. Apache PDFBox is published under the Apache License v2.0. + <meta name="description" content="The Apache PDFBox⢠library is an open source Java tool for working with PDF documents. This project allows creation of new PDF documents, manipulation of existing documents and the ability to extract content from documents. Apache PDFBox also includes several command-line utilities. Apache PDFBox is published under the Apache License v2.0. "> <title>Apache PDFBox | Architecture</title> @@ -84,7 +84,7 @@ <li><a href="/2.0/cookbook/encryption.html">Document Encryption</a></li> </ul> </li> - <li><a href="/2.0/commandline.html">Command Line Tools</a></li> + <li><a href="/2.0/commandline.html">Command-Line Tools</a></li> <li><a href="/2.0/faq.html">FAQ</a></li> <li><a href="/docs/2.0.3/javadocs/">API Docs</a></li> </ul> @@ -104,10 +104,10 @@ <li><a href="/1.8/cookbook/workingwithmetadata.html">Working with Metadata</a></li> <li><a href="/1.8/cookbook/workingwithattachments.html">Working with Attachments</a></li> <li><a href="/1.8/cookbook/pdfavalidation.html">PDF/A Validation</a></li> - <li><a href="/1.8/cookbook/pdfacreation.html">Creating a PDF/A document</a></li> + <li><a href="/1.8/cookbook/pdfacreation.html">Creating a PDF/A Document</a></li> </ul> </li> - <li><a href="/1.8/commandline.html">Command Line Tools</a></li> + <li><a href="/1.8/commandline.html">Command-Line Tools</a></li> <li><a href="/docs/1.8.12/javadocs/">API Docs</a></li> <li><a href="/1.8/faq.html">FAQ</a></li> </ul> @@ -245,7 +245,7 @@ doesnât provide the functionality needed.</p> </tbody> </table> -<p>A page in a pdf document is represented with a COSDictionary. The entries that are available for a page can be seen in the PDF Reference and an example of a page looks like this:</p> +<p>A page in a PDF document is represented with a COSDictionary. The entries that are available for a page can be seen in the PDF Reference and an example of a page looks like this:</p> <div class="highlighter-rouge"><pre class="highlight"><code><< /Type /Page http://git-wip-us.apache.org/repos/asf/pdfbox-docs/blob/9434dd0c/content/1.8/commandline.html ---------------------------------------------------------------------- diff --git a/content/1.8/commandline.html b/content/1.8/commandline.html index 0b8d065..64b3270 100644 --- a/content/1.8/commandline.html +++ b/content/1.8/commandline.html @@ -23,10 +23,10 @@ <meta charset="utf-8"> <meta http-equiv="X-UA-Compatible" content="IE=edge"> <meta name="viewport" content="width=device-width, initial-scale=1"> - <meta name="description" content="The Apache PDFBox⢠library is an open source Java tool for working with PDF documents. This project allows creation of new PDF documents, manipulation of existing documents and the ability to extract content from documents. Apache PDFBox also includes several command line utilities. Apache PDFBox is published under the Apache License v2.0. + <meta name="description" content="The Apache PDFBox⢠library is an open source Java tool for working with PDF documents. This project allows creation of new PDF documents, manipulation of existing documents and the ability to extract content from documents. Apache PDFBox also includes several command-line utilities. Apache PDFBox is published under the Apache License v2.0. "> - <title>Apache PDFBox | Command Line Tools</title> + <title>Apache PDFBox | Command-Line Tools</title> <link href="/bootstrap/css/bootstrap.min.css" rel="stylesheet"> <link href="/css/pygments-github.css" rel="stylesheet"> @@ -84,7 +84,7 @@ <li><a href="/2.0/cookbook/encryption.html">Document Encryption</a></li> </ul> </li> - <li><a href="/2.0/commandline.html">Command Line Tools</a></li> + <li><a href="/2.0/commandline.html">Command-Line Tools</a></li> <li><a href="/2.0/faq.html">FAQ</a></li> <li><a href="/docs/2.0.3/javadocs/">API Docs</a></li> </ul> @@ -104,10 +104,10 @@ <li><a href="/1.8/cookbook/workingwithmetadata.html">Working with Metadata</a></li> <li><a href="/1.8/cookbook/workingwithattachments.html">Working with Attachments</a></li> <li><a href="/1.8/cookbook/pdfavalidation.html">PDF/A Validation</a></li> - <li><a href="/1.8/cookbook/pdfacreation.html">Creating a PDF/A document</a></li> + <li><a href="/1.8/cookbook/pdfacreation.html">Creating a PDF/A Document</a></li> </ul> </li> - <li><a href="/1.8/commandline.html">Command Line Tools</a></li> + <li><a href="/1.8/commandline.html">Command-Line Tools</a></li> <li><a href="/docs/1.8.12/javadocs/">API Docs</a></li> <li><a href="/1.8/faq.html">FAQ</a></li> </ul> @@ -131,27 +131,27 @@ </ul> </div> <div class="col-xs-12 col-sm-9"> - <h1 id="command-line-tools">Command Line Tools</h1> + <h1 id="command-line-tools">Command-Line Tools</h1> -<p>PDFBox comes with a series of command line utilities. They are available as standard Java applications.</p> +<p>PDFBox comes with a series of command-line utilities. They are available as standard Java applications.</p> <p>See the <a href="/1.8/dependencies.html">Dependencies</a> page for instructions on how to set your classpath in order to run PDFBox tools as Java applications.</p> -<p><strong>Table of Contents</strong><br /> -<a href="#decrypt">Decrypt</a> -<a href="#encrypt">Encrypt</a> -<a href="#extractimages">ExtractImages</a> -<a href="#extracttext">ExtractText</a> -<a href="#overlaypdf">OverlayPDF</a> -<a href="#printpdf">PrintPDF</a> -<a href="#pdfdebugger">PDFDebugger</a> -<a href="#pdfreader">PDFReader</a> -<a href="#pdfmerger">PDFMerger</a> -<a href="#pdfsplit">PDFSplit</a> -<a href="#pdftoimage">PDFToImage</a> -<a href="#texttopdf">TextToPDF</a> -<a href="#writedecodeddoc">WriteDecodedDoc</a></p> +<p><strong>Table of Contents</strong> + - <a href="#decrypt">Decrypt</a> + - <a href="#encrypt">Encrypt</a> + - <a href="#extractimages">ExtractImages</a> + - <a href="#extracttext">ExtractText</a> + - <a href="#overlaypdf">OverlayPDF</a> + - <a href="#printpdf">PrintPDF</a> + - <a href="#pdfdebugger">PDFDebugger</a> + - <a href="#pdfreader">PDFReader</a> + - <a href="#pdfmerger">PDFMerger</a> + - <a href="#pdfsplit">PDFSplit</a> + - <a href="#pdftoimage">PDFToImage</a> + - <a href="#texttopdf">TextToPDF</a> + - <a href="#writedecodeddoc">WriteDecodedDoc</a></p> <h2 id="decrypt">Decrypt</h2> @@ -159,12 +159,12 @@ PDFBox tools as Java applications.</p> <p>NOTE: You must have the owner password to decrypt the document!</p> -<p>usage: <code class="highlighter-rouge">java -jar pdfbox-app-x.y.z.jar Decrypt [OPTIONS] <inputfile> [outputfile]</code></p> +<p>Usage: <code class="highlighter-rouge">java -jar pdfbox-app-x.y.z.jar Decrypt [OPTIONS] <inputfile> [outputfile]</code></p> <table> <thead> <tr> - <th>Command Line Parameter</th> + <th>Command-Line Parameter</th> <th>Description</th> </tr> </thead> @@ -196,12 +196,12 @@ PDFBox tools as Java applications.</p> <p>This application will encrypt a PDF document.</p> -<p>usage: <code class="highlighter-rouge">java -jar pdfbox-app-x.y.z.jar Encrypt [OPTIONS] <password> <inputfile></code></p> +<p>Usage: <code class="highlighter-rouge">java -jar pdfbox-app-x.y.z.jar Encrypt [OPTIONS] <password> <inputfile></code></p> <table> <thead> <tr> - <th>Command Line Parameter</th> + <th>Command-Line Parameter</th> <th>Default</th> <th>Description</th> </tr> @@ -284,12 +284,12 @@ PDFBox tools as Java applications.</p> <p>This application will extract all images from the given PDF document.</p> -<p>usage: <code class="highlighter-rouge">java -jar pdfbox-app-x.y.z.jar ExtractImages [OPTIONS] <inputfile></code></p> +<p>Usage: <code class="highlighter-rouge">java -jar pdfbox-app-x.y.z.jar ExtractImages [OPTIONS] <inputfile></code></p> <table> <thead> <tr> - <th>Command Line Parameter</th> + <th>Command-Line Parameter</th> <th>Default</th> <th>Description</th> </tr> @@ -317,12 +317,12 @@ PDFBox tools as Java applications.</p> <p>This application will extract all text from the given PDF document.</p> -<p>usage: <code class="highlighter-rouge">java -jar pdfbox-app-x.y.z.jar ExtractText [OPTIONS] <inputfile> [Text file]</code></p> +<p>Usage: <code class="highlighter-rouge">java -jar pdfbox-app-x.y.z.jar ExtractText [OPTIONS] <inputfile> [Text file]</code></p> <table> <thead> <tr> - <th>Command Line Parameter</th> + <th>Command-Line Parameter</th> <th>Default</th> <th>Description</th> </tr> @@ -390,12 +390,12 @@ PDFBox tools as Java applications.</p> <p>This application will overlay one document with the content of another document</p> -<p>usage: <code class="highlighter-rouge">java -jar pdfbox-app-x.y.z.jar OverlayPDF <input.pdf> [OPTIONS] <output.pdf></code></p> +<p>Usage: <code class="highlighter-rouge">java -jar pdfbox-app-x.y.z.jar OverlayPDF <input.pdf> [OPTIONS] <output.pdf></code></p> <table> <thead> <tr> - <th>Command Line Parameter</th> + <th>Command-Line Parameter</th> <th>Default</th> <th>Description</th> </tr> @@ -468,12 +468,12 @@ PDFBox tools as Java applications.</p> <p class="alert alert-info">You must have the correct permissions to print the document!</p> -<p>usage: <code class="highlighter-rouge">java -jar pdfbox-app-x.y.z.jar PrintPDF [OPTIONS] <inputfile></code></p> +<p>Usage: <code class="highlighter-rouge">java -jar pdfbox-app-x.y.z.jar PrintPDF [OPTIONS] <inputfile></code></p> <table> <thead> <tr> - <th>Command Line Parameter</th> + <th>Command-Line Parameter</th> <th>Description</th> </tr> </thead> @@ -497,12 +497,12 @@ PDFBox tools as Java applications.</p> <p>This application will take an existing PDF document and allows to analyze and inspect the internal structure</p> -<p>usage: <code class="highlighter-rouge">java -jar pdfbox-app-x.y.z.jar PDFDebugger [inputfile]</code></p> +<p>Usage: <code class="highlighter-rouge">java -jar pdfbox-app-x.y.z.jar PDFDebugger [inputfile]</code></p> <table> <thead> <tr> - <th>Command Line Parameter</th> + <th>Command-Line Parameter</th> <th>Default</th> <th>Description</th> </tr> @@ -530,12 +530,12 @@ PDFBox tools as Java applications.</p> <p>An application to read PDF documents. This will provide Acrobat Reader like functionality.</p> -<p>usage: <code class="highlighter-rouge">java -jar pdfbox-app-x.y.z.jar PDFReader [PDF file]</code></p> +<p>Usage: <code class="highlighter-rouge">java -jar pdfbox-app-x.y.z.jar PDFReader [PDF file]</code></p> <table> <thead> <tr> - <th>Command Line Parameter</th> + <th>Command-Line Parameter</th> <th>Default</th> <th>Description</th> </tr> @@ -563,7 +563,7 @@ PDFBox tools as Java applications.</p> <p>This application will take a list of pdf documents and merge them, saving the result in a new document.</p> -<p>usage: <code class="highlighter-rouge">java -jar pdfbox-app-x.y.z.jar PDFMerger <Source PDF files (2 ..n)> <Target PDF file></code></p> +<p>Usage: <code class="highlighter-rouge">java -jar pdfbox-app-x.y.z.jar PDFMerger <Source PDF files (2 ..n)> <Target PDF file></code></p> <h2 id="pdfsplit">PDFSplit</h2> @@ -572,12 +572,12 @@ PDFBox tools as Java applications.</p> <p>Per default the resulting files will be named after the original filenmame with <code class="highlighter-rouge">-<nr></code> appended before the suffix. To override the filename use the <code class="highlighter-rouge">outputPrefix</code> option.</p> -<p>usage: <code class="highlighter-rouge">java -jar pdfbox-app-x.y.z.jar PDFSplit [OPTIONS] <PDF file></code></p> +<p>Usage: <code class="highlighter-rouge">java -jar pdfbox-app-x.y.z.jar PDFSplit [OPTIONS] <PDF file></code></p> <table> <thead> <tr> - <th>Command Line Parameter</th> + <th>Command-Line Parameter</th> <th>Default</th> <th>Description</th> </tr> @@ -629,12 +629,12 @@ To override the filename use the <code class="highlighter-rouge">outputPrefix</c <p>This application will create an image for every page in the PDF document.</p> -<p>usage: <code class="highlighter-rouge">java -jar pdfbox-app-x.y.z.jar PDFToImage [OPTIONS] <PDF file></code></p> +<p>Usage: <code class="highlighter-rouge">java -jar pdfbox-app-x.y.z.jar PDFToImage [OPTIONS] <PDF file></code></p> <table> <thead> <tr> - <th>Command Line Parameter</th> + <th>Command-Line Parameter</th> <th>Default</th> <th>Description</th> </tr> @@ -677,12 +677,12 @@ To override the filename use the <code class="highlighter-rouge">outputPrefix</c <p>This application will create a PDF document from a text file.</p> -<p>usage: <code class="highlighter-rouge">java -jar pdfbox-app-x.y.z.jar TextToPDF [OPTIONS] <outputfile> <textfile></code></p> +<p>Usage: <code class="highlighter-rouge">java -jar pdfbox-app-x.y.z.jar TextToPDF [OPTIONS] <outputfile> <textfile></code></p> <table> <thead> <tr> - <th>Command Line Parameter</th> + <th>Command-Line Parameter</th> <th>Default</th> <th>Description</th> </tr> @@ -729,12 +729,12 @@ To override the filename use the <code class="highlighter-rouge">outputPrefix</c <p>An application to decompress PDF documents.</p> -<p>usage: <code class="highlighter-rouge">java -jar pdfbox-app-x.y.z.jar WriteDecodedDoc <input-file> <output-file></code></p> +<p>Usage: <code class="highlighter-rouge">java -jar pdfbox-app-x.y.z.jar WriteDecodedDoc <input-file> <output-file></code></p> <table> <thead> <tr> - <th>Command Line Parameter</th> + <th>Command-Line Parameter</th> <th>Default</th> <th>Description</th> </tr> http://git-wip-us.apache.org/repos/asf/pdfbox-docs/blob/9434dd0c/content/1.8/cookbook/documentcreation.html ---------------------------------------------------------------------- diff --git a/content/1.8/cookbook/documentcreation.html b/content/1.8/cookbook/documentcreation.html index 3ca2820..3365b5c 100644 --- a/content/1.8/cookbook/documentcreation.html +++ b/content/1.8/cookbook/documentcreation.html @@ -23,7 +23,7 @@ <meta charset="utf-8"> <meta http-equiv="X-UA-Compatible" content="IE=edge"> <meta name="viewport" content="width=device-width, initial-scale=1"> - <meta name="description" content="The Apache PDFBox⢠library is an open source Java tool for working with PDF documents. This project allows creation of new PDF documents, manipulation of existing documents and the ability to extract content from documents. Apache PDFBox also includes several command line utilities. Apache PDFBox is published under the Apache License v2.0. + <meta name="description" content="The Apache PDFBox⢠library is an open source Java tool for working with PDF documents. This project allows creation of new PDF documents, manipulation of existing documents and the ability to extract content from documents. Apache PDFBox also includes several command-line utilities. Apache PDFBox is published under the Apache License v2.0. "> <title>Apache PDFBox | Cookbook - Document Creation</title> @@ -84,7 +84,7 @@ <li><a href="/2.0/cookbook/encryption.html">Document Encryption</a></li> </ul> </li> - <li><a href="/2.0/commandline.html">Command Line Tools</a></li> + <li><a href="/2.0/commandline.html">Command-Line Tools</a></li> <li><a href="/2.0/faq.html">FAQ</a></li> <li><a href="/docs/2.0.3/javadocs/">API Docs</a></li> </ul> @@ -104,10 +104,10 @@ <li><a href="/1.8/cookbook/workingwithmetadata.html">Working with Metadata</a></li> <li><a href="/1.8/cookbook/workingwithattachments.html">Working with Attachments</a></li> <li><a href="/1.8/cookbook/pdfavalidation.html">PDF/A Validation</a></li> - <li><a href="/1.8/cookbook/pdfacreation.html">Creating a PDF/A document</a></li> + <li><a href="/1.8/cookbook/pdfacreation.html">Creating a PDF/A Document</a></li> </ul> </li> - <li><a href="/1.8/commandline.html">Command Line Tools</a></li> + <li><a href="/1.8/commandline.html">Command-Line Tools</a></li> <li><a href="/docs/1.8.12/javadocs/">API Docs</a></li> <li><a href="/1.8/faq.html">FAQ</a></li> </ul> @@ -133,7 +133,7 @@ <div class="col-xs-12 col-sm-9"> <h1 id="document-creation">Document Creation</h1> -<h2 id="create-a-blank-pdf">Create a blank PDF</h2> +<h2 id="create-a-blank-pdf">Create a Blank PDF</h2> <p>This small sample shows how to create a new PDF document using PDFBox.</p> @@ -153,7 +153,7 @@ </code></pre> </div> -<h2 id="hello-world-using-a-pdf-base-font">Hello World using a PDF base font</h2> +<h2 id="hello-world-using-a-pdf-base-font">Hello World Using a PDF Base Font</h2> <p>This small sample shows how to create a new document and print the text âHello Worldâ using one of the PDF base fonts.</p> http://git-wip-us.apache.org/repos/asf/pdfbox-docs/blob/9434dd0c/content/1.8/cookbook/encryption.html ---------------------------------------------------------------------- diff --git a/content/1.8/cookbook/encryption.html b/content/1.8/cookbook/encryption.html index 2d44198..8c3154f 100644 --- a/content/1.8/cookbook/encryption.html +++ b/content/1.8/cookbook/encryption.html @@ -23,10 +23,10 @@ <meta charset="utf-8"> <meta http-equiv="X-UA-Compatible" content="IE=edge"> <meta name="viewport" content="width=device-width, initial-scale=1"> - <meta name="description" content="The Apache PDFBox⢠library is an open source Java tool for working with PDF documents. This project allows creation of new PDF documents, manipulation of existing documents and the ability to extract content from documents. Apache PDFBox also includes several command line utilities. Apache PDFBox is published under the Apache License v2.0. + <meta name="description" content="The Apache PDFBox⢠library is an open source Java tool for working with PDF documents. This project allows creation of new PDF documents, manipulation of existing documents and the ability to extract content from documents. Apache PDFBox also includes several command-line utilities. Apache PDFBox is published under the Apache License v2.0. "> - <title>Apache PDFBox | Cookbook - Encrypting a file</title> + <title>Apache PDFBox | Cookbook - Encrypting a File</title> <link href="/bootstrap/css/bootstrap.min.css" rel="stylesheet"> <link href="/css/pygments-github.css" rel="stylesheet"> @@ -84,7 +84,7 @@ <li><a href="/2.0/cookbook/encryption.html">Document Encryption</a></li> </ul> </li> - <li><a href="/2.0/commandline.html">Command Line Tools</a></li> + <li><a href="/2.0/commandline.html">Command-Line Tools</a></li> <li><a href="/2.0/faq.html">FAQ</a></li> <li><a href="/docs/2.0.3/javadocs/">API Docs</a></li> </ul> @@ -104,10 +104,10 @@ <li><a href="/1.8/cookbook/workingwithmetadata.html">Working with Metadata</a></li> <li><a href="/1.8/cookbook/workingwithattachments.html">Working with Attachments</a></li> <li><a href="/1.8/cookbook/pdfavalidation.html">PDF/A Validation</a></li> - <li><a href="/1.8/cookbook/pdfacreation.html">Creating a PDF/A document</a></li> + <li><a href="/1.8/cookbook/pdfacreation.html">Creating a PDF/A Document</a></li> </ul> </li> - <li><a href="/1.8/commandline.html">Command Line Tools</a></li> + <li><a href="/1.8/commandline.html">Command-Line Tools</a></li> <li><a href="/docs/1.8.12/javadocs/">API Docs</a></li> <li><a href="/1.8/faq.html">FAQ</a></li> </ul> @@ -131,13 +131,13 @@ </ul> </div> <div class="col-xs-12 col-sm-9"> - <h1 id="encrypting-a-file">Encrypting a file</h1> + <h1 id="encrypting-a-file">Encrypting a File</h1> <p>PDF encryption requires two passwords: the âuser passwordâ to open and view the file with restricted permissions, the âowner passwordâ to access the file with all permission.</p> -<h2 id="load-and-save-encrypted">Load and save encrypted</h2> +<h2 id="load-and-save-encrypted">Load and Save Encrypted</h2> -<p>This small sample shows how to encrypt a file so that it can be viewed, but not printed..</p> +<p>This small sample shows how to encrypt a file so that it can be viewed, but not printed.</p> <div class="highlighter-rouge"><pre class="highlight"><code><span class="n">PDDocument</span> <span class="n">doc</span> <span class="o">=</span> <span class="n">PDDocument</span><span class="o">.</span><span class="na">load</span><span class="o">(</span><span class="s">"filename.pdf"</span><span class="o">);</span> @@ -147,11 +147,11 @@ <span class="n">AccessPermission</span> <span class="n">ap</span> <span class="o">=</span> <span class="k">new</span> <span class="n">AccessPermission</span><span class="o">();</span> -<span class="c1">// disable printing, everything else is allowed</span> +<span class="c1">// Disable printing, everything else is allowed</span> <span class="n">ap</span><span class="o">.</span><span class="na">setCanPrint</span><span class="o">(</span><span class="kc">false</span><span class="o">);</span> -<span class="c1">// owner password (to open the file with all permissions) is "12345"</span> -<span class="c1">// user password (to open the file but with restricted permissions, is empty here) </span> +<span class="c1">// Owner password (to open the file with all permissions) is "12345"</span> +<span class="c1">// User password (to open the file but with restricted permissions, is empty here) </span> <span class="n">StandardProtectionPolicy</span> <span class="n">spp</span> <span class="o">=</span> <span class="k">new</span> <span class="n">StandardProtectionPolicy</span><span class="o">(</span><span class="s">"12345"</span><span class="o">,</span> <span class="s">""</span><span class="o">,</span> <span class="n">ap</span><span class="o">);</span> <span class="n">spp</span><span class="o">.</span><span class="na">setEncryptionKeyLength</span><span class="o">(</span><span class="n">keyLength</span><span class="o">);</span> <span class="n">spp</span><span class="o">.</span><span class="na">setPermissions</span><span class="o">(</span><span class="n">ap</span><span class="o">);</span> http://git-wip-us.apache.org/repos/asf/pdfbox-docs/blob/9434dd0c/content/1.8/cookbook/fill-form-field.html ---------------------------------------------------------------------- diff --git a/content/1.8/cookbook/fill-form-field.html b/content/1.8/cookbook/fill-form-field.html index 1f941fd..0f9140a 100644 --- a/content/1.8/cookbook/fill-form-field.html +++ b/content/1.8/cookbook/fill-form-field.html @@ -23,7 +23,7 @@ <meta charset="utf-8"> <meta http-equiv="X-UA-Compatible" content="IE=edge"> <meta name="viewport" content="width=device-width, initial-scale=1"> - <meta name="description" content="The Apache PDFBox⢠library is an open source Java tool for working with PDF documents. This project allows creation of new PDF documents, manipulation of existing documents and the ability to extract content from documents. Apache PDFBox also includes several command line utilities. Apache PDFBox is published under the Apache License v2.0. + <meta name="description" content="The Apache PDFBox⢠library is an open source Java tool for working with PDF documents. This project allows creation of new PDF documents, manipulation of existing documents and the ability to extract content from documents. Apache PDFBox also includes several command-line utilities. Apache PDFBox is published under the Apache License v2.0. "> <title>Apache PDFBox | Cookbook - Fill a Form Field</title> @@ -84,7 +84,7 @@ <li><a href="/2.0/cookbook/encryption.html">Document Encryption</a></li> </ul> </li> - <li><a href="/2.0/commandline.html">Command Line Tools</a></li> + <li><a href="/2.0/commandline.html">Command-Line Tools</a></li> <li><a href="/2.0/faq.html">FAQ</a></li> <li><a href="/docs/2.0.3/javadocs/">API Docs</a></li> </ul> @@ -104,10 +104,10 @@ <li><a href="/1.8/cookbook/workingwithmetadata.html">Working with Metadata</a></li> <li><a href="/1.8/cookbook/workingwithattachments.html">Working with Attachments</a></li> <li><a href="/1.8/cookbook/pdfavalidation.html">PDF/A Validation</a></li> - <li><a href="/1.8/cookbook/pdfacreation.html">Creating a PDF/A document</a></li> + <li><a href="/1.8/cookbook/pdfacreation.html">Creating a PDF/A Document</a></li> </ul> </li> - <li><a href="/1.8/commandline.html">Command Line Tools</a></li> + <li><a href="/1.8/commandline.html">Command-Line Tools</a></li> <li><a href="/docs/1.8.12/javadocs/">API Docs</a></li> <li><a href="/1.8/faq.html">FAQ</a></li> </ul> http://git-wip-us.apache.org/repos/asf/pdfbox-docs/blob/9434dd0c/content/1.8/cookbook/pdfacreation.html ---------------------------------------------------------------------- diff --git a/content/1.8/cookbook/pdfacreation.html b/content/1.8/cookbook/pdfacreation.html index e900692..84d968a 100644 --- a/content/1.8/cookbook/pdfacreation.html +++ b/content/1.8/cookbook/pdfacreation.html @@ -23,10 +23,10 @@ <meta charset="utf-8"> <meta http-equiv="X-UA-Compatible" content="IE=edge"> <meta name="viewport" content="width=device-width, initial-scale=1"> - <meta name="description" content="The Apache PDFBox⢠library is an open source Java tool for working with PDF documents. This project allows creation of new PDF documents, manipulation of existing documents and the ability to extract content from documents. Apache PDFBox also includes several command line utilities. Apache PDFBox is published under the Apache License v2.0. + <meta name="description" content="The Apache PDFBox⢠library is an open source Java tool for working with PDF documents. This project allows creation of new PDF documents, manipulation of existing documents and the ability to extract content from documents. Apache PDFBox also includes several command-line utilities. Apache PDFBox is published under the Apache License v2.0. "> - <title>Apache PDFBox | Create a valid PDF/A document</title> + <title>Apache PDFBox | Create a Valid PDF/A Document</title> <link href="/bootstrap/css/bootstrap.min.css" rel="stylesheet"> <link href="/css/pygments-github.css" rel="stylesheet"> @@ -84,7 +84,7 @@ <li><a href="/2.0/cookbook/encryption.html">Document Encryption</a></li> </ul> </li> - <li><a href="/2.0/commandline.html">Command Line Tools</a></li> + <li><a href="/2.0/commandline.html">Command-Line Tools</a></li> <li><a href="/2.0/faq.html">FAQ</a></li> <li><a href="/docs/2.0.3/javadocs/">API Docs</a></li> </ul> @@ -104,10 +104,10 @@ <li><a href="/1.8/cookbook/workingwithmetadata.html">Working with Metadata</a></li> <li><a href="/1.8/cookbook/workingwithattachments.html">Working with Attachments</a></li> <li><a href="/1.8/cookbook/pdfavalidation.html">PDF/A Validation</a></li> - <li><a href="/1.8/cookbook/pdfacreation.html">Creating a PDF/A document</a></li> + <li><a href="/1.8/cookbook/pdfacreation.html">Creating a PDF/A Document</a></li> </ul> </li> - <li><a href="/1.8/commandline.html">Command Line Tools</a></li> + <li><a href="/1.8/commandline.html">Command-Line Tools</a></li> <li><a href="/docs/1.8.12/javadocs/">API Docs</a></li> <li><a href="/1.8/faq.html">FAQ</a></li> </ul> @@ -133,13 +133,13 @@ <div class="col-xs-12 col-sm-9"> <h1 id="pdfa-creation">PDF/A Creation</h1> -<p>The Apache PDFBox API can be used to create a PDF/A File. PDF/A is a PDF file with some constraints to ensure its +<p>The Apache PDFBox API can be used to create a PDF/A file. PDF/A is a PDF file with some constraints to ensure its long time conservation. These constraints are described in ISO 19005.</p> <p>This small sample shows what should be added during creation of a PDF file to transform it in a valid PDF/A document. The current example creates a valid PDF/A-1b document.</p> -<h2 id="load-all-the-fonts-used-in-document">Load all the fonts used in document</h2> +<h2 id="load-all-fonts-used-in-the-document">Load All Fonts Used in the Document</h2> <p>The PDF/A specification enforces that the fonts used in the document are present in the PDF File. You have to load them. As an example:</p> @@ -148,10 +148,11 @@ have to load them. As an example:</p> <span class="n">PDFont</span> <span class="n">font</span> <span class="o">=</span> <span class="n">PDTrueTypeFont</span><span class="o">.</span><span class="na">loadTTF</span><span class="o">(</span><span class="n">doc</span><span class="o">,</span> <span class="n">fontStream</span><span class="o">);</span> </code></pre> </div> -<p>## Including XMP metadata block</p> -<p>It is imposed to have xmp metadata defined in the PDF. At least, the PDFA Schema (giving details on the version -of PDF/A specification reached by the document) must be present. These lines create the xmp metadata for a +<h2 id="include-xmp-metadata-block">Include XMP Metadata Block</h2> + +<p>It is required to have XMP metadata defined in the PDF. At least, the PDFA Schema (giving details on the version +of PDF/A specification reached by the document) must be present. These lines create the XMP metadata for a PDF/A-1b document:</p> <div class="highlighter-rouge"><pre class="highlight"><code><span class="n">XMPMetadata</span> <span class="n">xmp</span> <span class="o">=</span> <span class="k">new</span> <span class="n">XMPMetadata</span><span class="o">();</span> @@ -164,12 +165,12 @@ PDF/A-1b document:</p> </code></pre> </div> -<h2 id="including-color-profile">Including color profile</h2> +<h2 id="include-color-profile">Include Color Profile</h2> <p>It is mandatory to include the color profile used by the document. Different profiles can be used. This example takes one present in pdfbox:</p> -<div class="highlighter-rouge"><pre class="highlight"><code><span class="c1">// create output intent</span> +<div class="highlighter-rouge"><pre class="highlight"><code><span class="c1">// Create output intent</span> <span class="n">InputStream</span> <span class="n">colorProfile</span> <span class="o">=</span> <span class="n">CreatePDFA</span><span class="o">.</span><span class="na">class</span><span class="o">.</span><span class="na">getResourceAsStream</span><span class="o">(</span><span class="s">"/org/apache/pdfbox/resources/pdfa/sRGB Color Space Profile.icm"</span><span class="o">);</span> <span class="n">PDOutputIntent</span> <span class="n">oi</span> <span class="o">=</span> <span class="k">new</span> <span class="n">PDOutputIntent</span><span class="o">(</span><span class="n">doc</span><span class="o">,</span> <span class="n">colorProfile</span><span class="o">);</span> <span class="n">oi</span><span class="o">.</span><span class="na">setInfo</span><span class="o">(</span><span class="s">"sRGB IEC61966-2.1"</span><span class="o">);</span> http://git-wip-us.apache.org/repos/asf/pdfbox-docs/blob/9434dd0c/content/1.8/cookbook/pdfavalidation.html ---------------------------------------------------------------------- diff --git a/content/1.8/cookbook/pdfavalidation.html b/content/1.8/cookbook/pdfavalidation.html index 7bb3db1..aa37e7d 100644 --- a/content/1.8/cookbook/pdfavalidation.html +++ b/content/1.8/cookbook/pdfavalidation.html @@ -23,7 +23,7 @@ <meta charset="utf-8"> <meta http-equiv="X-UA-Compatible" content="IE=edge"> <meta name="viewport" content="width=device-width, initial-scale=1"> - <meta name="description" content="The Apache PDFBox⢠library is an open source Java tool for working with PDF documents. This project allows creation of new PDF documents, manipulation of existing documents and the ability to extract content from documents. Apache PDFBox also includes several command line utilities. Apache PDFBox is published under the Apache License v2.0. + <meta name="description" content="The Apache PDFBox⢠library is an open source Java tool for working with PDF documents. This project allows creation of new PDF documents, manipulation of existing documents and the ability to extract content from documents. Apache PDFBox also includes several command-line utilities. Apache PDFBox is published under the Apache License v2.0. "> <title>Apache PDFBox | Cookbook - PDF/A Validation</title> @@ -84,7 +84,7 @@ <li><a href="/2.0/cookbook/encryption.html">Document Encryption</a></li> </ul> </li> - <li><a href="/2.0/commandline.html">Command Line Tools</a></li> + <li><a href="/2.0/commandline.html">Command-Line Tools</a></li> <li><a href="/2.0/faq.html">FAQ</a></li> <li><a href="/docs/2.0.3/javadocs/">API Docs</a></li> </ul> @@ -104,10 +104,10 @@ <li><a href="/1.8/cookbook/workingwithmetadata.html">Working with Metadata</a></li> <li><a href="/1.8/cookbook/workingwithattachments.html">Working with Attachments</a></li> <li><a href="/1.8/cookbook/pdfavalidation.html">PDF/A Validation</a></li> - <li><a href="/1.8/cookbook/pdfacreation.html">Creating a PDF/A document</a></li> + <li><a href="/1.8/cookbook/pdfacreation.html">Creating a PDF/A Document</a></li> </ul> </li> - <li><a href="/1.8/commandline.html">Command Line Tools</a></li> + <li><a href="/1.8/commandline.html">Command-Line Tools</a></li> <li><a href="/docs/1.8.12/javadocs/">API Docs</a></li> <li><a href="/1.8/faq.html">FAQ</a></li> </ul> http://git-wip-us.apache.org/repos/asf/pdfbox-docs/blob/9434dd0c/content/1.8/cookbook/rendering.html ---------------------------------------------------------------------- diff --git a/content/1.8/cookbook/rendering.html b/content/1.8/cookbook/rendering.html index 155a182..a7b7f00 100644 --- a/content/1.8/cookbook/rendering.html +++ b/content/1.8/cookbook/rendering.html @@ -23,7 +23,7 @@ <meta charset="utf-8"> <meta http-equiv="X-UA-Compatible" content="IE=edge"> <meta name="viewport" content="width=device-width, initial-scale=1"> - <meta name="description" content="The Apache PDFBox⢠library is an open source Java tool for working with PDF documents. This project allows creation of new PDF documents, manipulation of existing documents and the ability to extract content from documents. Apache PDFBox also includes several command line utilities. Apache PDFBox is published under the Apache License v2.0. + <meta name="description" content="The Apache PDFBox⢠library is an open source Java tool for working with PDF documents. This project allows creation of new PDF documents, manipulation of existing documents and the ability to extract content from documents. Apache PDFBox also includes several command-line utilities. Apache PDFBox is published under the Apache License v2.0. "> <title>Apache PDFBox | Cookbook - Rendering</title> @@ -84,7 +84,7 @@ <li><a href="/2.0/cookbook/encryption.html">Document Encryption</a></li> </ul> </li> - <li><a href="/2.0/commandline.html">Command Line Tools</a></li> + <li><a href="/2.0/commandline.html">Command-Line Tools</a></li> <li><a href="/2.0/faq.html">FAQ</a></li> <li><a href="/docs/2.0.3/javadocs/">API Docs</a></li> </ul> @@ -104,10 +104,10 @@ <li><a href="/1.8/cookbook/workingwithmetadata.html">Working with Metadata</a></li> <li><a href="/1.8/cookbook/workingwithattachments.html">Working with Attachments</a></li> <li><a href="/1.8/cookbook/pdfavalidation.html">PDF/A Validation</a></li> - <li><a href="/1.8/cookbook/pdfacreation.html">Creating a PDF/A document</a></li> + <li><a href="/1.8/cookbook/pdfacreation.html">Creating a PDF/A Document</a></li> </ul> </li> - <li><a href="/1.8/commandline.html">Command Line Tools</a></li> + <li><a href="/1.8/commandline.html">Command-Line Tools</a></li> <li><a href="/docs/1.8.12/javadocs/">API Docs</a></li> <li><a href="/1.8/faq.html">FAQ</a></li> </ul> @@ -133,7 +133,7 @@ <div class="col-xs-12 col-sm-9"> <h1 id="document-rendering">Document Rendering</h1> -<h2 id="convert-a-document-to-images">Convert a document to images</h2> +<h2 id="convert-a-document-to-images">Convert a Document to Images</h2> <p>This small sample shows how to render (convert to images) a PDF document using PDFBox.</p> http://git-wip-us.apache.org/repos/asf/pdfbox-docs/blob/9434dd0c/content/1.8/cookbook/textextraction.html ---------------------------------------------------------------------- diff --git a/content/1.8/cookbook/textextraction.html b/content/1.8/cookbook/textextraction.html index 7167a41..270fed8 100644 --- a/content/1.8/cookbook/textextraction.html +++ b/content/1.8/cookbook/textextraction.html @@ -23,10 +23,10 @@ <meta charset="utf-8"> <meta http-equiv="X-UA-Compatible" content="IE=edge"> <meta name="viewport" content="width=device-width, initial-scale=1"> - <meta name="description" content="The Apache PDFBox⢠library is an open source Java tool for working with PDF documents. This project allows creation of new PDF documents, manipulation of existing documents and the ability to extract content from documents. Apache PDFBox also includes several command line utilities. Apache PDFBox is published under the Apache License v2.0. + <meta name="description" content="The Apache PDFBox⢠library is an open source Java tool for working with PDF documents. This project allows creation of new PDF documents, manipulation of existing documents and the ability to extract content from documents. Apache PDFBox also includes several command-line utilities. Apache PDFBox is published under the Apache License v2.0. "> - <title>Apache PDFBox | Cookbook - Textextraction</title> + <title>Apache PDFBox | Cookbook - Text Extraction</title> <link href="/bootstrap/css/bootstrap.min.css" rel="stylesheet"> <link href="/css/pygments-github.css" rel="stylesheet"> @@ -84,7 +84,7 @@ <li><a href="/2.0/cookbook/encryption.html">Document Encryption</a></li> </ul> </li> - <li><a href="/2.0/commandline.html">Command Line Tools</a></li> + <li><a href="/2.0/commandline.html">Command-Line Tools</a></li> <li><a href="/2.0/faq.html">FAQ</a></li> <li><a href="/docs/2.0.3/javadocs/">API Docs</a></li> </ul> @@ -104,10 +104,10 @@ <li><a href="/1.8/cookbook/workingwithmetadata.html">Working with Metadata</a></li> <li><a href="/1.8/cookbook/workingwithattachments.html">Working with Attachments</a></li> <li><a href="/1.8/cookbook/pdfavalidation.html">PDF/A Validation</a></li> - <li><a href="/1.8/cookbook/pdfacreation.html">Creating a PDF/A document</a></li> + <li><a href="/1.8/cookbook/pdfacreation.html">Creating a PDF/A Document</a></li> </ul> </li> - <li><a href="/1.8/commandline.html">Command Line Tools</a></li> + <li><a href="/1.8/commandline.html">Command-Line Tools</a></li> <li><a href="/docs/1.8.12/javadocs/">API Docs</a></li> <li><a href="/1.8/faq.html">FAQ</a></li> </ul> @@ -131,13 +131,13 @@ </ul> </div> <div class="col-xs-12 col-sm-9"> - <h1 id="textextraction">Textextraction</h1> + <h1 id="text-extraction">Text Extraction</h1> <h2 id="extracting-text">Extracting Text</h2> -<p>See class:org.apache.pdfbox.util.PDFTextStripper<br /> -See class:org.apache.pdfbox.searchengine.lucene.LucenePDFDocument<br /> -See command line app:ExtractText</p> +<p>See class: org.apache.pdfbox.util.PDFTextStripper<br /> +See class: org.apache.pdfbox.searchengine.lucene.LucenePDFDocument<br /> +See command-line app: ExtractText</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 @@ -168,7 +168,7 @@ line application nor the LucenePDFDocument will be able to fulfill those require It is possible for users to utilize or extend the PDFTextStripper class to meet some of these requirements.</p> -<h3 id="limiting-the-extracted-text">Limiting The Extracted Text</h3> +<h3 id="limiting-the-extracted-text">Limiting the Extracted Text</h3> <p>There are several ways that we can limit the text that is extracted during the extraction process. The simplest is to specify the range of pages that you want to be extracted. http://git-wip-us.apache.org/repos/asf/pdfbox-docs/blob/9434dd0c/content/1.8/cookbook/workingwithattachments.html ---------------------------------------------------------------------- diff --git a/content/1.8/cookbook/workingwithattachments.html b/content/1.8/cookbook/workingwithattachments.html index d23c26d..c041da9 100644 --- a/content/1.8/cookbook/workingwithattachments.html +++ b/content/1.8/cookbook/workingwithattachments.html @@ -23,7 +23,7 @@ <meta charset="utf-8"> <meta http-equiv="X-UA-Compatible" content="IE=edge"> <meta name="viewport" content="width=device-width, initial-scale=1"> - <meta name="description" content="The Apache PDFBox⢠library is an open source Java tool for working with PDF documents. This project allows creation of new PDF documents, manipulation of existing documents and the ability to extract content from documents. Apache PDFBox also includes several command line utilities. Apache PDFBox is published under the Apache License v2.0. + <meta name="description" content="The Apache PDFBox⢠library is an open source Java tool for working with PDF documents. This project allows creation of new PDF documents, manipulation of existing documents and the ability to extract content from documents. Apache PDFBox also includes several command-line utilities. Apache PDFBox is published under the Apache License v2.0. "> <title>Apache PDFBox | Cookbook - Working with Attachments</title> @@ -84,7 +84,7 @@ <li><a href="/2.0/cookbook/encryption.html">Document Encryption</a></li> </ul> </li> - <li><a href="/2.0/commandline.html">Command Line Tools</a></li> + <li><a href="/2.0/commandline.html">Command-Line Tools</a></li> <li><a href="/2.0/faq.html">FAQ</a></li> <li><a href="/docs/2.0.3/javadocs/">API Docs</a></li> </ul> @@ -104,10 +104,10 @@ <li><a href="/1.8/cookbook/workingwithmetadata.html">Working with Metadata</a></li> <li><a href="/1.8/cookbook/workingwithattachments.html">Working with Attachments</a></li> <li><a href="/1.8/cookbook/pdfavalidation.html">PDF/A Validation</a></li> - <li><a href="/1.8/cookbook/pdfacreation.html">Creating a PDF/A document</a></li> + <li><a href="/1.8/cookbook/pdfacreation.html">Creating a PDF/A Document</a></li> </ul> </li> - <li><a href="/1.8/commandline.html">Command Line Tools</a></li> + <li><a href="/1.8/commandline.html">Command-Line Tools</a></li> <li><a href="/docs/1.8.12/javadocs/">API Docs</a></li> <li><a href="/1.8/faq.html">FAQ</a></li> </ul> http://git-wip-us.apache.org/repos/asf/pdfbox-docs/blob/9434dd0c/content/1.8/cookbook/workingwithfonts.html ---------------------------------------------------------------------- diff --git a/content/1.8/cookbook/workingwithfonts.html b/content/1.8/cookbook/workingwithfonts.html index d913879..9b2e9af 100644 --- a/content/1.8/cookbook/workingwithfonts.html +++ b/content/1.8/cookbook/workingwithfonts.html @@ -23,7 +23,7 @@ <meta charset="utf-8"> <meta http-equiv="X-UA-Compatible" content="IE=edge"> <meta name="viewport" content="width=device-width, initial-scale=1"> - <meta name="description" content="The Apache PDFBox⢠library is an open source Java tool for working with PDF documents. This project allows creation of new PDF documents, manipulation of existing documents and the ability to extract content from documents. Apache PDFBox also includes several command line utilities. Apache PDFBox is published under the Apache License v2.0. + <meta name="description" content="The Apache PDFBox⢠library is an open source Java tool for working with PDF documents. This project allows creation of new PDF documents, manipulation of existing documents and the ability to extract content from documents. Apache PDFBox also includes several command-line utilities. Apache PDFBox is published under the Apache License v2.0. "> <title>Apache PDFBox | Cookbook - Working with Fonts</title> @@ -84,7 +84,7 @@ <li><a href="/2.0/cookbook/encryption.html">Document Encryption</a></li> </ul> </li> - <li><a href="/2.0/commandline.html">Command Line Tools</a></li> + <li><a href="/2.0/commandline.html">Command-Line Tools</a></li> <li><a href="/2.0/faq.html">FAQ</a></li> <li><a href="/docs/2.0.3/javadocs/">API Docs</a></li> </ul> @@ -104,10 +104,10 @@ <li><a href="/1.8/cookbook/workingwithmetadata.html">Working with Metadata</a></li> <li><a href="/1.8/cookbook/workingwithattachments.html">Working with Attachments</a></li> <li><a href="/1.8/cookbook/pdfavalidation.html">PDF/A Validation</a></li> - <li><a href="/1.8/cookbook/pdfacreation.html">Creating a PDF/A document</a></li> + <li><a href="/1.8/cookbook/pdfacreation.html">Creating a PDF/A Document</a></li> </ul> </li> - <li><a href="/1.8/commandline.html">Command Line Tools</a></li> + <li><a href="/1.8/commandline.html">Command-Line Tools</a></li> <li><a href="/docs/1.8.12/javadocs/">API Docs</a></li> <li><a href="/1.8/faq.html">FAQ</a></li> </ul> @@ -204,7 +204,7 @@ </tbody> </table> -<h2 id="hello-world-using-a-pdf-base-font">Hello World using a PDF base font</h2> +<h2 id="hello-world-using-a-pdf-base-font">Hello World Using a PDF Base Font</h2> <p>This small sample shows how to create a new document and print the text âHello Worldâ using one of the PDF base fonts.</p> @@ -235,7 +235,7 @@ </code></pre> </div> -<h2 id="hello-world-using-a-truetype-font">Hello World using a TrueType font</h2> +<h2 id="hello-world-using-a-truetype-font">Hello World Using a TrueType Font</h2> <p>This small sample shows how to create a new document and print the text âHello Worldâ using a TrueType font.</p> @@ -274,16 +274,16 @@ PDFBox will look for a mapping file to use when substituting fonts.</p> names to TTF font files. The UNKNOWN_FONT property in that file will tell PDFBox which font to use when no mapping exists.</p> -<h2 id="hello-world-using-a-postscript-type1-font">Hello World using a Postscript Type1 font</h2> +<h2 id="hello-world-using-a-postscript-type1-font">Hello World Using a PostScript Type1 Font</h2> -<p>This small sample shows how to create a new document and print the text âHello Worldâ using a Postscript Type1 font.</p> +<p>This small sample shows how to create a new document and print the text âHello Worldâ using a PostScript Type1 font.</p> <div class="highlighter-rouge"><pre class="highlight"><code><span class="c1">// Create a document and add a page to it</span> <span class="n">PDDocument</span> <span class="n">document</span> <span class="o">=</span> <span class="k">new</span> <span class="n">PDDocument</span><span class="o">();</span> <span class="n">PDPage</span> <span class="n">page</span> <span class="o">=</span> <span class="k">new</span> <span class="n">PDPage</span><span class="o">();</span> <span class="n">document</span><span class="o">.</span><span class="na">addPage</span><span class="o">(</span> <span class="n">page</span> <span class="o">);</span> -<span class="c1">// Create a new font object by loading a Postscript Type 1 font into the document</span> +<span class="c1">// Create a new font object by loading a PostScript Type 1 font into the document</span> <span class="n">PDFont</span> <span class="n">font</span> <span class="o">=</span> <span class="k">new</span> <span class="n">PDType1AfmPfbFont</span><span class="o">(</span><span class="n">doc</span><span class="o">,</span><span class="s">"cfm.afm"</span><span class="o">);</span> <span class="c1">// Start a new content stream which will "hold" the to be created content</span> http://git-wip-us.apache.org/repos/asf/pdfbox-docs/blob/9434dd0c/content/1.8/cookbook/workingwithmetadata.html ---------------------------------------------------------------------- diff --git a/content/1.8/cookbook/workingwithmetadata.html b/content/1.8/cookbook/workingwithmetadata.html index 8b390f7..7addd1d 100644 --- a/content/1.8/cookbook/workingwithmetadata.html +++ b/content/1.8/cookbook/workingwithmetadata.html @@ -23,7 +23,7 @@ <meta charset="utf-8"> <meta http-equiv="X-UA-Compatible" content="IE=edge"> <meta name="viewport" content="width=device-width, initial-scale=1"> - <meta name="description" content="The Apache PDFBox⢠library is an open source Java tool for working with PDF documents. This project allows creation of new PDF documents, manipulation of existing documents and the ability to extract content from documents. Apache PDFBox also includes several command line utilities. Apache PDFBox is published under the Apache License v2.0. + <meta name="description" content="The Apache PDFBox⢠library is an open source Java tool for working with PDF documents. This project allows creation of new PDF documents, manipulation of existing documents and the ability to extract content from documents. Apache PDFBox also includes several command-line utilities. Apache PDFBox is published under the Apache License v2.0. "> <title>Apache PDFBox | Cookbook - Working with Metadata</title> @@ -84,7 +84,7 @@ <li><a href="/2.0/cookbook/encryption.html">Document Encryption</a></li> </ul> </li> - <li><a href="/2.0/commandline.html">Command Line Tools</a></li> + <li><a href="/2.0/commandline.html">Command-Line Tools</a></li> <li><a href="/2.0/faq.html">FAQ</a></li> <li><a href="/docs/2.0.3/javadocs/">API Docs</a></li> </ul> @@ -104,10 +104,10 @@ <li><a href="/1.8/cookbook/workingwithmetadata.html">Working with Metadata</a></li> <li><a href="/1.8/cookbook/workingwithattachments.html">Working with Attachments</a></li> <li><a href="/1.8/cookbook/pdfavalidation.html">PDF/A Validation</a></li> - <li><a href="/1.8/cookbook/pdfacreation.html">Creating a PDF/A document</a></li> + <li><a href="/1.8/cookbook/pdfacreation.html">Creating a PDF/A Document</a></li> </ul> </li> - <li><a href="/1.8/commandline.html">Command Line Tools</a></li> + <li><a href="/1.8/commandline.html">Command-Line Tools</a></li> <li><a href="/docs/1.8.12/javadocs/">API Docs</a></li> <li><a href="/1.8/faq.html">FAQ</a></li> </ul> @@ -161,9 +161,9 @@ provides a high level API to that information:</p> <h2 id="accessing-pdf-metadata">Accessing PDF Metadata</h2> -<p>See class:org.apache.pdfbox.pdmodel.common.PDMetadata<br /> -See example:AddMetadataFromDocInfo<br /> -See Adobe Documentation:XMP Specification</p> +<p>See class: org.apache.pdfbox.pdmodel.common.PDMetadata<br /> +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> @@ -185,10 +185,10 @@ or set the XML metadata.</p> <span class="n">PDDocumentCatalog</span> <span class="n">catalog</span> <span class="o">=</span> <span class="n">doc</span><span class="o">.</span><span class="na">getDocumentCatalog</span><span class="o">();</span> <span class="n">PDMetadata</span> <span class="n">metadata</span> <span class="o">=</span> <span class="n">catalog</span><span class="o">.</span><span class="na">getMetadata</span><span class="o">();</span> -<span class="c1">//to read the XML metadata</span> +<span class="c1">// To read the XML metadata</span> <span class="n">InputStream</span> <span class="n">xmlInputStream</span> <span class="o">=</span> <span class="n">metadata</span><span class="o">.</span><span class="na">createInputStream</span><span class="o">();</span> -<span class="c1">//or to write new XML metadata</span> +<span class="c1">// Or to write new XML metadata</span> <span class="n">InputStream</span> <span class="n">newXMPData</span> <span class="o">=</span> <span class="o">...;</span> <span class="n">PDMetadata</span> <span class="n">newMetadata</span> <span class="o">=</span> <span class="k">new</span> <span class="n">PDMetadata</span><span class="o">(</span><span class="n">doc</span><span class="o">,</span> <span class="n">newXMLData</span><span class="o">,</span> <span class="kc">false</span> <span class="o">);</span> <span class="n">catalog</span><span class="o">.</span><span class="na">setMetadata</span><span class="o">(</span> <span class="n">newMetadata</span> <span class="o">);</span> http://git-wip-us.apache.org/repos/asf/pdfbox-docs/blob/9434dd0c/content/1.8/dependencies.html ---------------------------------------------------------------------- diff --git a/content/1.8/dependencies.html b/content/1.8/dependencies.html index 287262d..24d94cd 100644 --- a/content/1.8/dependencies.html +++ b/content/1.8/dependencies.html @@ -23,7 +23,7 @@ <meta charset="utf-8"> <meta http-equiv="X-UA-Compatible" content="IE=edge"> <meta name="viewport" content="width=device-width, initial-scale=1"> - <meta name="description" content="The Apache PDFBox⢠library is an open source Java tool for working with PDF documents. This project allows creation of new PDF documents, manipulation of existing documents and the ability to extract content from documents. Apache PDFBox also includes several command line utilities. Apache PDFBox is published under the Apache License v2.0. + <meta name="description" content="The Apache PDFBox⢠library is an open source Java tool for working with PDF documents. This project allows creation of new PDF documents, manipulation of existing documents and the ability to extract content from documents. Apache PDFBox also includes several command-line utilities. Apache PDFBox is published under the Apache License v2.0. "> <title>Apache PDFBox | Dependencies</title> @@ -84,7 +84,7 @@ <li><a href="/2.0/cookbook/encryption.html">Document Encryption</a></li> </ul> </li> - <li><a href="/2.0/commandline.html">Command Line Tools</a></li> + <li><a href="/2.0/commandline.html">Command-Line Tools</a></li> <li><a href="/2.0/faq.html">FAQ</a></li> <li><a href="/docs/2.0.3/javadocs/">API Docs</a></li> </ul> @@ -104,10 +104,10 @@ <li><a href="/1.8/cookbook/workingwithmetadata.html">Working with Metadata</a></li> <li><a href="/1.8/cookbook/workingwithattachments.html">Working with Attachments</a></li> <li><a href="/1.8/cookbook/pdfavalidation.html">PDF/A Validation</a></li> - <li><a href="/1.8/cookbook/pdfacreation.html">Creating a PDF/A document</a></li> + <li><a href="/1.8/cookbook/pdfacreation.html">Creating a PDF/A Document</a></li> </ul> </li> - <li><a href="/1.8/commandline.html">Command Line Tools</a></li> + <li><a href="/1.8/commandline.html">Command-Line Tools</a></li> <li><a href="/docs/1.8.12/javadocs/">API Docs</a></li> <li><a href="/1.8/faq.html">FAQ</a></li> </ul> @@ -133,15 +133,15 @@ <div class="col-xs-12 col-sm-9"> <h1 id="dependencies">Dependencies</h1> -<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>PDFBox consists of 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> -<h2 id="core-components">Core components</h2> +<h2 id="core-components">Core Components</h2> <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 class="highlighter-rouge">pdfbox</code>, <code class="highlighter-rouge">fontbox</code> and <code class="highlighter-rouge">jempbox</code>. The Maven groupId of all PDFBox components is org.apache.pdfbox.</p> -<h3 id="minimum-requirement">Minimum Requirement</h3> +<h3 id="minimum-requirements">Minimum Requirements</h3> <ul> <li>Java 1.5</li> @@ -164,17 +164,17 @@ 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 class="highlighter-rouge"><pre class="highlight"><code><dependency> - <groupId>org.apache.pdfbox</groupId> - <artifactId>pdfbox</artifactId> - <version>...</version> -</dependency> +<div class="highlighter-rouge"><pre class="highlight"><code><span class="nt"><dependency></span> + <span class="nt"><groupId></span>org.apache.pdfbox<span class="nt"></groupId></span> + <span class="nt"><artifactId></span>pdfbox<span class="nt"></artifactId></span> + <span class="nt"><version></span>...<span class="nt"></version></span> +<span class="nt"></dependency></span> </code></pre> </div> <p>Set the version field to the latest stable PDFBox version.</p> -<h2 id="optional-dependencies">Optional dependencies</h2> +<h2 id="optional-dependencies">Optional Dependencies</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> @@ -193,38 +193,36 @@ pdfbox library directly and the other required jars as transitive dependencies.< <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="highlighter-rouge"><pre class="highlight"><code><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> +<div class="highlighter-rouge"><pre class="highlight"><code><span class="nt"><dependency></span> + <span class="nt"><groupId></span>org.bouncycastle<span class="nt"></groupId></span> + <span class="nt"><artifactId></span>bcprov-jdk15<span class="nt"></artifactId></span> + <span class="nt"><version></span>1.44<span class="nt"></version></span> +<span class="nt"></dependency></span> +<span class="nt"><dependency></span> + <span class="nt"><groupId></span>org.bouncycastle<span class="nt"></groupId></span> + <span class="nt"><artifactId></span>bcmail-jdk15<span class="nt"></artifactId></span> + <span class="nt"><version></span>1.44<span class="nt"></version></span> +<span class="nt"></dependency></span> </code></pre> </div> -<p><br /></p> - -<h4 id="support-for-bidirectional-languages">Support for bidirectional languages</h4> +<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> -<div class="highlighter-rouge"><pre class="highlight"><code><dependency> - <groupId>com.ibm.icu</groupId> - <artifactId>icu4j</artifactId> - <version>3.8</version> -</dependency> +<div class="highlighter-rouge"><pre class="highlight"><code><span class="nt"><dependency></span> + <span class="nt"><groupId></span>com.ibm.icu<span class="nt"></groupId></span> + <span class="nt"><artifactId></span>icu4j<span class="nt"></artifactId></span> + <span class="nt"><version></span>3.8<span class="nt"></version></span> +<span class="nt"></dependency></span> </code></pre> </div> <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> -<h2 id="dependencies-for-ant-builds">Dependencies for Ant builds</h2> +<h2 id="dependencies-for-ant-builds">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. 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 http://git-wip-us.apache.org/repos/asf/pdfbox-docs/blob/9434dd0c/content/1.8/faq.html ---------------------------------------------------------------------- diff --git a/content/1.8/faq.html b/content/1.8/faq.html index 620efa5..28b51f5 100644 --- a/content/1.8/faq.html +++ b/content/1.8/faq.html @@ -23,7 +23,7 @@ <meta charset="utf-8"> <meta http-equiv="X-UA-Compatible" content="IE=edge"> <meta name="viewport" content="width=device-width, initial-scale=1"> - <meta name="description" content="The Apache PDFBox⢠library is an open source Java tool for working with PDF documents. This project allows creation of new PDF documents, manipulation of existing documents and the ability to extract content from documents. Apache PDFBox also includes several command line utilities. Apache PDFBox is published under the Apache License v2.0. + <meta name="description" content="The Apache PDFBox⢠library is an open source Java tool for working with PDF documents. This project allows creation of new PDF documents, manipulation of existing documents and the ability to extract content from documents. Apache PDFBox also includes several command-line utilities. Apache PDFBox is published under the Apache License v2.0. "> <title>Apache PDFBox | Frequently Asked Questions (FAQ)</title> @@ -84,7 +84,7 @@ <li><a href="/2.0/cookbook/encryption.html">Document Encryption</a></li> </ul> </li> - <li><a href="/2.0/commandline.html">Command Line Tools</a></li> + <li><a href="/2.0/commandline.html">Command-Line Tools</a></li> <li><a href="/2.0/faq.html">FAQ</a></li> <li><a href="/docs/2.0.3/javadocs/">API Docs</a></li> </ul> @@ -104,10 +104,10 @@ <li><a href="/1.8/cookbook/workingwithmetadata.html">Working with Metadata</a></li> <li><a href="/1.8/cookbook/workingwithattachments.html">Working with Attachments</a></li> <li><a href="/1.8/cookbook/pdfavalidation.html">PDF/A Validation</a></li> - <li><a href="/1.8/cookbook/pdfacreation.html">Creating a PDF/A document</a></li> + <li><a href="/1.8/cookbook/pdfacreation.html">Creating a PDF/A Document</a></li> </ul> </li> - <li><a href="/1.8/commandline.html">Command Line Tools</a></li> + <li><a href="/1.8/commandline.html">Command-Line Tools</a></li> <li><a href="/docs/1.8.12/javadocs/">API Docs</a></li> <li><a href="/1.8/faq.html">FAQ</a></li> </ul> @@ -131,7 +131,7 @@ </ul> </div> <div class="col-xs-12 col-sm-9"> - <h1 id="frequently-asked-questions">Frequently asked questions</h1> + <h1 id="frequently-asked-questions">Frequently Asked Questions</h1> <h3 id="general-questions">General Questions</h3> @@ -156,8 +156,8 @@ <p><a name="log4j"></a> ### I am getting the below Log4J warning message, how do I remove it? ###</p> -<div class="highlighter-rouge"><pre class="highlight"><code><span class="nl">log4j:</span><span class="n">WARN</span> <span class="n">No</span> <span class="n">appenders</span> <span class="n">could</span> <span class="n">be</span> <span class="n">found</span> <span class="k">for</span> <span class="n">logger</span> <span class="o">(</span><span class="n">org</span><span class="o">.</span><span class="na">apache</span><span class="o">.</span><span class="na">pdfbox</span><span class="o">.</span><span class="na">util</span><span class="o">.</span><span class="na">ResourceLoader</span><span class="o">).</span> -<span class="nl">log4j:</span><span class="n">WARN</span> <span class="n">Please</span> <span class="n">initialize</span> <span class="n">the</span> <span class="n">log4j</span> <span class="n">system</span> <span class="n">properly</span><span class="o">.</span> +<div class="highlighter-rouge"><pre class="highlight"><code>log4j:WARN No appenders could be found for logger (org.apache.pdfbox.util.ResourceLoader). +log4j:WARN Please initialize the log4j system properly. </code></pre> </div> @@ -166,13 +166,13 @@ See the <a href="http://logging.apache.org/log4j/1.2/manual.html";>log4j document <p>PDFBox comes with a sample log4j configuration file. To use it you set a system property like this</p> -<div class="highlighter-rouge"><pre class="highlight"><code><span class="n">java</span> <span class="o">-</span><span class="n">Dlog4j</span><span class="o">.</span><span class="na">configuration</span><span class="o">=</span><span class="n">log4j</span><span class="o">.</span><span class="na">xml</span> <span class="n">org</span><span class="o">.</span><span class="na">apache</span><span class="o">.</span><span class="na">pdfbox</span><span class="o">.</span><span class="na">ExtractText</span> <span class="o"><</span><span class="n">PDF</span><span class="o">-</span><span class="n">file</span><span class="o">></span> <span class="o"><</span><span class="n">output</span><span class="o">-</span><span class="n">text</span><span class="o">-</span><span class="n">file</span><span class="o">></span> +<div class="highlighter-rouge"><pre class="highlight"><code>java -Dlog4j.configuration=log4j.xml org.apache.pdfbox.ExtractText <PDF-file> <output-text-file> </code></pre> </div> <p>If this is not working for you then you may have to specify the log4j config file using a URL path, like this:</p> -<div class="highlighter-rouge"><pre class="highlight"><code><span class="n">log4j</span><span class="o">.</span><span class="na">configuration</span><span class="o">=</span><span class="nl">file:</span><span class="c1">///<path to config file></span> +<div class="highlighter-rouge"><pre class="highlight"><code>log4j.configuration=file:///<path to config file> </code></pre> </div>
