On Nov 30, 2009, at 5:47 AM, Owen Winkler wrote:

> rick c wrote:
>>> 
>>> I have two questions:
>>> - How do the 'main' and 'secondary' name attributes apply in real life?
>> 
>> I'd be interested in the answer to this, too.
> 
> The intent is to allow a plugin to display different help when you click 
> on the ? button depending on what's being displayed in the plugin 
> configuration, and to allow a plugin the potential to provide links in 
> the initial help to other "pages" of help that provide more details for 
> complex operations.
> 
> This would be particularly helpful for plugins like the podcast plugin, 
> which has multiple options in its dropdown, and each displays a 
> different form.  By supplying a different set of help to each page, you 
> wouldn't need to sift through a single over-long chunk of text to get at 
> the instructions you need.
> 
> The implementation of this is in the same place as the language-specific 
> xml -- not there yet.

Sounds reasonable. And to help add a little clarification, the following 
appears true today (in 0.7):

1. <help> without a name attribute is the default, and will always show (alone 
or with another).

2. The name attribute directly coincides with the configure action name.

   Example: podcast has 'managefeeds' and 'configure_player' configure actions, 
so:

     - <help name="managefeeds"><value>Manage your podcast feeds by doing 
this</value></help>
     - <help name="configure_player"><value>Configure the podcast player like 
so</value></help>

3. The named helps are inline, so do not slide in/out like the default helps 
(so no jquery magic).

>>> - Is this schema considered final and implementation ready for 0.7?
> 
> There are probably some things that could be improved in the schema, but 
> for 0.7, I think it's ready.

Cool, I'll begin investigating and testing these further.

Regards,
Philip

-- 
To post to this group, send email to [email protected]
To unsubscribe from this group, send email to 
[email protected]
For more options, visit this group at http://groups.google.com/group/habari-dev

Reply via email to