.\" Automatically generated by Pod::Man 2.28 (Pod::Simple 3.28)
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Vb \" Begin verbatim text
.ft CW
.nf
.ne \\$1
..
.de Ve \" End verbatim text
.ft R
.fi
..
.\" Set up some character translations and predefined strings.  \*(-- will
.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
.\" double quote, and \*(R" will give a right double quote.  \*(C+ will
.\" give a nicer C++.  Capital omega is used to do unbreakable dashes and
.\" therefore won't be available.  \*(C` and \*(C' expand to `' in nroff,
.\" nothing in troff, for use with C<>.
.tr \(*W-
.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
.ie n \{\
.    ds -- \(*W-
.    ds PI pi
.    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
.    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
.    ds L" ""
.    ds R" ""
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds -- \|\(em\|
.    ds PI \(*p
.    ds L" ``
.    ds R" ''
.    ds C`
.    ds C'
'br\}
.\"
.\" Escape single quotes in literal strings from groff's Unicode transform.
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\"
.\" If the F register is turned on, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
.\" entries marked with X<> in POD.  Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.\"
.\" Avoid warning from groff about undefined register 'F'.
.de IX
..
.nr rF 0
.if \n(.g .if rF .nr rF 1
.if (\n(rF:(\n(.g==0)) \{
.    if \nF \{
.        de IX
.        tm Index:\\$1\t\\n%\t"\\$2"
..
.        if !\nF==2 \{
.            nr % 0
.            nr F 2
.        \}
.    \}
.\}
.rr rF
.\"
.\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
.\" Fear.  Run.  Save yourself.  No user-serviceable parts.
.    \" fudge factors for nroff and troff
.if n \{\
.    ds #H 0
.    ds #V .8m
.    ds #F .3m
.    ds #[ \f1
.    ds #] \fP
.\}
.if t \{\
.    ds #H ((1u-(\\\\n(.fu%2u))*.13m)
.    ds #V .6m
.    ds #F 0
.    ds #[ \&
.    ds #] \&
.\}
.    \" simple accents for nroff and troff
.if n \{\
.    ds ' \&
.    ds ` \&
.    ds ^ \&
.    ds , \&
.    ds ~ ~
.    ds /
.\}
.if t \{\
.    ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
.    ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
.    ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
.    ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
.    ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
.    ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
.\}
.    \" troff and (daisy-wheel) nroff accents
.ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
.ds 8 \h'\*(#H'\(*b\h'-\*(#H'
.ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
.ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
.ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
.ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
.ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
.ds ae a\h'-(\w'a'u*4/10)'e
.ds Ae A\h'-(\w'A'u*4/10)'E
.    \" corrections for vroff
.if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
.if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
.    \" for low resolution devices (crt and lpr)
.if \n(.H>23 .if \n(.V>19 \
\{\
.    ds : e
.    ds 8 ss
.    ds o a
.    ds d- d\h'-1'\(ga
.    ds D- D\h'-1'\(hy
.    ds th \o'bp'
.    ds Th \o'LP'
.    ds ae ae
.    ds Ae AE
.\}
.rm #[ #] #H #V #F C
.\" ========================================================================
.\"
.IX Title "Text::SmartyPants 3pm"
.TH Text::SmartyPants 3pm "2010-05-23" "perl v5.20.1" "User Contributed Perl Documentation"
.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
.nh
.SH "Methods"
.IX Header "Methods"
.SS "process"
.IX Subsection "process"
Do the bulk of the conversion work.
.SS "SmartQuotes"
.IX Subsection "SmartQuotes"
Quotes to entities.
.SS "SmartDashes"
.IX Subsection "SmartDashes"
Call the individual dash conversion to entities functions.
.SS "SmartEllipses"
.IX Subsection "SmartEllipses"
Call the individual ellipse conversion to entities functions.
.SS "EducateQuotes"
.IX Subsection "EducateQuotes"
.Vb 1
\&   Parameter:  String.
\&
\&   Returns:    The string, with "educated" curly quote HTML entities.
\&
\&   Example input:  "Isn\*(Aqt this fun?"
\&   Example output: &#8220;Isn&#8217;t this fun?&#8221;
.Ve
.SS "EducateBackticks"
.IX Subsection "EducateBackticks"
Replace double (back)ticks w/ \s-1HTML\s0 entities.
.SS "EducateSingleBackticks"
.IX Subsection "EducateSingleBackticks"
Replace single (back)ticks w/ \s-1HTML\s0 entities.
.SS "EducateDashes"
.IX Subsection "EducateDashes"
Dashes to \s-1HTML\s0 entity
.PP
.Vb 1
\&   Parameter:  String.
\&
\&   Returns:    The string, with each instance of "\-\-" translated to
\&               an em\-dash HTML entity.
.Ve
.SS "EducateDashesOldSchool"
.IX Subsection "EducateDashesOldSchool"
Dashes to entities.
.PP
.Vb 1
\&   Parameter:  String.
\&
\&   Returns:    The string, with each instance of "\-\-" translated to
\&               an en\-dash HTML entity, and each "\-\-\-" translated to
\&               an em\-dash HTML entity.
.Ve
.SS "EducateDashesOldSchoolInverted"
.IX Subsection "EducateDashesOldSchoolInverted"
.Vb 1
\&   Parameter:  String.
\&
\&   Returns:    The string, with each instance of "\-\-" translated to
\&               an em\-dash HTML entity, and each "\-\-\-" translated to
\&               an en\-dash HTML entity. Two reasons why: First, unlike the
\&               en\- and em\-dash syntax supported by
\&               EducateDashesOldSchool(), it\*(Aqs compatible with existing
\&               entries written before SmartyPants 1.1, back when "\-\-" was
\&               only used for em\-dashes.  Second, em\-dashes are more
\&               common than en\-dashes, and so it sort of makes sense that
\&               the shortcut should be shorter to type. (Thanks to Aaron
\&               Swartz for the idea.)
.Ve
.SS "EducateEllipses"
.IX Subsection "EducateEllipses"
.Vb 3
\&   Parameter:  String.
\&   Returns:    The string, with each instance of "..." translated to
\&               an ellipsis HTML entity.
\&
\&   Example input:  Huh...?
\&   Example output: Huh&#8230;?
.Ve
.SS "StupefyEntities"
.IX Subsection "StupefyEntities"
.Vb 3
\&   Parameter:  String.
\&   Returns:    The string, with each SmartyPants HTML entity translated to
\&               its ASCII counterpart.
\&
\&   Example input:  &#8220;Hello &#8212; world.&#8221;
\&   Example output: "Hello \-\- world."
.Ve
.SS "SmartyPantsVersion"
.IX Subsection "SmartyPantsVersion"
Return the version of SmartyPants.
.SS "ProcessEscapes"
.IX Subsection "ProcessEscapes"
.Vb 4
\&   Parameter:  String.
\&   Returns:    The string, with after processing the following backslash
\&               escape sequences. This is useful if you want to force a "dumb"
\&               quote or other character to appear.
\&
\&               Escape  Value
\&               \-\-\-\-\-\-  \-\-\-\-\-
\&               \e\e      &#92;
\&               \e"      &#34;
\&               \e\*(Aq      &#39;
\&               \e.      &#46;
\&               \e\-      &#45;
\&               \e\`      &#96;
.Ve
.SH "Name"
.IX Header "Name"
Text::SmartyPants \- cute little punctuation assistant
.SH "Synopsis"
.IX Header "Synopsis"
SmartyPants is a free web publishing plug-in for Movable Type, Blosxom,
and BBEdit that easily translates plain \s-1ASCII\s0 punctuation characters
into \*(L"smart\*(R" typographic punctuation \s-1HTML\s0 entities.
.SH "Description"
.IX Header "Description"
SmartyPants can perform the following transformations:
.IP "\(bu" 4
Straight quotes ( \*(L" and ' ) into \*(R"curly" quote \s-1HTML\s0 entities
.IP "\(bu" 4
Backticks-style quotes (``like this'') into \*(L"curly\*(R" quote \s-1HTML\s0 entities
.IP "\(bu" 4
Dashes (\f(CW\*(C`\-\-\*(C'\fR and \f(CW\*(C`\-\-\-\*(C'\fR) into en\- and em-dash entities
.IP "\(bu" 4
Three consecutive dots (\f(CW\*(C`...\*(C'\fR) into an ellipsis entity
.PP
This means you can write, edit, and save your posts using plain old
\&\s-1ASCII\s0 straight quotes, plain dashes, and plain dots, but your published
posts (and final \s-1HTML\s0 output) will appear with smart quotes, em-dashes,
and proper ellipses.
.PP
SmartyPants is a combination plug-in \*(-- the same file works with Movable
Type, Blosxom, and BBEdit. It can also be used from a Unix-style
command-line. Version requirements and installation instructions for
each of these tools can be found in the corresponding sub-section under
\&\*(L"Installation\*(R", below.
.PP
SmartyPants does not modify characters within \f(CW\*(C`<pre>\*(C'\fR, \f(CW\*(C`<code>\*(C'\fR, \f(CW\*(C`<kbd>\*(C'\fR, or \f(CW\*(C`<script>\*(C'\fR tag blocks. Typically, these tags
are used to display text where smart quotes and other \*(L"smart
punctuation\*(R" would not be appropriate, such as source code or example
markup.
.SS "Backslash Escapes"
.IX Subsection "Backslash Escapes"
If you need to use literal straight quotes (or plain hyphens and
periods), SmartyPants accepts the following backslash escape sequences
to force non-smart punctuation. It does so by transforming the escape
sequence into a decimal-encoded \s-1HTML\s0 entity:
.PP
.Vb 8
\&              Escape  Value  Character
\&              \-\-\-\-\-\-  \-\-\-\-\-  \-\-\-\-\-\-\-\-\-
\&                \e\e    &#92;    \e
\&                \e"    &#34;    "
\&                \e\*(Aq    &#39;    \*(Aq
\&                \e.    &#46;    .
\&                \e\-    &#45;    \-
\&                \e\`    &#96;    \`
.Ve
.PP
This is useful, for example, when you want to use straight quotes as
foot and inch marks: 6'2\*(L" tall; a 17\*(R" iMac.
.SS "MT-Textile Integration"
.IX Subsection "MT-Textile Integration"
Movable Type users should also note that SmartyPants can work in
conjunction with Brad Choate's MT-Textile plug-in:
.PP
.Vb 1
\&    http://bradchoate.com/past/mttextile.php
.Ve
.PP
MT-Textile is a port of Dean Allen's original Textile project to Perl
and Movable Type. MT-Textile by itself only translates Textile markup
to \s-1HTML.\s0 However, if SmartyPants is also installed, MT-Textile will
call on SmartyPants to educate quotes, dashes, and ellipses,
automatically. Using SmartyPants in conjunction with MT-Textile
requires no modifications to your Movable Type templates.
.PP
Textile is Dean Allen's \*(L"humane web text generator\*(R", an easy-to-write
and easy-to-read shorthand for writing text for the web. An online
Textile web application is available at Mr. Allen's site:
.PP
.Vb 1
\&    http://textism.com/tools/textile/
.Ve
.SH "Installation"
.IX Header "Installation"
.SS "Movable Type"
.IX Subsection "Movable Type"
SmartyPants works with Movable Type version 2.5 or later.
.IP "1." 4
Copy the \*(L"SmartyPants.pl\*(R" file into your Movable Type \*(L"plugins\*(R" directory.
The \*(L"plugins\*(R" directory should be in the same directory as \*(L"mt.cgi\*(R"; if it
doesn't already exist, use your \s-1FTP\s0 program to create it. Your
installation should look like this:
.Sp
.Vb 1
\&    (mt home)/plugins/SmartyPants.pl
.Ve
.IP "2." 4
If you're using SmartyPants with Brad Choate's MT-Textile, you're done.
.Sp
If not, to activate SmartyPants on your weblog, you need to edit your \s-1MT\s0
templates. The easiest way is to add the \f(CW\*(C`smarty_pants\*(C'\fR attribute to
each \s-1MT\s0 template tag whose contents you wish to apply SmartyPants'
transformations. Obvious tags would include \f(CW\*(C`MTEntryTitle\*(C'\fR,
\&\f(CW\*(C`MTEntryBody\*(C'\fR, and \f(CW\*(C`MTEntryMore\*(C'\fR. SmartyPants should work within any
\&\s-1MT\s0 content tag.
.Sp
For example, to apply SmartyPants to your entry titles:
.Sp
.Vb 1
\&    <$MTEntryTitle smarty_pants="1"$>
.Ve
.Sp
The value passed to \f(CW\*(C`smarty_pants\*(C'\fR specifies the way SmartyPants works.
See \*(L"Options\*(R", below, for full details on all of the supported options.
.SS "Blosxom"
.IX Subsection "Blosxom"
SmartyPants works with Blosxom version 2.0 or later.
.IP "1." 4
Rename the \*(L"SmartyPants.pl\*(R" plug-in to \*(L"SmartyPants\*(R" (case is
important). Movable Type requires plug-ins to have a \*(L".pl\*(R" extension;
Blosxom forbids it (at least as of this writing).
.IP "2." 4
Copy the \*(L"SmartyPants\*(R" plug-in file to your Blosxom plug-ins folder. If
you're not sure where your Blosxom plug-ins folder is, see the Blosxom
documentation for information.
.IP "3." 4
That's it. The entries in your weblog should now automatically have
SmartyPants' default transformations applied.
.IP "4." 4
If you wish to configure SmartyPants' behavior, open the \*(L"SmartyPants\*(R"
plug-in, and edit the value of the \f(CW$smartypants_attr\fR configuration
variable, located near the top of the script. The default value is 1;
see \*(L"Options\*(R", below, for the full list of supported values.
.SS "BBEdit"
.IX Subsection "BBEdit"
SmartyPants works with BBEdit 6.1 or later on Mac \s-1OS X\s0; and BBEdit 5.1
or later on Mac \s-1OS 9\s0 or earlier (provided you have MacPerl
installed).
.IP "1." 4
Copy the \*(L"SmartyPants.pl\*(R" file to appropriate filters folder in your
\&\*(L"BBEdit Support\*(R" folder. On Mac \s-1OS X,\s0 this should be:
.Sp
.Vb 1
\&    BBEdit Support:Unix Support:Unix Filters:
.Ve
.Sp
On Mac \s-1OS 9\s0 or earlier, this should be:
.Sp
.Vb 1
\&    BBEdit Support:MacPerl Support: Perl Filters:
.Ve
.Sp
See the BBEdit documentation for more details on the location of these
folders.
.Sp
You can rename \*(L"SmartyPants.pl\*(R" to whatever you wish.
.IP "2." 4
That's it. To use SmartyPants, select some text in a BBEdit document,
then choose SmartyPants from the Filters sub-menu or the Filters
floating palette. On Mac \s-1OS 9,\s0 the Filters sub-menu is in the \*(L"Camel\*(R"
menu; on Mac \s-1OS X,\s0 it is in the \*(L"#!\*(R" menu.
.IP "3." 4
If you wish to configure SmartyPants' behavior, open the SmartyPants
file and edit the value of the \f(CW$smartypants_attr\fR configuration
variable, located near the top of the script. The default value is 1;
see \*(L"Options\*(R", below, for the full list of supported values.
.SH "Options"
.IX Header "Options"
.SS "smarty_pants"
.IX Subsection "smarty_pants"
For \s-1MT\s0 users, the \f(CW\*(C`smarty_pants\*(C'\fR template tag attribute is where you
specify configuration options. For Blosxom and BBEdit users, settings
are specified by editing the value of the \f(CW$smartypants_attr\fR variable
in the script itself.
.PP
Numeric values are the easiest way to configure SmartyPants' behavior:
.ie n .IP "\fB""0""\fR" 4
.el .IP "\fB``0''\fR" 4
.IX Item "0"
Suppress all transformations. (Do nothing.)
.ie n .IP "\fB""1""\fR" 4
.el .IP "\fB``1''\fR" 4
.IX Item "1"
Performs default SmartyPants transformations: quotes (including
``backticks'' \-style), em-dashes, and ellipses. \*(L"\-\-\*(R" (dash dash) is used
to signify an em-dash; there is no support for en-dashes.
.ie n .IP "\fB""2""\fR" 4
.el .IP "\fB``2''\fR" 4
.IX Item "2"
Same as smarty_pants=\*(L"1\*(R", except that it uses the old-school typewriter
shorthand for dashes:  \*(L"\-\-\*(R" (dash dash) for en-dashes, \*(L"\-\-\-\*(R" (dash dash dash)
for em-dashes.
.ie n .IP "\fB""3""\fR" 4
.el .IP "\fB``3''\fR" 4
.IX Item "3"
Same as smarty_pants=\*(L"2\*(R", but inverts the shorthand for dashes:  \*(L"\-\-\*(R"
(dash dash) for em-dashes, and \*(L"\-\-\-\*(R" (dash dash dash) for en-dashes.
.ie n .IP "\fB""\-1""\fR" 4
.el .IP "\fB``\-1''\fR" 4
.IX Item "-1"
Stupefy mode. Reverses the SmartyPants transformation process, turning the
\&\s-1HTML\s0 entities produced by SmartyPants into their \s-1ASCII\s0 equivalents. E.g.
\&\*(L"&#8220;\*(R" is turned into a simple double-quote (\*(L"), \*(R"&#8212;\*(L" is turned
into two dashes, etc. This is useful if you are using SmartyPants from
Brad Choate's MT-Textile text filter, but wish to suppress smart
punctuation in specific \s-1MT\s0 templates, such as \s-1RSS\s0 feeds. Text filters do
their work before templates are processed; but you can use
smarty_pants=\*(R"\-1" to reverse the transformations in specific templates.
.PP
The following single-character attribute values can be combined to toggle
individual transformations from within the smarty_pants attribute. For
example, to educate normal quotes and em-dashes, but not ellipses or
``backticks'' \-style quotes:
.PP
.Vb 1
\&    <$MTFoo smarty_pants="qd"$>
.Ve
.ie n .IP "\fB""q""\fR" 4
.el .IP "\fB``q''\fR" 4
.IX Item "q"
Educates normal quote characters: (") and (').
.ie n .IP "\fB""b""\fR" 4
.el .IP "\fB``b''\fR" 4
.IX Item "b"
Educates ``backticks'' \-style double quotes.
.ie n .IP "\fB""B""\fR" 4
.el .IP "\fB``B''\fR" 4
.IX Item "B"
Educates ``backticks'' \-style double quotes and `single' quotes.
.ie n .IP "\fB""d""\fR" 4
.el .IP "\fB``d''\fR" 4
.IX Item "d"
Educates em-dashes.
.ie n .IP "\fB""D""\fR" 4
.el .IP "\fB``D''\fR" 4
.IX Item "D"
Educates em-dashes and en-dashes, using old-school typewriter shorthand:
(dash dash) for en-dashes, (dash dash dash) for em-dashes.
.ie n .IP "\fB""i""\fR" 4
.el .IP "\fB``i''\fR" 4
.IX Item "i"
Educates em-dashes and en-dashes, using inverted old-school typewriter
shorthand: (dash dash) for em-dashes, (dash dash dash) for en-dashes.
.ie n .IP "\fB""e""\fR" 4
.el .IP "\fB``e''\fR" 4
.IX Item "e"
Educates ellipses.
.ie n .IP "\fB""w""\fR" 4
.el .IP "\fB``w''\fR" 4
.IX Item "w"
Translates any instance of \f(CW\*(C`&quot;\*(C'\fR into a normal double-quote character.
This should be of no interest to most people, but of particular interest
to anyone who writes their posts using Dreamweaver, as Dreamweaver
inexplicably uses this entity to represent a literal double-quote
character. SmartyPants only educates normal quotes, not entities (because
ordinarily, entities are used for the explicit purpose of representing the
specific character they represent). The \*(L"w\*(R" option must be used in
conjunction with one (or both) of the other quote options (\*(L"q\*(R" or \*(L"b\*(R").
Thus, if you wish to apply all SmartyPants transformations (quotes, en\-
and em-dashes, and ellipses) and also translate \f(CW\*(C`&quot;\*(C'\fR entities into
regular quotes so SmartyPants can educate them, you should pass the
following to the smarty_pants attribute:
.Sp
.Vb 1
\&    <$MTFoo smarty_pants="qDew"$>
.Ve
.Sp
For Blosxom and BBEdit users, set:
.Sp
.Vb 1
\&    my $smartypants_attr = "qDew";
.Ve
.SS "Deprecated \s-1MT\s0 Attributes"
.IX Subsection "Deprecated MT Attributes"
The following Movable Type attributes are supported only for
compatibility with older versions of SmartyPants. They are obsoleted by
the \f(CW\*(C`smarty_pants\*(C'\fR attribute, which offers more control than these
individual attributes. If you're setting up SmartyPants for the first
time, you should use the \f(CW\*(C`SmartyPants\*(C'\fR attribute instead.
.PP
Blosxom and BBEdit users should simply ignore this section.
.PP
\fIsmart_quotes\fR
.IX Subsection "smart_quotes"
.PP
The smart_quotes attribute accepts the following values:
.ie n .IP "\fB""0""\fR" 4
.el .IP "\fB``0''\fR" 4
.IX Item "0"
Suppress all quote education. (Do nothing.)
.ie n .IP "\fB""1""\fR" 4
.el .IP "\fB``1''\fR" 4
.IX Item "1"
Default behavior. Educates normal quote characters: (") and (').
.ie n .IP "\fB""2""\fR" 4
.el .IP "\fB``2''\fR" 4
.IX Item "2"
Educate ``backticks'' \-style double quotes (in addition to educating
regular quotes). Transforms each instance of two consecutive backtick
characters (\f(CW\*(C`\`\`\*(C'\fR) into an opening double-quote, and each instance of two
consecutive apostrophes (\f(CW\*(Aq\*(Aq\fR) into a closing double-quote.
.PP
\fIsmart_dashes\fR
.IX Subsection "smart_dashes"
.PP
The smart_dashes attribute accepts the following values:
.ie n .IP "\fB""0""\fR" 4
.el .IP "\fB``0''\fR" 4
.IX Item "0"
Suppress dash education. (Do nothing.)
.ie n .IP "\fB""1""\fR" 4
.el .IP "\fB``1''\fR" 4
.IX Item "1"
Default behavior. Transforms each instance of \*(L"\-\-\*(R" (dash dash) into an
\&\s-1HTML\s0 entity-encoded em-dash.
.ie n .IP "\fB""2""\fR" 4
.el .IP "\fB``2''\fR" 4
.IX Item "2"
Educates both en\- and em-dashes, using the old-school typewriter
shorthand for dashes. Each instance of \*(L"\-\-\*(R" (dash dash) is turned into
an \s-1HTML\s0 entity-encoded en-dash; each instance of \*(L"\-\-\-\*(R" (dash dash dash)
is turned into an em-dash.
.ie n .IP "\fB""3""\fR" 4
.el .IP "\fB``3''\fR" 4
.IX Item "3"
Same as smart_dashes=\*(L"2\*(R", but inverts the shorthand, using \*(L"\-\-\*(R" (dash
dash) for em-dashes, and \*(L"\-\-\-\*(R" (dash dash dash) for en-dashes. Although
somewhat counterintuitive in that the longer shortcut is used for the
shorter dash, this syntax is backwards compatible with SmartyPants 1.0's
original syntax, which used (dash dash) for em-dashes.
.PP
\fIsmart_ellipses\fR
.IX Subsection "smart_ellipses"
.PP
The smart_ellipses attribute accepts the following values:
.ie n .IP "\fB""0""\fR" 4
.el .IP "\fB``0''\fR" 4
.IX Item "0"
Suppress ellipsis education. (Do nothing.)
.ie n .IP "\fB""1""\fR" 4
.el .IP "\fB``1''\fR" 4
.IX Item "1"
Default behavior. Transforms each instance of \*(L"...\*(R" (dot dot dot) into
an \s-1HTML\s0 entity-encoded ellipsis. If there are four consecutive dots,
SmartyPants assumes this means \*(L"full stop\*(R" followed by \*(L"ellipsis\*(R".
.SS "Version Info Tag"
.IX Subsection "Version Info Tag"
If you include this tag in a Movable Type template:
.PP
.Vb 1
\&    <$MTSmartyPantsVersion$>
.Ve
.PP
it will be replaced with a string representing the version number of the
installed version of SmartyPants, e.g. \*(L"1.2\*(R".
.SH "Caveats"
.IX Header "Caveats"
.SS "Why You Might Not Want to Use Smart Quotes in Your Weblog"
.IX Subsection "Why You Might Not Want to Use Smart Quotes in Your Weblog"
For one thing, you might not care.
.PP
Most normal, mentally stable individuals do not take notice of proper
typographic punctuation. Many design and typography nerds, however, break
out in a nasty rash when they encounter, say, a restaurant sign that uses
a straight apostrophe to spell \*(L"Joe's\*(R".
.PP
If you're the sort of person who just doesn't care, you might well want to
continue not caring. Using straight quotes \*(-- and sticking to the 7\-bit
\&\s-1ASCII\s0 character set in general \*(-- is certainly a simpler way to live.
.PP
Even if you \fIdo\fR care about accurate typography, you still might want to
think twice before educating the quote characters in your weblog. One side
effect of publishing curly quote \s-1HTML\s0 entities is that it makes your
weblog a bit harder for others to quote from using copy-and-paste. What
happens is that when someone copies text from your blog, the copied text
contains the 8\-bit curly quote characters (as well as the 8\-bit characters
for em-dashes and ellipses, if you use these options). These characters
are not standard across different text encoding methods, which is why they
need to be encoded as \s-1HTML\s0 entities.
.PP
People copying text from your weblog, however, may not notice that you're
using curly quotes, and they'll go ahead and paste the unencoded 8\-bit
characters copied from their browser into an email message or their own
weblog. When pasted as raw \*(L"smart quotes\*(R", these characters are likely to
get mangled beyond recognition.
.PP
That said, my own opinion is that any decent text editor or email client
makes it easy to stupefy smart quote characters into their 7\-bit
equivalents, and I don't consider it my problem if you're using an
indecent text editor or email client.
.SS "Algorithmic Shortcomings"
.IX Subsection "Algorithmic Shortcomings"
One situation in which quotes will get curled the wrong way is when
apostrophes are used at the start of leading contractions. For example:
.PP
.Vb 2
\&    the \*(Aq80s
\&    \*(AqTwas the night before Christmas.
.Ve
.PP
In both cases above, SmartyPants will turn the apostrophes into opening
single-quotes, when in fact they should be closing ones. I don't think
this problem can be solved in the general case \*(-- every word processor
I've tried gets this wrong as well. In such cases, it's best to use the
proper \s-1HTML\s0 entity for closing single-quotes (\f(CW\*(C`&#8217;\*(C'\fR) by hand.
.PP
(I should also note that my personal style is to abbreviate decades like
this:
.PP
.Vb 1
\&    the 80\*(Aqs
.Ve
.PP
so admittedly, I'm not all that interested in solving this problem.)
.SH "Bugs"
.IX Header "Bugs"
To file bug reports or feature requests (other than topics listed in the
Caveats section above) please send email to:
.PP
.Vb 1
\&    smartypants@daringfireball.net
.Ve
.PP
If the bug involves quotes being curled the wrong way, please send example
text to illustrate.
.SH "See Also"
.IX Header "See Also"
This plug-in effectively obsoletes the technique documented here:
.PP
.Vb 1
\&    http://daringfireball.net/2002/08/movable_type_smart_quote_devilry.html
.Ve
.PP
However, the above instructions may still be of interest if for some
reason you are still running an older version of Movable Type.
.SH "Version History"
.IX Header "Version History"
.Vb 1
\&    1.0: Wed Nov 13, 2002
\&
\&        Initial release.
\&
\&
\&    1.1: Wed Feb 5, 2003
\&
\&    +   The smart_dashes template attribute now offers an option to
\&        use "\-\-" for *en* dashes, and "\-\-\-" for *em* dashes.
\&
\&    +   The default smart_dashes behavior now simply translates "\-\-"
\&        (dash dash) into an em\-dash. Previously, it would look for
\&        " \-\- " (space dash dash space), which was dumb, since many
\&        people do not use spaces around their em dashes.
\&
\&    +   Using the smarty_pants attribute with a value of "2" will
\&        do the same thing as smarty_pants="1", with one difference:
\&        it will use the new shortcuts for en\- and em\-dashes.
\&
\&    +   Closing quotes (single and double) were incorrectly curled in
\&        situations like this:
\&            "<a>foo</a>",
\&        where the comma could be just about any punctuation character.
\&        Fixed.
\&
\&    +   Added <kbd> to the list of tags in which text shouldn\*(Aqt be
\&        educated.
\&
\&
\&    1.2: Thu Feb 27, 2003
\&
\&    +   SmartyPants is now a combination plug\-in, supporting both
\&        Movable Type (2.5 or later) and Blosxom (2.0 or later).
\&        It also works as a BBEdit text filter and standalone
\&        command\-line Perl program. Thanks to Rael Dornfest for the
\&        initial Blosxom port (and for the excellent Blosxom plug\-in
\&        API).
\&
\&    +   SmartyPants now accepts the following backslash escapes,
\&        to force non\-smart punctuation. It does so by transforming
\&        the escape sequence into a decimal\-encoded HTML entity: 
\&
\&              Escape  Value  Character
\&              \-\-\-\-\-\-  \-\-\-\-\-  \-\-\-\-\-\-\-\-\-
\&                \e\e    &#92;    \e
\&                \e"    &#34;    "
\&                \e\*(Aq    &#39;    \*(Aq
\&                \e.    &#46;    .
\&                \e\-    &#45;    \-
\&                \e\`    &#96;    \`
\&
\&        Note that this could produce different results than previous
\&        versions of SmartyPants, if for some reason you have an article
\&        containing one or more of these sequences. (Thanks to Charles
\&        Wiltgen for the suggestion.)
\&
\&    +   Added a new option to support inverted en\- and em\-dash notation:
\&        "\-\-" for em\-dashes, "\-\-\-" for en\-dashes. This is compatible with
\&        SmartyPants\*(Aq original "\-\-" syntax for em\-dashes, but also allows
\&        you to specify en\-dashes. It can be invoked by using
\&        smart_dashes="3", smarty_pants="3", or smarty_pants="i". 
\&        (Suggested by Aaron Swartz.)
\&
\&    +   Added a new option to automatically convert &quot; entities into
\&        regular double\-quotes before sending text to EducateQuotes() for
\&        processing. This is mainly for the benefit of people who write
\&        posts using Dreamweaver, which substitutes this entity for any
\&        literal quote char. The one and only way to invoke this option
\&        is to use the letter shortcuts for the smarty_pants attribute;
\&        the shortcut for this option is "w" (for Dream_w_eaver).
\&        (Suggested by Jonathon Delacour.)
\&
\&    +   Added <script> to the list of tags in which SmartyPants doesn\*(Aqt
\&        touch the contents.
\&
\&    +   Fixed a very subtle bug that would occur if a quote was the very
\&        last character in a body of text, preceded immediately by a tag.
\&        Lacking any context, previous versions of SmartyPants would turn
\&        this into an opening quote mark. It\*(Aqs now correctly turned into
\&        a closing one.
\&
\&    +   Opening quotes were being curled the wrong way when the
\&        subsequent character was punctuation. E.g.: "a \*(Aq.foo\*(Aq file".
\&        Fixed.
\&
\&    +   New MT global template tag: <$MTSmartyPantsVersion$>
\&        Prints the version number of SmartyPants, e.g. "1.2".
\&
\&
\&    1.2.1: Mon Mar 10, 2003
\&
\&    +   New "stupefy mode" for smarty_pants attribute. If you set
\&
\&            smarty_pants="\-1"
\&
\&        SmartyPants will perform reverse transformations, turning HTML
\&        entities into plain ASCII equivalents. E.g. "&#8220;" is turned
\&        into a simple double\-quote ("), "&#8212;" is turned into two
\&        dashes, etc. This is useful if you are using SmartyPants from Brad
\&        Choate\*(Aqs MT\-Textile text filter, but wish to suppress smart
\&        punctuation in specific MT templates, such as RSS feeds. Text
\&        filters do their work before templates are processed; but you can
\&        use smarty_pants="\-1" to reverse the transformations in specific
\&        templates.
\&
\&    +   Replaced the POSIX\-style regex character class [:punct:] with an
\&        ugly hard\-coded normal character class of all punctuation; POSIX
\&        classes require Perl 5.6 or later, but SmartyPants still supports
\&        back to 5.005.
\&
\&    +   Several small changes to allow SmartyPants to work when Blosxom
\&        is running in static mode.
\&
\&
\&    1.2.2: Thu Mar 13, 2003
\&
\&    +   1.2.1 contained a boneheaded addition which prevented SmartyPants
\&        from compiling under Perl 5.005. This has been remedied, and is
\&        the only change from 1.2.1.
\&
\&
\&    1.3: Tue 13 May 2003
\&
\&    +   Plugged the biggest hole in SmartyPants\*(Aqs smart quotes algorithm.
\&        Previous versions were hopelessly confused by single\-character
\&        quote tokens, such as:
\&
\&            <p>"<i>Tricky!</i>"</p>
\&
\&        The problem was that the EducateQuotes() function works on each
\&        token separately, with no means of getting surrounding context
\&        from the previous or next tokens. The solution is to curl these
\&        single\-character quote tokens as a special case, *before* calling
\&        EducateQuotes().
\&
\&    +   New single\-quotes backtick mode for smarty_pants attribute.
\&        The only way to turn it on is to include "B" in the configuration
\&        string, e.g. to translate backtick quotes, dashes, and ellipses:
\&
\&            smarty_pants="Bde"
\&
\&    +   Fixed a bug where an opening quote would get curled the wrong way
\&        if the quote started with three dots, e.g.:
\&
\&            <p>"...meanwhile"</p>
\&
\&    +   Fixed a bug where opening quotes would get curled the wrong way
\&        if there were double sets of quotes within each other, e.g.:
\&
\&            <p>"\*(AqSome\*(Aq people."</p>
\&
\&    +   Due to popular demand, four consecutive dots (....) will now be
\&        turned into an ellipsis followed by a period. Previous versions
\&        would turn this into a period followed by an ellipsis. If you
\&        really want a period\-then\-ellipsis sequence, escape the first
\&        period with a backslash: \e....
\&
\&    +   Removed "&" from our home\-grown punctuation class, since it
\&        denotes an entity, not a literal ampersand punctuation
\&        character. This fixes a bug where SmartyPants would mis\-curl
\&        the opening quote in something like this:
\&
\&            "&#8230;whatever"
\&
\&    +   SmartyPants has always had a special case where it looks for
\&        "\*(Aqs" in situations like this:
\&
\&            <i>Custer</i>\*(Aqs Last Stand
\&
\&        This special case is now case\-insensitive.
.Ve
.SH "Author"
.IX Header "Author"
.Vb 2
\&    John Gruber
\&    http://daringfireball.net
.Ve
.SH "Additional Credits"
.IX Header "Additional Credits"
Portions of this plug-in are based on Brad Choate's nifty MTRegex plug-in.
Brad Choate also contributed a few bits of source code to this plug-in.
Brad Choate is a fine hacker indeed. (http://bradchoate.com/)
.PP
Jeremy Hedley (http://antipixel.com/) and Charles Wiltgen
(http://playbacktime.com/) deserve mention for exemplary beta testing.
.PP
Rael Dornfest (http://raelity.org/) ported SmartyPants to Blosxom.
.SH "Copyright and License"
.IX Header "Copyright and License"
.Vb 3
\&    Copyright (c) 2003 John Gruber
\&    (http://daringfireball.net/)
\&    All rights reserved.
.Ve
.PP
Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions are met:
.PP
*   Redistributions of source code must retain the above copyright
    notice, this list of conditions and the following disclaimer.
.PP
*   Redistributions in binary form must reproduce the above copyright
    notice, this list of conditions and the following disclaimer in the
    documentation and/or other materials provided with the distribution.
.PP
*   Neither the name \*(L"SmartyPants\*(R" nor the names of its contributors may
    be used to endorse or promote products derived from this software
    without specific prior written permission.
.PP
This software is provided by the copyright holders and contributors \*(L"as is\*(R"
and any express or implied warranties, including, but not limited to, the 
implied warranties of merchantability and fitness for a particular purpose 
are disclaimed. In no event shall the copyright owner or contributors be 
liable for any direct, indirect, incidental, special, exemplary, or 
consequential damages (including, but not limited to, procurement of 
substitute goods or services; loss of use, data, or profits; or business 
interruption) however caused and on any theory of liability, whether in 
contract, strict liability, or tort (including negligence or otherwise) 
arising in any way out of the use of this software, even if advised of the
possibility of such damage.