Learn More





DNN Community Blog

The Community Blog is a personal opinion of community members and by no means the official standpoint of DNN Corp or DNN Platform. This is a place to express personal thoughts about DNNPlatform, the community and its ecosystem. Do you have useful information that you would like to share with the DNN Community in a featured article or blog? If so, please contact .

The use of the Community Blog is covered by our Community Blog Guidelines - please read before commenting or posting.

Help! How do I do THIS in the DNN API (Part 1 of 3)?

This MSDN style based Windows help file did fill a gap for serious developers, developers (re)using the DNN API: almost 7.500 downloads of this help file for various versions of DNN in the past 2 years with 4 and 5 star ratings by people visiting this CodePlex project. For me: a success in sharing my knowledge and efforts in the community

I blogged a couple of times in the past 2 years about updates (see my blog history for MSDN Style help files for DNN version X.X.X), and got positive responses on most of my blogs.

DNN Community teams

Being the Project lead for the Events module, I am, as volunteer, part of the DNN team.

At the start of 2010, the DNN team structure was reorganised by DNN, resulting in module teams (like Events) and more generic teams, such as Quality, Health, Experience and more. See this link for an overview of the DNN community teams.

I volunteered for the DNN Reference Team with a high level goal in mind: the Reference Team drives to expand and enhance the foundation of knowledge available to all DotNetNuke stakeholders; developers, administrators, users, decision makers, etc.

Goals are good,  but sometimes you have to start at the bottom. And so we did.

One of my personal objectives was to make the creation of the MSDN style windows based help file become part of a release of DNN: no separate project on CodePlex. The help and documentation should be an integral part of a DNN release (and it will save me time if DNN does it ;-)).

MSDN style help file: it is here!

With the release of DNN 5.5 one of my objectives as member of the Reference team is achieved: the MSDN style help file will be an integral part of the DNN release, see this link for the version of the help file related to DNN 5.5.

MSDN Style help file

Special thanks go to Philip Beadle, who integrated the MS Build structure I developed for generating the API help file into the release build process of a DNN release. Creating a MSDN style help file does take some work, especially because you have to install additional software (SandCastle help file builder) to extract documentation from the codebase and generate a help file.

What has been achieved?

In a second blog I will discuss a bit about the things that have been achieved, I will also ask for some help later. Although a lot of the (new) core code is well documented, there is room for improvement especially with the hidden treasure: the existing pre DNN 5.x code. In the seconds part of the blog I will explain how we have improved documentation over the past year.


Comment Form

Only registered users may post comments.


2sic Daniel Mettler (124)
Aderson Oliveira (15)
Alec Whittington (11)
Alex Shirley (10)
Andrew Nurse (30)
Anthony Glenwright (5)
Antonio Chagoury (28)
Ash Prasad (21)
Ben Schmidt (1)
Benjamin Hermann (25)
Benoit Sarton (9)
Beth Firebaugh (12)
Bill Walker (36)
Bob Kruger (5)
Brian Dukes (2)
Brice Snow (1)
Bruce Chapman (20)
Bryan Andrews (1)
cathal connolly (55)
Charles Nurse (163)
Chris Hammond (203)
Chris Paterra (55)
Clinton Patterson (28)
Cuong Dang (21)
Daniel Bartholomew (2)
Dave Buckner (2)
David Poindexter (3)
David Rodriguez (2)
Doug Howell (11)
Erik van Ballegoij (30)
Ernst Peter Tamminga (74)
Geoff Barlow (6)
Gifford Watkins (3)
Gilles Le Pigocher (3)
Ian Robinson (7)
Israel Martinez (17)
Jan Blomquist (2)
Jan Jonas (3)
Jaspreet Bhatia (1)
Jenni Merrifield (6)
Joe Brinkman (269)
John Mitchell (1)
Jon Henning (14)
Jonathan Sheely (4)
Jordan Coopersmith (1)
Joseph Craig (2)
Kan Ma (1)
Keivan Beigi (3)
Ken Grierson (10)
Kevin Schreiner (6)
Leigh Pointer (31)
Lorraine Young (60)
Malik Khan (1)
Matthias Schlomann (15)
Mauricio Márquez (5)
Michael Doxsey (7)
Michael Tobisch (3)
Michael Washington (202)
Mike Horton (19)
Mitchel Sellers (28)
Nathan Rover (3)
Navin V Nagiah (14)
Néstor Sánchez (31)
Nik Kalyani (14)
Peter Donker (52)
Philip Beadle (135)
Philipp Becker (4)
Richard Dumas (22)
Robert J Collins (5)
Roger Selwyn (8)
Ruben Lopez (1)
Ryan Martinez (1)
Salar Golestanian (4)
Sanjay Mehrotra (9)
Scott McCulloch (1)
Scott S (11)
Scott Wilkinson (3)
Scott Willhite (97)
Sebastian Leupold (80)
Shaun Walker (237)
Shawn Mehaffie (17)
Stefan Cullmann (12)
Stefan Kamphuis (12)
Steve Fabian (31)
Timo Breumelhof (24)
Tony Henrich (3)
Torsten Weggen (2)
Vicenç Masanas (27)
Vincent Nguyen (3)
Vitaly Kozadayev (6)
Will Morgenweck (37)
Will Strohl (163)
William Severance (5)
Try Evoq
For Free
Start Free Trial
a Demo
See Evoq Live
Need More Information?