Products

Solutions

Resources

Partners

Community

Blog

About

QA

Ideas Test

New Community Website

Ordinarily, you'd be at the right spot, but we've recently launched a brand new community website... For the community, by the community.

Yay... Take Me to the Community!

Welcome to the DNN Community Forums, your preferred source of online community support for all things related to DNN.
In order to participate you must be a registered DNNizen

HomeHomeArchived Discus...Archived Discus...Developing Under Previous Versions of .NETDeveloping Under Previous Versions of .NETASP.Net 2.0ASP.Net 2.0Documentation or examples on module-based help?Documentation or examples on module-based help?
Previous
 
Next
New Post
9/18/2008 3:30 PM
 

Hi DNN experts:

I'm not sure if I'm in the right spot.  I've been using dnn for a while, but don't know if the dnn Help Module will help me or if I need to look here or somewhere else.  Hopefully you can point me in the right direction.

I want to implement module Help.  We don't care if it's all in one module, and then a help and module id are sent to the help module, or if it's similar to the IActionable items (settings, etc), and if IHelp is implemented in the controller, then an action menu item shows up.

However, I don't see anywhere where this is explained.  I looked through the docs, but no avail.  I noticed there are multiple references to 'ctl' and 'Help' in the core, and also to 'mid' (module id)...so it appears that this feature is implemented in some manner (perhaps calls to the help module?).  Could someone point me in the right direction of how to achieve 'module-based help'?  Thanks!

 
New Post
9/18/2008 10:24 PM
 

Anyone?  Please?  Help is critical to any commercial website...I'm just looking for documentation or examples.  Does anyone on the core team troll around here?

 
New Post
11/18/2008 6:03 PM
 

I too am looking for help with this.  I have writen a few modules, and I am ready to begin polishing them up and getting them ready for release.  The question I have is what's the best or typical way to provide help within your module?  I see in the edit module control panel that you can edit the individual controls and provide a help link.  Is that the best way or only way to handle it within the framework?

I am interested in comparing and contrasting a few ways to integrate help.

Thanks!

 
New Post
11/20/2008 2:30 PM
 

Okay, so after some trial and error testing, I discovered that in the Module Definition, under the individual Control definitions there is a field called: Help Url.  when this is populated for the View control, it adds a new menu item in the module's Action menu on the view page called "Online Help" which links to the specified url.

What I have not figured out, and could use some help with are the following:

  1. When viewing your module with the page in edit mode, there is an option in the Action Menu called Help as well as a Help icon that shows up in the tools menu typically located beneath the module on the right side.  When I click this it takes me to a page that says "Module Help" as a header.  Some details below that header read "A moduleName Module" where moduleName is the name of my module.  How can I extend this to show my help information?
  2. The same two Help options I mentioned in point #1 appear on the "Edit page" for my module as well.  When I click either of those it takes me to a page that says "Module Help" as a header again, but this time there is no detail info below it.  Again, how can I extend this to show my help information?

Obviously, DNN has something in place for helping me create a nicely integrated help system for my module.  However I can not find any documentation or examples how to use it anywhere.  Please help...

 
New Post
11/20/2008 7:46 PM
 

Alright, I wasted three days on finding the answer to this but here it is (and it's quite simple).

Each ascx file in your module should have an associated resource file (resx) in your App_LocalResources subfolder.  Simply create a resource named ModuleHelp.Text and paste any html coding in the value you wish to be displayed.

It's almost too simple, I wish discovering it were so easy.

 
Previous
 
Next
HomeHomeArchived Discus...Archived Discus...Developing Under Previous Versions of .NETDeveloping Under Previous Versions of .NETASP.Net 2.0ASP.Net 2.0Documentation or examples on module-based help?Documentation or examples on module-based help?


These Forums are dedicated to discussion of DNN Platform and Evoq Solutions.

For the benefit of the community and to protect the integrity of the ecosystem, please observe the following posting guidelines:

  1. No Advertising. This includes promotion of commercial and non-commercial products or services which are not directly related to DNN.
  2. No vendor trolling / poaching. If someone posts about a vendor issue, allow the vendor or other customers to respond. Any post that looks like trolling / poaching will be removed.
  3. Discussion or promotion of DNN Platform product releases under a different brand name are strictly prohibited.
  4. No Flaming or Trolling.
  5. No Profanity, Racism, or Prejudice.
  6. Site Moderators have the final word on approving / removing a thread or post or comment.
  7. English language posting only, please.
What is Liquid Content?
Find Out
What is Liquid Content?
Find Out
What is Liquid Content?
Find Out