public
Description: Every Rails page has footnotes that link give request information and link back to your source via TextMate [extracted from Rails TextMate bundle project]
Clone URL: git://github.com/drnic/rails-footnotes.git
Updated README
josevalim (author)
Sun Jun 08 10:38:57 -0700 2008
commit  aeeb0b53aa19ca7060a6ef1982277ef662e6d818
tree    2928fad9a278b5bc3956fc6c351abf6e42a1733f
parent  d8803acbf9c26c24ad48c4619cc54ba694ca1564
...
33
34
35
36
37
 
 
38
39
40
41
 
 
42
43
44
45
 
46
47
48
...
50
51
52
53
 
 
 
54
55
56
...
33
34
35
 
 
36
37
38
39
40
 
41
42
43
44
45
 
46
47
48
49
...
51
52
53
 
54
55
56
57
58
59
0
@@ -33,16 +33,17 @@ If you are running on Rails 2.0.x or Rails 1.x, you should use Footnotes v3.0:
0
 
0
 Remember that in Rails 1.x, after filters appear first than before filters in the Filters tab.
0
 
0
-Usage notes
0
-===========
0
+Usage
0
+=====
0
 
0
 * Footnotes are applied in all actions under development. If You want to change this behaviour, check the initializer.rb file.
0
 
0
-* Some features only work if you are under MacOSX. But if your editor support opening files like Textmate, e.g. txmt://open?url=file://, you can put in your environment file the following line:
0
+* Some features only work by default if you are under MacOSX and using Textmate.
0
+ If your editor supports out-of-the-box opening files like Textmate, e.g. txmt://open?url=file://path/to/file, you can put in your environment file the following line:
0
 
0
   Footnotes::Filter.prefix = "editor://open?file://"
0
 
0
- Another option is to automatically register the protocol in your browser and/or OS. More information [here](http://kb.mozillazine.org/Register_protocol).
0
+ If it doesn't, you can enable this behavior in few steps. I've written a post about it [here](http://josevalim.blogspot.com/2008/06/textmate-protocol-behavior-on-any.html).
0
 
0
 * If you want to use your own stylesheet, you can disable the Footnotes stylesheet with:
0
 
0
@@ -50,7 +51,9 @@ Usage notes
0
 
0
 * Footnotes are appended at the end of the page, but if your page has a div with id "footnotes_holder", Footnotes will be inserted into this div.
0
 
0
-* If you want to open multiple notes at the same time, set Footnotes::Filter.multiple_notes = true
0
+* If you want to open multiple notes at the same time, just put in your enviroment:
0
+
0
+ Footnotes::Filter.multiple_notes = true
0
 
0
 * Finally, you can cherry pick which notes you want to use, simply doing:
0
 

Comments

    No one has commented yet.