Skip to content

Commit

Permalink
plugins guide: rewords a paragraph and revises some typography
Browse files Browse the repository at this point in the history
  • Loading branch information
fxn committed Feb 23, 2010
1 parent 17596be commit cadd593
Showing 1 changed file with 5 additions and 5 deletions.
10 changes: 5 additions & 5 deletions railties/guides/source/plugins.textile
Original file line number Original file line Diff line number Diff line change
Expand Up @@ -1333,15 +1333,15 @@ yaffle:squawk # Prints out the word 'Yaffle'


You can add as many files as you want in the tasks directory, and if they end in .rake Rails will pick them up. You can add as many files as you want in the tasks directory, and if they end in .rake Rails will pick them up.


Note that tasks from 'vendor/plugins/yaffle/Rakefile' are not available to the main app. Note that tasks from +vendor/plugins/yaffle/Rakefile+ are not available to the main app.


h3. PluginGems h3. Plugins as Gems


Turning your rails plugin into a gem is a simple and straightforward task. This section will cover how to turn your plugin into a gem. It will not cover how to distribute that gem. Turning your rails plugin into a gem is a simple and straightforward task. This section will cover how to turn your plugin into a gem. It will not cover how to distribute that gem.


Historically rails plugins loaded the plugin's 'init.rb' file. In fact some plugins contain all of their code in that one file. To be compatible with plugins, 'init.rb' was moved to 'rails/init.rb'. The initialization file has to be called +rails/init.rb+, the root +init.rb+ file, if any, is ignored by Rails. Also, the name of the plugin now is relevant since +config.gem+ tries to load it. Either name the main file after your gem, or document that users should use the +:lib+ option.


It's common practice to put any developer-centric rake tasks (such as tests, rdoc and gem package tasks) in 'Rakefile'. A rake task that packages the gem might look like this: It's common practice to put any developer-centric rake tasks (such as tests, rdoc and gem package tasks) in +Rakefile+. A rake task that packages the gem might look like this:


* *vendor/plugins/yaffle/Rakefile:* * *vendor/plugins/yaffle/Rakefile:*


Expand Down Expand Up @@ -1383,7 +1383,7 @@ rake gem
sudo gem install pkg/yaffle-0.0.1.gem sudo gem install pkg/yaffle-0.0.1.gem
</shell> </shell>


To test this, create a new rails app, add 'config.gem "yaffle"' to environment.rb and all of your plugin's functionality will be available to you. To test this, create a new rails app, add +config.gem "yaffle"+ to +config/environment.rb+ and all of your plugin's functionality will be available to you.


h3. RDoc Documentation h3. RDoc Documentation


Expand Down

0 comments on commit cadd593

Please sign in to comment.