XHTML2RTF

Overview

This article describes a conversion tool which takes an HTML document as input and generates a Microsoft Word document for printing.

It all started when I had to work on a new Information System with hundreds of computers. We decided to go for a 100% Web-based application. Everything was fine until we had to print official documents from the application...

Although there are standardization efforts in progress (both at the W3C with XHTML-PRINT and IEEE with the Print Working Group), and besides some good tools to print HTML (HTML Print from Bersoft, ScriptX from MeadCo), none of these seemed to address my needs. I wanted to keep my Web-based application, and reuse generated HTML to feed a printer...

Have you tried to print HTML documents? Have you tried to format your HTML documents for printing, with specific fonts, sizes, headers, footers, and margins?

If you have, you know that HTML is not appropriate for printing, but you can find other formats and use new tools to convert HTML documents into Microsoft Word format, a format suitable for printing... And this is what this article is about.


Contents


Features

The XHTML2RTF conversion tool has the following features:


Introduction

The XHTML2RTF conversion tool uses an XSL stylesheet to convert an XHTML document into an RTF document, suitable for previewing and printing with Word (or Word Viewer).

XHTML = HTML + XML

The Extensible HyperText Markup Language (XHTML) is a family of current and future document types and modules that reproduce, subset, and extend HTML, reformulated in XML. XHTML Family document types are all XML-based, and ultimately are designed to work in conjunction with XML-based user agents. XHTML is the successor of HTML, and a series of specifications has been developed for XHTML.

=> The XHTML2RTF conversion tool reads XHTML documents as input. As a consequence, you have to adapt your application to use this tool.

XSL

XSL stands for eXtensible Stylesheet Language. It is a family of recommendations for defining XML document transformation and presentation. It consists of three parts:

  1. A programming language for transforming XML documents: XSL Transformations (XSLT)
  2. An expression language used by XSLT to access or refer to parts of an XML document: XML Path Language (XPath). This language provides pattern matching (xsl:template match), conditional statements (xsl:when test), loops (for-each), etc...
  3. An XML vocabulary for specifying formatting semantics: similar to W3C cascading style sheets (CSS), this vocabulary provides enhanced presentation features.

For more about XSL, please refer to the XSL references pages.

=> The XHTML2RTF conversion tool uses XSL to transform XHTML documents (XML documents) into RTF documents. This is the core of the tool; anything else is just glue to build your application. Everything is in the XSL stylesheet.

Microsoft XML SDK 3.0

Microsoft provides an XML SDK for processing XML and XSL documents. It's often installed with the operating system, but you can download and install the latest SDK. See the References section for more on MSXML SDK.

=> The XHTML2RTF conversion tool uses XML SDK objects and methods to process XHTML and transform it into RTF. the XML SDK API is available to Web applications as well as batch applications and so is the XHTML2RTF conversion tool.

Microsoft Rich Text Format (RTF)

Microsoft created a exchange format for Word documents: Rich Text Format (RTF). Unlike the native Word format, it is documented; moreover, RTF has been here for some time (so you can view RTF document with good old Word 97). There is also a free RTF viewer (Word 97/2000 Viewer), and even WordPad (installed with most Windows releases) can open, view, and edit RTF documents.

XHTML2RTF

The XHTML to RTF converter consists in an XSL stylesheet for parsing XHTML tags and generating their RTF equivalents.


Usage

From HTML to XHTML

You have to adapt your application to generate XHTML documents if you want to use the XHTML2RTF convertion tool:

  • Include an XML declaration at the beginning of the document:
  • <?xml version="1.0" encoding="iso-8859-1" ?>
  • Include an XHTML namepace declaration (the default) and an XHTML2RTF namespace declaration in the <html> tag:
    <html
          xmlns="http://www.w3.org/1999/xhtml"
          xmlns:xhtml2rtf="http://www.lutecia.info/download/xmlns/
                                  xhtml2rtf">
    ...
    </html>
    
  • Use lower case for both tag names and attribute names:
  • <P></P> becomes <p></p>
    <A HREF="...">...</a> becomes <a href="...">...</a>
    etc...

  • Add termination for all tags (XHTML is stricter than HTML):
    <link rel="stylesheet" href="..."> becomes <link rel="stylesheet" href="..." />
    <hr> becomes <hr />
    <br> becomes <br />

  • Quote all attribute values:
    <table class=noprint> becomes <table class="noprint">
    <a href=mypage.asp> becomes <a href="mypage.asp">

  • Use encoded characters for non-ASCII and/or special characters:
    & becomes &amp;
    i becomes &#233;
    h becomes &#232;
    etc...

  • Replace HTML character entities by their code (XML knows very few character entity references; use character codes instead):
    &nbsp; becomes &#160;
    &egrave; becomes &#232;
    &eacute; becomes &#233;
    &ecirc; becomes &#234;
    etc...

  • Do not use direct style for tags (use class and an external CSS stylesheet instead)
    <div style='background:#c0c0c0; font-size: 125%; padding:1.0pt 10.0pt 1.0pt 10.0pt;'>
    becomes
    <div class="mydivstyle">
    Thus, you will be able to customize the RTF output for your class (it's much too hard to parse an HTML style declaration within an XSL stylesheet).

Spaces in HTML and RTF

In HTML, spaces are not significant; most browsers ignore them when they render the document. On the other hand, Microsoft Word (and RTF) renders spaces as visible characters. Be careful when building your HTML document: Do not generate spaces or they will be shown in your Word document.

Header and Footer in HTML and RTF

The default header in the RTF document contains the HTML <title> (from the <head> section). You can change the header by setting the parameters header-font-size-default, header-distance-from-edge, and header-indentation-left (see parameters below).

You also can create your own header by using class "rtf_header" and "rtf_header_first" in your HTML document:

  • rtf_header_first defines a complete HTML content for the header on first page of the document
  • rtf_header defines a complete HTML content for the header on all other pages of the document

The default footer in the RTF document contains the page number and document date (current date and time; i.e. print date and time). You can change the footer by setting the parameters footer-font-size-default, footer-distance-from-edge and use-default-footer (see parameters below).

Page Break

To force a page break in your RTF document, you can use the CSS style "page-break-before" or "page-break-after" with a value of "always":

This is on page 1
<p style="page-break-before:always"/>
This is on page 2

Note that other values for these CSS styles (left, right, auto...) are not supported (only "always" is supported).

XSL Stylesheet Parameters

The XSL stylesheet xhtml2rtf.xsl provides a set of parameters so that you can change the stylesheet default behavior:

  • page-start-number: Page start number (default: 1)
  • page-setup-paper-width: Paper width in TWIPS (default: 11907 TWIPS = 21 cm, i.e. A4 format)
  • page-setup-paper-height: Paper height in TWIPS (default: 16840 TWIPS = 29.7 cm, i.e. A4 format)
  • page-setup-margin-top: Top margin in TWIPS (default: 1440 TWIPS = 1 inch = 2.54 cm)
  • page-setup-margin-bottom: Bottom margin in TWIPS (default: 1440 TWIPS = 1 inch = 2.54 cm)
  • page-setup-margin-left: Left margin in TWIPS (default: 1134 TWIPS = 2 cm)
  • page-setup-margin-right: Right margin in TWIPS (default: 1134 TWIPS = 2 cm)
  • font-size-default: Default font size in TWIPS (default: 20 TWIPS = 10 pt.)
  • font-name-default: Default font name (default: 'Times New Roman')
  • font-name-fixed: Default font name for fixed-width text, like PRE or CODE (default: 'Courier New')
  • font-name-barcode: Barcode font name (default: '3 of 9 Barcode')
  • header-font-size-default: Header default font size in TWIPS (default: 14 TWIPS = 7 pt.)
  • header-distance-from-edge: Default distance between top of page and top of header, in TWIPS (default: 720 TWIPS = 1.27 cm)
  • header-indentation-left: Header left indentation in TWIPS (default: 0)
  • footer-font-size-default: Footer default font size in TWIPS (default: 14 TWIPS = 7 pt.)
  • footer-distance-from-edge: Default distance between bottom of page and bottom of footer, in TWIPS (default: 720 TWIPS = 1.27 cm)
  • use-default-footer: Boolean flag: 1 to use default footer (page number and date) or 0 no footer (default: 1)
  • document-protected: Boolean flag: 1 protected (cannot be modified) or 0 unprotected (default: 1)
  • normalize-space: Boolean flag: 1 spaces are normalized and trimmed, or 0 no normalization no trim (default: 0)
  • my-normalize-space: Boolean flag: 1 spaces are normalized (NOT TRIMMED), or 0 no normalization (default: 1)

Batch mode (WSH)

I wrote a BATCH program (XHTML2RTF.BAT) that relies on Windows Script Host (WSH) to call the XML DOM SDK and transforms an HTML file into its RTF equivalent (output is done in stdout).

To use this component from batch, call the XHTML2RTF.BAT program with the HTML file name as parameter. The RTF file is generated in stdout, so you should redirect the output with the > operator. Then, you can open the generated file with Microsoft Word (or Wordpad):

C:\> XHTML2RTF.BAT Readme.htm > Readme.rtf
C:\> START WINWORD Readme.rtf

To pass parameters to the XHTML2RTF program, use the -p flag followed by a parameter name and value.

Example:

C:\> XHTML2RTF.BAT -p page-start-number=5 -p document-protected=0
                   -p font-name-default='Arial' Readme.htm >
                                                Readme.rtf
C:\> START WINWORD Readme.rtf

Web-Based (ASP)

I wrote a simple ASP library to call the component from an ASP page, producing an RTF document from live, dynamic content (results from a SQL database request, for example).

To use this component from a Web page, you have to include the XHTML2RTF.inc file in your page, and call function XHTMLString2RTF(), passing the XHTML document (as a string):

<!--#include file="XHTML2RTF.inc"-->

var strXHTML = " \
<html xmlns=\"http://www.w3.org/1999/xhtml\"
      xmlns:xhtml2rtf=\"http://www.lutecia.info/download/xmlns/
                               xhtml2rtf\"> \
   <head> \
      <title>Hello, World! from string</title> \
   </head> \
   <body> \
      <h1>Hello, World!</h1> \
   </body> \
</html> \
";

XHTMLString2RTF(strXHTML);
Note: The real production system uses SQL requests, generates XML output, transforms it into XHTML via a first XSL stylesheet, and then transforms it into an RTF document. The example above is just that, an example for demonstration purposes. Please do not generate HTML via strings on your production system.

Raw RTF output

The XHTML2RTF conversion tool provides a direct RTF output with no rendering in XHTML. The tool processes a special tag (<xhtml2rtf:raw>) to send RTF directly. For example, this code will send a TAB character in the RTF output:

<xhtml2rtf:raw class="rtf">\tab </xhtml2rtf:raw>

This code will not be rendered in your Web browser because the class "rtf" is defined in the css stylesheet as "display:none".

There are many uses for this raw output; in particular, you can work around most of the current limitations in the conversion tool (as listed in TODO section). For example, you can send the RTF code for an image, even if the conversion tool doesn't handle images yet:

<xhtml2rtf:raw class="rtf">{\*\shppict{\pict\picw3043\pich3043
                            \picwgoal1725\pichgoal1725\pngblip
89504e470d0a1a0a0000000d49484452000000730000007308020000002421aab
1000000017352474200aece1ce90000000467414d410000b18f0bfc61050000
...
}}</xhtml2rtf:raw>

To find out what RTF code is appropriate for this image, I just used Word to edit a document with a picture, and then saved it in RTF format. I opened the resulting file as text, and copied/pasted the RTF code into the XHTML output, within <xhtml2rtf:raw> tags.

RTF-specific fields

Some RTF-specific fields are available in the conversion tool:

Page Number

You can display the current page number in your RTF document via <xhtml2rtf:page_number>:

PAGE <xhtml2rtf:page_number/>
Total Number of Pages

You can display total number of pages in your RTF document via <xhtml2rtf:total_number_of_pages>

PAGE <xhtml2rtf:page_number/> / <xhtml2rtf:total_number_of_pages/>

Samples

  1. Hello, World! (HTML) (RTF)
  2. Custom Header, 2 Pages (HTML) (RTF)
  3. No Footer (HTML) (RTF)
  4. The Readme file you're reading in RTF

Implementation

  • The XHTML to RTF converter consists in an XSL stylesheet for parsing XHTML tags and generating their RTF equivalents.

To Do Llist


Download

Download Article and Source Code (~60 KB).


References



Downloads

Comments

  • There are no comments yet. Be the first to comment!

Leave a Comment
  • Your email address will not be published. All fields are required.

Top White Papers and Webcasts

  • Live Event Date: October 29, 2014 @ 11:00 a.m. ET / 8:00 a.m. PT Are you interested in building a cognitive application using the power of IBM Watson? Need a platform that provides speed and ease for rapidly deploying this application? Join Chris Madison, Watson Solution Architect, as he walks through the process of building a Watson powered application on IBM Bluemix. Chris will talk about the new Watson Services just released on IBM bluemix, but more importantly he will do a step by step cognitive …

  • Live Event Date: November 13, 2014 @ 2:00 p.m. ET / 11:00 a.m. PT APIs can be a great source of competitive advantage. The practice of exposing backend services as APIs has become pervasive, however their use varies widely across companies and industries. Some companies leverage APIs to create internal, operational and development efficiencies, while others use them to drive ancillary revenue channels. Many companies successfully support both public and private programs from the same API by varying levels …

Most Popular Programming Stories

More for Developers

Latest Developer Headlines

RSS Feeds