LICENSE
@@ -1,4 +1,59 @@
-00Blogtags
+Blogtags
==========
-Description goes here
\ No newline at end of file
+Blogtags is a plugin for the [Radiant CMS][1] that provides some useful blogging tags. OK, for now there are just two tags. But they're really useful. Honest!
+
+`previous` and `next`
+=====================
+The `previous` and `next` tags get the previous and next siblings of the current page. You can specify which attribute to use for comparison in the `by` attribute. For example,
+
+ <r:previous by="published_at"><r:link/></r:previous>
+
+Will get the previous page according to the `published_at` date and output a link to it.
+
+Inside the `next` and `previous` tags you can use whatever page tags you like and they'll refer to the next or previous page. If your pages have a `summary` part, you could output the summary for the next page like this:
+
+ <r:next by="published_at"><r:content part="summary"/></r:next>
+
+Of course I have no idea _why_ you'd want to do that, but you could.
+
+Since this is the Blogtags plugin, the `previous` and `next` tags are designed to be used in a blog. Here's how I use the `previous` and `next` tags on [my site][2] to provide links to the previous and next blog entries:
+
+ <div class="article-nav">
+ <p><r:previous by="published_at"><r:link>« <r:title/></r:link> </r:previous><r:next
+ by="published_at"><r:link><r:title/> »</r:link></r:next></p>
+ </div>
+
+This produces HTML like
+
+ <div class="article-nav">
+ <p><a href="/articles/2006/06/06/jimmy-and-ginas-wedding/">« Jimmy and Gina's Wedding</a> <a
+ href="/articles/2006/06/22/railsconf-2006/">RailsConf 2006 »</a></p>
+ </div>
+
+When you're viewing the first page in a sequence, the `previous` tag outputs nothing. The `next` tag outputs nothing if you're at the last page in a sequence. Also, virtual pages (like "Archive Day Index" or "Page Not Found") are excluded from the page sequence, since you probably don't want to link to them this way.
+
+
+`time_ago_in_words`
+===================
+The `time_ago_in_words` tag outputs the `published_at` date of the page in natural language. For example, if it's 4:00pm and the page was published at 1:00pm the tag
+
+ <r:time_ago_in_words/>
+
+would output `about 3 hours`. I use it like this in my blog:
+
+ <p class="article-author">Posted by <r:author /> <r:time_ago_in_words /> ago</p>
+
+which outputs something like:
+
+ <p class="article-author">Posted by Sean about 3 hours ago</p>
+
+Questions?
+==========
+If you have questions, I follow the [Radiant mailing lists][3], or you can contact me through [my website][2]. Good luck!
+
+
+
+[1]: http://radiantcms.org/
+[2]: http://seansantry.com/
+[3]: http://radiantcms.org/mailing-list/
\ No newline at end of file
README
@@ -3,13 +3,14 @@ Behavior::Base.define_tags do
tag "next" do |tag|
current = tag.locals.page
by = tag.attr['by'] || 'title'
- siblings = current.self_and_siblings.sort_by { |page| page.attributes[by] }
- index = siblings.index(current)
- next_page = siblings.fetch(index += 1, siblings[0])
- while !(next_page.nil?) and next_page.behavior_id =~ /Archive/
- next_page = siblings.fetch(index += 1, siblings[0])
- end
+ # get the page's siblings, exclude any that have nil
+ # for the sorting attribute, exclude virtual pages,
+ # and sort by the chosen attribute
+ siblings = current.self_and_siblings.delete_if { |s| s.send(by).nil? || s.virtual? }.sort_by { |page| page.attributes[by] }
+ index = siblings.index(current)
+ next_page = siblings[index + 1]
+
if next_page
tag.locals.page = next_page
tag.expand
@@ -19,12 +20,12 @@ Behavior::Base.define_tags do
tag "previous" do |tag|
current = tag.locals.page
by = tag.attr['by'] || 'title'
- siblings = current.self_and_siblings.sort_by { |page| page.attributes[by] }
+ siblings = current.self_and_siblings.delete_if { |s| s.send(by).nil? || s.virtual? }.sort_by { |page| page.attributes[by] }
index = siblings.index(current)
- previous = siblings.fetch(index -= 1, nil)
- while !(previous.nil?) and previous.behavior_id =~ /Archive/
- previous = siblings.fetch(index -= 1, nil)
- end
+
+ # we don't want to wrap around to the last article
+ if index > 0 then previous = siblings[index - 1]
+ else previous = nil; end
if previous
tag.locals.page = previous
lib/00_blogtags.rb
5be8eddb8564c244a4e64f6c7acced9eae9e71c8
santry
santry@53b936e0-3221-0410-8748-df35822c787b
http://github.com/santry/blog_tags/commit/6a65eb26014ce012d9b921bfda286f8457265ab2
6a65eb26014ce012d9b921bfda286f8457265ab2
2006-11-01T14:32:16-08:00
2006-11-01T14:32:16-08:00
Added a LICENSE and content to the README
Updated next and previous to exclude virtual pages and pages that don't have the requested sorting attribute set
git-svn-id: http://seansantry.com/svn/radiant/plugins/blogtags/trunk@5 53b936e0-3221-0410-8748-df35822c787b
5b361ccb92da58b1aadfd4cb5ca3959be969712e
santry
santry@53b936e0-3221-0410-8748-df35822c787b