kramdown-man 0.1.4 → 0.1.5

data/ChangeLog.md

@@ -1,3 +1,13 @@
+### 0.1.5 / 2013-05-19
+
+* Translate unicode symbols into roff glyphs.
+* Convert typographic symbols and smart quotes into glyphs.
+* Simplify `\fB\fC` as `\fC` (Colin Watson).
+* Use `\fB` for codespans (Colin Watson).
+* Escape `--` as `\-\-` (Colin Watson).
+* Escape `\` as `\e` (Colin Watson).
+* Emit `.TP` or `.HP` if the paragraph begins with a strong element.
+
 ### 0.1.4 / 2013-05-05
 
 * Improve detection of tagged paragraphs.

data/lib/kramdown/converter/man.rb

@@ -13,28 +13,394 @@ module Kramdown
       # Comment header
       HEADER = [
         ".\\\" Generated by kramdown-man #{::Kramdown::Man::VERSION}",
-        ".\\\" https://github.com/postmodern/kramdown-roff#readme"
+        ".\\\" https://github.com/postmodern/kramdown-man#readme"
       ].join("\n")
 
       # Typographic Symbols and their UTF8 chars
       TYPOGRAPHIC_SYMS = {
-        :ndash       => "--",
-        :mdash       => "—",
-        :hellip      => "…",
-        :laquo       => "«",
-        :raquo       => "»",
-        :laquo_space => "«",
-        :raquo_space => "»"
+        :ndash       => '\-\-',
+        :mdash       => '\[em]',
+        :hellip      => '...',
+        :laquo       => '\[Fo]',
+        :raquo       => '\[Fc]',
+        :laquo_space => '\[Fo]',
+        :raquo_space => '\[Fc]'
       }
 
       # Smart Quotes and their UTF8 chars
       SMART_QUOTES = {
-        :lsquo => "‘",
-        :rsquo => "’",
-        :ldquo => "“",
-        :rdquo => "”"
+        :lsquo => '\[oq]',
+        :rsquo => '\[cq]',
+        :ldquo => '\[lq]',
+        :rdquo => '\[rq]'
       }
 
+      GLYPHS = {
+        'Ð' => '\[-D]',
+        'ð' => '\[Sd]',
+        'Þ' => '\[TP]',
+        'þ' => '\[Tp]',
+        'ß' => '\[ss]',
+        # Ligatures and Other Latin Glyphs
+        'ff' => '\[ff]',
+        'fi' => '\[fi]',
+        'fl' => '\[fl]',
+        'ffi' => '\[Fi]',
+        'ffl' => '\[Fl]',
+        'Ł' => '\[/L]',
+        'ł' => '\[/l]',
+        'Ø' => '\[/O]',
+        'ø' => '\[/o]',
+        'Æ' => '\[AE]',
+        'æ' => '\[ae]',
+        'Œ' => '\[OE]',
+        'œ' => '\[oe]',
+        'IJ' => '\[IJ]',
+        'ij' => '\[ij]',
+        'ı' => '\[.i]',
+        'ȷ' => '\[.j]',
+        # Accented Characters
+        'Á' => '\[\'A]',
+        'Ć' => '\[\'C]',
+        'É' => '\[\'E]',
+        'Í' => '\[\'I]',
+        'Ó' => '\[\'O]',
+        'Ú' => '\[\'U]',
+        'Ý' => '\[\'Y]',
+        'á' => '\[\'a]',
+        'ć' => '\[\'c]',
+        'é' => '\[\'e]',
+        'í' => '\[\'i]',
+        'ó' => '\[\'o]',
+        'ú' => '\[\'u]',
+        'ý' => '\[\'y]',
+        'Ä' => '\[:A]',
+        'Ë' => '\[:E]',
+        'Ï' => '\[:I]',
+        'Ö' => '\[:O]',
+        'Ü' => '\[:U]',
+        'Ÿ' => '\[:Y]',
+        'ä' => '\[:a]',
+        'ë' => '\[:e]',
+        'ï' => '\[:i]',
+        'ö' => '\[:o]',
+        'ü' => '\[:u]',
+        'ÿ' => '\[:y]',
+        'Â' => '\[^A]',
+        'Ê' => '\[^E]',
+        'Î' => '\[^I]',
+        'Ô' => '\[^O]',
+        'Û' => '\[^U]',
+        'â' => '\[^a]',
+        'ê' => '\[^e]',
+        'î' => '\[^i]',
+        'ô' => '\[^o]',
+        'û' => '\[^u]',
+        'À' => '\[`A]',
+        'È' => '\[`E]',
+        'Ì' => '\[`I]',
+        'Ò' => '\[`O]',
+        'Ù' => '\[`U]',
+        'à' => '\[`a]',
+        'è' => '\[`e]',
+        'ì' => '\[`i]',
+        'ò' => '\[`o]',
+        'ù' => '\[`u]',
+        'Ã' => '\[~A]',
+        'Ñ' => '\[~N]',
+        'Õ' => '\[~O]',
+        'ã' => '\[~a]',
+        'ñ' => '\[~n]',
+        'õ' => '\[~o]',
+        'Š' => '\[vS]',
+        'š' => '\[vs]',
+        'Ž' => '\[vZ]',
+        'ž' => '\[vz]',
+        'Ç' => '\[,C]',
+        'ç' => '\[,c]',
+        'Å' => '\[oA]',
+        'å' => '\[oa]',
+        # Accents
+        '˝' => '\[a"]',
+        '¯' => '\[a-]',
+        '˙' => '\[a.]',
+        '^' => '\[a^]',
+        '´' => "\\´",
+        '`' => '\`',
+        '˘' => '\[ab]',
+        '¸' => '\[ac]',
+        '¨' => '\[ad]',
+        'ˇ' => '\[ah]',
+        '˚' => '\[ao]',
+        '~' => '\(ti',
+        '˛' => '\[ho]',
+        '^' => '\(ha',
+        '~' => '\[ti]',
+        # Quotes
+        '„' => '\[Bq]',
+        '‚' => '\[bq]',
+        '“' => '\[lq]',
+        '”' => '\[rq]',
+        '‘' => '\[oq]',
+        '’' => '\[cq]',
+        "'" => '\(aq',
+        '"' => '\[dq]',
+        '«' => '\[Fo]',
+        '»' => '\[Fc]',
+        '‹' => '\[fo]',
+        '›' => '\[fc]',
+        # Punctuation
+        '.' => '\.',
+        '¡' => '\[r!]',
+        '¿' => '\[r?]',
+        '—' => '\[em]',
+        '–' => '\[en]',
+        '‐' => '\[hy]',
+        # Brackets
+        '[' => '\[lB]',
+        ']' => '\[rB]',
+        '{' => '\[lC]',
+        '}' => '\[rC]',
+        '⟨' => '\[la]',
+        '⟩' => '\[ra]',
+        '⎪' => '\[bv]',
+        '⎪' => '\[braceex]',
+        '⎡' => '\[bracketlefttp]',
+        '⎣' => '\[bracketleftbt]',
+        '⎢' => '\[bracketleftex]',
+        '⎤' => '\[bracketrighttp]',
+        '⎦' => '\[bracketrightbt]',
+        '⎥' => '\[bracketrightex]',
+        '╭' => '\[lt]',
+        '⎧' => '\[bracelefttp]',
+        '┥' => '\[lk]',
+        '⎨' => '\[braceleftmid]',
+        '╰' => '\[lb]',
+        '⎩' => '\[braceleftbt]',
+        '⎪' => '\[braceleftex]',
+        '╮' => '\[rt]',
+        '⎫' => '\[bracerighttp]',
+        '┝' => '\[rk]',
+        '⎬' => '\[bracerightmid]',
+        '╯' => '\[rb]',
+        '⎭' => '\[bracerightbt]',
+        '⎪' => '\[bracerightex]',
+        '⎛' => '\[parenlefttp]',
+        '⎝' => '\[parenleftbt]',
+        '⎜' => '\[parenleftex]',
+        '⎞' => '\[parenrighttp]',
+        '⎠' => '\[parenrightbt]',
+        '⎟' => '\[parenrightex]',
+        # Arrows
+        '←' => '\[<-]',
+        '→' => '\[->]',
+        '↔' => '\[<>]',
+        '↓' => '\[da]',
+        '↑' => '\[ua]',
+        '↕' => '\[va]',
+        '⇐' => '\[lA]',
+        '⇒' => '\[rA]',
+        '⇔' => '\[hA]',
+        '⇓' => '\[dA]',
+        '⇑' => '\[uA]',
+        '⇕' => '\[vA]',
+        '⎯' => '\[an]',
+        # Lines
+        '|' => '\[ba]',
+        '│' => '\[br]',
+        '_' => '\[ul]',
+        '‾' => '\[rn]',
+        '_' => '\[ru]',
+        '¦' => '\[bb]',
+        '/' => '\[sl]',
+        '\\' => '\e',
+        # Text markers
+        '○' => '\[ci]',
+        '·' => '\[bu]',
+        '‡' => '\[dd]',
+        '†' => '\[dg]',
+        '◊' => '\[lz]',
+        '□' => '\[sq]',
+        '¶' => '\[ps]',
+        '§' => '\[sc]',
+        '☜' => '\[lh]',
+        '☞' => '\[rh]',
+        '@' => '\[at]',
+        '#' => '\[sh]',
+        '↵' => '\[CR]',
+        '✓' => '\[OK]',
+        # Legal Symbols
+        '©' => '\[co]',
+        '®' => '\[rg]',
+        '™' => '\[tm]',
+        # Currency symbols
+        '$' => '\[Do]',
+        '¢' => '\[ct]',
+        '€' => '\[eu]',
+        '€' => '\[Eu]',
+        '¥' => '\[Ye]',
+        '£' => '\[Po]',
+        '¤' => '\[Cs]',
+        'ƒ' => '\[Fn]',
+        # Units
+        '°' => '\[de]',
+        '‰' => '\[%0]',
+        '′' => '\[fm]',
+        '″' => '\[sd]',
+        'µ' => '\[mc]',
+        'ª' => '\[Of]',
+        'º' => '\[Om]',
+        # Logical Symbols
+        '∧' => '\[AN]',
+        '∨' => '\[OR]',
+        '¬' => '\[no]',
+        '¬' => '\[tno]',
+        '∃' => '\[te]',
+        '∀' => '\[fa]',
+        '∋' => '\[st]',
+        '∴' => '\[3d]',
+        '∴' => '\[tf]',
+        '|' => '\[or]',
+        # Mathematical Symbols
+        '½' => '\[12]',
+        '¼' => '\[14]',
+        '¾' => '\[34]',
+        '⅛' => '\[18]',
+        '⅜' => '\[38]',
+        '⅝' => '\[58]',
+        '⅞' => '\[78]',
+        '¹' => '\[S1]',
+        '²' => '\[S2]',
+        '³' => '\[S3]',
+        '+' => '\[pl]',
+        '-' => '\-',
+        '−' => '\[mi]',
+        '∓' => '\[-+]',
+        '±' => '\[+-]',
+        '±' => '\[t+-]',
+        '·' => '\[pc]',
+        '⋅' => '\[md]',
+        '×' => '\[mu]',
+        '×' => '\[tmu]',
+        '⊗' => '\[c*]',
+        '⊕' => '\[c+]',
+        '÷' => '\[di]',
+        '÷' => '\[tdi]',
+        '⁄' => '\[f/]',
+        '∗' => '\[**]',
+        '≤' => '\[<=]',
+        '≥' => '\[>=]',
+        '≪' => '\[<<]',
+        '≫' => '\[>>]',
+        '=' => '\[eq]',
+        '≠' => '\[!=]',
+        '≡' => '\[==]',
+        '≢' => '\[ne]',
+        '≅' => '\[=~]',
+        '≃' => '\[|=]',
+        '∼' => '\[ap]',
+        '≈' => '\[~~]',
+        '≈' => '\[~=]',
+        '∝' => '\[pt]',
+        '∅' => '\[es]',
+        '∈' => '\[mo]',
+        '∉' => '\[nm]',
+        '⊂' => '\[sb]',
+        '⊄' => '\[nb]',
+        '⊃' => '\[sp]',
+        '⊅' => '\[nc]',
+        '⊆' => '\[ib]',
+        '⊇' => '\[ip]',
+        '∩' => '\[ca]',
+        '∪' => '\[cu]',
+        '∠' => '\[/_]',
+        '⊥' => '\[pp]',
+        '∫' => '\[is]',
+        '∫' => '\[integral]',
+        '∑' => '\[sum]',
+        '∏' => '\[product]',
+        '∐' => '\[coproduct]',
+        '∇' => '\[gr]',
+        '√' => '\[sr]',
+        '√' => '\[sqrt]',
+        '⌈' => '\[lc]',
+        '⌉' => '\[rc]',
+        '⌊' => '\[lf]',
+        '⌋' => '\[rf]',
+        '∞' => '\[if]',
+        'ℵ' => '\[Ah]',
+        'ℑ' => '\[Im]',
+        'ℜ' => '\[Re]',
+        '℘' => '\[wp]',
+        '∂' => '\[pd]',
+        'ℏ' => '\[-h]',
+        'ℏ' => '\[hbar]',
+        # Greek glyphs
+        'Α' => '\[*A]',
+        'Β' => '\[*B]',
+        'Γ' => '\[*G]',
+        'Δ' => '\[*D]',
+        'Ε' => '\[*E]',
+        'Ζ' => '\[*Z]',
+        'Η' => '\[*Y]',
+        'Θ' => '\[*H]',
+        'Ι' => '\[*I]',
+        'Κ' => '\[*K]',
+        'Λ' => '\[*L]',
+        'Μ' => '\[*M]',
+        'Ν' => '\[*N]',
+        'Ξ' => '\[*C]',
+        'Ο' => '\[*O]',
+        'Π' => '\[*P]',
+        'Ρ' => '\[*R]',
+        'Σ' => '\[*S]',
+        'Τ' => '\[*T]',
+        'Υ' => '\[*U]',
+        'Φ' => '\[*F]',
+        'Χ' => '\[*X]',
+        'Ψ' => '\[*Q]',
+        'Ω' => '\[*W]',
+        'α' => '\[*a]',
+        'β' => '\[*b]',
+        'γ' => '\[*g]',
+        'δ' => '\[*d]',
+        'ε' => '\[*e]',
+        'ζ' => '\[*z]',
+        'η' => '\[*y]',
+        'θ' => '\[*h]',
+        'ι' => '\[*i]',
+        'κ' => '\[*k]',
+        'λ' => '\[*l]',
+        'μ' => '\[*m]',
+        'ν' => '\[*n]',
+        'ξ' => '\[*c]',
+        'ο' => '\[*o]',
+        'π' => '\[*p]',
+        'ρ' => '\[*r]',
+        'ς' => '\[ts]',
+        'σ' => '\[*s]',
+        'τ' => '\[*t]',
+        'υ' => '\[*u]',
+        'ϕ' => '\[*f]',
+        'χ' => '\[*x]',
+        'ψ' => '\[*q]',
+        'ω' => '\[*w]',
+        'ϑ' => '\[+h]',
+        'φ' => '\[+f]',
+        'ϖ' => '\[+p]',
+        'ϵ' => '\[+e]',
+        # Card symbols
+        '♣' => '\[CL]',
+        '♠' => '\[SP]',
+        '♥' => '\[HE]',
+        '♡' => '\[u2661]',
+        '♦' => '\[DI]',
+        '♢' => '\[u2662]'
+      }
+
+      # Regular expression to convert unicode characters into glyphs
+      GLYPH_REGEXP = Regexp.union(GLYPHS.keys)
+
       #
       # Initializes the converter.
       #
@@ -324,8 +690,9 @@ module Kramdown
       def convert_p(p)
         children = p.children
 
-        if (children.length >= 2) &&
-           (children.first.type == :em || children.first.type == :codespan)
+        if ((children.length >= 2) && (children.first.type == :codespan ||
+                                       children.first.type == :em       ||
+                                       children.first.type == :strong))
           newline = children.find_index { |el|
             el.type == :text && el.value.start_with?("\n")
           }
@@ -379,7 +746,7 @@ module Kramdown
       #   The roff output.
       #
       def convert_codespan(codespan)
-        "\\fB\\fC#{codespan.value}\\fR"
+        "\\fB#{codespan.value}\\fR"
       end
 
       #
@@ -392,7 +759,7 @@ module Kramdown
       #   The roff output.
       #
       def convert_a(a)
-        href = a.attr['href']
+        href = escape(a.attr['href'])
         text = convert_children(a.children)
 
         case href
@@ -436,7 +803,7 @@ module Kramdown
       #   The escaped text.
       #
       def escape(text)
-        text.gsub('\\','\&\&').gsub('-','\\-')
+        text.gsub(GLYPH_REGEXP) { |char| GLYPHS[char] }
       end
 
     end

data/lib/kramdown/man/version.rb

@@ -1,6 +1,6 @@
 module Kramdown
   module Man
     # kramdown-man version
-    VERSION = "0.1.4"
+    VERSION = "0.1.5"
   end
 end

data/man/kramdown-man.1

@@ -1,23 +1,23 @@
 .\" Generated by kramdown-man 0.1.4
-.\" https://github.com/postmodern/kramdown-roff#readme
+.\" https://github.com/postmodern/kramdown-man#readme
 .TH kramdown-man.1 "April 2013" kramdown-man "User Manuals"
 .LP
 .SH DESCRIPTION
 .LP
 .PP
 A Kramdown
-.UR http://kramdown.rubyforge.org/
-.UE convert for converting Markdown files into man pages.
+.UR http:\[sl]\[sl]kramdown\.rubyforge\.org\[sl]
+.UE plugin for converting Markdown files into man pages\.
 .LP
 .SH EXAMPLE
 .LP
 .nf
-require 'kramdown'
-require 'kramdown/man'
+require \(aqkramdown\(aq
+require \(aqkramdown\[sl]man\(aq
 
-doc = Kramdown::Document.new(File.read('man/kramdown\-man.1.md'))
-File.write('man/kramdown\-man.1',doc.to_man)
-system 'man', 'man/kramdown\-man.1'
+doc \[eq] Kramdown::Document\.new(File\.read(\(aqman\[sl]kramdown\-man\.1\.md\(aq))
+File\.write(\(aqman\[sl]kramdown\-man\.1\(aq,doc\.to\[ru]man)
+system \(aqman\(aq, \(aqman\[sl]kramdown\-man\.1\(aq
 .fi
 .LP
 .SH SYNTAX
@@ -25,11 +25,11 @@ system 'man', 'man/kramdown\-man.1'
 .SS FORMATTING
 .LP
 .nf
-`code`
+\`code\`
 .fi
 .LP
 .PP
-\fB\fCcode\fR
+\fBcode\fR
 .LP
 .nf
 *emphasis*
@@ -48,53 +48,53 @@ system 'man', 'man/kramdown\-man.1'
 .SS PARAGRAPHS
 .LP
 .nf
-Normal paragraph.
+Normal paragraph\.
 .fi
 .LP
 .PP
-Normal paragraph.
+Normal paragraph\.
 .LP
 .nf
-`command` [`\-\-foo`] *FILE*
+\`command\` \[lB]\`\-\-foo\`\[rB] *FILE*
 .fi
 .LP
 .HP
-\fB\fCcommand\fR [\fB\fC--foo\fR] \fIFILE\fP
+\fBcommand\fR \[lB]\fB--foo\fR\[rB] \fIFILE\fP
 .LP
 .nf
-`\-\-tagged`
-  Text here.
+\`\-\-tagged\`
+  Text here\.
 .fi
 .LP
 .TP
-\fB\fC--tagged\fR
-Text here.
+\fB--tagged\fR
+Text here\.
 .LP
 .SS LINKS
 .LP
 .nf
-[website](http://example.com/)
+\[lB]website\[rB](http:\[sl]\[sl]example\.com\[sl])
 .fi
 .LP
 .PP
 website
-.UR http://example.com/
+.UR http:\[sl]\[sl]example\.com\[sl]
 .UE
 .LP
 .nf
-[bash](man:bash(1))
+\[lB]bash\[rB](man:bash(1))
 .fi
 .LP
 .PP
 .BR bash (1)
 .LP
 .nf
-Email <bob@example.com>
+Email <bob\[at]example\.com>
 .fi
 .LP
 .PP
 Email 
-.MT bob@example.com
+.MT bob\[at]example\.com
 .ME
 .LP
 .SS LISTS
@@ -142,42 +142,42 @@ extra paragraph
 .SS BLOCKQUOTES
 .LP
 .nf
-> Perfection is achieved, not when there is nothing more to add, but when there is nothing left to take away.
+> Perfection is achieved, not when there is nothing more to add, but when there is nothing left to take away\.
 >
-> \-\-Antoine de Saint\-Exupéry
+> \-\-Antoine de Saint\-Exup\['e]ry
 .fi
 .LP
 .PP
 .RS
-Perfection is achieved, not when there is nothing more to add, but when there is nothing left to take away.
+Perfection is achieved, not when there is nothing more to add, but when there is nothing left to take away\.
 .LP
---Antoine de Saint\-Exupéry
+\-\-Antoine de Saint\-Exup\['e]ry
 .RE
 .LP
 .SS CODE BLOCKS
 .LP
 .nf
-    #include <stdio.h>
+    \[sh]include <stdio\.h>
 
     int main()
-    {
-	    printf("hello world\\n");
+    \[lC]
+	    printf(\[dq]hello world\en\[dq]);
 	    return 0;
-    }
+    \[rC]
 
-#include <stdio.h>
+\[sh]include <stdio\.h>
 
 int main()
-{
-    printf("hello world\\n");
+\[lC]
+    printf(\[dq]hello world\en\[dq]);
     return 0;
-}
+\[rC]
 .fi
 .LP
 .SH AUTHOR
 .LP
 .PP
 Postmodern 
-.MT postmodern.mod3@gmail.com
+.MT postmodern\.mod3\[at]gmail\.com
 .ME
 .LP

data/man/kramdown-man.1.md

@@ -2,7 +2,7 @@
 
 ## DESCRIPTION
 
-A [Kramdown][kramdown] convert for converting Markdown files into man pages.
+A [Kramdown][kramdown] plugin for converting Markdown files into man pages.
 
 ## EXAMPLE
 

data/spec/kramdown/converter/man_spec.rb

@@ -25,7 +25,7 @@ Hello world.
         ".TH Header",
         ".LP",
         ".PP",
-        "Hello world."
+        'Hello world\.'
       ].join("\n")
     end
   end
@@ -46,7 +46,7 @@ Hello world.
         ".TH Header",
         ".LP",
         ".PP",
-        "Hello world."
+        'Hello world\.'
       ].join("\n")
     end
   end
@@ -100,8 +100,8 @@ Hello world.
       let(:doc) { Kramdown::Document.new("-- foo")     }
       let(:sym) { doc.root.children[0].children[0] }
 
-      it "should convert ndash symbols back into '--'" do
-        subject.convert_typographic_sym(sym).should == '--'
+      it "should convert ndash symbols back into '\-\-'" do
+        subject.convert_typographic_sym(sym).should == "\\-\\-"
       end
     end
 
@@ -109,8 +109,8 @@ Hello world.
       let(:doc) { Kramdown::Document.new("--- foo") }
       let(:sym) { doc.root.children[0].children[0]  }
 
-      it "should convert mdash symbols into '—'" do
-        subject.convert_typographic_sym(sym).should == '—'
+      it "should convert mdash symbols into '\[em]'" do
+        subject.convert_typographic_sym(sym).should == '\[em]'
       end
     end
 
@@ -118,8 +118,8 @@ Hello world.
       let(:doc) { Kramdown::Document.new("... foo") }
       let(:sym) { doc.root.children[0].children[0]  }
 
-      it "should convert mdash symbols into '…'" do
-        subject.convert_typographic_sym(sym).should == '…'
+      it "should convert mdash symbols into '...'" do
+        subject.convert_typographic_sym(sym).should == '...'
       end
     end
 
@@ -127,8 +127,8 @@ Hello world.
       let(:doc) { Kramdown::Document.new("<< foo") }
       let(:sym) { doc.root.children[0].children[0]  }
 
-      it "should convert mdash symbols into '«'" do
-        subject.convert_typographic_sym(sym).should == '«'
+      it "should convert mdash symbols into '\[Fo]'" do
+        subject.convert_typographic_sym(sym).should == '\[Fo]'
       end
     end
 
@@ -136,8 +136,8 @@ Hello world.
       let(:doc) { Kramdown::Document.new("foo >> bar") }
       let(:sym) { doc.root.children[0].children[1]  }
 
-      it "should convert mdash symbols into '»'" do
-        subject.convert_typographic_sym(sym).should == '»'
+      it "should convert mdash symbols into '\[Fc]'" do
+        subject.convert_typographic_sym(sym).should == '\[Fc]'
       end
     end
 
@@ -145,8 +145,8 @@ Hello world.
       let(:doc) { Kramdown::Document.new(" << foo") }
       let(:sym) { doc.root.children[0].children[0]  }
 
-      it "should convert mdash symbols into '«'" do
-        subject.convert_typographic_sym(sym).should == '«'
+      it "should convert mdash symbols into '\[Fo]'" do
+        subject.convert_typographic_sym(sym).should == '\[Fo]'
       end
     end
 
@@ -154,8 +154,8 @@ Hello world.
       let(:doc) { Kramdown::Document.new("foo  >> bar") }
       let(:sym) { doc.root.children[0].children[1]  }
 
-      it "should convert mdash symbols into '»'" do
-        subject.convert_typographic_sym(sym).should == '»'
+      it "should convert mdash symbols into '\[Fc]'" do
+        subject.convert_typographic_sym(sym).should == '\[Fc]'
       end
     end
   end
@@ -165,8 +165,8 @@ Hello world.
       let(:doc)   { Kramdown::Document.new("'hello world'") }
       let(:quote) { doc.root.children[0].children.first }
 
-      it "should convert lsquo quotes into '‘'" do
-        subject.convert_smart_quote(quote).should == '‘'
+      it "should convert lsquo quotes into '\[oq]'" do
+        subject.convert_smart_quote(quote).should == '\[oq]'
       end
     end
 
@@ -174,8 +174,8 @@ Hello world.
       let(:doc)   { Kramdown::Document.new("'hello world'") }
       let(:quote) { doc.root.children[0].children.last }
 
-      it "should convert rsquo quotes into '’'" do
-        subject.convert_smart_quote(quote).should == '’'
+      it "should convert rsquo quotes into '\[cq]'" do
+        subject.convert_smart_quote(quote).should == '\[cq]'
       end
     end
 
@@ -183,8 +183,8 @@ Hello world.
       let(:doc)   { Kramdown::Document.new('"hello world"') }
       let(:quote) { doc.root.children[0].children.first }
 
-      it "should convert lsquo quotes into '“'" do
-        subject.convert_smart_quote(quote).should == '“'
+      it "should convert lsquo quotes into '\[lq]'" do
+        subject.convert_smart_quote(quote).should == '\[lq]'
       end
     end
 
@@ -192,8 +192,8 @@ Hello world.
       let(:doc)   { Kramdown::Document.new('"hello world"') }
       let(:quote) { doc.root.children[0].children.last }
 
-      it "should convert lsquo quotes into '”'" do
-        subject.convert_smart_quote(quote).should == '”'
+      it "should convert lsquo quotes into '\[rq]'" do
+        subject.convert_smart_quote(quote).should == '\[rq]'
       end
     end
   end
@@ -322,8 +322,6 @@ Hello world.
       let(:doc)   { Kramdown::Document.new("1. #{text1}\n\n   #{text2}") }
 
       it "should convert the other p elements to '.IP \\\\n\\n...'" do
-        p li
-
         subject.convert_ol_li(li).should == [
           ".IP \\n+[step0]",
           text1,
@@ -346,22 +344,24 @@ Hello world.
   end
 
   describe "#convert_blockquote" do
-    let(:text)       { "Some quote." }
-    let(:doc)        { Kramdown::Document.new("> #{text}") }
-    let(:blockquote) { doc.root.children[0] }
+    let(:text)         { "Some quote." }
+    let(:escaped_text) { 'Some quote\.' }
+    let(:doc)          { Kramdown::Document.new("> #{text}") }
+    let(:blockquote)   { doc.root.children[0] }
 
     it "should convert blockquote elements into '.PP\\n.RS\\ntext...\\n.RE'" do
-      subject.convert_blockquote(blockquote).should == ".PP\n.RS\n#{text}\n.RE"
+      subject.convert_blockquote(blockquote).should == ".PP\n.RS\n#{escaped_text}\n.RE"
     end
   end
 
   describe "#convert_codeblock" do
-    let(:code)      { "puts 'hello world'" }
-    let(:doc)       { Kramdown::Document.new("    #{code}\n") }
-    let(:codeblock) { doc.root.children[0] }
+    let(:code)         { "puts 'hello world'" }
+    let(:escaped_code) { 'puts \(aqhello world\(aq' }
+    let(:doc)          { Kramdown::Document.new("    #{code}\n") }
+    let(:codeblock)    { doc.root.children[0] }
 
     it "should convert codeblock elements into '.nf\\ntext...\\n.fi'" do
-      subject.convert_codeblock(codeblock).should == ".nf\n#{code}\n.fi"
+      subject.convert_codeblock(codeblock).should == ".nf\n#{escaped_code}\n.fi"
     end
   end
 
@@ -376,12 +376,13 @@ Hello world.
   end
 
   describe "#convert_p" do
-    let(:text) { "Hello world." }
-    let(:doc)  { Kramdown::Document.new(text) }
-    let(:p)    { doc.root.children[0] }
+    let(:text)         { "Hello world." }
+    let(:escaped_text) { 'Hello world\.' }
+    let(:doc)          { Kramdown::Document.new(text) }
+    let(:p)            { doc.root.children[0] }
 
     it "should convert p elements into '.PP\\ntext'" do
-      subject.convert_p(p).should == ".PP\n#{text}"
+      subject.convert_p(p).should == ".PP\n#{escaped_text}"
     end
 
     context "when the paragraph starts with a codespan element" do
@@ -389,16 +390,16 @@ Hello world.
       let(:text)   { 'Foo bar baz' }
       let(:doc)    { Kramdown::Document.new("`#{option}`\n\t#{text}") }
 
-      it "should convert p elements into '.TP\\n\\fB\\fC--option\\fR\\ntext...'" do
-        subject.convert_p(p).should == ".TP\n\\fB\\fC#{option}\\fR\n#{text}"
+      it "should convert p elements into '.TP\\n\\fB--option\\fR\\ntext...'" do
+        subject.convert_p(p).should == ".TP\n\\fB#{option}\\fR\n#{text}"
       end
 
       context "when there is only one codespan element" do
         let(:code) { 'code' }
         let(:doc)  { Kramdown::Document.new("`#{code}`") }
 
-        it "should convert p elements into '.PP\\n\\fB\\fC...\\fR'" do
-          subject.convert_p(p).should == ".PP\n\\fB\\fC#{code}\\fR"
+        it "should convert p elements into '.PP\\n\\fB...\\fR'" do
+          subject.convert_p(p).should == ".PP\n\\fB#{code}\\fR"
         end
       end
 
@@ -408,53 +409,60 @@ Hello world.
         let(:text)   { 'Foo bar baz' }
         let(:doc)    { Kramdown::Document.new("`#{flag}`, `#{option}`\n\t#{text}") }
 
-        it "should convert p elements into '.TP\\n\\fB\\fC-o\\fR, \\fB\\fC--option\\fR\\ntext...'" do
-          subject.convert_p(p).should == ".TP\n\\fB\\fC#{flag}\\fR, \\fB\\fC#{option}\\fR\n#{text}"
+        it "should convert p elements into '.TP\\n\\fB-o\\fR, \\fB--option\\fR\\ntext...'" do
+          subject.convert_p(p).should == ".TP\n\\fB#{flag}\\fR, \\fB#{option}\\fR\n#{text}"
         end
 
         context "when there is no newline" do
           let(:doc) { Kramdown::Document.new("`#{flag}` `#{option}`") }
 
           it "should convert the p element into a '.HP\\n...'" do
-            subject.convert_p(p).should == ".HP\n\\fB\\fC#{flag}\\fR \\fB\\fC#{option}\\fR"
+            subject.convert_p(p).should == ".HP\n\\fB#{flag}\\fR \\fB#{option}\\fR"
           end
         end
       end
     end
 
     context "when the paragraph starts with a em element" do
-      let(:option) { '--foo' }
-      let(:text)   { 'Foo bar baz' }
-      let(:doc)    { Kramdown::Document.new("*#{option}*\n\t#{text}") }
+      let(:option)         { '--foo'       }
+      let(:escaped_option) { "\\-\\-foo"   }
+      let(:text)           { 'Foo bar baz' }
+
+      let(:doc) do
+        Kramdown::Document.new("*#{option}*\n\t#{text}")
+      end
 
-      it "should convert p elements into '.TP\\n\\fB\\fC--option\\fR\\ntext...'" do
-        subject.convert_p(p).should == ".TP\n\\fI#{option}\\fP\n#{text}"
+      it "should convert p elements into '.TP\\n\\fI--option\\fP\\ntext...'" do
+        subject.convert_p(p).should == ".TP\n\\fI#{escaped_option}\\fP\n#{text}"
       end
 
       context "when there is only one em element" do
         let(:text)   { 'foo' }
         let(:doc)    { Kramdown::Document.new("*#{text}*") }
 
-        it "should convert p elements into '.PP\\n\\fB\\fC...\\fR'" do
+        it "should convert p elements into '.PP\\n\\fI...\\fP'" do
           subject.convert_p(p).should == ".PP\n\\fI#{text}\\fP"
         end
       end
 
       context "when there are more than one em element" do
-        let(:flag)    { '-f'    }
-        let(:option)  { '--foo' }
-        let(:text)    { 'Foo bar baz' }
-        let(:doc)     { Kramdown::Document.new("*#{flag}*, *#{option}*\n\t#{text}") }
+        let(:flag)           { '-f'          }
+        let(:escaped_flag)   { "\\-f"        }
+        let(:text)           { 'Foo bar baz' }
 
-        it "should convert p elements into '.TP\\n\\fI-o\\fP, \\fI--option\\fP\\ntext...'" do
-          subject.convert_p(p).should == ".TP\n\\fI\\#{flag}\\fP, \\fI#{option}\\fP\n#{text}"
+        let(:doc) do
+          Kramdown::Document.new("*#{flag}*, *#{option}*\n\t#{text}")
+        end
+
+        it "should convert p elements into '.TP\\n\\fI-o\\fP, \\fI\\-\\-option\\fP\\ntext...'" do
+          subject.convert_p(p).should == ".TP\n\\fI#{escaped_flag}\\fP, \\fI#{escaped_option}\\fP\n#{text}"
         end
 
         context "when there is no newline" do
           let(:doc) { Kramdown::Document.new("*#{flag}* *#{option}*") }
 
           it "should convert the p element into a '.HP\\n...'" do
-            subject.convert_p(p).should == ".HP\n\\fI\\#{flag}\\fP \\fI#{option}\\fP"
+            subject.convert_p(p).should == ".HP\n\\fI#{escaped_flag}\\fP \\fI#{escaped_option}\\fP"
           end
         end
       end
@@ -486,36 +494,37 @@ Hello world.
     let(:doc)      { Kramdown::Document.new("`#{code}`") }
     let(:codespan) { doc.root.children[0].children[0] }
 
-    it "should convert codespan elements into '\\fB\\fCcode\\fR'" do
-      subject.convert_codespan(codespan).should == "\\fB\\fC#{code}\\fR"
+    it "should convert codespan elements into '\\fBcode\\fR'" do
+      subject.convert_codespan(codespan).should == "\\fB#{code}\\fR"
     end
   end
 
   describe "#convert_a" do
-    let(:text) { 'example'             }
-    let(:href) { 'http://example.com/' }
-    let(:doc)  { Kramdown::Document.new("[#{text}](#{href})") }
-    let(:link) { doc.root.children[0].children[0] }
+    let(:text)         { 'example'             }
+    let(:href)         { 'http://example.com/' }
+    let(:escaped_href) { 'http:\[sl]\[sl]example\.com\[sl]' }
+    let(:doc)          { Kramdown::Document.new("[#{text}](#{href})") }
+    let(:link)         { doc.root.children[0].children[0] }
 
     it "should convert a link elements into 'text\\n.UR href\\n.UE'" do
-      subject.convert_a(link).should == "#{text}\n.UR #{href}\n.UE"
+      subject.convert_a(link).should == "#{text}\n.UR #{escaped_href}\n.UE"
     end
 
     context "when the href begins with mailto:" do
-      let(:text)  { 'Bob'             }
-      let(:email) { 'bob@example.com' }
-      let(:doc)   { Kramdown::Document.new("[#{text}](mailto:#{email})") }
+      let(:text)          { 'Bob'             }
+      let(:email)         { 'bob@example.com' }
+      let(:escaped_email) { 'bob\[at]example\.com' }
+      let(:doc)           { Kramdown::Document.new("[#{text}](mailto:#{email})") }
 
       it "should convert the link elements into '.MT email\\n.ME'" do
-        subject.convert_a(link).should == "#{text}\n.MT #{email}\n.ME"
+        subject.convert_a(link).should == "#{text}\n.MT #{escaped_email}\n.ME"
       end
 
       context "when link is <email>" do
-        let(:email) { 'bob@example.com' }
-        let(:doc)   { Kramdown::Document.new("<#{email}>") }
+        let(:doc) { Kramdown::Document.new("<#{email}>") }
 
         it "should convert the link elements into '.MT email\\n.ME'" do
-          subject.convert_a(link).should == "\n.MT #{email}\n.ME"
+          subject.convert_a(link).should == "\n.MT #{escaped_email}\n.ME"
         end
       end
     end
@@ -540,12 +549,12 @@ Hello world.
   end
 
   describe "#escape" do
-    it "should escape '\\' as '\\\\'" do
-      subject.escape("hello\\ world").should == "hello\\\\ world"
-    end
+    let(:text) { "hello\nworld" }
 
-    it "should escape '-' as '\\-'" do
-      subject.escape("foo-bar").should == "foo\\-bar"
+    described_class::GLYPHS.each do |char,glyph|
+      it "should convert #{char.dump} into #{glyph.dump}" do
+        subject.escape("#{text} #{char}").should == "#{text} #{glyph}"
+      end
     end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: kramdown-man
 version: !ruby/object:Gem::Version
-  version: 0.1.4
+  version: 0.1.5
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-05-06 00:00:00.000000000 Z
+date: 2013-05-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: kramdown