doc/file.README.html in attrtastic-0.2.2 vs doc/file.README.html in attrtastic-0.3.0
- old
+ new
@@ -1,11 +1,11 @@
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
- <meta name="Content-Type" content="text/html; charset=UTF-8" />
-<title>Documentation by YARD 0.5.3</title>
+ <meta name="Content-Type" content="text/html; charset=utf-8" />
+<title>Documentation by YARD 0.6.3</title>
<link rel="stylesheet" href="css/style.css" type="text/css" media="screen" charset="utf-8" />
<link rel="stylesheet" href="css/common.css" type="text/css" media="screen" charset="utf-8" />
<script type="text/javascript" charset="utf-8">
relpath = '';
@@ -41,46 +41,49 @@
<iframe id="search_frame"></iframe>
<div id="content"><div id='filecontents'><h1>Attrtastic</h1>
-<p>Attrtastic, in its assumtion, should be similar in usage to formtastic and
-ease of displaying AR record informations (attributes). It should help
-scafforld show/index pages.</p>
+<p>Attrtastic is simple view helper which can be used to create index/show pages
+for any objects (for example Active Model objects). It helps you display
+all present attributes of object.</p>
+<p>If you need compatibility with Rails 2.x, then please install version 0.2.2 of
+this gem.</p>
+
<h2>Using</h2>
<p>Install the gem:</p>
<pre class="code"><span class='id gem'>gem</span> <span class='id install'>install</span> <span class='id attrtastic'>attrtastic</span>
</pre>
-<p>Add to <code>config.rb</code> as dependency:</p>
+<p>Add to your <code>Gemfile</code>:</p>
-<pre class="code"><span class='id config'>config</span><span class='period'>.</span><span class='id gem'>gem</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>attrtastic</span><span class='tstring_end'>'</span></span>
+<pre class="code"><span class='id gem'>gem</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>attrtastic</span><span class='tstring_end'>"</span></span>
</pre>
<p>And use in your views, for example in user/show.erb</p>
-<pre class="code"><% semantic_attributes_for @user do |attr| %>
- <% attr.attributes "User" do %>
+<pre class="code"><%= semantic_attributes_for @user do |attr| %>
+ <%= attr.attributes "User" do %>
<%= attr.attribute :first_name %>
<%= attr.attribute :last_name %>
- <% attr.attribute :avatar do %>
+ <%= attr.attribute :avatar do %>
<%= image_tag @user.avatar.url %>
- <% end %>
+ <% end %>
<% end %>
- <% attr.attributes "Contact" do %>
+ <%= attr.attributes "Contact" do %>
<%= attr.attribute :email %>
<%= attr.attribute :tel %>
<%= attr.attribute :fax %>
<% end %>
<% end %>
</pre>
-<p>By default attributes which returns #blank? value are ommited, unless
-<code>:display_blank => true</code> is added to #attribute.</p>
+<p>By default attributes which returns <code>#blank?</code> value are ommited, unless
+<code>:display_blank => true</code> is added to <code>#attribute</code>.</p>
<h2>Note on Patches/Pull Requests</h2>
<ul>
<li>Fork the project.</li>
@@ -93,15 +96,15 @@
</ul>
<h2>Copyright</h2>
-<p>Copyright (c) 2009 Boruta Miroslaw. See LICENSE for details.</p></div></div>
+<p>Copyright (c) 2009-2010 Boruta Miroslaw. See LICENSE for details.</p></div></div>
<div id="footer">
- Generated on Fri Jan 15 21:15:12 2010 by
- <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool">yard</a>
- 0.5.3 (ruby-1.9.1).
+ Generated on Fri Dec 3 21:43:44 2010 by
+ <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
+ 0.6.3 (ruby-1.9.2).
</div>
</body>
</html>
\ No newline at end of file