NTimeLine

Get Version

0.1.0

What

NTimeLine is a wrapper library for @nifty TimeLine. You can show/search/create/modify/delete timelines and articles.

Installing

sudo gem install ntimeline

API document

The basics

timeline

show

TimeLine.show(id)

create

TimeLine.create(:timeline_key => $timeline_key,
                :title => "NTimeLine TEST",
                :description => "This is a test for NTimeLine.",
                :label_for_vaxis => "dummy",
                :initial_position => "last",
                :category => "TimeLine")

modify

timeline.modify(:title => "modified")
timeline.title # => modified

delete

# Articles in the timeline are deleted if the argument is true.
timeline.delete(true)

search

pager = Timeline.search_by_owner("keita.yamaguchi")
list = []
while pager do
  list += pager.timelines
  pager = pager.next
end

article

create

timeline.create_article(:title => "NTimeLine test",
                        :description => "This is a test for NTimeLine library.",
                        :label_for_vaxis => "dummy")

modify

article.modify(:title => "modified")
article.title # => modified

delete

article.delete

search

pager = article.search_by_timeline_id(timeline.id)
# or timeline.search_articles
list = []
while pager do
  list += pager.articles
  pager = pager.next
end

Forum

http://groups.google.com/group/ntimeline

How to submit patches

Read the 8 steps for fixing other people’s code and for section 8b: Submit patch to Google Groups, use the Google Group above.

The trunk repository is svn://rubyforge.org/var/svn/ntimeline/trunk for anonymous access.

License

This code is free to use under the terms of the Ruby license.

Links

Contact

Comments are welcome. Send an email to Keita Yamaguchi or the forum

Keita Yamaguchi, 30th December 2007
Theme extended from Paul Battley