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
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.
Care to join? Just send me an e-mail: [email protected].