Page 1 of 1

Component Help - location?

Posted: Tue Jun 30, 2009 2:35 am
by Damian Hickey
Hi,

We are hoping to add detailed component help into Joomla.

What are the accepted practices related to adding component help to the Admin top menu Help menu and reusing the exiting com_admin help process for specific component entries?

I don't seem to have found this in the forums and doco so far. If there are no standards, we are happy to suggest a draft of one and describe how it would be used.

Thanks,

Damian

Re: Component Help - location?

Posted: Tue Jun 30, 2009 11:52 am
by radiant_tech
Perhaps this answers your question?
Local Help Server

Re: Component Help - location?

Posted: Tue Jun 30, 2009 1:12 pm
by Damian Hickey
Hi,

Thanks for that but we are more interested in adding help into Joomla itself. We have a simple solution to use the nice lifesaver float icons at the far left of each page like on the Extension install/unistall page etc.

Cheers,

Damo

Re: Component Help - location?

Posted: Wed Jul 01, 2009 7:13 am
by Chris Davenport
I can't remember the specific details, but I think you just add a /help directory to your component admin directory and use one of the JToolBarHelper methods to link to it by name. The help file itself can be XML, such as DocBook, or HTML.

You might like to ask this question on the developer forum where you might get further information.

Regards,
Chris.

Re: Component Help - location?

Posted: Wed Jul 01, 2009 7:54 am
by Damian Hickey
Thanks so much Chris, I really appreciate your help!

Cheers,

Damo

Re: Component Help - location?

Posted: Wed Jul 01, 2009 9:47 am
by radiant_tech
Ah... I misunderstood your original question Damian. See this thread.

Re: Component Help - location?

Posted: Wed Jul 01, 2009 11:36 am
by Damian Hickey
Hi there,

Thanks for your help. That looks like what I needed.

Cheers,

Damo