test/MDTest/Implementations/Markdown.pl test/MDTest/Implementations/markdown-extra.php test/MDTest/Implementations/markdown.php test/MDTest/License.text test/MDTest/Markdown.mdtest/.svn/all-wcprops test/MDTest/Markdown.mdtest/.svn/entries test/MDTest/Markdown.mdtest/.svn/format test/MDTest/Markdown.mdtest/.svn/prop-base/Links, shortcut references.html.svn-base test/MDTest/Markdown.mdtest/.svn/prop-base/Links, shortcut references.text.svn-base test/MDTest/Markdown.mdtest/.svn/text-base/Amps and angle encoding.html.svn-base test/MDTest/Markdown.mdtest/.svn/text-base/Amps and angle encoding.text.svn-base test/MDTest/Markdown.mdtest/.svn/text-base/Auto links.html.svn-base test/MDTest/Markdown.mdtest/.svn/text-base/Auto links.text.svn-base test/MDTest/Markdown.mdtest/.svn/text-base/Backslash escapes.html.svn-base test/MDTest/Markdown.mdtest/.svn/text-base/Backslash escapes.text.svn-base test/MDTest/Markdown.mdtest/.svn/text-base/Blockquotes with code blocks.html.svn-base test/MDTest/Markdown.mdtest/.svn/text-base/Blockquotes with code blocks.text.svn-base test/MDTest/Markdown.mdtest/.svn/text-base/Code Blocks.html.svn-base test/MDTest/Markdown.mdtest/.svn/text-base/Code Blocks.text.svn-base test/MDTest/Markdown.mdtest/.svn/text-base/Code Spans.html.svn-base test/MDTest/Markdown.mdtest/.svn/text-base/Code Spans.text.svn-base test/MDTest/Markdown.mdtest/.svn/text-base/Hard-wrapped paragraphs with list-like lines.html.svn-base test/MDTest/Markdown.mdtest/.svn/text-base/Hard-wrapped paragraphs with list-like lines.text.svn-base test/MDTest/Markdown.mdtest/.svn/text-base/Horizontal rules.html.svn-base test/MDTest/Markdown.mdtest/.svn/text-base/Horizontal rules.text.svn-base test/MDTest/Markdown.mdtest/.svn/text-base/Images.html.svn-base test/MDTest/Markdown.mdtest/.svn/text-base/Images.text.svn-base test/MDTest/Markdown.mdtest/.svn/text-base/Inline HTML (Advanced).html.svn-base test/MDTest/Markdown.mdtest/.svn/text-base/Inline HTML (Advanced).text.svn-base test/MDTest/Markdown.mdtest/.svn/text-base/Inline HTML (Simple).html.svn-base test/MDTest/Markdown.mdtest/.svn/text-base/Inline HTML (Simple).text.svn-base test/MDTest/Markdown.mdtest/.svn/text-base/Inline HTML comments.html.svn-base test/MDTest/Markdown.mdtest/.svn/text-base/Inline HTML comments.text.svn-base test/MDTest/Markdown.mdtest/.svn/text-base/Links, inline style.html.svn-base test/MDTest/Markdown.mdtest/.svn/text-base/Links, inline style.text.svn-base test/MDTest/Markdown.mdtest/.svn/text-base/Links, reference style.html.svn-base test/MDTest/Markdown.mdtest/.svn/text-base/Links, reference style.text.svn-base test/MDTest/Markdown.mdtest/.svn/text-base/Links, shortcut references.html.svn-base test/MDTest/Markdown.mdtest/.svn/text-base/Links, shortcut references.text.svn-base test/MDTest/Markdown.mdtest/.svn/text-base/Literal quotes in titles.html.svn-base test/MDTest/Markdown.mdtest/.svn/text-base/Literal quotes in titles.text.svn-base test/MDTest/Markdown.mdtest/.svn/text-base/Markdown Documentation - Basics.html.svn-base test/MDTest/Markdown.mdtest/.svn/text-base/Markdown Documentation - Basics.text.svn-base test/MDTest/Markdown.mdtest/.svn/text-base/Markdown Documentation - Syntax.html.svn-base test/MDTest/Markdown.mdtest/.svn/text-base/Markdown Documentation - Syntax.text.svn-base test/MDTest/Markdown.mdtest/.svn/text-base/Nested blockquotes.html.svn-base test/MDTest/Markdown.mdtest/.svn/text-base/Nested blockquotes.text.svn-base test/MDTest/Markdown.mdtest/.svn/text-base/Ordered and unordered lists.html.svn-base test/MDTest/Markdown.mdtest/.svn/text-base/Ordered and unordered lists.text.svn-base test/MDTest/Markdown.mdtest/.svn/text-base/Strong and em together.html.svn-base test/MDTest/Markdown.mdtest/.svn/text-base/Strong and em together.text.svn-base test/MDTest/Markdown.mdtest/.svn/text-base/Tabs.html.svn-base test/MDTest/Markdown.mdtest/.svn/text-base/Tabs.text.svn-base test/MDTest/Markdown.mdtest/.svn/text-base/Tidyness.html.svn-base test/MDTest/Markdown.mdtest/.svn/text-base/Tidyness.text.svn-base test/MDTest/Markdown.mdtest/Amps and angle encoding.html test/MDTest/Markdown.mdtest/Amps and angle encoding.text test/MDTest/Markdown.mdtest/Auto links.html test/MDTest/Markdown.mdtest/Auto links.text test/MDTest/Markdown.mdtest/Backslash escapes.html test/MDTest/Markdown.mdtest/Backslash escapes.text test/MDTest/Markdown.mdtest/Blockquotes with code blocks.html test/MDTest/Markdown.mdtest/Blockquotes with code blocks.text test/MDTest/Markdown.mdtest/Code Blocks.html test/MDTest/Markdown.mdtest/Code Blocks.text test/MDTest/Markdown.mdtest/Code Spans.html test/MDTest/Markdown.mdtest/Code Spans.text test/MDTest/Markdown.mdtest/Hard-wrapped paragraphs with list-like lines.html test/MDTest/Markdown.mdtest/Hard-wrapped paragraphs with list-like lines.text test/MDTest/Markdown.mdtest/Horizontal rules.html test/MDTest/Markdown.mdtest/Horizontal rules.text test/MDTest/Markdown.mdtest/Images.html test/MDTest/Markdown.mdtest/Images.text test/MDTest/Markdown.mdtest/Inline HTML (Advanced).html test/MDTest/Markdown.mdtest/Inline HTML (Advanced).text test/MDTest/Markdown.mdtest/Inline HTML (Simple).html test/MDTest/Markdown.mdtest/Inline HTML (Simple).text test/MDTest/Markdown.mdtest/Inline HTML comments.html test/MDTest/Markdown.mdtest/Inline HTML comments.text test/MDTest/Markdown.mdtest/Links, inline style.html test/MDTest/Markdown.mdtest/Links, inline style.text test/MDTest/Markdown.mdtest/Links, reference style.html test/MDTest/Markdown.mdtest/Links, reference style.text test/MDTest/Markdown.mdtest/Links, shortcut references.html test/MDTest/Markdown.mdtest/Links, shortcut references.text test/MDTest/Markdown.mdtest/Literal quotes in titles.html test/MDTest/Markdown.mdtest/Literal quotes in titles.text test/MDTest/Markdown.mdtest/Markdown Documentation - Basics.html test/MDTest/Markdown.mdtest/Markdown Documentation - Basics.text test/MDTest/Markdown.mdtest/Markdown Documentation - Syntax.html test/MDTest/Markdown.mdtest/Markdown Documentation - Syntax.text test/MDTest/Markdown.mdtest/Nested blockquotes.html test/MDTest/Markdown.mdtest/Nested blockquotes.text test/MDTest/Markdown.mdtest/Ordered and unordered lists.html test/MDTest/Markdown.mdtest/Ordered and unordered lists.text test/MDTest/Markdown.mdtest/Strong and em together.html test/MDTest/Markdown.mdtest/Strong and em together.text test/MDTest/Markdown.mdtest/Tabs.html test/MDTest/Markdown.mdtest/Tabs.text test/MDTest/Markdown.mdtest/Tidyness.html test/MDTest/Markdown.mdtest/Tidyness.text test/MDTest/PHP Markdown Extra.mdtest/Abbr.html test/MDTest/PHP Markdown Extra.mdtest/Abbr.text test/MDTest/PHP Markdown Extra.mdtest/Definition Lists.html test/MDTest/PHP Markdown Extra.mdtest/Definition Lists.text test/MDTest/PHP Markdown Extra.mdtest/Emphasis.html test/MDTest/PHP Markdown Extra.mdtest/Emphasis.text test/MDTest/PHP Markdown Extra.mdtest/Footnotes.html test/MDTest/PHP Markdown Extra.mdtest/Footnotes.text test/MDTest/PHP Markdown Extra.mdtest/Inline HTML with Markdown content.html test/MDTest/PHP Markdown Extra.mdtest/Inline HTML with Markdown content.text test/MDTest/PHP Markdown Extra.mdtest/Tables.html test/MDTest/PHP Markdown Extra.mdtest/Tables.text test/MDTest/PHP Markdown.mdtest/Backslash escapes.html test/MDTest/PHP Markdown.mdtest/Backslash escapes.text test/MDTest/PHP Markdown.mdtest/Code Spans.html test/MDTest/PHP Markdown.mdtest/Code Spans.text test/MDTest/PHP Markdown.mdtest/Code block in a list item.html test/MDTest/PHP Markdown.mdtest/Code block in a list item.text test/MDTest/PHP Markdown.mdtest/Email auto links.html test/MDTest/PHP Markdown.mdtest/Email auto links.text test/MDTest/PHP Markdown.mdtest/Emphasis.html test/MDTest/PHP Markdown.mdtest/Emphasis.text test/MDTest/PHP Markdown.mdtest/Headers.html test/MDTest/PHP Markdown.mdtest/Headers.text test/MDTest/PHP Markdown.mdtest/Images (Untitled).html test/MDTest/PHP Markdown.mdtest/Images (Untitled).text test/MDTest/PHP Markdown.mdtest/Inline HTML (Simple).html test/MDTest/PHP Markdown.mdtest/Inline HTML (Simple).text test/MDTest/PHP Markdown.mdtest/Inline HTML (Span).html test/MDTest/PHP Markdown.mdtest/Inline HTML (Span).text test/MDTest/PHP Markdown.mdtest/Inline HTML comments.html test/MDTest/PHP Markdown.mdtest/Inline HTML comments.text test/MDTest/PHP Markdown.mdtest/Ins & del.html test/MDTest/PHP Markdown.mdtest/Ins & del.text test/MDTest/PHP Markdown.mdtest/Links, inline style.html test/MDTest/PHP Markdown.mdtest/Links, inline style.text test/MDTest/PHP Markdown.mdtest/MD5 Hashes.html test/MDTest/PHP Markdown.mdtest/MD5 Hashes.text test/MDTest/PHP Markdown.mdtest/Nesting.html test/MDTest/PHP Markdown.mdtest/Nesting.text test/MDTest/PHP Markdown.mdtest/PHP-Specific Bugs.html test/MDTest/PHP Markdown.mdtest/PHP-Specific Bugs.text test/MDTest/PHP Markdown.mdtest/Parens in URL.html test/MDTest/PHP Markdown.mdtest/Parens in URL.text test/MDTest/PHP Markdown.mdtest/Tight blocks.html test/MDTest/PHP Markdown.mdtest/Tight blocks.text test/MDTest/index.php test/MDTest/mdtest.php @@ -1,3 +1,7 @@ +# BEWARE: THIS CODE IS NOT CURRENTLY FUNCTIONAL + +ClothBlue is currently undergoing a major rewrite and the code currently on GitHub is almost certainly non-functional. + # ClothBlue HTML to Markdown library @@ -27,17 +31,15 @@ This is beta software, and only a few Markdown rules have been implemented yet: ## Usage -`require 'clothblue'` - -`text = ClothBlue.new("Bold HTML!")` - -`text.to_markdown` + require 'clothblue' + text = ClothBlue.new("Bold HTML!") + text.to_markdown ## Get Help Feel free to contact me, or view the homepage. -* http://craigjolicoeur.com/clothblue/ +* http://craigjolicoeur.com/blog/clothblue/ * http://github.com/cpjolicoeur/clothblue/ ## Developers @@ -72,4 +74,6 @@ THE SOFTWARE. ClothBlue received inspiration from the [ClothRed library](http://clothred.rubyforge.org/) and the [Markdownify PHP library](http://milianw.de/projects/markdownify/). -[Markdown](http://daringfireball.com/projects/markdown) is, of course, written by [John Gruber](http://daringfireball.com). Michel Fortin's [Markdown Extra](http://www.michelf.com/projects/php-markdown/extra/) support is also included. \ No newline at end of file +[Markdown](http://daringfireball.com/projects/markdown) is, of course, written by [John Gruber](http://daringfireball.com). Michel Fortin's [Markdown Extra](http://www.michelf.com/projects/php-markdown/extra/) support is also included. + +All attempts have been made to pass Michel Fortin's [MDTest Suite](http://article.gmane.org/gmane.text.markdown.general/2540) as well. README.markdown @@ -1,14 +1,14 @@ Gem::Specification.new do |s| s.name = "ClothBlue" - s.version = "0.2.2" - s.date = "Time.now" + s.version = "0.5.1" + s.date = "2008-11-25" s.summary = "HTML to Markdown converter" s.email = "cpjolicoeur@gmail.com" s.homepage = "http://github.com/cpjolicoeur/clothblue" s.description = "ClothBlue is BlueCloth's evil twin. It converts existing HTML into Markdown format for use with BlueCloth." s.has_rdoc = true s.authors = ["Craig P Jolicoeur"] - s.files = ["README", "TODO", "clothblue.gemspec", "lib/clothblue.rb", "lib/README.rdoc", "test/README", "test/test_entities.rb", "test/test_formatting.rb", "test/test_headings.rb", "test/test_lists.rb", "test/test_structure.rb", "test/test_tables.rb"] + s.files = ["README", "TODO", "clothblue.gemspec", "lib/clothblue.rb", "lib/parsehtml/parsehtml.rb", "test/README", "test/test_entities.rb", "test/test_formatting.rb", "test/test_headings.rb", "test/test_lists.rb", "test/test_structure.rb", "test/test_tables.rb"] s.test_files = ["test/test_entities.rb", "test/test_formatting.rb", "test/test_headings.rb", "test/test_lists.rb", "test/test_structure.rb", "test/test_tables.rb"] s.rdoc_options = ["--main", "lib/README.rdoc"] -end \ No newline at end of file +end clothblue.gemspec @@ -1,12 +1,12 @@ -# require 'html/document' require 'parsehtml/parsehtml' -class ClothBlue #:nodoc: +class ClothBlue # Constants - MDFY_LINKS_EACH_PARAGRAPH = false - MDFY_BODYWIDTH = false - MDFY_KEEPHTML = true + LINKS_EACH_PARAGRAPH = false + BODYWIDTH = false + KEEPHTML = true + MIN_BODYWIDTH = 25 # tags which can be handled by markdown IS_MARKDOWNABLE = { @@ -34,10 +34,10 @@ class ClothBlue #:nodoc: } # html tags to be ignored (content will be parsed) - IGNORE = [] + IGNORE = %w(html body) # html tags to be dropped (content will not be parsed!) - DROP = %w(script head style form) + DROP = %w(script head style form area object param iframe) # Markdown indents which could be wrapped WRAPPABLE_INDENTS = [ @@ -62,36 +62,23 @@ class ClothBlue #:nodoc: ] # parseHTML parser - attr_reader :parser + attr_accessor :parser # markdown output - @output = '' - attr_accessor :output + attr_reader :output # stack with tags which were not converted to html - @not_converted = [] attr_reader :not_converted # skip conversion to markdown - @skip_conversion = false attr_reader :skip_conversion # keep html tags which cannot be converted to markdown - @keep_html = false attr_reader :keep_html # wrap output, set to 0 to skip wrapping - @body_width = 0 attr_reader :body_width - # minimum body width - @min_body_width = 25 - attr_reader :min_body_width - - # display links after each paragraph - @links_after_each_paragraph = false - attr_reader :links_after_each_paragraph - # whether last processed node was a block tag or not @last_was_block_tag = false attr_reader :last_was_block_tag @@ -121,13 +108,17 @@ class ClothBlue #:nodoc: attr_accessor :stack # Constructor - def initialize(text = '', links_after_each_paragraph = MDFY_LINKS_EACH_PARAGRAPH, body_width = MDFY_BODYWIDTH, keep_html = MDFY_KEEPHTML) + def initialize(text = '', links_after_each_paragraph = LINKS_EACH_PARAGRAPH, body_width = BODYWIDTH, keep_html = KEEPHTML) @links_after_each_paragraph = links_after_each_paragraph @keep_html = keep_html - @body_width = (body_width > @min_body_width) ? body_width.to_i : false + @body_width = (body_width > MIN_BODYWIDTH) ? body_width.to_i : MIN_BODYWIDTH @parser = HTML::Tokenizer.new(text) + @output = '' + @not_converted = [] + @skip_conversion = false + @search, @replace = [], [] ESCAPE_IN_TEXT.each do |s,r| @search << '/(?<!\\\)/' + s + '/U' @@ -728,4 +719,4 @@ class ClothBlue #:nodoc: # return $text; end -end \ No newline at end of file +end lib/clothblue.rb a09f49bb6cf19ed1a8b785ad14f2bc9dacdf4bae Craig P Jolicoeur cpjolicoeur@gmail.com http://github.com/cpjolicoeur/clothblue/commit/45d534cc9f9c5667f7d59fd8bac34bc340b6710b 45d534cc9f9c5667f7d59fd8bac34bc340b6710b

2008-11-26T05:42:32-08:00

update readme for non-working code 767938e824aed78f4ccc852684aca5bc95d166bd Craig P Jolicoeur cpjolicoeur@gmail.com