<?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: index.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>index.txt</h1>
<table class="header-table">
<tr class="top-aligned-row">
<td><strong>Path:</strong></td>
<td>website/index.txt
</td>
</tr>
<tr class="top-aligned-row">
<td><strong>Last Update:</strong></td>
<td>Sat Mar 22 21:56:42 -0500 2008</td>
</tr>
</table>
</div>
<!-- banner header -->
<div id="bodyContent">
<div id="contextContent">
<div id="description">
<p>
h1. annotate-models
</p>
<p>
h1. &x2192; ‘annotate-models‘
</p>
<p>
h2. What
</p>
<p>
h2. Installing
</p>
<p>
<pre syntax="ruby">
</p>
<pre>
sudo gem install annotate-models
</pre>
<p>
</pre>
</p>
<p>
h2. The basics
</p>
<p>
Add a comment summarizing the current schema to the top of each
ActiveRecord model source file.
</p>
<p>
This was created by Dave Thomas as a Rails plugin. This is now a gem that
can run from command line
</p>
<p>
h2. Demonstration of usage
</p>
<p>
Go to your project dir (RAILS_ROOT), then run: <tt>annotate</tt>
</p>
<p>
To remove annotations: <tt>annotate -d</tt>
</p>
<p>
To add annotations at the end of files: <tt>annotate -p after</tt>
</p>
<p>
h2. How to submit patches
</p>
<p>
See "Using Git within a project":<a
href="http://drnicwilliams.com/2008/02/03/using-git-within-a-team">drnicwilliams.com/2008/02/03/using-git-within-a-team</a>/
</p>
<p>
The trunk repository is <tt><a
href="http://github.com/ctran/annotate_models">github.com/ctran/annotate_models</a></tt>
</p>
<p>
A svn mirror is on rubyforge
<tt>svn://rubyforge.org/var/svn/annotate-models/trunk</tt>
</p>
<p>
h2. License
</p>
<p>
This code is free to use under the terms of the MIT license.
</p>
<p>
h2. Contact
</p>
<p>
Comments are welcome. Send an email to "Cuong Tran":<a
href="mailto:ctran@pragmaquest.com">ctran@pragmaquest.com</a>
</p>
</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>