@@ -2,13 +2,16 @@ I don't know about you, but I'm not too much of a fan of writing out raw HTML when I'm trying to belt out some blog posts. Keeping track of those pesky closing tags, escaping entities, and so on, can really get in the way of your creativity. -As a result, most blogs provide a simplified markup or some sort of editor. For technicalpickles.com[http://technicalpickles.com], I went for the former. +As a result, most blogs provide a simplified markup or some sort of editor. For technicalpickles.com[http://technicalpickles.com], I went with markdown[http://daringfireball.net/projects/markdown/]. -I extracted the markdown[http://daringfireball.net/projects/markdown/] magic out of my blog, and this plugin is the result. +I extracted this markup magic out of my blog, and this plugin is the result. It lets you: -Perhaps you intend yourself to have some markup in your model, say it's markdown, and say it's required or not, and it's cached or not. - -This plugin helps you do such things. + * Specify a column contains markup + * Specify the syntax (markdown and textile, with markdown being the default) + * Specify if the markup column is required + * Generate a helper for generating the HTML + * Specify if the HTML should be cached in the database + * ... all using only one line == Example README @@ -12,6 +12,7 @@ begin s.homepage = "http://github.com/technicalpickles/has_markup" s.description = "Manage markup close to home... right in the model! Caching, validation, etc" s.authors = ["Josh Nichols"] + s.files = FileList["[A-Z]*.*", "{generators,lib,test,spec}/**/*"] end Jeweler.craft(gemspec) rescue LoadError @@ -29,7 +30,7 @@ Rake::RDocTask.new(:rdoc) do |rdoc| rdoc.rdoc_dir = 'rdoc' rdoc.title = 'HasMarkup' rdoc.options << '--line-numbers' << '--inline-source' - rdoc.rdoc_files.include('README.*') + rdoc.rdoc_files.include('README*') rdoc.rdoc_files.include('lib/**/*.rb') end Rakefile @@ -13,11 +13,11 @@ module HasMarkup # example of using <tt>:content</tt>, it would require a column named <tt>:cached_content_html</tt>. # It also adds a before_save hook <tt>:cache_content_html</tt> for generating the html before saving. # - # To support other syntaxes, you just need to add a method on ActiveRecord::Base named like - # <tt>sprinkle_ursyntax_magic</tt> which takes a column (where <tt>ursyntax</tt> is the name - # of your awesome syntax). You should define a method named - # "#{column}_html" which generates the html from the markup. You might also want to validate - # the syntax of the column. + # For adding additional syntaxes, see has_markup/markdown and has_markup/textile. Basically: + # + # * Create HasMarkup::SyntaxNameHere + # * Define sprinkle_syntax_name_here_magic which takes a column name, like <tt>:content</tt> + # * In sprinkle_syntax_name_here_magic, create <tt>"#{column}_html"</tt>, which handles the actual generation def has_markup(column, options = {}) options = HasMarkup::default_has_markup_options.merge(options) lib/has_markup/active_record.rb 4313648f4ebff9046814ebfda9bde45978ea68cb Josh Nichols josh@technicalpickles.com http://github.com/technicalpickles/has_markup/commit/a038cff60b36ad9846310ea5e9d4df1cfa8613df a038cff60b36ad9846310ea5e9d4df1cfa8613df 2008-10-12T22:03:07-07:00 2008-10-12T22:03:07-07:00 Cleaned up comments and README. Include README in rdoc eed9bc629ffbfb14c10bfca4f1a8206d06165cbf Josh Nichols josh@technicalpickles.com