A ruby gem that reads a Rich Text Format (RTF) word processing file and outputs plain text.

Usage¶ ↑

Convert rtf file to plain text

RtfFilter.to_txt('name_of_file.rtf')

Convert rtf file and format text (this will remove blank lines at top and bottom of document, multiple line breaks and justify text left)

RtfFilter.to_txt('name_of_file.rtf', :format_txt => true)

Convert rtf file to text file. Will create name_of_file.txt

RtfFilter.to_txt_file('name_of_file.rtf', :format_txt => true)

Specify directory text file should be written to

RtfFilter.to_txt_file('name_of_file.rtf', :destination_folder => 'folder_name', :format_txt => true)

Other options

:allow_tags => true #Does not supress output of angle bracketted tags e.g. <notes>, default is fase
:io_exception => true #Return IO exceptions instead of nil if there is a file / directory problem

Installation¶ ↑

You need to have the rtf-filter C++ executable installed:

github.com/leanbid/rtf-filter

Bug reports¶ ↑

If you discover a problem with rtf-filter, we would like to know about it.

Our Issues Tracker is available here:

pscomputer.lighthouseapp.com/projects/87573-rtf_filter-ruby-gem

License¶ ↑

COMMON DEVELOPMENT AND DISTRIBUTION LICENSE (CDDL) Version 1.0 Copyright PS Computer Services Ltd 2003-2011