README_txt.html

<?xml version="1.0" encoding="iso-8859-1"?>
<!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>
  <title>File: README.txt</title>
  <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
  <meta http-equiv="Content-Script-Type" content="text/javascript" />
  <link rel="stylesheet" href=".././rdoc-style.css" type="text/css" media="screen" />
  <script type="text/javascript">
  // <![CDATA[

  function popupCode( url ) {
    window.open(url, "Code", "resizable=yes,scrollbars=yes,toolbar=no,status=no,height=150,width=400")
  }

  function toggleCode( id ) {
    if ( document.getElementById )
      elem = document.getElementById( id );
    else if ( document.all )
      elem = eval( "document.all." + id );
    else
      return false;

    elemStyle = elem.style;
    
    if ( elemStyle.display != "block" ) {
      elemStyle.display = "block"
    } else {
      elemStyle.display = "none"
    }

    return true;
  }
  
  // Make codeblocks hidden by default
  document.writeln( "<style type=\"text/css\">div.method-source-code { display: none }</style>" )
  
  // ]]>
  </script>

</head>
<body>


  <div id="fileHeader">
    <h1>README.txt</h1>
    <table class="header-table">
    <tr class="top-aligned-row">
      <td><strong>Path:</strong></td>
      <td>README.txt
      </td>
    </tr>
    <tr class="top-aligned-row">
      <td><strong>Last Update:</strong></td>
      <td>Sat Mar 22 21:53:08 -0500 2008</td>
    </tr>
    </table>
  </div>
  <!-- banner header -->

  <div id="bodyContent">


  <div id="contextContent">

    <div id="description">
      <h2>AnnotateModels</h2>
<p>
Add a comment summarizing the current schema to the top of each
ActiveRecord model source file.
</p>
<pre>
  # Schema as of Sun Feb 26 21:58:32 CST 2006 (schema version 7)
  #
  #  id                  :integer(11)   not null
  #  quantity            :integer(11)
  #  product_id          :integer(11)
  #  unit_price          :float
  #  order_id            :integer(11)
  #

  class LineItem &lt; ActiveRecord::Base
    belongs_to :product

   end
</pre>
<p>
Note that this code will blow away the initial comment block in your models
if it looks like it was previously added by annotate models, so you
don&#8216;t want to add additional text to an automatically created comment
block.
</p>
<h2>Install</h2>
<pre>
  sudo gem install annotate-models
</pre>
<h2>Usage</h2>
<pre>
  cd [your project]
  annotate
  annotate -d
  annotate -p [before|after]
  annotate -h
</pre>
<h2>Source</h2>
<pre>
  http://github.com/ctran/annotate_models
</pre>
<h2>Author</h2>
<pre>
   Dave Thomas
   Pragmatic Programmers, LLC
</pre>
<p>
Released under the same license as Ruby. No Support. No Warranty.
</p>
<h2>Modifications</h2>
<pre>
 - alex@pivotallabs.com
 - Cuong Tran - http://github.com/ctran
 - Jack Danger - http://github.com/JackDanger
 - Michael Bumann - http://github.com/bumi
</pre>

    </div>


   </div>


  </div>


    <!-- if includes -->

    <div id="section">


    <!-- if method_list -->


  </div>


<div id="validator-badges">
  <p><small><a href="http://validator.w3.org/check/referer">[Validate]</a></small></p>
</div>

</body>
</html>