@@ -3,10 +3,42 @@ module EnkoderTags class TagError < StandardError; end + desc %{ + Everything within <r:enkode></r:enkode> tags will be obfuscated using + javascript. + + Be aware that obfuscated content will not be visible to web clients + which do not have javascript enabled. + } tag "enkode" do |tag| Enkoder.new(tag.expand).enkode end + desc %{ + The enkode_mailto tag obfuscates mailto links. This makes it very + difficult for bots to harvest email addresses, allowing you to publish + email addresses on the web without attracting spam. + + The enkode_mailto tag accepts the following attributes as tags: + + * @email@ (_manadatory_) - the email address you want to publish + * @link_text@ - The text which will display in the link + (if left blank, email address is used) + * @title_text@ - Populates the @title@ attribute + * @subject@ - Text entered here will be used as the _Subject_ for emails + + Any additional attributes (e.g. @class@ or @id@) provided will also be + applied to the tag. + + *Usage:* + + <pre><code><r:enkode_mailto email="hello@example.com" link_text="Say hello" + title_text="Click here to say hello by email" subject="Hello" /> + </code></pre> + + Be aware that browsers which do not have javascript enabled will not see + the email address. + } tag "enkode_mailto" do |tag| attr = tag.attr.symbolize_keys lib/enkoder_tags.rb fef21f163f016fb0db958c0fc05984e062f3057a Andrew Neil andrew.jr.neil@gmail.com http://github.com/santry/enkoder_tags/commit/877b45cbd9a1f944f7d4d04851bf229f8b4ffdcb 877b45cbd9a1f944f7d4d04851bf229f8b4ffdcb 2009-05-28T08:13:20-07:00 2009-05-28T08:13:20-07:00 Added descriptions for enkode and enkode_mailto. dee6a7f9312e0ba1e4c305e51c8ab64ec407b98e Andrew Neil andrew.jr.neil@gmail.com