ctran / annotate_models fork watch download tarball
public
Description: Annotate ActiveRecord models as a gem
Homepage: http://agilewebdevelopment.com/plugins/annotate_models
Clone URL: git://github.com/ctran/annotate_models.git 
Push a new version 1.0.3 out to rubyforge
ctran (author)
Fri May 02 21:25:35 -0700 2008
commit  753091c5623cdce5a58daf97e5448dec8acbdb2a
tree    a16d4acad3c049e19755618500b3618759c2740d
parent  8c8c3c58055c8659da55f5cc130552204f469dfd
annotate_models / website / index.html
100644 106 lines (65 sloc) 2.925 kb
raw history 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
  <link rel="stylesheet" href="stylesheets/screen.css" type="text/css" media="screen" />
  <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
  <title>
      annotate-models
  </title>
  <script src="javascripts/rounded_corners_lite.inc.js" type="text/javascript"></script>
<style>
 
</style>
  <script type="text/javascript">
    window.onload = function() {
      settings = {
          tl: { radius: 10 },
          tr: { radius: 10 },
          bl: { radius: 10 },
          br: { radius: 10 },
          antiAlias: true,
          autoPad: true,
          validTags: ["div"]
      }
      var versionBox = new curvyCorners(settings, document.getElementById("version"));
      versionBox.applyCornersToAll();
    }
  </script>
</head>
<body>
<div id="main">
 
    <h1>annotate-models</h1>
    <div id="version" class="clickable" onclick='document.location = "http://rubyforge.org/projects/annotate-models"; return false'>
      <p>Get Version</p>
      <a href="http://rubyforge.org/projects/annotate-models" class="numbers">1.0.3</a>
    </div>
    <h1>&#x2192; &#8216;annotate-models&#8217;</h1>
 
 
  <h2>What</h2>
 
 
  <h2>Installing</h2>
 
 
  <p><pre class='syntax'>
  <span class="ident">sudo</span> <span class="ident">gem</span> <span class="ident">install</span> <span class="ident">annotate</span><span class="punct">-</span><span class="ident">models</span>
</pre></p>
 
 
  <h2>The basics</h2>
 
 
  <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>
 
 
  <h2>Demonstration of usage</h2>
 
 
  <p>Go to your project dir (RAILS_ROOT), then run: <code>annotate</code></p>
 
 
  <p>To remove annotations: <code>annotate -d</code></p>
 
 
  <p>To add annotations at the end of files: <code>annotate -p after</code></p>
 
 
  <h2>How to submit patches</h2>
 
 
  <p>See <a href="http://drnicwilliams.com/2008/02/03/using-git-within-a-team/">Using Git within a project</a></p>
 
 
  <p>The trunk repository is <code>http://github.com/ctran/annotate_models</code></p>
 
 
  <p>A svn mirror is on rubyforge <code>svn://rubyforge.org/var/svn/annotate-models/trunk</code></p>
 
 
  <h2>License</h2>
 
 
  <p>This code is free to use under the terms of the <span class="caps">MIT</span> license.</p>
 
 
  <h2>Contact</h2>
 
 
  <p>Comments are welcome. Send an email to <a href="mailto:ctran@pragmaquest.com">Cuong Tran</a></p>
    <p class="coda">
      <a href="http://www.pragmaquest.com">Cuong Tran</a>, 2nd May 2008<br>
      Theme extended from <a href="http://rb2js.rubyforge.org/">Paul Battley</a>
    </p>
</div>
 
<!-- insert site tracking codes here, like Google Urchin -->
 
</body>
</html>