RTF to HTML converter library

Released 26 June 2020

ScroogeXHTML for the Java platform is a library which supports a subset of the Rich Text Format (RTF) standard and converts to HTML5 and XHTML, as a standalone document, or as a fragment which can be embedded in other documents, with little coding.


It supports RTF features such as hyperlinks, field results, simple tables, picture data extraction, and embeds PNG and JPG pictures as data URIs


It minimizes documents using CSS font definitions, and supports post processing of the intermediate DOM document for additional fine tuning


It is easy to use, and requires no external runtime libraries except the SLF4J logging facade


The online demo converts a RTF document and displays the result HTML5

Try the demo

Conversion example 1

The RTF for this example has been created from the original RTF specification version 1.9.1, a MS Word docx document, using the LibreOffice editor version

Input (RTF document) - as shown in MS Wordpad
example 1 RTF
  • Wordpad auto-detects URLs and renders them as hyperlinks. With ScroogeXHTML, this can be emulated in a post processing step.
  • Wordpad renders table borders with a light grey line, even if it has no border style. This may be achieved with CSS in ScroogeXHTML.
Output (HTML document) - as shown in Mozilla Firefox
example 1 HTML
  • To create similar grey borders around table cells as in Wordpad, the custom CSS for the conversion includes a custom border format:
td {
  vertical-align: top;
  border: 1px solid silver;

Conversion example 2

The RTF for this example has been created using LibreOffice, then opened in MS Wordpad.

Input (RTF document) - as shown in MS Wordpad
example 2 RTF
  • The first picture uses the JPG format, the second one PNG
Output (HTML document) - as shown in Mozilla Firefox
example 2 HTML

Code example


Java code

package com.scroogexhtml.examples.helloworld;

import com.scroogexhtml.ScroogeXHTML;

public class Main {
    public static void main(String ... args) {
        ScroogeXHTML converter = new ScroogeXHTML();
        String html = converter.convert("{\\rtf1 Hello world}");

HTML output

      <p>Hello world</p>

Font style example


Java code

package com.scroogexhtml.examples.fontstyle;

import com.scroogexhtml.ScroogeXHTML;

public class Main {
    public static void main(String ... args) {
        ScroogeXHTML converter = new ScroogeXHTML();
        String html = converter.convert("{\\rtf1 {\\b Bold \\i Bold Italic \\i0 Bold again} \\par}");

HTML output

          <span style="font-weight:bold;">Bold </span><span style="font-weight:bold;font-style:italic;">Bold Italic </span><span style="font-weight:bold;">Bold again</span> 

Post processing example


Java code

public class Main {

    public static void main(String... args) {
        ScroogeXHTML scrooge = new ScroogeXHTML();
        scrooge.addPostProcessListener(new PostProcessListener() {
            public void postProcess(PostProcessEventObject e) {
                Document doc = e.getDocument();
                Element html = doc.getDocumentElement();
                Node head = html.getFirstChild();

                // add meta date
                Element metaDate = doc.createElement("meta");
                metaDate.setAttribute("name", "date");
                metaDate.setAttribute("content", new Date().toString());

        String html = scrooge.convert("{\\rtf1 Hello world}");

HTML output

    <!DOCTYPE html>
        <META http-equiv="Content-Type" content="text/html; charset=UTF-8">
        <title>Untitled document</title>
        <meta content="ScroogeXHTML for the Java(tm) platform 8.0" name="generator">
        <meta content="Fri Jan 11 10:39:02 CET 2019" name="date">
        <p>Hello world</p>
Text properties
Bold/italic/underlined ✓/✓/✓
Foreground/background/highlight color ✓/✓/✓
Subscript/superscript ✓/✓
Strikethrough/hidden ✓/✓
LTR/RTL text ✓/✓
Unicode/DBCS text ✓/✓
Language attribute
Paragraph properties
Left/right/centered/justified alignment ✓/✓/✓/✓
Left/right/first line indent ✓/✓/✓
Background color
Border box color/width ✓/✓
Space before/after ✓/✓
Numbered/unnumbered lists ✓/✓ ①
Tabulators replaced by a sequence of non breaking spaces
Simple tables
Total width
Left margin
Column width
Horizontal cell merging
Cell background color
Row height
Cell border color/width ✓/✓
Other content
Hyperlink fields
Bookmark fields
Document types
XHTML 1.0 Transitional
CSS based document minimizer
Font substitution
Logging framework
SLF4J support
Java platform
Minimum supported platform (Source edition) Java SE 8
Tested with JDK 8 / JDK 11 / JDK 14 ✓/✓/✓
Advanced features
Picture data extraction ✓ ②
Data URI image embedding ✓ ③
Post processing (XPath based)
Android platform see Base64Utils API docs
List templates (RTF listtable section)
generates <ol>/<ul>/<li> elements but result quality varies between RTF writer applications
JUnit tests ✓ (Source Edition)
Installer and uninstaller

① uses direct text formatting, does not generate <ol>/<ul>/<li> HTML elements

② conversion of image data to a web-safe format is not included

③ the included MemoryPictureAdapterBase64 supports embedding of PNG and JPG pictures

Released 26 June 2020



Read the "Getting Started" user guide



Browse the online API documentation


Release notes

Browse release notes (new features, enhancements, and bug fixes)



Frequently asked questions: use cases, licensing, and technical



Contact Habarisoft for support and sales inqueries



Visit the blog for release announcements and useful news

Released 26 June 2020


Installer (Source edition) for registered users:

Download »


Installer (Jar edition) for registered users:

Download »



On the library home page you will find a link to the download area for registered users. The credentials (user name and password) will be sent to you when a new release is available. New releases will also be announced on the blog at


Yes, a free online demo version is available at - To check if the library meets your requirements, you may also purchase a Single Developer license, which includes a 14 days full money back guarantee. This allows to test the full version of the library without any risk. The reseller (ShareIt) will give a full refund if you find that the library does not work as expected.

Picture Support


The library does not convert embedded pictures. It extracts binary picture data from the RTF document. The picture data may be in WMF, JPEG, or other formats. For small images, embedding as Data URI is possible, and - depending on the image format - no additional data conversion is required .

Developer License


Yes, each developer that uses our products must have their own license.

No, developer licenses are perpetual. However, you will be using the last product version released before your free upgrade period expired. They may also may be revoked in case of license violations, or violations of ShareIt terms of sale.


Yes! If you are a registered user, please contact Habarisoft and ask for discount coupon code.

Source Code Distribution


No, the source code is not redistributable, even if you change it. Under no circumstances is it acceptable to disclose the source to any third party.

Server Deployment License


Server Deployment Licenses are required if ScroogeXHTML for the Java platform is used on the server side of a client/server application.

No. A Server Deployment license covers all applications on the server.


Server Deployment licenses are available under two license models, 'Perpetual' or 'Subscription'. When licensed as a subscription, the license expires when the subscription ends. They may also expire in case of license violations, or violations of ShareIt terms of sale.

No. The proof of purchase for Server Deployment licenses is your license document.


No. ScroogeXHTML Server Deployment Licenses or parts of it may not be distributed, sold, rented or transferred to any other party, this includes mergers and acquisitions of the license holder.


Advocate Health Care

APT Business Solutions

Artisan Design Group

Becton, Dickinson and Company


Canadian Natural Resources

Criterion Security Services


Denim Group



GE Medical Systems

Glencore International AG

Include Software

Iodine Software

洁茹 牛

Mayo Foundation

Manuh Solutions

Micrologos Software Developer


NxGen Software

Philips Medical Systems

ProClarity Corporation

Promutuel Assurance

QuadraMed Corporation

Saxos Informatica

Scherer Software


Stanford University

TIP Technologies

YADA Systems


"This is an excellent unique product that has saved us many hours of work. It is simple to use with lots of documentation."

Stewart S., UK

"Scrooge has really helped me out! I'm converting a database of 10,000 questions in RTF into HTML, Scrooge has been invaluable!"

J. M., USA

"It works great and it is stunningly fast - on production, converting 115.000 documents takes 25 seconds instead of 9 hours."

Robert S., Germany

"We are very, very glad with this Component"

M. R., Germany