The Joomla! Forum ™






Post new topic Reply to topic  [ 7 posts ] 
Author Message
PostPosted: Tue Jun 30, 2009 2:35 am 
User avatar
Joomla! Intern
Joomla! Intern

Joined: Thu Jan 03, 2008 11:23 pm
Posts: 56
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 [email protected]


Top
 Profile  
 
PostPosted: Tue Jun 30, 2009 11:52 am 
User avatar
Joomla! Guru
Joomla! Guru

Joined: Sat Dec 15, 2007 3:02 pm
Posts: 531
Location: Washington DC Metro
Perhaps this answers your question?
Local Help Server

_________________
Catch up with me on Google+: https://plus.google.com/106742096640193690159


Top
 Profile  
 
PostPosted: Tue Jun 30, 2009 1:12 pm 
User avatar
Joomla! Intern
Joomla! Intern

Joined: Thu Jan 03, 2008 11:23 pm
Posts: 56
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 [email protected]


Top
 Profile  
 
PostPosted: Wed Jul 01, 2009 7:13 am 
User avatar
Joomla! Ace
Joomla! Ace

Joined: Thu Aug 18, 2005 8:57 am
Posts: 1382
Location: Shrewsbury, Shropshire, United Kingdom
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/


Top
 Profile  
 
PostPosted: Wed Jul 01, 2009 7:54 am 
User avatar
Joomla! Intern
Joomla! Intern

Joined: Thu Jan 03, 2008 11:23 pm
Posts: 56
Thanks so much Chris, I really appreciate your help!

Cheers,

Damo

_________________
Damian Hickey
www.jentla.com
+61 (0) 415 981 852
email [email protected]


Top
 Profile  
 
PostPosted: Wed Jul 01, 2009 9:47 am 
User avatar
Joomla! Guru
Joomla! Guru

Joined: Sat Dec 15, 2007 3:02 pm
Posts: 531
Location: Washington DC Metro
Ah... I misunderstood your original question Damian. See this thread.

_________________
Catch up with me on Google+: https://plus.google.com/106742096640193690159


Top
 Profile  
 
PostPosted: Wed Jul 01, 2009 11:36 am 
User avatar
Joomla! Intern
Joomla! Intern

Joined: Thu Jan 03, 2008 11:23 pm
Posts: 56
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 [email protected]


Top
 Profile  
 
Display posts from previous:  Sort by  
Post new topic Reply to topic  [ 7 posts ] 



Who is online

Users browsing this forum: No registered users and 12 guests


You cannot post new topics in this forum
You cannot reply to topics in this forum
You cannot edit your posts in this forum
You cannot delete your posts in this forum
You cannot post attachments in this forum

Jump to:  
Powered by phpBB® Forum Software © phpBB Group