@@ -33,16 +33,17 @@ If you are running on Rails 2.0.x or Rails 1.x, you should use Footnotes v3.0: Remember that in Rails 1.x, after filters appear first than before filters in the Filters tab. -Usage notes -=========== +Usage +===== * Footnotes are applied in all actions under development. If You want to change this behaviour, check the initializer.rb file. -* 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: +* Some features only work by default if you are under MacOSX and using Textmate. + 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: Footnotes::Filter.prefix = "editor://open?file://" - Another option is to automatically register the protocol in your browser and/or OS. More information [here](http://kb.mozillazine.org/Register_protocol). + 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). * If you want to use your own stylesheet, you can disable the Footnotes stylesheet with: @@ -50,7 +51,9 @@ Usage notes * 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. -* If you want to open multiple notes at the same time, set Footnotes::Filter.multiple_notes = true +* If you want to open multiple notes at the same time, just put in your enviroment: + + Footnotes::Filter.multiple_notes = true * Finally, you can cherry pick which notes you want to use, simply doing: README.markdown d8803acbf9c26c24ad48c4619cc54ba694ca1564 josevalim jose.valim@gmail.com http://github.com/mhartl/rails-footnotes/commit/aeeb0b53aa19ca7060a6ef1982277ef662e6d818 aeeb0b53aa19ca7060a6ef1982277ef662e6d818 2008-06-08T10:38:57-07:00 2008-06-08T10:38:57-07:00 Updated README 2928fad9a278b5bc3956fc6c351abf6e42a1733f josevalim jose.valim@gmail.com