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

HomeHomeOur CommunityOur CommunityCommunity Membe...Community Membe...Looking for MSDN style documentation of the DNN core?Looking for MSDN style documentation of the DNN core?
Previous
 
Next
New Post
7/23/2008 4:55 PM
 

I have spent a number of hours in the evening and weekend to create a MSDN style documentation of the DotNetNuke core routines, a wealth of information for every serious DNN (module) developer. to be exact: I have used SandCastle Help File Builder and various other tools to extract all code comments from the source version of the DNN core in order to create this documentation. So no documenting myself, only reusing what is already hidden in our treasure box, the DNN core.

You will find the results of my work on http://www.codeplex.com/DNNHelpSystem. Free to be used for anyone interested.

What can you do with the files that I have created?

If you want to browse help:

  • Extract the .zip with the .chm file to a local disk
  • Double click the .chm file
  • Now you can browse all help items MSDN style

If you build your module against an Install version of DNN and reference the DotNetNuke dll's in your project (which I recommend above using the DNN source version in your project):

  • Unzip DNNHelpSystem_Intellisense.zip into the folder where you referenced the DotNetNuke core .dll's, so that the .xml and dll's go together
  • Now you have intellisense in your project for the referenced DNN dll's

If you want to do some SandCastle help file building yourself

  • You can get some ideas what I have by using the .sfhb project file that I have supplied

What next?

Well, as you will find out, there is a lot of useful documentation, but there is enough room for improvement. So, you might expect improvements on the level of documentation over time.

Also, I am still learning to use SandCastle and tools,  so some improvement in the various files over time can be expected as well.


XCESS expertise center b.v.
Regards,
Ernst Peter
LinkedIn Profile Ernst Peter Tamminga


XCESS: DNN/Evoq specialist, zie www.xcess.nl

Events 7.0.1 - Released
Reports 6.1.0 - Released
 
New Post
7/23/2008 5:22 PM
 

Enrst Peter,

that's great, it's been long overdue - ideally it would be nice to host the chm file on dotnetnuke.com as well if that's possible (also I'd like to use http://www.codeplex.com/SHFB to generate an ajax version of the help so that the details can be browsed online). A few months back I started to update the xml documentation in a document on my machine, and plan to spend some time updating the public API once I've a few pieces of work out of the way (and completed some presentation slides).

Cathal


Buy the new Professional DNN7: Open Source .NET CMS Platform book Amazon US
 
New Post
7/24/2008 2:21 AM
 

Hi Cathal!

I asked Nestor (Documentation group) were to put the things, but did not get an answer yet. Therefore I started to look for a place were everyone could download it:, hence CodePlex. But feel free to suggest a better place to me.

I am still learning what I can do with SHFB, so if you have hints how I can generate what you want I would be more than happy. Is it something that Leigh has done? See this posting here.

As for the "spend some time" I think the some is more "a lot of", but hey, you can eat an elephant if you do it in small chunks. I have offered "some" of my time in this area to Nestor as well.

 


XCESS expertise center b.v.
Regards,
Ernst Peter
LinkedIn Profile Ernst Peter Tamminga


XCESS: DNN/Evoq specialist, zie www.xcess.nl

Events 7.0.1 - Released
Reports 6.1.0 - Released
 
Previous
 
Next
HomeHomeOur CommunityOur CommunityCommunity Membe...Community Membe...Looking for MSDN style documentation of the DNN core?Looking for MSDN style documentation of the DNN core?


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