\n}; } sub tab { my ($self, $n_tabs) = @_; $n_tabs ||= 1; return qq{}; } sub field { my ($self, $fieldname, $args, $content, $prevent_html_entity_encoding) = @_; for ($args, $content) { $_ ||= ""; # undef replaced by empty string s/&/&/g, s//>/g # replace HTML entities unless $prevent_html_entity_encoding; } my $field; # when args : long form of field encoding if ($args) { my $space = qq{ }; $field = qq{} . $space . $fieldname . $space . $args . qq{} . $content . qq{}; } # otherwise : short form of field encoding else { $field = qq{$content}; } return $field; } sub quote { my ($self, $text, $prevent_html_entity_encoding) = @_; my $args = $text; $args =~ s/"/\\"/g; $args = qq{"$args"}; $args =~ s/"/"/g; return $self->field('QUOTE', $args, $text, $prevent_html_entity_encoding); } sub content { my ($self) = @_; # separator for parts in MIME document my $boundary = qw/__NEXT_PART__/; # MIME multipart header my $mime = qq{MIME-Version: 1.0\n} . qq{Content-Type: multipart/related; boundary="$boundary"\n\n} . qq{MIME document generated by MsOffice::Word::HTML::Writer\n\n}; # generate each part (main document must be first) my @parts = $self->_MIME_parts; my $filelist = $self->_filelist(@parts); for my $pair ($self->_main, @parts, $filelist) { my ($filename, $content) = @$pair; my $mime_type = MIME::Types->new->mimeTypeOf($filename) || ''; my ($encoding, $encoded); if ($mime_type =~ /^text|xml$/) { $encoding = 'quoted-printable'; $content =~ s/\r\n/\n/g; $encoded = encode_qp(encode_utf8($content), ''); # '': no "soft line breaks" } else { $encoding = 'base64'; $encoded = encode_base64(encode_utf8($content)); } $mime .= qq{--$boundary\n} . qq{Content-Location: file:///C:/foo/$filename\n} . qq{Content-Transfer-Encoding: $encoding\n} . qq{Content-Type: $mime_type\n\n} . $encoded . "\n"; } # close last MIME part $mime .= "--$boundary--\n"; return $mime; } #====================================================================== # PRIVATE METHODS #====================================================================== sub _main { my ($self) = @_; # body : concatenate content from all sections my $body = ""; my $i = 1; foreach my $section (@{$self->{sections}}) { # section break if ($i > 1) { # type of break my $break = $section->{new_page}; $break = 'always' if $break && $break !~ /\w/; # if true but not a word $break ||= 'auto'; # if false # otherwise, type of break will just be the word given in {new_page} # insert into body my $style = qq{page-break-before:$break;mso-break-type:section-break}; $body .= qq{
\n}; } # section content $body .= qq{
\n$section->{content}\n
\n};
$i += 1;
}
# assemble head and body into a full document
my $html
= qq{\n}
. $self->_head
. qq{\n$body\n}
. qq{\n};
return ["main.htm", $html];
}
sub _head {
my ($self) = @_;
# HTML head : link to filelist, title, view format and styles
my $head
= qq{\n}
. qq{\n}
. qq{\n}
. $section->{$hf} . "\n"
. qq{
\n};
}
$i += 1;
}
# if at least one such div, need to create an attached file
my $header_footer = !$hf_divs ? "" :
qq{\n}
. qq{\n}
. qq{\n}
. $self->{hf_head}
. qq{\n}
. qq{\n} . $hf_divs . qq{\n}
. qq{\n};
return $header_footer;
}
sub _filelist {
my ($self, @parts) = @_;
# xml header
my $xml = qq{hello, world
", $doc->page_break, "hello from another page
"); $doc->create_section( page => {size => "21.0cm 29.7cm", margin => "1.2cm 2.4cm 2.3cm 2.4cm", page_numbers => 50, # initial page number within this section }, header => sprintf("Section 2, page %s of %s", $doc->field('PAGE'), $doc->field('NUMPAGES')), footer => sprintf("printed at %s", $doc->field('PRINTDATE')), new_page => 1, # or 'left', or 'right' ); $doc->write("this is the second section, look at header/footer"); $doc->attach("my_image.gif", $path_to_my_image); $doc->write("
");
my $filename = $doc->save_as("/path/to/some/file");
=head1 DESCRIPTION
=head2 Goal
The present module is one way to programatically generate documents
targeted for Microsoft Word (MsWord). It doesn't need
MsWord to be installed, and doesn't even require a Win32 machine
(which is why it is not in the Cs in a separate HTML document).
=item WordDocument
a hashref of options to include as an XML island in the
HTML C, corresponding to various options in the
MsWord "Tools/Options" panel. These will be included
in a XML element named C<< >>, and
all children elements will be automatically prefixed
by C. The hashref may contain nested hashrefs, such as
WordDocument => { View => 'Print',
Compatibility => {DoNotExpandShiftReturn => "",
BreakWrappedTables => ""} }
Names and values of options
must be found from the Microsoft documentation, or from
reverse engineering of HTML files generated by MsWord.
=back
Parameters may also be passed as a hashref instead of a hash.
=head2 write
$doc->write(".
The remaining arguments to C specify the source of the attachment;
they are directly passed to L and therefore have the same
API flexibility : you can specify a filename, a reference to a memory
variable, a reference to another filehandle, etc.
=head2 create_section
$doc->create_section(
page => {size => "21.0cm 29.7cm",
margin => "1.2cm 2.4cm 2.3cm 2.4cm"},
header => sprintf("Section 2, page %s of %s",
$doc->field('PAGE'),
$doc->field('NUMPAGES')),
footer => sprintf("printed at %s",
$doc->field('PRINTDATE')),
new_page => 1, # or 'left', or 'right'
);
Opens a new section within the document
(or, if this is called before any L,
setups pagination parameters for the first section).
Subsequent calls to the L method will add content to
that section, until the next L call.
Pagination parameters are all optional and may be given
either as a hash or as a hashref; accepted parameters are :
=over
=item page
Hashref of CSS page styles, such as :
=over
=item size
Paper size (for example C<21cm 29.7cm>)
=item margin
Margins (top right bottom left).
=item header_margin
Margin for header
=item footer_margin
Margin for footer
=item page_numbers
Initial value for page numbers within this section
=item paper_source
Parameters for paper source within this section
(values for these parameters must be reverse engineered from MsWord HTML
output)
=back
=item header
Header content (in HTML)
=item first_header
Header content for the first page of that section.
=item footer
Footer content (in HTML).
=item first_footer
Footer content for the first page.
=item new_page
If true, a page break will be inserted before the new section.
If the argument is the word C<'left'> or C<'right'>, one or two
page breaks will be inserted so that the next page is formatted
as a left (right) page.
=back
=head2 save_as
my $filename = $doc->save_as("/path/to/some/file");
Generates the MIME document and saves it at the given location.
If no extension is present, file extension F<.doc> will be added
by default to the filename; this is returned as the result from the method
call.
=head2 content
Returns the whole MIME-encoded document as a single string; this is
used internally by the L method. Direct call is useful if
you don't want to save the document into a file, but want to do
something else like embedding it in a message or a ZIP file, or
returning it as an HTTP response.
=head2 page_break
my $html = $doc->page_break;
my $html = $doc->page_break('left');
my $html = $doc->page_break('right');
Returns HTML markup for encoding a page break.
If an argument C<'left'> or C<'right'> is given, one or two
page breaks will be inserted so that the next page is formatted
as a left (right) page.
=head2 tab
my $html = $doc->tab($n_tabs);
Returns HTML markup for encoding one or several tabs. If C<$n_tab> is
omitted, it defaults to 1.
=head2 field
my $html = $doc->field($fieldname, $args, $content,
$prevent_html_entity_encoding);
Returns HTML markup for a MsWord field.
Optional C<$args> is a string with arguments or flags for
the field. See MsWord help documentation for the list of
field names and their associated arguments or flags.
Optional C<$content> is the initial displayed content for the
field (because unfortunately MsWord does not immediately compute
the field content when opening the document; users will have
to explicitly request to update all fields, by selecting the whole
document and then hitting the F9 key).
Optional C<$prevent_html_entity_encoding> is a boolean
that prevents the automatic translation of C<< < >>, C<< > >> and
C<< & >> characters into HTML entities C<< < >>, C<< > >> and
C<< & >>. This is useful if you want to insert some rich text.
Here are some examples :
my $header = sprintf "%s of %s", $doc->field('PAGE'),
$doc->field('NUMPAGES');
my $footer = sprintf "created at %s, printed at %s",
doc->field(CREATEDATE => '\\@ "d MM yyyy"'),
doc->field(PRINTDATE => '\\@ "dddd d MMMM yyyy" \\* Upper');
my $quoted = $doc->field('QUOTE', '"hello, world"', 'hello, world');
=head2 quote
my $html = $doc->quote($text, $prevent_html_entity_encoding);
Shortcut to produce a QUOTE field (see last field example just above).
The optional C<$prevent_html_entity_encoding> argument is explained in the
L method.
=head1 AUTHORING MHT DOCUMENTS
=head2 HTML for MsWord
MsWord does not support the full HTML and CSS standard,
so authoring MHT documents requires some trial and error.
Basic divs, spans, paragraphs and tables,
are reasonably supported, together with their common CSS
properties; but fancier features like floats, absolute
positioning, etc. may yield some surprises.
To specify widths and heights, you will get better results
by using CSS properties rather than attributes of the
HTML table model.
In case of difficulties for implementing specific features,
try to see what MsWord does with that feature when saving
a document in HTML format (plain HTM, not MHT!).
The generated HTML is quite verbose, but after eliminating
unnecessary tags one can sometimes figure out which are
the key tags (they start with C or C) or the
key attributes (they start with C) which correspond
to the desired functionality.
=head2 Collaboration with the Template Toolkit
The L (TT for short)
is a very helpful tool for generating the HTML.
Below are some hints about collaboration between
the two modules.
=head3 Client code calls both TT and Word::HTML::Writer
The first mode is to use the Template Toolkit for
generating various document parts, and then assemble
them into C.
use Template;
my $tmpl_app = Template->new(%options);
$tmpl_app->process("doctmpl/html_head.tt", \%data, \my $html_head);
$tmpl_app->process("doctmpl/body.tt", \%data, \my $body);
$tmpl_app->process("doctmpl/header.tt", \%data, \my $header);
$tmpl_app->process("doctmpl/footer.tt", \%data, \my $footer);
use MsOffice::Word::HTML::Writer;
my $doc = MsOffice::Word::HTML::Writer->new(
title => $data{title},
head => $html_head,
);
$doc->create_section(
header => $header,
footer => $footer,
);
$doc->write($body);
$doc->save_as("/path/to/some/file");
This architecture is straightforward, but various document parts
are split into several templates, which might be inconvenient
when maintaining a large body of document templates.
=head3 HTML parts as blocks in a single template
Document parts might also be encoded as blocks within one
single template :
[% BLOCK html_head %]
[% END; # BLOCK html_head %]
[% BLOCK body %]
Hello, world
[% END; # BLOCK body %]
etc.
Then the client code calls each block in turn to gather
the various parts :
use Template::Context;
my $tmpl_ctxt = Template::Context->new(%options);
my $tmpl = $tmpl_ctxt->template("doctmpl/all_blocks.tt");
my $html_head = $tmpl_ctxt->process($tmpl->blocks->{html_head}, \%data);
my $body = $tmpl_ctxt->process($tmpl->blocks->{body}, \%data);
my $header = $tmpl_ctxt->process($tmpl->blocks->{header}, \%data);
my $footer = $tmpl_ctxt->process($tmpl->blocks->{footer}, \%data);
# assemble into MsOffice::Word::HTML::Writer, same as before
=head3 Template toolkit calls MsOffice::Word::HTML::Writer
Now let's look at a different architecture: the client code
calls the Template toolkit, which in turn calls
C.
The most common way to call modules from TT is to use
a I; but since there is currently
no TT plugin for C,
we will just tell TT that templates can load regular
Perl modules, by turning on the C option.
The client code looks like any other TT application; but the output of
the L method is a fully-fledged MHT
document, instead of plain HTML.
use Template;
my $tmpl_app = Template->new(LOAD_PERL => 1, %other_options);
$tmpl_app->process("doc_template.tt", \%data, \my $msword_doc);
Within C, we have
[% # main entry point
# gather various parts
SET html_head = PROCESS html_head;
SET header = PROCESS header;
SET footer = PROCESS footer;
SET body = PROCESS body;
# create Word::HTML::Writer object
USE msword = MsOffice.Word.HTML.Writer(head=html_head);
# setup section format
CALL msword.create_section(
page => {size => "21.0cm 29.7cm",
margin => "1cm 2.5cm 1cm 2.5cm",
header_margin => "1cm",
footer_margin => "0cm",},
header => header,
footer => footer
);
# write the body
CALL msword.write(body);
# return the MIME-encoded MsWord document
msword.content(); %]
[% BLOCK html_head %]
...
=head3 Inheritance through TT views
The above architecture can be refined one step further,
by using L to
encapsulate documents. Views have an inheritance mechanism,
so it becomes possible to define families of document
templates, that inherit properties or methods from common
ancestors. Let us start with F,
a generic letter template :
[% VIEW generic_letter
title="Generic letter template";
BLOCK main;
USE msword = MsOffice.Word.HTML.Writer(
title => view.title,
head => view.html_head(),
);
view.write_body();
msword.content();
END; # BLOCK main
BLOCK write_body;
CALL msword.create_section(
page => {size => "21.0cm 29.7cm",
margin => "1cm 2.5cm 1cm 2.5cm"},
header => view.header(),
footer => view.footer()
);
CALL msword.write(view.body());
END; # BLOCK write_body
BLOCK body;
view.letter_head();
view.letter_body();
END; # BLOCK body
BLOCK letter_body; %]
Generic letter body; please override BLOCK letter_body in subviews
[% END; # BLOCK letter_body;
# ... other blocks for header, footer, letter_head, etc.
END; # VIEW generic_letter
[% # call main() method if this templated was loaded directly
letter.main() UNLESS component.caller %]
This is quite similar to an object-oriented class : assignments
within the view are like object attributes (i.e. the C
variable), and blocks within the view are like methods.
After the end of the view, we call the C<main> method, but
only if that view was called directly from client code.
If the view is inherited, as displayed below, then the
call to C<main> will be from the subview.
Now we can define a specific letter template that inherits
from the generic letter and overrides the C<letter_body> block :
[% PROCESS generic_letter.tt2; # loads the parent view
VIEW advertisement;
BLOCK letter_body; %]
<p>Dear [% receiver.name %],</p>
<p>You have won a wonderful [% article %].
Just call us at [% sender.phone %].</p>
<p>Best regards,</p>
[% view.signature(name => sender.name ) %]
[% END; # BLOCK letter_body
END; # VIEW advertisement
advertisement.main() UNLESS component.caller %]
=head1 TO DO
Many features could be added; for example:
- link same header/footers across several sections
- multiple columns
- watermarks (I tried hard to reverse engineer MsWord behaviour,
but it still doesn't work ... couldn't figure out all details
of VML markup)
Contributions welcome!
=head1 AUTHOR
Laurent Dami, C<< <laurent DOT dami AT etat DOT geneve DOT ch> >>
=head1 BUGS
Please report any bugs or feature requests to
C<bug-win32-word-html-writer at rt.cpan.org>, or through the web interface at
L<http://rt.cpan.org/NoAuth/ReportBug.html?Queue=MsOffice-Word-HTML-Writer>.
I will be notified, and then you'll automatically be notified of progress on
your bug as I make changes.
=head1 SUPPORT
You can find documentation for this module with the perldoc command.
perldoc MsOffice::Word::HTML::Writer
You can also look for information at:
=over 4
=item * AnnoCPAN: Annotated CPAN documentation
L<http://annocpan.org/dist/MsOffice-Word-HTML-Writer>
=item * CPAN Ratings
L<http://cpanratings.perl.org/d/MsOffice-Word-HTML-Writer>
=item * RT: CPAN's request tracker
L<http://rt.cpan.org/NoAuth/Bugs.html?Dist=MsOffice-Word-HTML-Writer>
=item * Search CPAN
L<http://search.cpan.org/dist/MsOffice-Word-HTML-Writer>
=back
=head1 SEE ALSO
L<Win32::Word::Writer>, L<RTF::Writer>, L<Spreadsheet::WriteExcel>,
L<OpenOffice::OODoc>.
=head1 COPYRIGHT & LICENSE
Copyright 2009 Laurent Dami, all rights reserved.
This program is free software; you can redistribute it and/or modify it
under the same terms as Perl itself.
MsOffice-Word-HTML-Writer-1.04/t 000755 000000 000000 0 13620654705 16660 5 ustar 00unknown unknown 000000 000000 MsOffice-Word-HTML-Writer-1.04/t/00-load.t 000444 000000 000000 313 11711652770 20312 0 ustar 00unknown unknown 000000 000000 #!perl -T
use Test::More tests => 1;
BEGIN {
use_ok( 'MsOffice::Word::HTML::Writer' );
}
diag( "Testing MsOffice::Word::HTML::Writer $MsOffice::Word::HTML::Writer::VERSION, Perl $], $^X" );
MsOffice-Word-HTML-Writer-1.04/t/01_word_document.t 000444 000000 000000 2505 13620654270 22352 0 ustar 00unknown unknown 000000 000000 #!perl
use utf8;
use Test::More tests => 5;
use MIME::QuotedPrint qw/encode_qp/;
use Encode qw/encode_utf8/;
use MsOffice::Word::HTML::Writer;
my $doc = MsOffice::Word::HTML::Writer->new(
title => "Demo",
WordDocument => {View => 'Print',
Compatibility => {DoNotExpandShiftReturn => ""} },
);
$doc->write("hello, world");
my $br = $doc->page_break('right');
$doc->write($br . "new page after manual break");
$doc->create_section(new_page => 'right');
$doc->write("new page after section break");
my $txt = "this <b>is</b> an <em>April 1<sup>st</sup> joke</em>";
$doc->write($doc->quote($txt, 'true')); # prevent HTML entity encoding
$doc->write("27 Ocak 1756 yılında Salzbug'da doğmuş, 5 Aralık 1791 yılında Viyana'da ölmüştür");
my $content = $doc->content;
like($content, qr(<w:View>Print</w:View>), "View => print");
like($content, qr(<w:Compatibility><w:DoNotExpandShiftReturn />),
"Compatibility => DoNotExpandShiftReturn");
my @break_right = $content =~ /page-break-before:right/g;
is(scalar(@break_right), 2, "page break:right");
like($content, qr(<em>April 1<sup>st</sup> joke</em>),
"prevent HTML entity encoding");
my $utf8_word = encode_qp(encode_utf8('doÄŸmuÅŸ'), '');
like($content, qr/$utf8_word/, 'UTF8 support');
MsOffice-Word-HTML-Writer-1.04/t/pod.t 000444 000000 000000 222 11711652770 17737 0 ustar 00unknown unknown 000000 000000 #!perl -T
use Test::More;
eval "use Test::Pod 1.14";
plan skip_all => "Test::Pod 1.14 required for testing POD" if $@;
all_pod_files_ok();
hello, world
"); Adds some HTML into the document body. =head2 attach $doc->attach($localname, $filename); $doc->attach($localname, "<", \$content); $doc->attach($localname, "<&", $filehandle); Adds an attachment into the document; the attachment will be encoded as a MIME part and will be accessible under C