2008-07-18 11:34:06 -04:00
< !DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN"
"http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
< html xmlns = "http://www.w3.org/1999/xhtml" xml:lang = "en" >
< head >
< meta http-equiv = "Content-Type" content = "text/html; charset=utf-8" / >
< meta name = "microid" content = "mailto+http:sha1:566841e568e84b46c92d2291b44b836dfddc5c42" / >
2008-07-18 20:35:20 -04:00
< title > timeago: a jQuery plugin< / title >
2010-01-15 13:31:03 -05:00
< script src = "http://ajax.googleapis.com/ajax/libs/jquery/1.4/jquery.min.js" type = "text/javascript" > < / script >
2008-07-18 11:34:06 -04:00
< script src = "jquery.timeago.js" type = "text/javascript" > < / script >
2009-08-15 10:26:12 -04:00
< script src = "test/test_helpers.js" type = "text/javascript" > < / script >
2008-07-18 11:34:06 -04:00
< script type = "text/javascript" >
jQuery(document).ready(function($) {
2009-10-25 20:22:09 -04:00
prepareDynamicDates();
2010-01-27 17:30:51 -05:00
$("abbr.timeago").timeago();
2008-07-20 17:36:40 -04:00
$("#prog_date").text(jQuery.timeago(new Date()));
2008-07-20 17:49:17 -04:00
$("#prog_string").text(jQuery.timeago("2008-07-17"));
2008-07-20 17:36:40 -04:00
$("#prog_element").text(jQuery.timeago("2008-07-20"));
2008-07-18 11:34:06 -04:00
});
2008-07-20 17:36:40 -04:00
2008-07-18 11:34:06 -04:00
< / script >
< style >
* { margin: 0; padding: 0; }
body { font-family: Helvetica,Arial,sans-serif; color: #333; background-color: #ccc; font-size: 16px; line-height: 24px; }
h1 { margin: 0; font-size: 60px; line-height: 100px; text-align: center; }
h2 { margin: -30px 0 40px 50px; font-size: 20px; line-height: 20px; text-align: center; color: #999; }
h3 { margin: 24px 0 6px 0; font-size: 18px; line-height: 18px; border-bottom: 1px solid #ccc; }
h1 img { vertical-align: middle; }
p { margin: 0 0 24px 0; }
p.example { margin: 0 0 12px 0; }
p.how, p.last { margin: 0; }
ul { margin: 0 24px 24px; }
li { line-height: 24px; }
2008-07-18 15:58:26 -04:00
pre { background-color: #333; color: #fff; margin: 12px 0; font-size: 12px; padding: 0 6px; }
2008-07-18 11:34:06 -04:00
pre em { font-style: normal; background-color: #554; }
pre, tt { font-family: monaco,"courier new",mono; }
2008-07-18 15:58:26 -04:00
abbr { border-bottom: 1px dotted #333; }
2008-07-18 11:34:06 -04:00
tt { font-size: 14px; }
a { color: #06e; padding: 1px; }
2008-07-21 10:35:25 -04:00
em { font-style: normal; background-color: #feb }
2008-07-18 11:34:06 -04:00
a:hover { background-color: #06c; color: #fff; text-decoration: none; }
#content { margin:0 auto; padding: 24px; width:700px; background-color:#fff; border: 1px solid #999; border-width: 0 1px 1px 1px; }
#footer { margin:0 auto 24px; padding: 12px; width:700px; line-height: 24px; }
.help { font-size: 14px; color: #888; }
< / style >
< / head >
< body >
< div id = "content" >
< h1 > < img src = "clock.png" / > timeago< / h1 >
< h2 > a jQuery plugin< / h2 >
< h3 > What?< / h3 >
< p >
Timeago is a jQuery plugin that makes it easy to support automatically updating fuzzy
timestamps (e.g. "4 minutes ago" or "about 1 day ago"). < a href = "jquery.timeago.js" > Download< / a > , view
the examples, and enjoy.
< / p >
2009-10-25 20:22:09 -04:00
< noscript > < p class = "example" > < strong > Turn on javascript, loser!< / strong > < / p > < / noscript >
2008-07-18 11:34:06 -04:00
< p class = "example" >
2009-10-25 20:22:09 -04:00
You opened this page < abbr class = "loaded timeago" > when you opened the page< / abbr > . < span class = "help" > (This will update every minute. Wait for it.)< / span >
2008-07-18 11:34:06 -04:00
< / p >
< p class = "example" >
2008-07-18 16:16:37 -04:00
This page was last modified < abbr class = "modified timeago" > sometime before now [browser might not support document.lastModified]< / abbr > .
2008-07-18 11:34:06 -04:00
< / p >
< p class = "example" >
Ryan was born < abbr class = "timeago" title = "1978-12-18T17:17:00Z" > Dec 18, 1978< / abbr > .
< / p >
2008-07-20 17:36:40 -04:00
< h3 > Why?< / h3 >
2008-08-20 15:38:25 -04:00
< p > Timeago was originally built for use with < a href = "http://yarp.com" > Yarp.com< / a > to timestamp comments.< / p >
2008-07-20 17:36:40 -04:00
< ul >
2009-02-12 18:25:16 -05:00
< li > Avoid timestamps dated "1 minute ago" even though the page was opened 10 minutes ago; < em > timeago refreshes automatically< / em > .< / li >
2008-07-21 10:35:25 -04:00
< li > You can < em > take full advantage of page caching< / em > in your web applications, because the timestamps aren't calculated on the server.< / li >
2009-07-17 14:08:53 -04:00
< li > You get to < em > use < a href = "http://microformats.org/wiki/datetime-design-pattern" > microformats< / a > < / em > like the cool kids.< / li >
2008-07-20 17:36:40 -04:00
< / ul >
2008-07-18 11:34:06 -04:00
< h3 > How?< / h3 >
< p class = "how" >
First, load < a href = "http://jquery.com/" > jQuery< / a > and the plugin:
< / p >
< pre >
2008-07-18 15:58:26 -04:00
< script src=" jquery.min.js" type=" text/javascript" > < /script>
< script src=" jquery.timeago.js" type=" text/javascript" > < /script> < / pre >
2008-07-18 11:34:06 -04:00
< p class = "how" >
Now, let's attach it to your timestamps on DOM ready:
< / p >
< pre >
2008-07-18 15:58:26 -04:00
jQuery(document).ready(function() {
2010-01-27 17:30:51 -05:00
jQuery("abbr.timeago").timeago();
2008-07-18 15:58:26 -04:00
});< / pre >
2008-07-18 11:34:06 -04:00
< p class = "how" >
This will turn all < tt > abbr< / tt > elements with a class
of < tt > timeago< / tt > and an < a href = "http://en.wikipedia.org/wiki/ISO_8601" > ISO 8601< / a > timestamp in the title:
< / p >
< pre >
2008-07-18 15:58:26 -04:00
< abbr class=" < em > timeago< / em > " title=" < em > 2008-07-17T09:24:17Z< / em > " > July 17, 2008< /abbr> < / pre >
2008-07-18 11:34:06 -04:00
< p class = "how" >
into something like this:
< / p >
< pre >
2009-10-31 09:12:32 -04:00
< abbr class=" timeago" title=" July 17, 2008" > < em > < abbr class = "timeago" title = "2008-07-17T09:24:17Z" > time ago< / abbr > < / em > < /abbr> < / pre >
2008-07-18 17:57:03 -04:00
< p >
which yields: < abbr class = "timeago" title = "2008-07-17T09:24:17Z" > July 17, 2008< / abbr > . As time passes, the timestamps will automatically update.
2008-07-18 11:34:06 -04:00
< / p >
2008-07-20 17:36:40 -04:00
< p class = "how" >
You can also use it programmatically:
< / p >
< pre >
2008-07-20 17:49:17 -04:00
jQuery.timeago(new Date()); //=> " < span id = "prog_date" > < / span > "
jQuery.timeago("2008-07-17"); //=> " < span id = "prog_string" > < / span > "
jQuery.timeago(jQuery("abbr#some_id")); //=> " < span id = "prog_element" > < / span > " // [title=" 2008-07-20" ]< / pre >
2008-07-18 11:34:06 -04:00
2008-08-06 07:04:15 -04:00
< p class = "how" >
To support timestamps in the future, use the < tt > allowFuture< / tt > setting:
< / p >
< pre >
jQuery.timeago.settings.allowFuture = true;< / pre >
2008-08-20 10:04:33 -04:00
< h3 > Excusez-moi?< / h3 >
< p >
Yes, timeago has locale/i18n/language support. Here are some < a href = "http://gist.github.com/6251" > configuration examples< / a > . Email < a href = "http://ryan.mcgeary.org" > Ryan McGeary< / a > for corrections or additional languages.
< / p >
2008-07-18 21:08:45 -04:00
< h3 > Where?< / h3 >
< p > < a href = "jquery.timeago.js" > Download the " stable" release< / a > .< / p >
< p >
The code is hosted on
2008-08-05 15:45:20 -04:00
GitHub: < a href = "http://github.com/rmm5t/jquery-timeago" > http://github.com/rmm5t/jquery-timeago< / a > .
2008-07-18 21:08:45 -04:00
Go on, live on the edge.
< / p >
2008-07-18 11:34:06 -04:00
< h3 > Who?< / h3 >
< p >
Timeago was built by < a href = "http://ryan.mcgeary.org" > Ryan McGeary< / a >
2009-02-07 10:59:11 -05:00
(< a href = "http://twitter.com/rmm5t" > @rmm5t< / a > ) while standing on the
shoulders of giants. John Resig wrote about
2008-07-18 11:34:06 -04:00
a < a href = "http://ejohn.org/blog/javascript-pretty-date/" > similar
approach< / a > . The verbiage was based on
the < tt > distance_of_time_in_words< / tt > ActionView helper
in < a href = "http://rubyonrails.org" > Ruby on Rails< / a > .
< / p >
2008-07-18 21:08:45 -04:00
< h3 > When?< / h3 >
2008-07-18 17:00:35 -04:00
< p >
2008-07-18 21:08:45 -04:00
Timeago was conceived < abbr class = "timeago" title = "2008-07-17T02:30:00-0500" > on July 17, 2008< / abbr > . < span class = "help" > (Yup, that's powered by timeago too)< / span >
2008-07-18 17:00:35 -04:00
< / p >
2009-10-25 20:41:41 -04:00
< h3 > What else?< / h3 >
< p class = "example" >
HTML5 has a new < tt > time< / tt > tag and timeago supports it too.
< / p >
< pre >
< time class=" < em > timeago< / em > " datetime=" < em > 2008-07-17T09:24:17Z< / em > " > July 17, 2008< /time> < / pre >
< p class = "how" >
Attach timeago like so:
< / p >
< pre >
jQuery(document).ready(function() {
2010-01-27 17:30:51 -05:00
jQuery("time.timeago").timeago();
2009-10-25 20:41:41 -04:00
});< / pre >
2008-07-19 12:08:43 -04:00
< h3 > Huh?< / h3 >
2008-07-18 11:34:06 -04:00
< p class = "last" >
2008-07-18 21:08:45 -04:00
Need a Rails helper to make those fancy microformat < tt > abbr< / tt > tags? Fine, here ya go:
2008-07-18 11:34:06 -04:00
< / p >
2008-07-18 21:08:45 -04:00
< pre >
def timeago(time, options = {})
options[:class] ||= "timeago"
content_tag(:abbr, time.to_s, options.merge(:title => time.getutc.iso8601)) if time
end< / pre >
2008-07-18 11:34:06 -04:00
< / div >
< div id = "footer" >
< div style = "float:right;" >
< a href = "http://www.opensource.org/licenses/mit-license.php" > MIT
License< / a >
< / div >
2010-01-02 22:30:20 -05:00
Copyright © 2008-2010 < a href = "http://ryan.mcgeary.org" > Ryan McGeary< / a >
2009-02-07 10:59:11 -05:00
(< a href = "http://twitter.com/rmm5t" > @rmm5t< / a > )
2008-07-18 11:34:06 -04:00
< / div >
2009-01-02 09:34:22 -05:00
< a href = "http://github.com/rmm5t/jquery-timeago" > < img style = "position: absolute; top: 0; right: 0; border: 0;" src = "http://s3.amazonaws.com/github/ribbons/forkme_right_orange_ff7600.png" alt = "Fork me on GitHub" / > < / a >
2008-07-18 11:34:06 -04:00
< script type = "text/javascript" >
var gaJsHost = (("https:" == document.location.protocol) ? "https://ssl." : "http://www.");
document.write(unescape("%3Cscript src='" + gaJsHost + "google-analytics.com/ga.js' type='text/javascript'%3E%3C/script%3E"));
< / script >
< script type = "text/javascript" >
var pageTracker = _gat._getTracker("UA-2856277-2");
pageTracker._initData();
pageTracker._trackPageview();
< / script >
< / body >
< / html >
