XML/XHTML and CSS 2.1 renderer in pure Java
Clone or download
pbrant Merge pull request #145 from Gaboso/readme_update
Add version and license badges
Latest commit 83d6e3b Sep 10, 2018
Permalink
Failed to load latest commit information.
archive Move Ant build to archive Jun 24, 2012
bin Fix links, menu, add news page Mar 8, 2009
doc Update users-guide-r8.xil Dec 1, 2013
flying-saucer-core Update for v9.1.15 Aug 9, 2018
flying-saucer-examples Update for v9.1.15 Aug 9, 2018
flying-saucer-fop Update for v9.1.15 Aug 9, 2018
flying-saucer-log4j Update for v9.1.15 Aug 9, 2018
flying-saucer-pdf-itext5 Update for v9.1.15 Aug 9, 2018
flying-saucer-pdf-osgi Update for v9.1.15 Aug 9, 2018
flying-saucer-pdf Update to OpenPDF 1.2.3. Sep 10, 2018
flying-saucer-swt-examples Update for v9.1.15 Aug 9, 2018
flying-saucer-swt Update for v9.1.15 Aug 9, 2018
lib Move build to Maven Jun 24, 2012
notes Remove Minium anti-aliasing library as sources are not available. Rem… Mar 22, 2009
src Move build to Maven Jun 24, 2012
temp Remove Doctype, causing problems with some loaders Jul 24, 2007
test Work on bringing regression test classes up-to-date. Apr 12, 2009
tests regression snapshot was missing source images, now using Ant to make … Apr 17, 2009
www Reapply changes that cvsps had trouble with Apr 19, 2010
.cvsignore . Apr 13, 2009
.gitignore Update for Bintray deployment Sep 3, 2015
.hgignore Add .hgignore for those using hg-git Aug 7, 2010
LICENSE - change (back) license to 2.1 or later Jul 15, 2015
LICENSE-GPL-2.txt + license text GPL 2 Jul 16, 2015
LICENSE-GPL-3.txt - license update LGPL version 2.1 to 3 Jul 15, 2015
LICENSE-LGPL-2.1.txt - change (back) license to 2.1 or later Jul 15, 2015
LICENSE-LGPL-3.txt - license update LGPL version 2.1 to 3 Jul 15, 2015
LICENSE-W3C-TEST Added license for W3C tests, as requested on tests website. Jul 10, 2007
README.md Update license badge to LGPL-2.1 Aug 13, 2018
pom.xml Update for v9.1.15 Aug 9, 2018

README.md

Flying Saucer Download License: LGPL v2.1

OVERVIEW

Flying Saucer is a pure-Java library for rendering arbitrary well-formed XML (or XHTML) using CSS 2.1 for layout and formatting, output to Swing panels, PDF, and images.

Comprehensive documentation available in our user's guide, linked from our website at https://code.google.com/archive/p/flying-saucer/

For information on our development releases, please contact us on our mailing lists.

If you end up using Flying Saucer for your own projects, please drop us an email and tell us about it; it helps inform where we go next, and is interesting and inspiring to other developers.

LICENSE

Flying Saucer is distributed under the LGPL. Flying Saucer itself is licensed under the GNU Lesser General Public License, version 2.1 or later, available at http://www.gnu.org/copyleft/lesser.html. You can use Flying Saucer in any way and for any purpose you want as long as you respect the terms of the license. A copy of the LGPL license is included as LICENSE-LGPL-2.1.txt or LICENSE-LGPL-3.txt in our distributions and in our source tree.

Flying Saucer uses a couple of FOSS packages to get the job done. A list of these, along with the license they each have, is listed in the LICENSE file in our distribution.

GETTING FLYING SAUCER

New releases of Flying Saucer are distributed through Maven. The available artifacts are:

  • org.xhtmlrenderer:flying-saucer-core - Core library and Java2D rendering
  • org.xhtmlrenderer:flying-saucer-pdf - PDF output using iText 2.x
  • org.xhtmlrenderer:flying-saucer-pdf-itext5 - PDF output using iText 5.x
  • org.xhtmlrenderer:flying-saucer-pdf-openpdf - PDF output using OpenPDF
  • org.xhtmlrenderer:flying-saucer-swt - SWT output
  • org.xhtmlrenderer:flying-saucer-log4j - Logging plugin for log4j

iText 2.x has unfixed security bugs. New projects should avoid it.

GETTING STARTED

There is a large amount of sample code under the flying-saucer-examples directory.

flying-saucer-core, flying-saucer-pdf, and flying-saucer-swt must be on the build path, as well as the SWT JAR for your OS.

org.xhtmlrenderer.demo.browser.BrowserStartup will start the browser demo.

Some good entry points (classes) are:

  • org.xhtmlrenderer.simple.XHTMLPanel
  • org.xhtmlrenderer.simple.PDFRenderer
  • org.xhtmlrenderer.simple.ImageRenderer

STATE OF THE PROJECT

Ongoing discussions are carried out in our online discussion group.

Excerpt from the latest merge/release policy:

If you create a PR that can merge without conflicts, I'll merge it. I might ask for additional changes (or feedback from others), but I expect that will be extremely rare.

The basic contract is this: If you're still using Flying Saucer, need something changed, and are willing to do the work yourself, the change will be accepted and released.

Along that line, please also let me know if you need a release done right away. Otherwise I'll bundle up the changes and do a release every four to six months as long as it's required.

This is also the reason why Issues are currently deactivated on GitHub.

HISTORIC LINKS