This simple gem allows you to create MS Word docx documents from simple html documents. This makes it easy to create dynamic reports and forms that can be downloaded by your users as simple MS Word docx files.
Add this line to your application's Gemfile:
gem 'htmltoword'
And then execute:
$ bundle
Or install it yourself as:
$ gem install htmltoword
require 'htmltoword'
my_html = '<html><head></head><body><p>Hello</p></body></html>'
file = Htmltoword::Document.create my_html, file_name# Add mime-type in /config/initializers/mime_types.rb:
Mime::Type.register "application/vnd.openxmlformats-officedocument.wordprocessingml.document", :docx
# Add docx reponder in your controler
def show
respond_to do |format|
format.docx do
file = Htmltoword::Document.create params[:docx_html_source], "file_name.docx"
send_file file.path, :disposition => "attachment"
end
end
end // OPTIONAL: Use a jquery click handler to store the markup in a hidden form field before the form is submitted.
// Using this strategy makes it easy to allow users to dynamically edit the document that will be turned
// into a docx file, for example by toggling sections of a document.
$('#download-as-docx').on('click', function () {
$('input[name="docx_html_source"]').val('<!DOCTYPE html>\n' + $('.delivery').html());
});All standard html elements are supported and will create the closest equivalent in wordml. For example spans will create inline elements and divs will create block like elements.
You can add highlighting to text by wrapping it in a span with class h and adding a data style with a color that wordml supports (http://www.schemacentral.com/sc/ooxml/t-w_ST_HighlightColor.html) ie:
<span class="h" data-style="green">This text will have a green highlight</span>To create page breaks simply add a div with class -page-break ie:
<div class="-page-break"></div>Word docx files are essentially just a zipped collection of xml files and resources. This gem contains a standard empty MS Word docx file and a stylesheet to transform arbitrary html into wordml. The basic functioning of this gem can be summarised as:
- Transform inputed html to wordml.
- Unzip empty word docx file bundled with gem and replace its document.xml content with the new transformed result of step 1.
- Zip up contents again into a resulting .docx file.
For more info about WordML: http://rep.oio.dk/microsoft.com/officeschemas/wordprocessingml_article.htm
Contributions would be very much appreciated.
- Fork it
- Create your feature branch (
git checkout -b my-new-feature) - Commit your changes (
git commit -am 'Add some feature') - Push to the branch (
git push origin my-new-feature) - Create new Pull Request
(The MIT License)
Copyright © 2013:
-
Cristina Matonte
-
Nicholas Frandsen