Merge branch 'virtualfunction/master'

Conflicts:

	lib/redcloth/version.rb

CHANGELOG

@@ -1,3 +1,8 @@
+*EDGE*
+
+* Added some very basic support for images in LaTeX. [virtualfunction]
+
+
 *4.0.3 (August 18, 2008)*
 
 * Fix NoMethodError: private method gsub!' called for nil:NilClass when two dimensions followed by a space. #38

lib/redcloth/formatters/latex.rb

@@ -4,6 +4,15 @@ module RedCloth::Formatters::LATEX
   include RedCloth::Formatters::Base
 
   ENTITIES = YAML::load(File.read(File.dirname(__FILE__)+'/latex_entities.yml')) 
+
+  module Settings
+    # Maps CSS style names to latex formatting options
+    def latex_image_styles
+      @latex_image_class_styles ||= {}
+    end
+  end
+
+  RedCloth::TextileDoc.send(:include, Settings)
 
   def escape(text)
     latex_esc(text)
@@ -136,8 +145,23 @@ def link(opts)
   end
 
   # FIXME: use includegraphics with security verification
+  #
+  # Remember to use '\RequirePackage{graphicx}' in your LaTeX header
+  # 
+  # FIXME: Look at dealing with width / height gracefully as this should be 
+  # specified in a unit like cm rather than px.
   def image(opts)
-    ""
+    # Don't know how to use remote links, plus can we trust them?
+    return "" if opts[:src] =~ /^\w+\:\/\//
+    # Resolve CSS styles if any have been set
+    styling = opts[:class].to_s.split(/\s+/).collect { |style| latex_image_styles[style] }.compact.join ','
+    # Build latex code
+    [ "\\begin{figure}[htp]",
+      "  \\includegraphics[#{styling}]{#{opts[:src]}}",
+     ("  \\caption{#{escape opts[:title]}}" if opts[:title]),
+     ("  \\label{#{escape opts[:alt]}}" if opts[:alt]),
+      "\\end{figure}",
+    ].compact.join "\n"
   end
 
   def footno(opts)
@@ -204,12 +228,14 @@ def dim(opts)
 
   private
 
+  # Use this for block level commands that use \begin
   def begin_chunk(type)
     chunk_counter[type] += 1
     return "\\begin{#{type}}" if 1 == chunk_counter[type]
     ''
   end
 
+  # Use this for block level commands that use \end
   def end_chunk(type)
     chunk_counter[type] -= 1
     raise RuntimeError, "Bad latex #{type} nesting detected" if chunk_counter[type] < 0 # This should never need to happen

test/images.yml

@@ -1,12 +1,27 @@
 ---
 in:  This is an !image.jpg!
 html: <p>This is an <img src="image.jpg" alt="" /></p>
+latex: |+
+  This is an \begin{figure}[htp]
+    \includegraphics[]{image.jpg}
+  \end{figure}
+
 ---
 in:  This is an !image.jpg(with alt text)!
 html: <p>This is an <img src="image.jpg" title="with alt text" alt="with alt text" /></p>
+latex: |+
+  This is an \begin{figure}[htp]
+    \includegraphics[]{image.jpg}
+    \caption{with alt text}
+  \end{figure}
+
 ---
 in:  This is an !http://example.com/i/image.jpg!
 html: <p>This is an <img src="http://example.com/i/image.jpg" alt="" /></p>
+# Note that we are removing remote links fro security reasons for now
+latex: |+
+  This is an 
+
 ---
 in:  This is an !http://example.com/i/image.jpg#a1!
 html: <p>This is an <img src="http://example.com/i/image.jpg#a1" alt="" /></p>
@@ -176,6 +191,11 @@ html: <p>(This is an <a href="http://example.com/index.html?foo=bar&amp;a=b#a10"
 name: image with relative src with dot
 in: "!../../image.jpg!"
 html: <p><img src="../../image.jpg" alt="" /></p>
+latex: |+
+  \begin{figure}[htp]
+    \includegraphics[]{../../image.jpg}
+  \end{figure}
+
 ---
 name: image with class
 in: "!(myclass)image.jpg!"
@@ -204,10 +224,22 @@ html: <p><img src="image.jpg" style="color:red;" alt="" /></p>
 name: image attributes has ampersand html entity in alt and title
 in: "!/pictures/cat_and_fox.jpg(Trady Blix & The cartoon fox)!"
 html: '<p><img src="/pictures/cat_and_fox.jpg" title="Trady Blix &amp; The cartoon fox" alt="Trady Blix &amp; The cartoon fox" /></p>'
+latex: |+
+  \begin{figure}[htp]
+    \includegraphics[]{/pictures/cat_and_fox.jpg}
+    \caption{Trady Blix \& The cartoon fox}
+  \end{figure}
+
 ---
 name: image attributes has double quote html entity in alt and title
 in: '!/pictures/bacon.jpg(The fox said: "Have some chunky bacon")!'
 html: '<p><img src="/pictures/bacon.jpg" title="The fox said: &quot;Have some chunky bacon&quot;" alt="The fox said: &quot;Have some chunky bacon&quot;" /></p>'
+latex: |+
+  \begin{figure}[htp]
+    \includegraphics[]{/pictures/bacon.jpg}
+    \caption{The fox said: "Have some chunky bacon"}
+  \end{figure}
+
 ---
 name: image attributes has single quote html entity in alt and title
 in: "!/pictures/bacon.jpg(The fox said: 'Have some chunky bacon')!"