Repository: pdfbox-docs Updated Branches: refs/heads/asf-site 30cc3b072 -> 3f67f8b81
http://git-wip-us.apache.org/repos/asf/pdfbox-docs/blob/3f67f8b8/content/download.html ---------------------------------------------------------------------- diff --git a/content/download.html b/content/download.html index 04895e2..6376159 100644 --- a/content/download.html +++ b/content/download.html @@ -1,26 +1,137 @@ ---- -license: Licensed to the Apache Software Foundation (ASF) under one - or more contributor license agreements. See the NOTICE file - distributed with this work for additional information - regarding copyright ownership. The ASF licenses this file - to you under the Apache License, Version 2.0 (the - "License"); you may not use this file except in compliance - with the License. You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, - software distributed under the License is distributed on an - "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY - KIND, either express or implied. See the License for the - specific language governing permissions and limitations - under the License. - -layout: default -title: Downloads ---- - -<h1>Downloads</h1> +<!DOCTYPE html> +<html lang="en"> + +<!-- + + Licensed to the Apache Software Foundation (ASF) under one or more + contributor license agreements. See the NOTICE file distributed with + this work for additional information regarding copyright ownership. + The ASF licenses this file to You under the Apache License, Version 2.0 + (the "License"); you may not use this file except in compliance with + the License. You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE- 2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. + --> + +<head> + <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. +"> + + <title>Apache PDFBox | Downloads</title> + + <link href="/bootstrap/css/bootstrap.min.css" rel="stylesheet"> + <link href="/assets/open-iconic/font/css/open-iconic-bootstrap.min.css" rel="stylesheet"> + <link href="/css/pygments-github.css" rel="stylesheet"> + + <link href="/css/site.css" rel="stylesheet"> + + + + + + + +</head> + +<body> + <nav class="navbar navbar-default navbar-top"> + <div class="container"> + <div class="navbar-header"> + <a href="/index.html"> + <img class="logo" src="/images/logo-head.gif"> + </a> + <p class="pull-right visible-xs"> + <button type="button" class="btn btn-primary btn-sm" data-toggle="offcanvas">Menu</button> + </p> + </div> + </div> + </nav> + + <div class="container"> + + <div class="row row-offcanvas row-offcanvas-left"> + <div class="col-xs-6 col-sm-3 sidebar-offcanvas" id="sidebar"> + + <ul class="sidebar"> + <li class="sidebar-header">Apache PDFBox</li> + <li><a href="/index.html">Overview</a></li> + <li><a href="/download.cgi">Downloads</a></li> + + <li class="sidebar-header">Community</li> + <li><a href="/support.html">Support</a></li> + <li><a href="/mailinglists.html">Mailing Lists</a></li> + <li><a href="/team.html">Project Team</a></li> + + <li class="sidebar-header">Documentation</li> + <li class="sidebar-node" id="v2-0"> + <a href="#">2.0.0 (trunk)</a> + <ul> + <li><a href="/2.0/migration.html">Migration Guide</a></li> + <li><a href="/2.0/getting-started.html">Getting Started</a></li> + <li><a href="/2.0/examples.html">Examples</a></li> + <li><a href="/2.0/dependencies.html">Dependencies</a></li> + <li class="sidebar-node" id="v2-0-cookbook"> + <a href="#">Cookbook</a> + <ul> + <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="/docs/2.0.0-SNAPSHOT/javadocs/">API Docs</a></li> + </ul> + </li> + <li class="sidebar-node" id="v1-8"> + <a href="#">1.8.10</a> + <ul> + <li><a href="/1.8/architecture.html">Architecture</a></li> + <li><a href="/1.8/dependencies.html">Dependencies</a></li> + <li class="sidebar-node" id="v1-8-cookbook"> + <a href="#">Cookbook</a> + <ul> + <li><a href="/1.8/cookbook/documentcreation.html">Document Creation</a></li> + <li><a href="/1.8/cookbook/textextraction.html">Text Extraction</a></li> + <li><a href="/1.8/cookbook/encryption.html">Document Encryption</a></li> + <li><a href="/1.8/cookbook/workingwithfonts.html">Working with Fonts</a></li> + <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> + </ul> + </li> + <li><a href="/1.8/commandline.html">Command Line Tools</a></li> + <li><a href="/docs/1.8.10/javadocs/">API Docs</a></li> + <li><a href="/1.8/faq.html">FAQ</a></li> + </ul> + </li> + + <li class="sidebar-header">Development</li> + <li><a href="/building.html">Building from Source</a></li> + <li><a href="/codingconventions.html">Coding Conventions</a></li> + <li><a href="/siteupdate.html">Update the Website</a></li> + <li><a href="https://builds.apache.org/view/All/job/PDFBox-trunk/";>Jenkins</a></li> + <li><a href="https://travis-ci.org/apache/pdfbox";>Travis CI</a></li> + <li><a href="https://analysis.apache.org/dashboard/index/org.apache.pdfbox:pdfbox-reactor";>SonarQube</a></li> + <li><a href="https://issues.apache.org/jira/browse/PDFBOX";>JIRA</a></li> + <li><a href="/ideas.html">Ideas</a></li> + <li><a href="/references.html">External Links</a></li> + + <li class="sidebar-header">Apache Software Foundation</li> + <li><a href="http://www.apache.org/";>Apache Software Foundation</a></li> + <li><a href="http://www.apache.org/foundation/thanks.html";>ASF Sponsors</a></li> + <li><a href="http://www.apache.org/security/";>Security</a></li> + </ul> + </div> + <div class="col-xs-12 col-sm-9"> + <h1>Downloads</h1> <p>There are several ways to obtain the PDFBox binaries or sources:</p> @@ -275,4 +386,64 @@ Section 740.13) for both object code and source code. <ul> <li>Apache PDFBox uses the Java Cryptography Architecture (JCA) and the Bouncy Castle libraries for handling encryption in PDF documents. </li> -</ul> \ No newline at end of file +</ul> + </div> + </div> + </div> + + <footer class="footer"> + <div class="container" + <div class="row"> + <div class="span3"> + <!-- nothing in here on purpose --> + </div> + <div class="span9"> + <p>Copyright © 2009–2015 <a href="http://www.apache.org/";>The Apache Software Foundation</a>, Licensed under the <a href="http://www.apache.org/licenses/LICENSE-2.0";>Apache License, Version 2.0</a>. + <br/>Apache PDFBox, PDFBox, Apache, the Apache feather logo and the Apache PDFBox project logos are trademarks of The Apache Software Foundation.</p> + </div> + </div> + </div> + </footer> + + <!-- Twitter Bootstrap and jQuery after this line. --> + <script src="//code.jquery.com/jquery-latest.js"></script> + <script src="/bootstrap/js/bootstrap.min.js"></script> + <script type="text/javascript"> + + $(document).ready(function () { + $('[data-toggle="offcanvas"]').click(function () { + $('.row-offcanvas').toggleClass('active') + }); + }); + + $(function() { + // collapse tree nodes dynamically to support noscript + $('.sidebar-node').addClass('collapsed'); + + + // toggle expand/collapse + $('.sidebar-node > a').click(function(e) { + $(this).parent().toggleClass('collapsed'); + e.preventDefault(); + }); + + // preserve expand/collapse across page navigation + var path = document.location.pathname; + if (path.indexOf('/2.0') == 0) { + $('#v2-0').removeClass('collapsed'); + if (path.indexOf('/2.0/cookbook') == 0) { + $('#v2-0-cookbook').removeClass('collapsed'); + } + } else { + $('#v1-8').removeClass('collapsed'); + if (path.indexOf('/1.8/cookbook') == 0) { + $('#v1-8-cookbook').removeClass('collapsed'); + } + } + + }); + </script> + +</body> + +</html> \ No newline at end of file http://git-wip-us.apache.org/repos/asf/pdfbox-docs/blob/3f67f8b8/content/errors/403.md ---------------------------------------------------------------------- diff --git a/content/errors/403.md b/content/errors/403.md deleted file mode 100644 index 888f7b8..0000000 --- a/content/errors/403.md +++ /dev/null @@ -1,15 +0,0 @@ ---- -layout: default -title: Forbidden (403) ---- -# 403 - -We're sorry, but the page you requested cannot be accessed. - -Maybe you - -* typed the address incorrectly -* followed a link from another site that pointed to this page. - - -If you came by following a broken link, please report the [issue](https://issues.apache.org/jira/browse/pdfbox). \ No newline at end of file http://git-wip-us.apache.org/repos/asf/pdfbox-docs/blob/3f67f8b8/content/errors/404.md ---------------------------------------------------------------------- diff --git a/content/errors/404.md b/content/errors/404.md deleted file mode 100644 index e83602d..0000000 --- a/content/errors/404.md +++ /dev/null @@ -1,15 +0,0 @@ ---- -layout: default -title: Page Not Found ---- -# 404 - -We're sorry, but the page you requested cannot be found. - -Maybe you - -* typed the address incorrectly -* followed a link from another site that pointed to this page. - - -If you came by following a broken link, please report the [issue](https://issues.apache.org/jira/browse/pdfbox). \ No newline at end of file http://git-wip-us.apache.org/repos/asf/pdfbox-docs/blob/3f67f8b8/content/ideas.md ---------------------------------------------------------------------- diff --git a/content/ideas.md b/content/ideas.md deleted file mode 100644 index 8e38445..0000000 --- a/content/ideas.md +++ /dev/null @@ -1,105 +0,0 @@ ---- -license: Licensed to the Apache Software Foundation (ASF) under one - or more contributor license agreements. See the NOTICE file - distributed with this work for additional information - regarding copyright ownership. The ASF licenses this file - to you under the Apache License, Version 2.0 (the - "License"); you may not use this file except in compliance - with the License. You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, - software distributed under the License is distributed on an - "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY - KIND, either express or implied. See the License for the - specific language governing permissions and limitations - under the License. - -layout: default -title: Ideas ---- - -# Ideas - -There are several ideas to enhance PDFBox. These are outlined below together with -comments and the releases they are planned for as soon as there is agreement to do the -implementation. - -## Enhance type safety - -Enhance the type safety of PDFBox and add more generic collections and code cleanup. - -## Remove all deprecated methods - -This is an ongoing effort and most/all deprecated methods will be removed in PDFBox 2.0.0 - -## Handle large PDF files - -In addition to the PDF parsing pdfbox does not always handle large PDF files well as some -of the references are implemented as int instead of long - - -## <span class="complete">Switch to Java 1.6</span> - -<span class="complete">PDFBox 2.0.0 has Java 6 as minimum requirement.</span> - -## <span class="complete">Break PDFBox into modules</span> - -<span class="complete">In order to support different use cases and provide a minimal toolset PDFBox 2.0.0 should be -separated into different modules. This goes inline with rearranging some of the code -e.g. remove AWT from PDDocument. -</span> - -## <span class="complete">Enhance the font rendering</span> - -<span class="complete">PDFBox 2.0.0 will render most of the fonts without using AWT.</span> - -## Replace/enhance PDF parsing - -<span class="complete">The old "classic" PDF parser in PDFBox is not in line with the PDF specification as it parses -a PDF from top to bottom instead of respecting the XRef information.</span> The NonSequentialParser -enhanced that situation but there is a need to have a cleaner foundation broken into several levels - -- io -- tokenization -- parsing according to structure -- COS level document -- PD level document -- add some self healing mechanism to process corrupt files - -In addition handling documents which are not conforming shouldn't be part of the core parser -but of a extentable approach e.g. by adding hooks to allow for handling parsing exceptions. - -## <span class="complete">Add the ability to create PDFs using unicode encoded text</span> - -<span class="complete">The recent PDFBox version is limited to WinANSI encoded text. 2.0.0 should have unicode support as well.</span> - -## Rearchitect the COS level objects - -The COS level objects need to be refactored to be in line with the new parser. In addition -method signatures, constructing ... should be made similar across the COS objects - -## Parsing on demand - -Instead of always parsing the complete document PDFs should be parsable on demand making -objects only available as they are needed to enhance performance and minimize memory footprint. - -This might be achieved by providing a layered approach where a base (non caching) parser provides -the on demand parsing and a caching parser built on top caches objects for use cases where -this is beneficial e.g. rendering, debugging ... - -- the lexer would be the low level component delivering tokens to the parser. - A sample implementation exists as part of PDFBOX-1000. The benefit would be a clean low - level handling of tokens. The current implementation needs to be (slightly ?) revised though -- the incremental (non caching) parser would allow for page by page processing moving forward - only to support text extraction, merging, splitting ⦠- the benefit would be a lower memory - consumption as well as a potential faster processing -- the caching parser would support applications such a PDFDebugger or PDFReader - -## Handling of PDF versions -The current implementation is a mix of PDF 1.4 and some adhoc additions without a clear -distinction what is and is not supported. We could ad some support for explicitly handling -versions in PDFBox e.g. my marking certain methods and properties to the PDF version support -level. This could in addition be a good basis for PDF/A and other compliance checks. - http://git-wip-us.apache.org/repos/asf/pdfbox-docs/blob/3f67f8b8/content/index.md ---------------------------------------------------------------------- diff --git a/content/index.md b/content/index.md deleted file mode 100644 index 6f66aac..0000000 --- a/content/index.md +++ /dev/null @@ -1,82 +0,0 @@ ---- -license: Licensed to the Apache Software Foundation (ASF) under one - or more contributor license agreements. See the NOTICE file - distributed with this work for additional information - regarding copyright ownership. The ASF licenses this file - to you under the Apache License, Version 2.0 (the - "License"); you may not use this file except in compliance - with the License. You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, - software distributed under the License is distributed on an - "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY - KIND, either express or implied. See the License for the - specific language governing permissions and limitations - under the License. - -layout: default -title: A Java PDF Library ---- -# Apache PDFBox - A Java PDF Library - -<p class="lead">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.</p> - -## News -With the initial discussions starting 3 years ago PDFBox 2.0.0 is in the works for quite some time now - **and we are in the final stages!** To give you the opportunity to provide feedback a [PDFBox 2.0.0-RC1 Release Candidate](http://pdfbox.apache.org/download.cgi) is now available. The [Migration Guide](http://pdfbox.apache.org/2.0/migration.html) shall give users coming from PDFBox 1.8 or earlier an overview about things to look at when switching over. More details to come. - -## Getting Help ## - -To get help on using PDFBox, please [Subscribe to the Users Mailing List](mailto:users-subscr...@pdfbox.apache.org) and post your -questions there. We're happy to help. - -The project is a volunteer effort and we're always looking for interested people to help -us improve PDFBox. There are a multitude of ways that you can help us depending on your -skills. Subscribe to the [Mailing Lists](/mailinglists.html) and find out how you can help. - -<h2 id="features">Features</h2> - -<div class="row"> - <div class="col-md-3"> - <header><h4><span class="oi oi-box"></span>Extract Text</h4></header> - <p>Extract Unicode text from PDF files.</p> - </div> - <div class="col-md-3"> - <header><h4><span class="oi oi-box"></span>Split & Merge</h4></header> - <p>Split a single PDF into many files or merge multiple PDF files.</p> - </div> - <div class="col-md-3"> - <header><h4><span class="oi oi-box"></span>Fill Forms</h4></header> - <p>Extract data from PDF forms or fill a PDF form.</p> - </div> - <div class="col-md-3"> - <header><h4><span class="oi oi-box"></span>Preflight</h4></header> - <p>Validate PDF files against the PDF/A-1b standard.</p> - </div> -</div> - -<div class="row"> - <div class="col-md-3"> - <header><h4><span class="oi oi-box"></span>Print</h4></header> - <p>Print a PDF file using the standard Java printing API.</p> - </div> - <div class="col-md-3"> - <header><h4><span class="oi oi-box"></span>Save as Image</h4></header> - <p>Save PDFs as image files, such as PNG or JPEG.</p> - </div> - <div class="col-md-3"> - <header><h4><span class="oi oi-box"></span>Create PDFs</h4></header> - <p>Create a PDF from scratch, with embedded fonts and images.</p> - </div> - <div class="col-md-3"> - <header><h4><span class="oi oi-box"></span>Signing</h4></header> - <p>Digitally sign PDF files.</p> - </div> -</div> - http://git-wip-us.apache.org/repos/asf/pdfbox-docs/blob/3f67f8b8/content/mailinglists.md ---------------------------------------------------------------------- diff --git a/content/mailinglists.md b/content/mailinglists.md deleted file mode 100644 index fa669e6..0000000 --- a/content/mailinglists.md +++ /dev/null @@ -1,45 +0,0 @@ ---- -license: Licensed to the Apache Software Foundation (ASF) under one - or more contributor license agreements. See the NOTICE file - distributed with this work for additional information - regarding copyright ownership. The ASF licenses this file - to you under the Apache License, Version 2.0 (the - "License"); you may not use this file except in compliance - with the License. You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, - software distributed under the License is distributed on an - "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY - KIND, either express or implied. See the License for the - specific language governing permissions and limitations - under the License. - -layout: default -title: Mailing Lists ---- - -# Mailing Lists - -Mailing Lists are the primary communication channels for all projects at -The Apache Software Foundation. Therefore, this applies to Apache PDFBox, too. - -**Please read the [public forum archive policy](http://www.apache.org/foundation/public-archives.html) carefully before subscribing to one of our list.** - -If you have any questions about or problems with Apache PDFBox, you can get them addressed -on the **Users Mailing List**. - -If you like to participate in the development of Apache PDFBox, -the **Developers Mailing List** is the place to be. - -If you like to keep track of what's being changed inside the project, you can subscribe -to the **Commit Mailing List**. - -<p class="alert alert-info">Please use the Users Mailing List if you are unsure which list to use</p> - -| Name | Address | Subscribe | Unsubscribe | Help | Archive | MarkMail | -| --- | --- | --- | ---| ---| --- | --- | -| Users | us...@pdfbox.apache.org | [Subscribe](mailto:users-subscr...@pdfbox.apache.org) | [Unsubscribe](mailto:users-unsubscr...@pdfbox.apache.org) | [Help](mailto:users-h...@pdfbox.apache.org) | [Archive](http://mail-archives.apache.org/mod_mbox/pdfbox-users/) | [MarkMail](http://pdfbox-users.markmail.org/) | -| Developers | d...@pdfbox.apache.org | [Subscribe](mailto:dev-subscr...@pdfbox.apache.org) | [Unsubscribe](mailto:dev-unsubscr...@pdfbox.apache.org) | [Help](mailto:dev-h...@pdfbox.apache.org) | [Archive](http://mail-archives.apache.org/mod_mbox/pdfbox-dev/) | [MarkMail](http://pdfbox-dev.markmail.org/) | -| Commits List | commits@pdfbox.apache.org | [Subscribe](mailto:commits-subscr...@pdfbox.apache.org) | [Unsubscribe](mailto:commits-unsubscr...@pdfbox.apache.org) | [Help](mailto:commits-h...@pdfbox.apache.org) | [Archive](http://mail-archives.apache.org/mod_mbox/pdfbox-commits/) | [MarkMail](http://pdfbox-commits.markmail.org/) | http://git-wip-us.apache.org/repos/asf/pdfbox-docs/blob/3f67f8b8/content/references.md ---------------------------------------------------------------------- diff --git a/content/references.md b/content/references.md deleted file mode 100644 index b2ff0ce..0000000 --- a/content/references.md +++ /dev/null @@ -1,65 +0,0 @@ ---- -license: Licensed to the Apache Software Foundation (ASF) under one - or more contributor license agreements. See the NOTICE file - distributed with this work for additional information - regarding copyright ownership. The ASF licenses this file - to you under the Apache License, Version 2.0 (the - "License"); you may not use this file except in compliance - with the License. You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, - software distributed under the License is distributed on an - "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY - KIND, either express or implied. See the License for the - specific language governing permissions and limitations - under the License. - -layout: default -title: External Links ---- - -# External Links - -This page lists projects that utilize PDFBox and articles that have been written about PDFBox. -Please file an [improvement issue](https://issues.apache.org/jira/browse/PDFBOX) to get new projects or articles added to this page, or to update the information on existing links. - -## Projects - -| Project Name | License | Project Description | -| --- | --- | --- | -| [Alfresco](http://www.alfresco.org/) | LGPL - commercial services/support/training is available | Alfresco is an open source, open-standards content repository built by the most experienced content management team that includes the co-founder of Documentum.| -| [Apache Nutch](http://nutch.apache.org/) | Apache License V2.0 | Apache Nutch is open source web-search software. It builds on Apache Lucene, adding web-specifics, such as a crawler, a link-graph database, parsers for HTML and other document formats, etc.| -| [Apache Tika](http://tika.apache.org/) | Apache License V2.0 | Apache Tika is a toolkit for detecting and extracting metadata and structured text content from various documents using existing parser libraries.| -| [Centric CRM](http://www.centriccrm.com/) | Free To Use But Restricted/Commercial | The Most Advanced Open Source CRM Software.| -| [Canoo Webtest](http://webtest.canoo.com/webtest/manual/WebTestHome.html) | BSD Like | Free OpenSource tool for XP-style acceptance testing of Java-based Web applications.| -| [contineo](http://webtest.canoo.com/webtest/manual/WebTestHome.html) | GPL | Contineo is a web based document management system.| -| [ECM REWOO Scope](http://www.rewoo.de/) | Commercial | REWOO Scope is an Enterprise Content Management (ECM) software to organize, structure and consolidate enterprise data. Apache PDFBox is an integral part to read and index PDF documents.| -| [Jahia](http://www.jahia.org/) | collaborative source license | The Jahia product is currently the most powerful, ready-to-use and affordable integrated midrange Java Content Management and Corporate Portal Server.| -| [jLibrary](http://jlibrary.sourceforge.net/) | BSD | jLibrary is a Document Management System, oriented for personal and enterprise use.| -| [Jomic](http://jomic.sourceforge.net/) | GPL | Jomic is a viewer for comic book archives.| -| [JpdfUnit](http://jpdfunit.sourceforge.net/) | Apache License V2.0 | pdfUnit is a framework for testing a generated pdf document with the JUnit Test Framework.| -| [Liferay Portal](http://www.liferay.com/) | MIT | Liferay Portal is an open source portal that helps organizations collaborate more efficiently by providing a consolidated view of disparate applications.| -| [LIUS](http://www.bibl.ulaval.ca/lius/index.en.html) | GPL | LIUS is an indexing Java framework based on the Jakarta Lucene project. The LIUS framework adds to Lucene many files format indexing fonctionalities as: Ms World, Ms Excel, Ms PowerPoint, RTF, PDF, XML, HTML, TXT, Open Office suite and JavaBeans.| -| [LuceGene](http://gmod.org/wiki/LuceGene) | Artistic License | LuceGene is an open-source document/object search and retrieval system specially tuned for bioinformatics text databases and documents.| -| [Lutece](http://www.lutece.paris.fr/) | BSD-like | Lutece is a portal engine which allows you to easily create your websites or intranets based upon HTML,XML content.| -| [MMBase Lucene Module](http://mmapps.sourceforge.net/lucenemodule/) | MPL | Lucenemodule is a plugin (module) for the MMBase content management system that enables Lucene full text search through it's content, and thanks to PDFBox also PDF content.| -| [OpenCms](http://www.opencms.org/) | Custom | OpenCms is a professional level Open Source Website Content Management System.| -| [OpenSearchServer](http://www.open-search-server.com/) | GPLv3 | An open source search engine and crawler based on best open source technologies. It is a modern search engine and a suite of high-powered full text search algorithms.| -| [Orbeon PresentationServer](http://forge.objectweb.org/projects/ops) | LGPL | Orbeon PresentationServer (OPS) is an open source J2EE-based platform for XML-centric web applications. OPS is built around XHTML, XForms, XSLT, XML pipelines, and Web Services, which makes it ideal for applications that capture, process and present XML data. Commercial consulting/training/support is available through orbeon.| -| [PDFcat](http://pdfcat.sourceforge.net/) | LGPL | PDFcat is multi-platform catalog manager that provides searching capability over documents among virtual catalogs.| -| [SearchBlox](http://www.searchblox.com/) | Commercial | SearchBlox is a high-performance corporate search software designed for the Java 2 Enterprise Edition (J2EE) platform.| -| [SimplexRepaginator](http://www.simplexrepaginator.com/) | Apache License V2.0 | Simplex Repaginator converts simplex-scanned PDFs into properly duplex-paginated PDFs and vice versa. | -| [Terrier](http://ir.dcs.gla.ac.uk/terrier/) | MPL | Terrier is software for the rapid development of Web, intranet and desktop search engines.| -| [Triboni GinkGO](http://www.triboni.com/) | Commercial | Triboni GinkGO is a highly scalable J2EE services platform that is based on a simple XML business object defintion and scripting language. Toghether with XSLT content centric web applications can be configured in a very short time.| -| [Zilverline](http://www.zilverline.org/) | Collaborative Source License | Zilverline is a search engine that offers web access to your personal or intranet content.| - -## Articles/Books - -| Article Name | Article Abstract| -| --- | --- | -| Build an eDoc Reader for your iPod <br/> [Part 1 - User Interface](http://www.oreillynet.com/pub/a/mac/2004/12/14/ipod_reader.html) <br/> [Part 2 - Document Reading Engine](http://www.oreillynet.com/pub/a/mac/2004/12/17/ipod_reader.html) <br/> [Part 3 - *Integration with PDFBox*](http://www.oreillynet.com/pub/a/mac/2005/01/07/ipod_reader.html) | A three part article that discusses the implementation of the PodReader application. PodReader is Cocoa application written in Objective-C and article discusses how to use the Cocoa-Java bridge to integrate with the Java version of PDFBox.| -| [Lucene In Action](http://www.manning.com/hatcher2/) | A book that discusses integrating with the lucene search engine. One chapter discusses how to index various file formats and highlights PDFBox for indexing PDF documents.| -| [Java Developers Journal - March 2005](http://java.sys-con.com/node/48543) | An article written by the lead developer of PDFBox discussing text extraction and AcroForm integration using PDFBox functionality.| -| [Refactoring trends across N versions of N Java open source systems: an empirical study](http://www.dcs.bbk.ac.uk/research/techreps/2005/bbkcs-05-02.pdf) | This article describes an empirical study of multiple versions of a range of open source Java systems in an attempt to understand whether refactoring occur and, if so, which types of refactoring were most (and least) common. PDFBox is used as a case study. | \ No newline at end of file http://git-wip-us.apache.org/repos/asf/pdfbox-docs/blob/3f67f8b8/content/siteupdate.md ---------------------------------------------------------------------- diff --git a/content/siteupdate.md b/content/siteupdate.md deleted file mode 100644 index 0fd2099..0000000 --- a/content/siteupdate.md +++ /dev/null @@ -1,101 +0,0 @@ ---- -license: Licensed to the Apache Software Foundation (ASF) under one - or more contributor license agreements. See the NOTICE file - distributed with this work for additional information - regarding copyright ownership. The ASF licenses this file - to you under the Apache License, Version 2.0 (the - "License"); you may not use this file except in compliance - with the License. You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, - software distributed under the License is distributed on an - "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY - KIND, either express or implied. See the License for the - specific language governing permissions and limitations - under the License. - -layout: default -title: Updating the Website ---- - -# Updating the PDFBox Website - -The content for the PDFBox website is kept in a [git repository](https://git-wip-us.apache.org/repos/asf/pdfbox-docs) which is also mirrored to [GitHub](https://github.com/apache/pdfbox-docs). 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 -The site is based on [Jekyll](http://jekyllrb.com). So you have to be familiar with the [Markdown](http://daringfireball.net/projects/markdown/syntax) template language and have Jekyll (ver. 2+) installed to contribute to the project. - -## Contribute -If you would like to enhance the website content you can submit a patch. To do so please open a ticket at our [Issue Tracker](https://issues.apache.org/jira/browse/PDFBOX), use `Documentation` for the `Component` and add your patch to the ticket. - -## Development - -### Install Jekyll -Follow the instructions available on the [Jekyll](http://jekyllrb.com) website. - -### Check out 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 -You can now do the changes and additions to the sources of the PDFBox website. To test these locally use - -~~~ -jekyll serve -~~~ - -which will compile the changes and run a local webserver at - -~~~ -http://localhost:4000 -~~~ - -### 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> - -`pdfbox-site` is referenced from the PDFBox pom.xml file. - -<p class="alert alert-warning">The password should be encrypted following <a href="https://maven.apache.org/guides/mini/guide-encryption.html";>Maven Password Encryption</a></p> - -Ensure that the new website content is build locally - -~~~~ -jekyll build -~~~ - -This will read the sources and generate the new content in the ``./staging`` directory. - -Upload the new content to the production site - -~~~ -mvn scm-publish:publish-scm -~~~ - -This will checkout the current content into the ``./target``directory, apply the changes from ``./staging`` and publish -the changes to the PDFBox production website. - -### Update the JavaDocs for PDFBOX 2.x -To publish the javadocs follow these steps: - -Run - - $ mvn clean javadoc:aggregate scm-publish:publish-scm - -from the `<SVN_ROOT>/../pdfbox` directory. - -It uses the same `pdfbox-site` settings from above to connect to the repository. - -<p class="alert alert-info">As <code>mvn clean</code> will delete the javadoc files download from the Apache CMS it's advised to configure <code>${svn.scmJavadocCheckoutDirectory}</code> to a local directory not below <code>./target</code>.</p> \ No newline at end of file http://git-wip-us.apache.org/repos/asf/pdfbox-docs/blob/3f67f8b8/content/support.md ---------------------------------------------------------------------- diff --git a/content/support.md b/content/support.md deleted file mode 100644 index d45b962..0000000 --- a/content/support.md +++ /dev/null @@ -1,70 +0,0 @@ ---- -license: Licensed to the Apache Software Foundation (ASF) under one - or more contributor license agreements. See the NOTICE file - distributed with this work for additional information - regarding copyright ownership. The ASF licenses this file - to you under the Apache License, Version 2.0 (the - "License"); you may not use this file except in compliance - with the License. You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, - software distributed under the License is distributed on an - "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY - KIND, either express or implied. See the License for the - specific language governing permissions and limitations - under the License. - -layout: default -title: Support ---- - -# Support - -## Questions about How to use PDFBox - -If you have questions about how to use PDFBox do ask on the [Users Mailing List](/mailinglists.html "Subscribe to Mailing List"). This will get you help from the entire community. - -The PDFBox examples and the test code in the sources will also provide additional information. - -And there are additonal resources available on sites such as [Stack Overflow](http://stackoverflow.com/search?q=pdfbox "Stack Overflow"). - - -## Filing a bug report or enhancement request - -<p class="alert alert-info">Please refrain from immediately opening a ticket in the issue tracker unless -you are really certain it's a problem in the PDFBox software. Try using the Mailing Lists -before.</p> - -If you are sure you have found a bug the please report the problem in our -[Issue Tracker](https://issues.apache.org/jira/browse/PDFBOX). - -**Before you submit a bug there are several things you can try first** - - - 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 issue tracker to see if the issue has already been reported - -**To help us resolving a bug quicker** - - - attach the PDF that makes trouble by using "More", "Attach files" in the 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 - - try using the non-sequential parser (loadNonSeq() instead of load(), and "-nonSeq" with the command line applications) - - search JIRA if your problem has been mentioned before. - - 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 JIRA and then go on vacation so you won't repond to our questions / suggestions. - - ask "how to" questions in JIRA. 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 - -<p class="alert alert-info">We can sometimes solve problems without having the PDF, but it is difficult.</p> http://git-wip-us.apache.org/repos/asf/pdfbox-docs/blob/3f67f8b8/content/team.md ---------------------------------------------------------------------- diff --git a/content/team.md b/content/team.md deleted file mode 100644 index 3a1d1ad..0000000 --- a/content/team.md +++ /dev/null @@ -1,62 +0,0 @@ ---- -license: Licensed to the Apache Software Foundation (ASF) under one - or more contributor license agreements. See the NOTICE file - distributed with this work for additional information - regarding copyright ownership. The ASF licenses this file - to you under the Apache License, Version 2.0 (the - "License"); you may not use this file except in compliance - with the License. You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, - software distributed under the License is distributed on an - "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY - KIND, either express or implied. See the License for the - specific language governing permissions and limitations - under the License. - -layout: default -title: Project Team ---- - -# Project Team - -A successful project requires many people to play many roles. Some members write code or documentation, while others are valuable as testers, -submitting patches and suggestions. - -The team is comprised of Members and Contributors. Members have direct access to the source of a project and actively evolve the code-base. -Contributors improve the project through submission of patches and suggestions to the Members. The number of Contributors to the project is unbounded. -Get involved today. All contributions to the project are greatly appreciated. - -## Members - -The following is a list of developers with commit privileges that have directly contributed to the project in one way or another. - -| Id | Name | Roles | -| ------------- | --------------------- | ---------- | -| adam | Adam Nichols | PMC Member | -| lehmi | Andreas Lehmkühler | PMC Chair | -| blitchfield | Ben Litchfield | PMC Member | -| carrier | Brian Carrier | PMC Member | -| danielwilson | Daniel Wilson | PMC Member | -| gbailleul | Guillaume Bailleul | PMC Member | -| jeremias | Jeremias Maerki | PMC Member | -| koch | Johannes Koch | PMC Member | -| jahewson | John Hewson | PMC Member | -| kjackson | Kevin Jackson | PMC Member | -| msahyoun | Maruan Sahyoun | PMC Member | -| pkoch | Phillipp Koch | PMC Member | -| tchojecki | Thomas Chojecki | PMC Member | -| tboehme | Timo Boehme | PMC Member | -| tilman | Tilman Hausherr | PMC Member | -| vfed | Villu Ruusmann | PMC Member | - -## Emeritus members - -The following is a list of former developers going emeritus from the PDFBox PMC. - -| Id | Name | Roles | -| ------------- | ------------- | ---------- | -| leleueri | Eric Leleu | | -| jukka | Jukka Zitting | | http://git-wip-us.apache.org/repos/asf/pdfbox-docs/blob/3f67f8b8/pom.xml ---------------------------------------------------------------------- diff --git a/pom.xml b/pom.xml deleted file mode 100644 index c2b6de4..0000000 --- a/pom.xml +++ /dev/null @@ -1,64 +0,0 @@ -<?xml version="1.0" encoding="UTF-8"?> - - <!-- -! Licensed to the Apache Software Foundation (ASF) under one or more -! contributor license agreements. See the NOTICE file distributed with -! this work for additional information regarding copyright ownership. -! The ASF licenses this file to You under the Apache License, Version 2.0 -! (the "License"); you may not use this file except in compliance with -! the License. You may obtain a copy of the License at -! -! http://www.apache.org/licenses/LICENSE-2.0 -! -! Unless required by applicable law or agreed to in writing, software -! distributed under the License is distributed on an "AS IS" BASIS, -! WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -! See the License for the specific language governing permissions and -! limitations under the License. -!--> - - <project xmlns="http://maven.apache.org/POM/4.0.0"; xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"; xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/maven-v4_0_0.xsd";> - <modelVersion>4.0.0</modelVersion> - - <groupId>org.apache.pdfbox</groupId> - <artifactId>pdfbox-site</artifactId> - <version>2.0.0</version> - - <name>Apache PDFBox Website</name> - <description> - The Apache PDFBox library is an open source Java tool for working with PDF documents. - </description> - <inceptionYear>2002</inceptionYear> - - <properties> - <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding> - <project.reporting.outputEncoding>UTF-8</project.reporting.outputEncoding> - <svn.scmContentUrl>https://svn.apache.org/repos/infra/websites/production/pdfbox/content</svn.scmContentUrl> - </properties> - - <build> - <!-- - Publish to Apache CMS - After completion log in to https://cms.apache.org/pdfbox/publish - and click on the Submit button to commit to production. - --> - <plugins> - <plugin> - <groupId>org.apache.maven.plugins</groupId> - <artifactId>maven-scm-publish-plugin</artifactId> - <version>1.1</version> - <configuration> - <content>staging</content> - <pubScmUrl>scm:svn:${svn.scmContentUrl}</pubScmUrl> - <tryUpdate>true</tryUpdate> - <checkoutDirectory>${svn.scmCheckoutDirectory}</checkoutDirectory> - <ignorePathsToDelete> - <ignorePathToDelete>docs**</ignorePathToDelete> - </ignorePathsToDelete> - <serverId>pdfbox-site</serverId> - </configuration> - </plugin> - </plugins> - </build> - - </project> \ No newline at end of file
