doc/rdoc/files/README.html in gem_plugin-0.2.1 vs doc/rdoc/files/README.html in gem_plugin-0.2.2
- old
+ new
@@ -54,11 +54,11 @@
<td>README
</td>
</tr>
<tr class="top-aligned-row">
<td><strong>Last Update:</strong></td>
- <td>Mon Mar 06 00:33:03 EST 2006</td>
+ <td>Fri Jun 30 12:43:01 -0700 2006</td>
</tr>
</table>
</div>
<!-- banner header -->
@@ -79,51 +79,46 @@
</p>
<p>
<a href="../classes/GemPlugin.html">GemPlugin</a> works by listing the gems
installed, and doing a require_gem on any that have the right dependencies.
For example, if a gem depends on "gem_plugin" and
-"mongrel" then it’ll load as a Mongrel plugin. This makes
+"mongrel" then it‘ll load as a Mongrel plugin. This makes
it so that users of the plugins only need to gem install (and maybe config
a bit), and plugin authors only need to make gems.
</p>
<h2>Implementers</h2>
<p>
To use <a href="../classes/GemPlugin.html">GemPlugin</a> in your system you
-only have to require ‘gem_plugin’ and then use the <a
-href="../classes/GemPlugin/Manager.html#M000008">GemPlugin::Manager.create</a>,
-<a
-href="../classes/GemPlugin/Manager.html#M000006">GemPlugin::Manager.load</a>,
-and GemPlugin::Manager.available methods to work with them.
+only have to require ‘gem_plugin’ and then use the
+GemPlugin::Manager.create, GemPlugin::Manager.load, and
+GemPlugin::Manager.available methods to work with them.
</p>
<ul>
-<li><a
-href="../classes/GemPlugin/Manager.html#M000006">GemPlugin::Manager.load</a>
-— Takes a "depend include/exclude map" and loads plugins
-based on it.
+<li>GemPlugin::Manager.load — Takes a "depend include/exclude
+map" and loads plugins based on it.
</li>
-<li><a
-href="../classes/GemPlugin/Manager.html#M000008">GemPlugin::Manager.create</a>
-— Takes a URI style name and some options then creates one for you.
+<li>GemPlugin::Manager.create — Takes a URI style name and some options
+then creates one for you.
</li>
<li>GemPlugin::Manager.available — Lets you inspect and mess with the
internal plugin registry.
</li>
</ul>
<h3>Loading Plugins</h3>
<p>
-As an example from Mongrel it’s necessary to load plugins that depend
+As an example from Mongrel it‘s necessary to load plugins that depend
on rails after the Rails system is configured, but load other plugins right
when Mongrel is ready. To do this we very first do:
</p>
<pre>
GemPlugin::Manager.instance.load "mongrel" => GemPlugin::INCLUDE, "rails" => GemPlugin::EXCLUDE
</pre>
<p>
-Later, when it’s ready to load Rails plugins as well we do this:
+Later, when it‘s ready to load Rails plugins as well we do this:
</p>
<pre>
GemPlugin::Manager.instance.load "mongrel" => GemPlugin::INCLUDE
</pre>
<p>
@@ -135,36 +130,36 @@
</p>
<pre>
plug = GemPlugin::Manager.instance.create("/commands/snazzy", "something" => "yeah")
</pre>
<p>
-In this case we’re making the snazzy command and passing a couple
+In this case we‘re making the snazzy command and passing a couple
fake options.
</p>
<h3>Finding Available Plugins</h3>
<p>
Finding plugins is also very easy, you just call
GemPlugin::Manager.instance.available and you get a Hash that maps
categories to name => class. For example, if I had the
-"/commands/snazzy" plugin registered above, then I’d get
+"/commands/snazzy" plugin registered above, then I‘d get
the following:
</p>
<pre>
puts GemPlugin::Manager.instance.available["/commands"].inspect
-> { "/snazzy" => Snazzy}
</pre>
<h3>Plugins Inside Modules</h3>
<p>
Plugins that are placed in modules are also lowercased when registered but
still retain their module. So, if Snazzy was actually MyModule::Snazzy,
-then it’d be registered as "/commands/mymodule::snazzy".
+then it‘d be registered as "/commands/mymodule::snazzy".
</p>
<h2>Plugin Authors</h2>
<p>
People who wish to write gem plugins have a faily easy time of it, but need
to know the particular rules for the target system. To keep this example
-concrete we’ll assume you want to write a Mongrel command plugin.
+concrete we‘ll assume you want to write a Mongrel command plugin.
</p>
<p>
First thing is create your project like normal and setup Rake to make your
gem. Your plugin then needs to be created like so:
</p>
@@ -208,11 +203,11 @@
they get the plugin automagically.
</p>
<p>
People writing GemPlugins for other systems would have to check the
documentation from that project to get an idea of what extra requirements
-might be needed. For example, you’d probably have to depend on
+might be needed. For example, you‘d probably have to depend on
another project other that <b>mongrel</b> and most likely have a few more
things to configure in your init.rb.
</p>
<h2>Plugin Users</h2>
<p>
@@ -220,20 +215,20 @@
</p>
<pre>
gem install mongrel_command_snazzy
</pre>
<p>
-And that’s it. When they run mongrel_rails (given the above example)
+And that‘s it. When they run mongrel_rails (given the above example)
this snazzy command get loaded automatically without any intervention.
</p>
<p>
The only thing missing in this release is a way for end users to configure
such a plugin. I really think this is the job of the implementers to
define.
</p>
<h2>Contact</h2>
<p>
-E-mail zedshaw at zedshaw.com and I’ll help. Comments about the API
+E-mail zedshaw at zedshaw.com and I‘ll help. Comments about the API
are welcome.
</p>
</div>
\ No newline at end of file