Updated Plugins Guide - questions and RFT

[Ian Clatworthy]

Neil Martinsen-Burrell wrote:

> One problem with the css from Sphinx is apparently that code blocks as
> one gets with the double-colon don't have a distinct style.  See
> http://doc.bazaar-vcs.org/plugins/en/automirror-plugin.html where the
> line starting "echo..." is a preformatted block.

Add a space (or two) before echo and the formatting will work. The doc
for many plugins needs this done.

> I've updated bzr-automirror according to your suggestions.  I feel as if
> I'm duplicating a great deal of content between README.txt and
> __init__.py.  As a plugin author yourself, do you have any suggestion on
> how to manage the problem?

I put the information in __init__.py and tell them in the README to run

  bzr help xxx

E.g.

  bzr help autommirror

As long as the plugin name doesn't exactly match a command name, that
will work. If it does clash, then you need

  bzr help plugins/xxx

instead. You can also reference the Guide's HTML page for your plugin in
your README. The URLs should be stable and readable.

Ian C.