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

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
Chris Davenport
Joomla! Ace
Joomla! Ace
Posts: 1383
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 - Joomla Production Leadership Team

Lion Coppice http://www.lioncoppice.org/
Davenport Technology Services http://www.davenporttechnology.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.



Return to “Documentation - Feedback/Information/Suggestions”

Who is online

Users browsing this forum: No registered users and 5 guests