This page lists projects that utilize PDFBox and articles that have been written about PDFBox. Please file an improvement issue to get new projects or articles added to this page, or to update the information on existing links.

Updating the PDFBox Website

The content for the PDFBox website is kept in a git repository which is also mirrored to GitHub. The site is split into two parts: the static content and the Javadoc for the PDFBox API. Both parts are build independently as further described below.

The content for the PDFBox website is kept in a Git repository which is also mirrored to GitHub. The site is split into two parts: the static content and the Javadoc for the PDFBox API. Both parts are build independently as further described below.

Project info

Project Info

The site is based on Jekyll. So you have to be familiar with the Markdown template language and have Jekyll (ver. 2+) installed to contribute to the project.

Contribute

@@ -146,14 +146,14 @@

Install Jekyll

Follow the instructions available on the Jekyll website.

Check out from the git repository

Before you can edit the site, you need to check it out from the git repository:

Checkout from the Git Repository

Before you can edit the site, you need to check it out from the Git repository:

git clone https://git-wip-us.apache.org/repos/asf/pdfbox-docs

Local changes

Local Changes

You can now do the changes and additions to the sources of the PDFBox website. To test these locally use

jekyll serve
@@ -166,16 +166,16 @@

Publish the website (for comitters only)

Publish the Website (For Comitters Only)

After you have done the local changes follow these steps to publish the content:

Add the following server configuration in your ~/.m2/settings.xml file

<server>
-  <id>pdfbox-site</id>
-  <username>** USERNAME **</username>
-  <password>** PASSWORD **</password>
-</server>
+<server>
+  <id>pdfbox-site</id>
+  <username>** USERNAME **</username>
+  <password>** PASSWORD **</password>
+</server>
 
 
 
@@ -183,20 +183,20 @@
 
 The password should be encrypted following Maven Password Encryption
 
-Ensure that the new website content is build locally
+Ensure that the new website content can build locally
 
 jekyll build
-~~~
+
+
 
-This will read the sources and generate the new content in the ``./staging`` directory.
+This will read the sources and generate the new content in the ./staging directory.
 
-When you are happy with the new content update the source repository
+When you are happy with the new content update the source repository
 
+git commit -m "..."
+git push origin master
 
 
-git commit -m “…”
-git push origin master
-~~~
 
 Upload the new content to the production site
 
@@ -207,7 +207,7 @@ git push origin master
 This will checkout the current content into the ./targetdirectory, apply the changes from ./staging and publish
 the changes to the PDFBox production website.
 
-Update the JavaDocs for PDFBOX 2.x
+Update the JavaDocs for PDFBox 2.x
 To publish the javadocs follow these steps:
 
 Run

http://git-wip-us.apache.org/repos/asf/pdfbox-docs/blob/9434dd0c/content/support.html
----------------------------------------------------------------------
diff --git a/content/support.html b/content/support.html
index ec5ed5e..21a243b 100644
--- a/content/support.html
+++ b/content/support.html
@@ -23,7 +23,7 @@
     
     
     
-    
 
     Apache PDFBox | Support
@@ -84,7 +84,7 @@
                                     Document Encryption
                                 
                             
-                            Command Line Tools
+                            Command-Line Tools
                             FAQ
                             API Docs
                         
@@ -104,10 +104,10 @@
                                     Working with Metadata
                                     Working with Attachments
                                     PDF/A Validation
-                                    Creating a PDF/A document
+                                    Creating a PDF/A Document
                                 
                             
-                            Command Line Tools
+                            Command-Line Tools
                             API Docs
                             FAQ
                         
@@ -133,7 +133,7 @@
             
                 Support
 
-Questions about How to use PDFBox
+Questions About How to Use PDFBox
 
 If you have questions about how to use PDFBox do ask on the Users Mailing List. This will get you help from the entire community.
 
@@ -141,45 +141,44 @@
 
 And there are additonal resources available on sites such as Stack Overflow.
 
-Filing a bug report or enhancement request
+Filing a Bug Report or Enhancement Request
 
 Please refrain from immediately opening a ticket in the JIRA issue tracker unless
-you are really certain it's a problem in the PDFBox software. Try using the Mailing Lists
-before.
+you are really certain it's a problem in the PDFBox software. Try using the Mailing Lists first.
 
-If you are sure you have found a bug the please report the problem in our
+
If you are sure you have found a bug then please report the problem in our
 JIRA Issue Tracker.
 
 Before you submit a bug there are several things you can try first
 
 
-  for PDFBOX 1.8.x try using the non-sequential parser (PDDocument.loadNonSeq instead of PDDocument.load, and “-nonSeq” with the command line applications)
-  for issues with text extraction try if Adobe Reader can extract the text
-  try the latest SNAPSHOT to see if it’s fixed in the pre-release
-  search the mailing list to see if has been discussed before
-  check the JIRA issue tracker to see if the issue has already been reported
+  For PDFBOX 1.8.x try using the non-sequential parser (PDDocument.loadNonSeq instead of PDDocument.load, and “-nonSeq” with the command-line applications)
+  For issues with text extraction try if Adobe Reader can extract the text
+  Try the latest SNAPSHOT to see if it’s fixed in the pre-release
+  Search the mailing list to see if has been discussed before
+  Check the JIRA issue tracker to see if the issue has already been reported
 
 
-To help us resolving a bug quicker
+To help us resolve a bug quicker
 
 
-  attach the PDF that makes trouble by using “More”, “Attach files” in the JIRA issue tracker
-  if your file is too large, upload it to a sharehoster, or use the PDFSplit application to isolate the troublesome page
-  mention the PDFBox version you are using.
-  attach the shortest possible code that reproduces the problem. Insert java code between {code}…{code}. Or try to reproduce the problem with the command line applications.
-  mention what you were doing, what was the expected behaviour, and what happened instead
-  provide a stack trace of an exception if there is one
+  Attach the PDF that makes trouble by using “More”, “Attach files” in the JIRA issue tracker
+  If your file is too large, upload it to a sharehoster, or use the PDFSplit application to isolate the troublesome page
+  Mention the PDFBox version you are using.
+  Attach the shortest possible code that reproduces the problem. Insert java code between {code}…{code}. Or try to reproduce the problem with the command-line applications.
+  Mention what you were doing, what was the expected behaviour, and what happened instead
+  Provide a stack trace of an exception if there is one
   Be patient: all the people here are unpaid volunteers who work for you in their free time
 
 
 And please DON’T
 
 
-  upload files to a hoster that requires registration to read the file.
-  create an issue in the JIRA issue tracker and then go on vacation so you won’t repond to our questions / suggestions.
-  ask “how to” questions in JIRA issue tracker. Ask such questions on the mailing lists, on stackoverflow.com, and look at the sample and the test code in the sources.
-  attach PDF files with confidential and/or personal data (name, DoB, bank data, health data, SSN) without getting permission from the client and/or the people mentioned on the PDF
-  create issues about obsolete PDFBox versions
+  Upload files to a host that requires registration to read the file.
+  Create an issue in the JIRA issue tracker and then go on vacation so you won’t repond to our questions / suggestions.
+  Ask “how to” questions in the JIRA issue tracker. Ask such questions on the mailing lists, on stackoverflow.com, and look at the sample and the test code in the sources.
+  Attach PDF files with confidential and/or personal data (name, DoB, bank data, health data, SSN) without getting permission from the client and/or the people mentioned on the PDF
+  Create issues about obsolete PDFBox versions
 
 
 We can sometimes solve problems without having the PDF, but it is difficult.

http://git-wip-us.apache.org/repos/asf/pdfbox-docs/blob/9434dd0c/content/team.html
----------------------------------------------------------------------
diff --git a/content/team.html b/content/team.html
index a86c29a..96ae16d 100644
--- a/content/team.html
+++ b/content/team.html
@@ -23,7 +23,7 @@
     
     
     
-    
 
     Apache PDFBox | Project Team
@@ -84,7 +84,7 @@
                                     Document Encryption
                                 
                             
-                            Command Line Tools
+                            Command-Line Tools
                             FAQ
                             API Docs
                         
@@ -104,10 +104,10 @@
                                     Working with Metadata
                                     Working with Attachments
                                     PDF/A Validation
-                                    Creating a PDF/A document
+                                    Creating a PDF/A Document
                                 
                             
-                            Command Line Tools
+                            Command-Line Tools
                             API Docs
                             FAQ

Projects using PDFBox

Projects Using PDFBox

Updating the PDFBox Website

Project info

Project Info

Contribute

Install Jekyll

Check out from the git repository

Checkout from the Git Repository

Local changes

Local Changes

Publish the website (for comitters only)

Publish the Website (For Comitters Only)

Update the JavaDocs for PDFBOX 2.x

Update the JavaDocs for PDFBox 2.x

Support

Questions about How to use PDFBox

Questions About How to Use PDFBox

Filing a bug report or enhancement request

Filing a Bug Report or Enhancement Request