Component Help - location?

Joomla! Documentation Workgroup

Moderators: Chris Davenport, Hutchy68

User avatar
Damian Hickey
Joomla! Intern
Joomla! Intern
Posts: 56
Joined: Thu Jan 03, 2008 11:23 pm

Component Help - location?

Postby Damian Hickey » Tue Jun 30, 2009 2:35 am

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
Damian Hickey
www.jentla.com
+61 (0) 415 981 852
email damian.hickey@zac-ware.com

User avatar
radiant_tech
Joomla! Guru
Joomla! Guru
Posts: 531
Joined: Sat Dec 15, 2007 3:02 pm
Location: Washington DC Metro

Re: Component Help - location?

Postby radiant_tech » Tue Jun 30, 2009 11:52 am

Perhaps this answers your question?
Local Help Server

User avatar
Damian Hickey
Joomla! Intern
Joomla! Intern
Posts: 56
Joined: Thu Jan 03, 2008 11:23 pm

Re: Component Help - location?

Postby Damian Hickey » Tue Jun 30, 2009 1:12 pm

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
Damian Hickey
www.jentla.com
+61 (0) 415 981 852
email damian.hickey@zac-ware.com

User avatar
Chris Davenport
Joomla! Ace
Joomla! Ace
Posts: 1384
Joined: Thu Aug 18, 2005 8:57 am
Location: Shrewsbury, Shropshire, United Kingdom

Re: Component Help - location?

Postby Chris Davenport » Wed Jul 01, 2009 7:13 am

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.
Chris Davenport

Davenport Technology Services http://www.davenporttechnology.com/
Lion Coppice http://www.lioncoppice.org/

User avatar
Damian Hickey
Joomla! Intern
Joomla! Intern
Posts: 56
Joined: Thu Jan 03, 2008 11:23 pm

Re: Component Help - location?

Postby Damian Hickey » Wed Jul 01, 2009 7:54 am

Thanks so much Chris, I really appreciate your help!

Cheers,

Damo
Damian Hickey
www.jentla.com
+61 (0) 415 981 852
email damian.hickey@zac-ware.com

User avatar
radiant_tech
Joomla! Guru
Joomla! Guru
Posts: 531
Joined: Sat Dec 15, 2007 3:02 pm
Location: Washington DC Metro

Re: Component Help - location?

Postby radiant_tech » Wed Jul 01, 2009 9:47 am

Ah... I misunderstood your original question Damian. See this thread.

User avatar
Damian Hickey
Joomla! Intern
Joomla! Intern
Posts: 56
Joined: Thu Jan 03, 2008 11:23 pm

Re: Component Help - location?

Postby Damian Hickey » Wed Jul 01, 2009 11:36 am

Hi there,

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

Cheers,

Damo
Damian Hickey
www.jentla.com
+61 (0) 415 981 852
email damian.hickey@zac-ware.com


Return to “Documentation - Feedback/Information/Suggestions”

Who is online

Users browsing this forum: No registered users and 8 guests