Clicky Web Analytics Microsoft Sandcastle to possibly be released today - Brenton House

Microsoft Sandcastle to possibly be released today

You can follow the posts in this thread, but I know a *lot* of people are anxiously awaiting the release of Microsoft Sandcastle.  Sandcastle is the codename for Microsoft’s NDoc like documentation compiler. 

I have spoken with people from Microsoft ever since .NET 2.0 came out about what tool they use to do their documentation.  We were having issues with NDoc 1.3 and generics and needed a solution.  Kevin Downs was kind enough to send me alpha releases of NDoc2, the next generation of NDoc, which fixed the issues with generics.

From comments by Anand Raman, The CTP release will not include and MSBuild tasks.  I wish I could have been on beta testing list for this because then I could have had the MSBuild tasks built and ready for the CTP release. 

I am curious if it will be possible to integrate the output from Sandcastle with Innovasys Help Studio Lite, which ships (free) with the Visual Studio 2005 SDK.  That would be cool because then we could have an integrated documentation release that included a getting started guide and SDK docs.

From other posts and forums I am able to get a little more info about it:

[via Andrew Stopford]

Sandcastle Overview:

 

  • Produces quality, comprehensive, familiar MSDN-like documentation.
  • Works with or without authored comments.
  • Supports Generics and .NET Framework 2.0
  • Sandcastle has 2 main components (MrefBuilder and Build Assembler)
  • MrefBuilder generates reflection xml file for Build Assembler
  • Build Assembler includes syntax generation, transformation..etc
  • Sandcastle is used internally to build .Net Framework documentation 
  • MS plan to "..include Sandcastle in our August CTP release of VS SDK."

[via Michael Primeaux]

Sandcastle generates documentation using the following overall process:

  1. Use the /doc compiler option to generate an XML documentation file.
  2. Run the assemblies through Sandcastle (MRefBuilder, XslTransform, and BuildAssembler) to produce a set of HTML files.
  3. Use the Microsoft HTML Help Compiler. The help compiler version 1.0 is used to produce CHM files and version 2.0 is used to generate HXS files.

 

Published Friday, July 21, 2006 8:24 AM by dotnetboy2003

Comments

# re: Microsoft Sandcastle to possibly be released today

Brenton,

We are looking at Innovasys Help Studio Lite as an option for GUI. I will provide more information as it's available.

How do you wnvision building MSBuild tasks? Please feel free to email me directly and my address is aramATmicrosoftDOTcom. Cheers.

Anand..

Friday, July 21, 2006 5:46 PM by Anand Raman

# Microsoft Sandcastle - status update

Jan Schreuder blogged about it earlier, and the buzz around Sandcastle is growing...Brenton House posted...

Monday, July 24, 2006 6:25 AM by Gump's blog

# re: Microsoft Sandcastle to possibly be released today

I've been using alpha builds of NDoc2 and I've found it to work well enough for me. The big issue with this Innovasys Help Studio Lite (which I had to install to install to get NDoc2 to work) is that it keeps trying to install crap on my machine when I start up certain applications (i.e. CD Burner XP Pro freeware)...it's mind boggling and annoying as hell.

Monday, July 24, 2006 1:43 PM by Chuck

# re: Microsoft Sandcastle to possibly be released today

I have used the NDoc2 alphas for quite a while, but I never had to install Help Studio Lite in order to use them.  What message did you get when you tried to use NDoc2 without Help Studio Lite?

Monday, July 24, 2006 2:47 PM by dotnetboy2003

# re: Microsoft Sandcastle to possibly be released today

"I have used the NDoc2 alphas for quite a while, but I never had to install Help Studio Lite in order to use them.  What message did you get when you tried to use NDoc2 without Help Studio Lite?"

Actually, it was installed along with VS2005 SDK April CTP, which had a component that I needed to run NDoc2 (and for the life of me I can't recall what it was...).

But that's kind of been settled: http://www.charliedigital.com/PermaLink,guid,95b2ab68-ba92-413a-b758-2783cde5df9c.aspx

Wednesday, July 26, 2006 2:29 PM by Chuck

# re: Microsoft Sandcastle to possibly be released today

Unfortunately, Kevin Downs has just emailed his beta testing community that he has decided to discontinue work on NDoc 2.0.

His email:

"I have decided to discontinue work on NDoc 2.0 and no longer participate in any open-source development work.

The development and release of NDoc 1.3 was a huge amount of work, and by all accounts widely appreciated. Unfortunately, despite the almost ubiquitous use of NDoc, there has been no support for the project from the .Net developer community either financially or by development contributions. Since 1.3 was released, there have been the grand total of eleven donations to the project. In fact, were it not for Oleg Tkachenko’s kind donation of a MS MVP MSDN subscription, I would not even have a copy of VS2005 to work with!

To put this into perspective, if only roughly 1-in-10 of the those who downloaded NDoc had donated the minimum allowable amount of $5 then I could have worked on NDoc 2.0 full-time and it could have been released months ago! Now, I am not suggesting that this should have occurred, or that anyone owes me anything for the work I have done, rather I am trying to demonstrate that if the community values open-source projects then it should do *something* to support them. MS has for years acknowledged community contributions via the MVP program but there is absolutely no support for community projects.

Once ‘Sandcastle’ is released, it is my belief that it will become the de-facto standard and that NDoc will slowly become a stagnant side-water. This will happen regardless of technical considerations, even if Sandcastle were to be less feature-complete. It's just an inevitable result of MS's 'not-invented-here' mentality, one only has to look at Nant and NUnit to see the effects of MS 'competition'.

This is not, however, my only reason for stopping development work - I have a big enough ego to think I could still produce a better product than them :-)

As some of you are aware, there are some in the community who believe that a .Net 2.0 compatible release was theirs by-right and that I should be moving faster – despite the fact that I am but one man working in his spare time...

This came to head in the last week; I have been subjected to an automated mail-bomb attack on both my public mail addresses and the ndoc2 mailing list address. These mails have been extremely offensive and resulted in my ISP temporarily suspending my account because of the traffic volume. This incident has been reported to the local authorities, although I am highly doubtful they will be able to do anything about it.

This has was the ‘last-straw’ and has convinced me that I should withdraw from the community; I’m not prepared to have myself and my family threatened by some lunatic!

"

Wednesday, July 26, 2006 3:42 PM by todd brooks

Leave a Comment

(required) 
(required) 
(optional)
(required)