---

Here Documents

If you want to quote many lines of text literally, you use the "Here Document" notation which consists of an introductory line which has two open angles followed by a keyword, the end tag, for signalling the end of the quote. All text and lines following the introductory line are quoted. The quote ends when the end tag is found, by itself, on a line. For example, the end tag is "EOT":

<font size="-1">#!/usr/bin/perl -w
use strict;
my $foo = 123.45;
my $bar = "Martha Stewedprune";
print <<"EOT";
=====

This is an example of
   text taken literally
   except that variables are
   expanded where their
   variable names appear.
   foo: $foo
   bar: $bar
EOT
[download]

This example, when run, produces the following:

=====

This is an example of
   text taken literally
   except that variables are
   expanded where their
   variable names appear.
   foo: 123.45
   bar: Martha Stewedprune
[download]

They way you quote, the end tag is important: like their regular quote counterparts, double-quotes allow expansion of variables and special characters, single quotes don't allow expansion. You may also have a bare, unquoted, end tag; this is equivalent to a double quote, i.e., expansion expansion.

Some warnings:

• The end tag specifier must follow the << without any intermediate space.
• The actual end tag must be exactly the same as in the introduction line.
• Don't forget that the introduction line must end with a semicolon, just like any other perl statement.

The here document is particularly useful when embedding HTML in Perl because it increases the readability of the HTML. The quote character is printed out without any escapes. For example:

my $url = "http://www.maperl.com";
my $text = "Mother of Perl";
print <<"EOT";

<a href="$url">$text</a>
EOT
[download]

Prints just what we would hope:

<a href="http://www.maperl.com">Mother of Perl</a>
[download]

---

---

• Are you posting in the right place? Check out Where do I post X? to know for sure.
• Posts may use any of the Perl Monks Approved HTML tags. Currently these include the following:

  <code> <a> <b> <big> <blockquote> <br /> <dd> <dl> <dt> <em> <font> <h1> <h2> <h3> <h4> <h5> <h6> <hr /> <i> <li> <nbsp> <ol> <p> <small> <strike> <strong> <sub> <sup> <table> <td> <th> <tr> <tt> <u> <ul>

• Snippets of code should be wrapped in <code> tags not <pre> tags. In fact, <pre> tags should generally be avoided. If they must be used, extreme care should be taken to ensure that their contents do not have long lines (<70 chars), in order to prevent horizontal scrolling (and possible janitor intervention).
• Want more info? How to link or How to display code and escape characters are good places to start.