karakuri-bao 0.1.4 → 0.1.5

data/README.md

@@ -37,6 +37,13 @@ For example, to use seo friendly titles, your layout.rhtml should be looking lik
     .
     .
 
+**TIPS**: To have a customized title separator, put this in your `config.ru`
+
+    require 'karakuri'
+
+    Karakuri.title_separator = '+'
+
+
 ### Tags
 Adding the tagging feature requires the _toto_prerelease_ as mentioned above, since we need the http request to apply our little hack.
 
@@ -66,9 +73,16 @@ Next, you need a place to show the tag links, for example the index.rhtml:
     .
     .
 
+**TIPS**: Again, to customize your tag link format, put this in your `config.ru`:
+
+    require 'karakuri'
+
+    Karakuri.link_format = '<a href="/tagged?tag={tag}" title="your customed title">{tag}</a> '
+
+`{tag}` (keep it as it is in your `config.ru`) will be the placeholder for your tag corresponding to each article and is required.
 
 
-And again: piece of cake ;-). Now all we need to add is a page that displays articles belonging to a ceratin tag:
+And again: piece of cake ;-). Now all we need to add is a page that displays articles belonging to a certain tag:
 
 Create a page called `tagged.rhtml` in your `templates/pages` directory that looks like this:
 
@@ -82,7 +96,7 @@ Create a page called `tagged.rhtml` in your `templates/pages` directory that loo
 
     <% Karakuri::desired_articles(@articles, desired_tag).each do |article| %>
       <li>
-        <span class="descr"><a href="<%= article.path %>" alt="<%= article.title %>"><%= article.title %></a><br/></span>
+        <span class="descr"><a href="<%= article.path %>" title="<%= article.title %>"><%= article.title %></a><br/></span>
       </li>
     <% end %>
     </ul>
@@ -103,7 +117,7 @@ Thanks [baopham](https://github.com/baopham) for the nice addition.
 
 ### short url (via bit.ly)
 
-To use a bit.ly shortened URL, just call the followin function inside a .rhtml file:
+To use a bit.ly shortened URL, just call the following function inside a .rhtml file:
 
     <%= Karakuri::short_url_bitly(<url>, <bit.ly login name>, <bit.ly api key>) %>
 

data/lib/karakuri.rb

@@ -6,6 +6,16 @@ require 'uri'
 # Some useful feature for toto and the likes. Basically, any ruby based blog or site.
 #
 module Karakuri
+  @link_format = '<a href="/tagged?tag={tag}" title="articles concerning {tag}">{tag}</a> '
+  @title_separator = '|'
+
+  def self.link_format(format)
+    @link_format = format
+  end
+
+  def self.title_separator(separator)
+    @title_separator = separator
+  end
   #
   # create a list of links to tagged articles, default link_format: <code>%&amp;&lt;a href=&quot;/tagged?tag=#{tag}&quot; title=&quot;articles concerning #{tag}&quot; &gt;#{tag}&lt;/a&gt; &amp;</code>
   #
@@ -14,8 +24,7 @@ module Karakuri
     tag_list = csv_to_array(csv_string)
     if tag_list
       tag_string = ""
-      #TODO pass a format via parameter
-      tag_list.each { |tag| tag_string << %&<a href="/tagged?tag=#{tag}" title="articles concerning #{tag}" >#{tag}</a> & }
+      tag_list.each { |tag| tag_string << @link_format.gsub('{tag}', tag) }
     end
     tag_string
   end
@@ -31,13 +40,12 @@ module Karakuri
   # example for toto: <code>seo_friendly_title(@path, title, "mysite.com") will produce 'subpage | mysite.com' as seo friendly page title.</code>
   #
   def Karakuri.seo_friendly_title(path, title, seo_ending)
-    #TODO use custom title separator...
        if path == 'index'
         page_title = seo_ending
        elsif path.split('/').compact.length == 4
-        page_title = title << " | #{seo_ending}"
+        page_title = title << " #{@title_separator} #{seo_ending}"
        else
-        page_title = path.capitalize.gsub(/[-]/, ' ') << " | #{seo_ending}"
+        page_title = path.capitalize.gsub(/[-]/, ' ') << " #{@title_separator} #{seo_ending}"
       end
       page_title
   end
@@ -127,3 +135,5 @@ module Karakuri
 
 end
 
+
+

metadata

@@ -1,67 +1,51 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: karakuri-bao
-version: !ruby/object:Gem::Version 
-  prerelease: false
-  segments: 
-  - 0
-  - 1
-  - 4
-  version: 0.1.4
+version: !ruby/object:Gem::Version
+  version: 0.1.5
+  prerelease: 
 platform: ruby
-authors: 
+authors:
 - Bao Pham
 autorequire: 
 bindir: bin
 cert_chain: []
-
-date: 2012-04-11 00:00:00 -07:00
-default_executable: 
+date: 2012-04-12 00:00:00.000000000 Z
 dependencies: []
-
 description: Some handy helpers for toto and the likes...
 email: gbaopham@gmail.com
 executables: []
-
 extensions: []
-
-extra_rdoc_files: 
+extra_rdoc_files:
 - README.md
 - LICENSE
-files: 
+files:
 - LICENSE
 - README.md
 - Rakefile
 - lib/karakuri.rb
 - lib/serious_blog_helper.rb
-has_rdoc: true
 homepage: http://github.com/baopham/karakuri
 licenses: []
-
 post_install_message: 
 rdoc_options: []
-
-require_paths: 
+require_paths:
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement 
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      segments: 
-      - 0
-      version: "0"
-required_rubygems_version: !ruby/object:Gem::Requirement 
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      segments: 
-      - 0
-      version: "0"
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
 requirements: []
-
 rubyforge_project: 
-rubygems_version: 1.3.6
+rubygems_version: 1.8.15
 signing_key: 
 specification_version: 3
 summary: Some handy helpers for toto and the likes...
 test_files: []
-