You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@pdfbox.apache.org by ms...@apache.org on 2015/10/23 14:32:38 UTC
svn commit: r969971 - in /websites/production/pdfbox/content/1.8/cookbook:
pdfavalidation.html textextraction.html workingwithattachments.html
workingwithfonts.html workingwithmetadata.html
Author: msahyoun
Date: Fri Oct 23 12:32:38 2015
New Revision: 969971
Log:
Site checkin for project Apache PDFBox Website
Modified:
websites/production/pdfbox/content/1.8/cookbook/pdfavalidation.html
websites/production/pdfbox/content/1.8/cookbook/textextraction.html
websites/production/pdfbox/content/1.8/cookbook/workingwithattachments.html
websites/production/pdfbox/content/1.8/cookbook/workingwithfonts.html
websites/production/pdfbox/content/1.8/cookbook/workingwithmetadata.html
Modified: websites/production/pdfbox/content/1.8/cookbook/pdfavalidation.html
==============================================================================
--- websites/production/pdfbox/content/1.8/cookbook/pdfavalidation.html (original)
+++ websites/production/pdfbox/content/1.8/cookbook/pdfavalidation.html Fri Oct 23 12:32:38 2015
@@ -165,55 +165,54 @@
Check Compliance with PDF/A-1b</p>
<p>This small sample shows how to check the compliance of a file with the PDF/A-1b specification.</p>
-<div class="highlight"><pre><code class="language-text" data-lang="text">:::java
-ValidationResult result = null;
+<div class="highlight"><pre><code class="language-java" data-lang="java"><span class="n">ValidationResult</span> <span class="n">result</span> <span class="o">=</span> <span class="kc">null</span><span class="o">;</span>
-FileDataSource fd = new FileDataSource(args[0]);
-PreflightParser parser = new PreflightParser(fd);
-try
-{
-
- /* Parse the PDF file with PreflightParser that inherits from the NonSequentialParser.
- * Some additional controls are present to check a set of PDF/A requirements.
- * (Stream length consistency, EOL after some Keyword...)
- */
- parser.parse();
-
- /* Once the syntax validation is done,
- * the parser can provide a PreflightDocument
- * (that inherits from PDDocument)
- * This document process the end of PDF/A validation.
- */
- PreflightDocument document = parser.getPreflightDocument();
- document.validate();
-
- // Get validation result
- result = document.getResult();
- document.close();
-
-}
-catch (SyntaxValidationException e)
-{
- /* the parse method can throw a SyntaxValidationException
- * if the PDF file can't be parsed.
- * In this case, the exception contains an instance of ValidationResult
- */
- result = e.getResult();
-}
-
-// display validation result
-if (result.isValid())
-{
- System.out.println("The file " + args[0] + " is a valid PDF/A-1b file");
-}
-else
-{
- System.out.println("The file" + args[0] + " is not valid, error(s) :");
- for (ValidationError error : result.getErrorsList())
- {
- System.out.println(error.getErrorCode() + " : " + error.getDetails());
- }
-}
+<span class="n">FileDataSource</span> <span class="n">fd</span> <span class="o">=</span> <span class="k">new</span> <span class="nf">FileDataSource</span><span class="o">(</span><span class="n">args</span><span class="o">[</span><span class="mi">0</span><span class="o">]);</span>
+<span class="n">PreflightParser</span> <span class="n">parser</span> <span class="o">=</span> <span class="k">new</span> <span class="nf">PreflightParser</span><span class="o">(</span><span class="n">fd</span><span class="o">);</span>
+<span class="k">try</span>
+<span class="o">{</span>
+
+ <span class="cm">/* Parse the PDF file with PreflightParser that inherits from the NonSequentialParser.</span>
+<span class="cm"> * Some additional controls are present to check a set of PDF/A requirements. </span>
+<span class="cm"> * (Stream length consistency, EOL after some Keyword...)</span>
+<span class="cm"> */</span>
+ <span class="n">parser</span><span class="o">.</span><span class="na">parse</span><span class="o">();</span>
+
+ <span class="cm">/* Once the syntax validation is done, </span>
+<span class="cm"> * the parser can provide a PreflightDocument </span>
+<span class="cm"> * (that inherits from PDDocument) </span>
+<span class="cm"> * This document process the end of PDF/A validation.</span>
+<span class="cm"> */</span>
+ <span class="n">PreflightDocument</span> <span class="n">document</span> <span class="o">=</span> <span class="n">parser</span><span class="o">.</span><span class="na">getPreflightDocument</span><span class="o">();</span>
+ <span class="n">document</span><span class="o">.</span><span class="na">validate</span><span class="o">();</span>
+
+ <span class="c1">// Get validation result</span>
+ <span class="n">result</span> <span class="o">=</span> <span class="n">document</span><span class="o">.</span><span class="na">getResult</span><span class="o">();</span>
+ <span class="n">document</span><span class="o">.</span><span class="na">close</span><span class="o">();</span>
+
+<span class="o">}</span>
+<span class="k">catch</span> <span class="o">(</span><span class="n">SyntaxValidationException</span> <span class="n">e</span><span class="o">)</span>
+<span class="o">{</span>
+ <span class="cm">/* the parse method can throw a SyntaxValidationException </span>
+<span class="cm"> * if the PDF file can't be parsed.</span>
+<span class="cm"> * In this case, the exception contains an instance of ValidationResult </span>
+<span class="cm"> */</span>
+ <span class="n">result</span> <span class="o">=</span> <span class="n">e</span><span class="o">.</span><span class="na">getResult</span><span class="o">();</span>
+<span class="o">}</span>
+
+<span class="c1">// display validation result</span>
+<span class="k">if</span> <span class="o">(</span><span class="n">result</span><span class="o">.</span><span class="na">isValid</span><span class="o">())</span>
+<span class="o">{</span>
+ <span class="n">System</span><span class="o">.</span><span class="na">out</span><span class="o">.</span><span class="na">println</span><span class="o">(</span><span class="s">"The file "</span> <span class="o">+</span> <span class="n">args</span><span class="o">[</span><span class="mi">0</span><span class="o">]</span> <span class="o">+</span> <span class="s">" is a valid PDF/A-1b file"</span><span class="o">);</span>
+<span class="o">}</span>
+<span class="k">else</span>
+<span class="o">{</span>
+ <span class="n">System</span><span class="o">.</span><span class="na">out</span><span class="o">.</span><span class="na">println</span><span class="o">(</span><span class="s">"The file"</span> <span class="o">+</span> <span class="n">args</span><span class="o">[</span><span class="mi">0</span><span class="o">]</span> <span class="o">+</span> <span class="s">" is not valid, error(s) :"</span><span class="o">);</span>
+ <span class="k">for</span> <span class="o">(</span><span class="n">ValidationError</span> <span class="n">error</span> <span class="o">:</span> <span class="n">result</span><span class="o">.</span><span class="na">getErrorsList</span><span class="o">())</span>
+ <span class="o">{</span>
+ <span class="n">System</span><span class="o">.</span><span class="na">out</span><span class="o">.</span><span class="na">println</span><span class="o">(</span><span class="n">error</span><span class="o">.</span><span class="na">getErrorCode</span><span class="o">()</span> <span class="o">+</span> <span class="s">" : "</span> <span class="o">+</span> <span class="n">error</span><span class="o">.</span><span class="na">getDetails</span><span class="o">());</span>
+ <span class="o">}</span>
+<span class="o">}</span>
</code></pre></div>
<h2 id="categories-of-validation-error">Categories of Validation Error</h2>
@@ -228,7 +227,7 @@ In order to help in the failure understa
<p>Category ('Y') and cause ('Z') may be missing according to the difficulty to identify the error detail.</p>
-<p>Here after, you can find all Categories (for detailed cause, see constants in the PreglihtConstant interface) :</p>
+<p>Here after, you can find all Categories (for detailed cause, see constants in the <code>PreflightConstants</code> interface) :</p>
<table><thead>
<tr>
Modified: websites/production/pdfbox/content/1.8/cookbook/textextraction.html
==============================================================================
--- websites/production/pdfbox/content/1.8/cookbook/textextraction.html (original)
+++ websites/production/pdfbox/content/1.8/cookbook/textextraction.html Fri Oct 23 12:32:38 2015
@@ -177,7 +177,7 @@ org.apache.pdfbox.ExtractText.</p>
<p>Lucene is an open source text search library from the Apache Jakarta Project. In order for
Lucene to be able to index a PDF document it must first be converted to text. PDFBox provides
a simple approach for adding PDF documents into a Lucene index.</p>
-<div class="highlight"><pre><code class="language-text" data-lang="text">Document luceneDocument = LucenePDFDocument.getDocument( ... );
+<div class="highlight"><pre><code class="language-java" data-lang="java"><span class="n">Document</span> <span class="n">luceneDocument</span> <span class="o">=</span> <span class="n">LucenePDFDocument</span><span class="o">.</span><span class="na">getDocument</span><span class="o">(</span> <span class="o">...</span> <span class="o">);</span>
</code></pre></div>
<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 LucenePDFDocument automatically
@@ -199,10 +199,10 @@ these requirements.</p>
process. The simplest is to specify the range of pages that you want to be extracted.
For example, to only extract text from the second and third pages of the PDF document
you could do this:</p>
-<div class="highlight"><pre><code class="language-text" data-lang="text">PDFTextStripper stripper = new PDFTextStripper();
-stripper.setStartPage( 2 );
-stripper.setEndPage( 3 );
-stripper.writeText( ... );
+<div class="highlight"><pre><code class="language-java" data-lang="java"><span class="n">PDFTextStripper</span> <span class="n">stripper</span> <span class="o">=</span> <span class="k">new</span> <span class="nf">PDFTextStripper</span><span class="o">();</span>
+<span class="n">stripper</span><span class="o">.</span><span class="na">setStartPage</span><span class="o">(</span> <span class="mi">2</span> <span class="o">);</span>
+<span class="n">stripper</span><span class="o">.</span><span class="na">setEndPage</span><span class="o">(</span> <span class="mi">3</span> <span class="o">);</span>
+<span class="n">stripper</span><span class="o">.</span><span class="na">writeText</span><span class="o">(</span> <span class="o">...</span> <span class="o">);</span>
</code></pre></div>
<p>NOTE: The startPage and endPage properties of PDFTextStripper are 1 based and inclusive.</p>
Modified: websites/production/pdfbox/content/1.8/cookbook/workingwithattachments.html
==============================================================================
--- websites/production/pdfbox/content/1.8/cookbook/workingwithattachments.html (original)
+++ websites/production/pdfbox/content/1.8/cookbook/workingwithattachments.html Fri Oct 23 12:32:38 2015
@@ -169,42 +169,42 @@ See example:EmbeddedFiles </p>
<p>A PDF can contain references to external files via the file system or a URL to a remote
location. It is also possible to embed a binary file into a PDF document.</p>
-<p>There are two classes that can be used when referencing a file. PDSimpleFileSpecification
+<p>There are two classes that can be used when referencing a file. <code>PDSimpleFileSpecification</code>
is a simple string reference to a file(e.g. "./movies/BigMovie.avi"). The simple file
specification does not allow for any parameters to be set. </p>
-<p>The PDComplexFileSpecification is more feature rich and allows for advanced settings on
+<p>The <code>PDComplexFileSpecification</code> is more feature rich and allows for advanced settings on
the file reference.</p>
<p>It is also possible to embed a file directly into a PDF. Instead of setting the file
-attribute of the PDComplexFileSpecification, the EmbeddedFile attribute can be used instead.</p>
+attribute of the <code>PDComplexFileSpecification</code>, the <code>EmbeddedFile</code> attribute can be used instead.</p>
<h2 id="adding-a-file-attachment">Adding a File Attachment</h2>
<p>PDF documents can contain file attachments that are accessed from the Document->File Attachments
menu. PDFBox allows attachments to be added to and extracted from PDF documents.
Attachments are part of the named tree that is attached to the document catalog.</p>
-<div class="highlight"><pre><code class="language-text" data-lang="text">PDEmbeddedFilesNameTreeNode efTree = new PDEmbeddedFilesNameTreeNode();
+<div class="highlight"><pre><code class="language-java" data-lang="java"><span class="n">PDEmbeddedFilesNameTreeNode</span> <span class="n">efTree</span> <span class="o">=</span> <span class="k">new</span> <span class="nf">PDEmbeddedFilesNameTreeNode</span><span class="o">();</span>
-//first create the file specification, which holds the embedded file
-PDComplexFileSpecification fs = new PDComplexFileSpecification();
-fs.setFile( "Test.txt" );
-InputStream is = ...;
-PDEmbeddedFile ef = new PDEmbeddedFile(doc, is );
-//set some of the attributes of the embedded file
-ef.setSubtype( "test/plain" );
-ef.setSize( data.length );
-ef.setCreationDate( new GregorianCalendar() );
-fs.setEmbeddedFile( ef );
-
-//now add the entry to the embedded file tree and set in the document.
-Map efMap = new HashMap();
-efMap.put( "My first attachment", fs );
-efTree.setNames( efMap );
-//attachments are stored as part of the "names" dictionary in the document catalog
-PDDocumentNameDictionary names = new PDDocumentNameDictionary( doc.getDocumentCatalog() );
-names.setEmbeddedFiles( efTree );
-doc.getDocumentCatalog().setNames( names );
+<span class="c1">//first create the file specification, which holds the embedded file</span>
+<span class="n">PDComplexFileSpecification</span> <span class="n">fs</span> <span class="o">=</span> <span class="k">new</span> <span class="nf">PDComplexFileSpecification</span><span class="o">();</span>
+<span class="n">fs</span><span class="o">.</span><span class="na">setFile</span><span class="o">(</span> <span class="s">"Test.txt"</span> <span class="o">);</span>
+<span class="n">InputStream</span> <span class="n">is</span> <span class="o">=</span> <span class="o">...;</span>
+<span class="n">PDEmbeddedFile</span> <span class="n">ef</span> <span class="o">=</span> <span class="k">new</span> <span class="nf">PDEmbeddedFile</span><span class="o">(</span><span class="n">doc</span><span class="o">,</span> <span class="n">is</span> <span class="o">);</span>
+<span class="c1">//set some of the attributes of the embedded file</span>
+<span class="n">ef</span><span class="o">.</span><span class="na">setSubtype</span><span class="o">(</span> <span class="s">"test/plain"</span> <span class="o">);</span>
+<span class="n">ef</span><span class="o">.</span><span class="na">setSize</span><span class="o">(</span> <span class="n">data</span><span class="o">.</span><span class="na">length</span> <span class="o">);</span>
+<span class="n">ef</span><span class="o">.</span><span class="na">setCreationDate</span><span class="o">(</span> <span class="k">new</span> <span class="nf">GregorianCalendar</span><span class="o">()</span> <span class="o">);</span>
+<span class="n">fs</span><span class="o">.</span><span class="na">setEmbeddedFile</span><span class="o">(</span> <span class="n">ef</span> <span class="o">);</span>
+
+<span class="c1">//now add the entry to the embedded file tree and set in the document.</span>
+<span class="n">Map</span> <span class="n">efMap</span> <span class="o">=</span> <span class="k">new</span> <span class="nf">HashMap</span><span class="o">();</span>
+<span class="n">efMap</span><span class="o">.</span><span class="na">put</span><span class="o">(</span> <span class="s">"My first attachment"</span><span class="o">,</span> <span class="n">fs</span> <span class="o">);</span>
+<span class="n">efTree</span><span class="o">.</span><span class="na">setNames</span><span class="o">(</span> <span class="n">efMap</span> <span class="o">);</span>
+<span class="c1">//attachments are stored as part of the "names" dictionary in the document catalog</span>
+<span class="n">PDDocumentNameDictionary</span> <span class="n">names</span> <span class="o">=</span> <span class="k">new</span> <span class="nf">PDDocumentNameDictionary</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="o">);</span>
+<span class="n">names</span><span class="o">.</span><span class="na">setEmbeddedFiles</span><span class="o">(</span> <span class="n">efTree</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="na">setNames</span><span class="o">(</span> <span class="n">names</span> <span class="o">);</span>
</code></pre></div>
</div>
</div>
Modified: websites/production/pdfbox/content/1.8/cookbook/workingwithfonts.html
==============================================================================
--- websites/production/pdfbox/content/1.8/cookbook/workingwithfonts.html (original)
+++ websites/production/pdfbox/content/1.8/cookbook/workingwithfonts.html Fri Oct 23 12:32:38 2015
@@ -232,58 +232,58 @@
<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>
-<div class="highlight"><pre><code class="language-text" data-lang="text">// Create a document and add a page to it
-PDDocument document = new PDDocument();
-PDPage page = new PDPage();
-document.addPage( page );
-
-// Create a new font object selecting one of the PDF base fonts
-PDFont font = PDType1Font.HELVETICA_BOLD;
-
-// Start a new content stream which will "hold" the to be created content
-PDPageContentStream contentStream = new PDPageContentStream(document, page);
-
-// Define a text content stream using the selected font, moving the cursor and drawing the text "Hello World"
-contentStream.beginText();
-contentStream.setFont( font, 12 );
-contentStream.moveTextPositionByAmount( 100, 700 );
-contentStream.drawString( "Hello World" );
-contentStream.endText();
-
-// Make sure that the content stream is closed:
-contentStream.close();
-
-// Save the results and ensure that the document is properly closed:
-document.save( "Hello World.pdf");
-document.close();
+<div class="highlight"><pre><code class="language-java" data-lang="java"><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="nf">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="nf">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 selecting one of the PDF base fonts</span>
+<span class="n">PDFont</span> <span class="n">font</span> <span class="o">=</span> <span class="n">PDType1Font</span><span class="o">.</span><span class="na">HELVETICA_BOLD</span><span class="o">;</span>
+
+<span class="c1">// Start a new content stream which will "hold" the to be created content</span>
+<span class="n">PDPageContentStream</span> <span class="n">contentStream</span> <span class="o">=</span> <span class="k">new</span> <span class="nf">PDPageContentStream</span><span class="o">(</span><span class="n">document</span><span class="o">,</span> <span class="n">page</span><span class="o">);</span>
+
+<span class="c1">// Define a text content stream using the selected font, moving the cursor and drawing the text "Hello World"</span>
+<span class="n">contentStream</span><span class="o">.</span><span class="na">beginText</span><span class="o">();</span>
+<span class="n">contentStream</span><span class="o">.</span><span class="na">setFont</span><span class="o">(</span> <span class="n">font</span><span class="o">,</span> <span class="mi">12</span> <span class="o">);</span>
+<span class="n">contentStream</span><span class="o">.</span><span class="na">moveTextPositionByAmount</span><span class="o">(</span> <span class="mi">100</span><span class="o">,</span> <span class="mi">700</span> <span class="o">);</span>
+<span class="n">contentStream</span><span class="o">.</span><span class="na">drawString</span><span class="o">(</span> <span class="s">"Hello World"</span> <span class="o">);</span>
+<span class="n">contentStream</span><span class="o">.</span><span class="na">endText</span><span class="o">();</span>
+
+<span class="c1">// Make sure that the content stream is closed:</span>
+<span class="n">contentStream</span><span class="o">.</span><span class="na">close</span><span class="o">();</span>
+
+<span class="c1">// Save the results and ensure that the document is properly closed:</span>
+<span class="n">document</span><span class="o">.</span><span class="na">save</span><span class="o">(</span> <span class="s">"Hello World.pdf"</span><span class="o">);</span>
+<span class="n">document</span><span class="o">.</span><span class="na">close</span><span class="o">();</span>
</code></pre></div>
<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>
-<div class="highlight"><pre><code class="language-text" data-lang="text">// Create a document and add a page to it
-PDDocument document = new PDDocument();
-PDPage page = new PDPage();
-document.addPage( page );
-
-// Create a new font object by loading a TrueType font into the document
-PDFont font = PDTrueTypeFont.loadTTF(document, "Arial.ttf");
-
-// Start a new content stream which will "hold" the to be created content
-PDPageContentStream contentStream = new PDPageContentStream(document, page);
-
-// Define a text content stream using the selected font, moving the cursor and drawing the text "Hello World"
-contentStream.beginText();
-contentStream.setFont( font, 12 );
-contentStream.moveTextPositionByAmount( 100, 700 );
-contentStream.drawString( "Hello World" );
-contentStream.endText();
-
-// Make sure that the content stream is closed:
-contentStream.close();
-
-// Save the results and ensure that the document is properly closed:
-document.save( "Hello World.pdf");
-document.close();
+<div class="highlight"><pre><code class="language-java" data-lang="java"><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="nf">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="nf">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 TrueType font into the document</span>
+<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">document</span><span class="o">,</span> <span class="s">"Arial.ttf"</span><span class="o">);</span>
+
+<span class="c1">// Start a new content stream which will "hold" the to be created content</span>
+<span class="n">PDPageContentStream</span> <span class="n">contentStream</span> <span class="o">=</span> <span class="k">new</span> <span class="nf">PDPageContentStream</span><span class="o">(</span><span class="n">document</span><span class="o">,</span> <span class="n">page</span><span class="o">);</span>
+
+<span class="c1">// Define a text content stream using the selected font, moving the cursor and drawing the text "Hello World"</span>
+<span class="n">contentStream</span><span class="o">.</span><span class="na">beginText</span><span class="o">();</span>
+<span class="n">contentStream</span><span class="o">.</span><span class="na">setFont</span><span class="o">(</span> <span class="n">font</span><span class="o">,</span> <span class="mi">12</span> <span class="o">);</span>
+<span class="n">contentStream</span><span class="o">.</span><span class="na">moveTextPositionByAmount</span><span class="o">(</span> <span class="mi">100</span><span class="o">,</span> <span class="mi">700</span> <span class="o">);</span>
+<span class="n">contentStream</span><span class="o">.</span><span class="na">drawString</span><span class="o">(</span> <span class="s">"Hello World"</span> <span class="o">);</span>
+<span class="n">contentStream</span><span class="o">.</span><span class="na">endText</span><span class="o">();</span>
+
+<span class="c1">// Make sure that the content stream is closed:</span>
+<span class="n">contentStream</span><span class="o">.</span><span class="na">close</span><span class="o">();</span>
+
+<span class="c1">// Save the results and ensure that the document is properly closed:</span>
+<span class="n">document</span><span class="o">.</span><span class="na">save</span><span class="o">(</span> <span class="s">"Hello World.pdf"</span><span class="o">);</span>
+<span class="n">document</span><span class="o">.</span><span class="na">close</span><span class="o">();</span>
</code></pre></div>
<p>While it is recommended to embed all fonts for greatest portability not all PDF producer
applications will do this. When displaying a PDF it is necessary to find an external font to use.
@@ -296,30 +296,30 @@ use when no mapping exists. </p>
<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>
-<div class="highlight"><pre><code class="language-text" data-lang="text">// Create a document and add a page to it
-PDDocument document = new PDDocument();
-PDPage page = new PDPage();
-document.addPage( page );
-
-// Create a new font object by loading a Postscript Type 1 font into the document
-PDFont font = new PDType1AfmPfbFont(doc,"cfm.afm");
-
-// Start a new content stream which will "hold" the to be created content
-PDPageContentStream contentStream = new PDPageContentStream(document, page);
-
-// Define a text content stream using the selected font, moving the cursor and drawing the text "Hello World"
-contentStream.beginText();
-contentStream.setFont( font, 12 );
-contentStream.moveTextPositionByAmount( 100, 700 );
-contentStream.drawString( "Hello World" );
-contentStream.endText();
-
-// Make sure that the content stream is closed:
-contentStream.close();
-
-// Save the results and ensure that the document is properly closed:
-document.save( "Hello World.pdf");
-document.close();
+<div class="highlight"><pre><code class="language-java" data-lang="java"><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="nf">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="nf">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="n">PDFont</span> <span class="n">font</span> <span class="o">=</span> <span class="k">new</span> <span class="nf">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>
+<span class="n">PDPageContentStream</span> <span class="n">contentStream</span> <span class="o">=</span> <span class="k">new</span> <span class="nf">PDPageContentStream</span><span class="o">(</span><span class="n">document</span><span class="o">,</span> <span class="n">page</span><span class="o">);</span>
+
+<span class="c1">// Define a text content stream using the selected font, moving the cursor and drawing the text "Hello World"</span>
+<span class="n">contentStream</span><span class="o">.</span><span class="na">beginText</span><span class="o">();</span>
+<span class="n">contentStream</span><span class="o">.</span><span class="na">setFont</span><span class="o">(</span> <span class="n">font</span><span class="o">,</span> <span class="mi">12</span> <span class="o">);</span>
+<span class="n">contentStream</span><span class="o">.</span><span class="na">moveTextPositionByAmount</span><span class="o">(</span> <span class="mi">100</span><span class="o">,</span> <span class="mi">700</span> <span class="o">);</span>
+<span class="n">contentStream</span><span class="o">.</span><span class="na">drawString</span><span class="o">(</span> <span class="s">"Hello World"</span> <span class="o">);</span>
+<span class="n">contentStream</span><span class="o">.</span><span class="na">endText</span><span class="o">();</span>
+
+<span class="c1">// Make sure that the content stream is closed:</span>
+<span class="n">contentStream</span><span class="o">.</span><span class="na">close</span><span class="o">();</span>
+
+<span class="c1">// Save the results and ensure that the document is properly closed:</span>
+<span class="n">document</span><span class="o">.</span><span class="na">save</span><span class="o">(</span> <span class="s">"Hello World.pdf"</span><span class="o">);</span>
+<span class="n">document</span><span class="o">.</span><span class="na">close</span><span class="o">();</span>
</code></pre></div>
</div>
</div>
Modified: websites/production/pdfbox/content/1.8/cookbook/workingwithmetadata.html
==============================================================================
--- websites/production/pdfbox/content/1.8/cookbook/workingwithmetadata.html (original)
+++ websites/production/pdfbox/content/1.8/cookbook/workingwithmetadata.html Fri Oct 23 12:32:38 2015
@@ -172,17 +172,17 @@ Getting basic Metadata</p>
<p>To set or retrieve basic information about the document the PDDocumentInformation object
provides a high level API to that information:</p>
-<div class="highlight"><pre><code class="language-text" data-lang="text">PDDocumentInformation info = document.getDocumentInformation();
-System.out.println( "Page Count=" + document.getNumberOfPages() );
-System.out.println( "Title=" + info.getTitle() );
-System.out.println( "Author=" + info.getAuthor() );
-System.out.println( "Subject=" + info.getSubject() );
-System.out.println( "Keywords=" + info.getKeywords() );
-System.out.println( "Creator=" + info.getCreator() );
-System.out.println( "Producer=" + info.getProducer() );
-System.out.println( "Creation Date=" + info.getCreationDate() );
-System.out.println( "Modification Date=" + info.getModificationDate());
-System.out.println( "Trapped=" + info.getTrapped() );
+<div class="highlight"><pre><code class="language-java" data-lang="java"><span class="n">PDDocumentInformation</span> <span class="n">info</span> <span class="o">=</span> <span class="n">document</span><span class="o">.</span><span class="na">getDocumentInformation</span><span class="o">();</span>
+<span class="n">System</span><span class="o">.</span><span class="na">out</span><span class="o">.</span><span class="na">println</span><span class="o">(</span> <span class="s">"Page Count="</span> <span class="o">+</span> <span class="n">document</span><span class="o">.</span><span class="na">getNumberOfPages</span><span class="o">()</span> <span class="o">);</span>
+<span class="n">System</span><span class="o">.</span><span class="na">out</span><span class="o">.</span><span class="na">println</span><span class="o">(</span> <span class="s">"Title="</span> <span class="o">+</span> <span class="n">info</span><span class="o">.</span><span class="na">getTitle</span><span class="o">()</span> <span class="o">);</span>
+<span class="n">System</span><span class="o">.</span><span class="na">out</span><span class="o">.</span><span class="na">println</span><span class="o">(</span> <span class="s">"Author="</span> <span class="o">+</span> <span class="n">info</span><span class="o">.</span><span class="na">getAuthor</span><span class="o">()</span> <span class="o">);</span>
+<span class="n">System</span><span class="o">.</span><span class="na">out</span><span class="o">.</span><span class="na">println</span><span class="o">(</span> <span class="s">"Subject="</span> <span class="o">+</span> <span class="n">info</span><span class="o">.</span><span class="na">getSubject</span><span class="o">()</span> <span class="o">);</span>
+<span class="n">System</span><span class="o">.</span><span class="na">out</span><span class="o">.</span><span class="na">println</span><span class="o">(</span> <span class="s">"Keywords="</span> <span class="o">+</span> <span class="n">info</span><span class="o">.</span><span class="na">getKeywords</span><span class="o">()</span> <span class="o">);</span>
+<span class="n">System</span><span class="o">.</span><span class="na">out</span><span class="o">.</span><span class="na">println</span><span class="o">(</span> <span class="s">"Creator="</span> <span class="o">+</span> <span class="n">info</span><span class="o">.</span><span class="na">getCreator</span><span class="o">()</span> <span class="o">);</span>
+<span class="n">System</span><span class="o">.</span><span class="na">out</span><span class="o">.</span><span class="na">println</span><span class="o">(</span> <span class="s">"Producer="</span> <span class="o">+</span> <span class="n">info</span><span class="o">.</span><span class="na">getProducer</span><span class="o">()</span> <span class="o">);</span>
+<span class="n">System</span><span class="o">.</span><span class="na">out</span><span class="o">.</span><span class="na">println</span><span class="o">(</span> <span class="s">"Creation Date="</span> <span class="o">+</span> <span class="n">info</span><span class="o">.</span><span class="na">getCreationDate</span><span class="o">()</span> <span class="o">);</span>
+<span class="n">System</span><span class="o">.</span><span class="na">out</span><span class="o">.</span><span class="na">println</span><span class="o">(</span> <span class="s">"Modification Date="</span> <span class="o">+</span> <span class="n">info</span><span class="o">.</span><span class="na">getModificationDate</span><span class="o">());</span>
+<span class="n">System</span><span class="o">.</span><span class="na">out</span><span class="o">.</span><span class="na">println</span><span class="o">(</span> <span class="s">"Trapped="</span> <span class="o">+</span> <span class="n">info</span><span class="o">.</span><span class="na">getTrapped</span><span class="o">()</span> <span class="o">);</span>
</code></pre></div>
<h2 id="accessing-pdf-metadata">Accessing PDF Metadata</h2>
@@ -202,17 +202,17 @@ PDStream
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
or set the XML metadata.</p>
-<div class="highlight"><pre><code class="language-text" data-lang="text">PDDocument doc = PDDocument.load( ... );
-PDDocumentCatalog catalog = doc.getDocumentCatalog();
-PDMetadata metadata = catalog.getMetadata();
+<div class="highlight"><pre><code class="language-java" data-lang="java"><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="o">...</span> <span class="o">);</span>
+<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>
-//to read the XML metadata
-InputStream xmlInputStream = metadata.createInputStream();
+<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>
-//or to write new XML metadata
-InputStream newXMPData = ...;
-PDMetadata newMetadata = new PDMetadata(doc, newXMLData, false );
-catalog.setMetadata( newMetadata );
+<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="nf">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>
</code></pre></div>
</div>
</div>