Archive
Monthly
Go
|
|
DNN Blog
Jul
23
Posted by:
Ernst Peter Tamminga
2008-07-23 17:51:32Z
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.
Care to join? Just send me an e-mail: ernstpeter.tamminga@dotnetnuke.com.
5 comment(s) so far...
Re: Looking for MSDN style DNN Core documentation?
nice one ... thanks
By bbhermann on
2008-07-24 06:57:16Z
|
Re: Looking for MSDN style DNN Core documentation?
To view the .chm you usually have to right-click on it and select Properties, then click the button that says "unblock".
EPT> Thank you, I will add this to the readme
By AdefWebserver on
2008-07-24 06:57:50Z
|
Re: Looking for MSDN style DNN Core documentation?
awesome - love the intellisense, big help!
Rich
By RichardSeal on
2008-07-24 15:01:45Z
|
Re: Looking for MSDN style DNN Core documentation?
Wonderful. I really appreciate this.
Will be very helpful on the way for DNN framework from »hidden jewel«
(http://www.dotnetnuke.com/Community/Blogs/tabid/825/EntryID/1912/Default.aspx) to a well accepted development platform.
But wouldn't it a good idea to publish this core docs as a wiki? Advantage: changes can be made on the fly without recompiling the chm. And: experts can add explanations.
EPT> Nice idea.
Advantage of the extraction for core source docs is that it stays in line with the source. I expect the build of the .chm to become part of the release build process of a DNN version.
MB wiki can be used for more general documentation?
By hpeller on
2008-07-25 12:04:21Z
|
Re: Looking for MSDN style DNN Core documentation?
Thanks! Great addition. What about crowd sourcing the creation of VB and C# syntax samples of the various functions. This would be the icing on the cake.
EPT> Correct, I am open for any samples to be included in the soyrce comments. This would certainly improve the usefullness. Do not hesitate and mail it to me.
By mhile on
2008-07-29 20:52:40Z
|
|