Products

Evoq Content Overview Content Creation Workflow Asset Management Mobile Responsive Personalization Content Analytics SEO Integrations Security Website PerformanceEvoq Engage Overview Community Management  Dashboard  Analytics  Member Profile Gamification Advocate Marketing Community Engagement  Ideas  Answers  Discussions  Groups  Wikis  Events Mobile ReadyDNN Support PackagesEvoq: CMS FeaturesEvoq OnDemandCompare DNN's CMS Products

Solutions

Content Management SystemMulti-Channel PublishingDigital MarketingOnline Community ManagementIntranet Software SolutionOur CustomersPrime

Resources

Test DrivesSchedule A DemoDocumentation CenterWebinarsWhite PapersProduct ManualsRequest PricingData SheetsCase StudiesEvoq Preferred Products Content Management Ecommerce Forms Identity Management and Authentication Site Management Social Themes

Partners

DNN Partners Partner Directory Become a DNN Partner Partner Program Overview  Hosting  Implementation  ISV  Training  Competencies

Community

Participate Ask a Question Forums Community Showcase DNN MVP  Program Overview  Lifetime MVPs  Honorary MVPs Subscribe to DNN Digest Advisory Groups  Awareness Advisory Group  Developer Advisory Group  Partner Advisory Group  Technology Advisory GroupLearn Documentation Wiki Community Blog Video Library Project History Development RoadmapDownload DNN Store Language Packs Manuals Nightly BuildsSecurity Policies Security Center

Blog

About

News Press Releases News Coverage Press KitCareersContact DNN

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 CommunityGeneral Discuss...General Discuss...Creating DNN documentation works better with VSDocman than SandcastleCreating DNN documentation works better with VSDocman than Sandcastle
Previous
 
Next
New Post
3/6/2014 12:47 PM
 
Tony Henrich


Joined: 12/15/2008
Posts: 838

I was researching documentation creation tools other than Sandcastle and came across VSDocMan. I created a chm file from the source and compared it with the current one from Sandcastle and noticed that the one from VSDocman looks more complete and has better features. (See the two images below)

- There are whole namespaces and classes missing in the Sandcastle documentation. For example all of DotNetNuke.Authentication... is missing. Above that namespace there are ClientDependency... 

- The different language syntaxes are in tabs so only one is shown instead of showing both VB & C# in same view like in SC. It's very simple to create a chm with just one syntax.

VSDocmMan works from inside Visual Studio and is very easy to use yet powerful. I remember using SC years ago and it was cumbersome. 

SO.. what I want to conclude here is that I think the corp should invest in a license ($229) and create a nice chm file for everyone to enjoy with every new release. Create one C# only version and one VB only version. Plus my hope that documentation gets better. The SC chm shows a ton of 'missing..'. We need to fill these out.

 

VSDocman

 

Sandcastle

 

 

 

 
 
New Post
3/6/2014 1:05 PM
 
cathal connolly


cathal connolly's Avatar

www.cathal.co.uk
Joined: 4/9/2003
Posts: 9676

I'd suggest adding it as an idea to http://www.dnnsoftware.com/voice so if it get's enough support we can investigate it (note: I looked at this a year ago and it wasn't a possibility as it didn't work for automated build server scripts, though it appears that's been fixed now - http://www.helixoft.com/latest-news/v... )

Regarding adding xml documentation, I fully agree, and it's something we're going to be doing more of this year - I've spent the past few days doing some API cleanup and ensuring there was good documentation in key controller classes, and we're about to accept 3 github contributions with additional documentation so it looks like others feel the same way.

In case you didn't get the community newsletter, Shaun confirmed that the focus for 2014 will be on the following key product areas:

- Performance and Scalability

- Usability and User Experience

- Stability and Feature Depth

As such we expect to touch many areas, and as we work on them doing "clean-up" work of removing unused private member variables/functions and added documentation is part of that process.

Buy the new Professional DNN7: Open Source .NET CMS Platform book Amazon US
 
New Post
3/6/2014 1:17 PM
 
Tony Henrich


Joined: 12/15/2008
Posts: 838

I created a new voice. VSDocman has a command line option which can be used in automated builds. You have to set up the settings in the GUI first. You can create different profiles with different settings. I suggest creating a profile for C# syntax only and another profile for VB.NET syntax only only and run the command line twice using each profile. Very simple and straight forward.

Looking forward to better documentation. All the extensions developers will appreciate the work.
 
New Post
3/6/2014 2:14 PM
 
Tony Henrich


Joined: 12/15/2008
Posts: 838
VSDocMan has a cumbersome feature and I corresponded with the developer about it and they will improve it. DNN has 45 projects and each project has a separate settings file. If you want to have the same non default setting across all the projects, one has to open VSDocMan for each project! That means opening it 45 times and manually make the change.

Or edit each .vsdoc file (the setting file) and make the edits yourself. If you know regex and use a global replace tool, you could do it pretty quickly. There's no easy way to apply the same settings across all the projects but the developer will implement this in a newer version.
 
 Page 1 of 1
Previous
 
Next
HomeHomeOur CommunityOur CommunityGeneral Discuss...General Discuss...Creating DNN documentation works better with VSDocman than SandcastleCreating DNN documentation works better with VSDocman than Sandcastle


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