@@ -1,15 +1,10 @@
README for ajax-rdoc - the javascript enhanced rdoc template
-The files included in this first release allow you to create a javascript enhanced rdoc (similar to what is on www.railsbrain.com right now).
+This template creates a javascript enhanced rdoc (similar to what is on http://www.railsbrain.com ).
-Switch over to the directory where you want to run this rdoc template
-rdoc --fmt ajax
-
-Some shortcuts
-=======
== Installation
-1) Get the files
+1) Get the files (pick your flavor)
* tarball: http://github.com/breakpointer/ajax-rdoc/tarball/master)
* git: git clone git://github.com/breakpointer/ajax-rdoc.git
@@ -24,16 +19,21 @@ Some shortcuts
5) This should start the generator and you'll have your new rdoc template in no-time! It should be in a folder called "doc"
-alias jaxdoc="rdoc --fmt ajax --exclude .*generator.* --exclude .*test.* --exclude .*spec.*"
+For a shortcut you might try adding this to your .bash_profile
+>alias ajaxrdoc="rdoc --fmt ajax --exclude .*generator.* --exclude .*test.* --exclude .*spec.*"
+
+Thanks to:
+Tien Dung (http://github.com/tiendung) for a neat title insertion hack. The title of your rails documentation is pulled from the
+directory name (with some humanizing). For example, standing in this directory /blah/ruby/rails-2.1.0 and running rdoc --fmt ajax
+will create a title "Rails 2.1.0" for the generated documentation pages.
-References
+John Nunemaker (http://github.com/jnunemaker) for the addition of the installation rake task.
+Also, for the very nice QuickSilver search failover if an exact name match is not found. Very nice indeed!
-http://github.com/breakpointer/ajax-rdoc/tree/master/README
=======
-Thanks!
-Brian
Alternatively you can set this env var and run the documentation generator from anywhere (ie your home dir)
-export RUBYLIB=~/Usersbrian/rails/src/ajax-rdoc (for example)
+>export RUBYLIB=~/Usersbrian/rails/src/ajax-rdoc (for example)
README
@@ -185,7 +185,7 @@ ul#groupType li.activeLi{
}
#listScroller ul{
- width: 500px;
+ width: 600px;
padding:0px;
margin:0px;
list-style: none;
@@ -195,7 +195,7 @@ ul#groupType li.activeLi{
padding: 0px;
margin: 0px;
display: block;
- line-height: 1em;
+ line-height: 1.1em;
}
#listScroller a{
@@ -431,9 +431,6 @@ CLASS_PAGE = <<HTML
In:
START:infiles
<a href="#" onclick="jsHref('%full_path_url%');">%full_path%</a>
-IF:cvsurl
- (<a href="#" onclick="jsHref('%cvsurl%');">CVS</a>)
-ENDIF:cvsurl
END:infiles
IF:parent
@@ -600,8 +597,6 @@ END:sections
HTML
-
-
BODY = <<ENDBODY
!INCLUDE! <!-- banner header -->
@@ -630,11 +625,7 @@ FILE_PAGE = <<HTML
<table class="header-table">
<tr class="top-aligned-row">
<td><strong>Path:</strong></td>
- <td>%full_path%
-IF:cvsurl
- (<a href="%cvsurl%"><acronym title="Concurrent Versioning System">CVS</acronym></a>)
-ENDIF:cvsurl
- </td>
+ <td>%full_path%</td>
</tr>
<tr class="top-aligned-row">
<td><strong>Last Update:</strong></td>
rdoc/generators/template/ajax/ajax.rb
71309a4e3fd9c50f47a05e83a16f68f0887fc01a
Brian
blchamberlain@cifra.local
http://github.com/breakpointer/ajax-rdoc/commit/8c135c29e3d986839eb141c2b5103d76ad05ed3d
8c135c29e3d986839eb141c2b5103d76ad05ed3d
2008-10-04T12:30:34-07:00
2008-10-04T12:30:34-07:00
Readme updates and a small css tweak
cb9d95796840e355b6edab2e81f80a6809f109cd
Brian
blchamberlain@cifra.local