Creating a Chm build using Sandcastle

re: Creating a Chm build using Sandcastle

drohm — Sat, 29 Jul 2006 10:29:01 GMT

Where is the link to download it so we can test it?

re: Creating a Chm build using Sandcastle

George J. Capnias — Sat, 29 Jul 2006 11:19:15 GMT

Is the CTP version released?

re: Creating a Chm build using Sandcastle

aram — Sat, 29 Jul 2006 17:58:38 GMT

Not yet and will come out shortly. I will post a blog as soon as it's out and thanks for your pateince.

Anand..

re: Creating a Chm build using Sandcastle

aram — Sat, 29 Jul 2006 17:58:42 GMT

Not yet and will come out shortly. I will post a blog as soon as it's out and thanks for your pateince.

Anand..

Interesting Finds: July 29, 2006

Jason Haley — Sat, 29 Jul 2006 18:46:38 GMT

re: Creating a Chm build using Sandcastle

Mikael Söderström — Sat, 29 Jul 2006 20:31:06 GMT

Isn´t it going to be a add-in for VS?
Is it going to have a GUI?

Thanks,
Mikael Söderström

re: Creating a Chm build using Sandcastle

aram — Sat, 29 Jul 2006 20:54:32 GMT

Mikael - The first CTP release will be a stand-alone release. We plan to have monthly updates and will be adding lots of additional features.
Yes we plan a VS add-in and a GUI later down the road.

Anand..

re: Creating a Chm build using Sandcastle

Mikael Söderström — Sat, 29 Jul 2006 21:45:45 GMT

Okey, great.

Will there be an SDK so developers can use it in their own applications?

re: Creating a Chm build using Sandcastle

Mikael Söderström — Sun, 30 Jul 2006 03:02:45 GMT

Are you sure that step 4 is correct? I tried it, but nothing happends.

This is what i tries:
XslTransform "C:\Program Files\Sandcastle\ProductionTransforms\AddOverloads.xsl" /out:"D:\Projects\Applications\TestingSandCastle\WindowsApplication1\bin\Debug\reflection.org" | XslTransform "C:\Program Files\Sandcastle\ProductionTransforms\AddGuidFilenames.xsl" /out:"D:\Projects\Applications\TestingSandCastle\WindowsApplication1\bin\Debug\reflection.xml"

I also tried...

XslTransform "C:\Program Files\Sandcastle\ProductionTransforms\AddOverloads.xsl" /out:"D:\Projects\Applications\TestingSandCastle\WindowsApplication1\bin\Debug\reflection.org"

...which prints the whole xml file.

Is there anything wrong?

re: Creating a Chm build using Sandcastle

nuggetboy — Sun, 30 Jul 2006 04:38:39 GMT

Mikael:

Try taking out the "/out:" before the path to reflection.org. I'm assuming this file is an input.

re: Creating a Chm build using Sandcastle

aram — Sun, 30 Jul 2006 05:50:44 GMT

Yes and there is no /out in this step. Did you try the test example provided?

Sandcastle - Microsoft CTP of a Help CHM file generator on the tails of the deat

Scott Hanselman's Computer Zen — Sun, 30 Jul 2006 07:52:56 GMT

re: Creating a Chm build using Sandcastle

mpietsch — Sun, 30 Jul 2006 12:37:56 GMT

Step 4 is somewhat misleading. Everything typed there goes into one line and there is a pipe (|) before the second XslTransform instruction.

It definetly is a great tool. I only recently switched production to .net 2.0 and actually considered switching back for lack of proper documentation options.

I am from Germany and looking forward to a version that will provide localized documentation. In some projects my comments have to be German for various reasons.

re: Creating a Chm build using Sandcastle

Mikael Söderström — Sun, 30 Jul 2006 13:39:58 GMT

Thanks, I have successfully created a chm file now.

But I´ve got some problems with it, I keep getting runtime errors in it all the time. Is this a known problem or have I done something wrong?

I´m going to post a blog about it and upload all the files soon.

re: Creating a Chm build using Sandcastle

Mikael Söderström — Sun, 30 Jul 2006 15:29:53 GMT

Where am I supposed to implement the comments.xml file?

I can´t find it in the guide.

Sandcastle - Documenting Managed Class Libraries

Rob Caron — Sun, 30 Jul 2006 17:42:43 GMT

If you've always wanted to create MSDN-like documentation for your managed class libraries, you'll want...

re: Creating a Chm build using Sandcastle

Ashley van Gerven — Sun, 30 Jul 2006 18:34:06 GMT

Thanks for the instructions. After figuring out the paths issue in the config file I managed to come up with a batch file to perform all these steps. More info here:

http://ixnay2infinity.blogspot.com/2006/07/batch-file-for-microsoft-sandcastle.html

re: Creating a Chm build using Sandcastle

aram — Sun, 30 Jul 2006 19:04:43 GMT

Mikael - Looks like you have figures out the comments.xml issue. Thanks for posting a blog with Sandcastle helper. I will create a seperate blog with pointers to your helper.

Yes as Mikael points in his helper readme
Replace %XMLCOMMENTS% in sandcastle.config to the path to your XML Comments file (i.e. c:\projects\MyApp\bin\comments.xml).

The comments.xml in sandcastle.config file can be replaced with any other file name such as foo.xml or multiple xml files with *.xml.

Anand..

re: Creating a Chm build using Sandcastle

Mikael Söderström — Sun, 30 Jul 2006 19:21:55 GMT

Anand,

Is it possible to change the XML Comments files path in another way?
It would be nice to change the path in the bat file instead of the config.

Thanks,
Mikael Söderström

re: Creating a Chm build using Sandcastle

aram — Sun, 30 Jul 2006 19:22:38 GMT

mpietsch - You are correct about step 4. Mikael and Ashely have batch file now available and thank you both.

Sandcastle supports comments in localized version. As I explained above releace comments.xml in sandcastle.config with your comments file or multiple *.xml files.

Anand..

re: Creating a Chm build using Sandcastle

aram — Sun, 30 Jul 2006 19:28:44 GMT

Mikael - Not in the example I provided. Internally we construct lot of information into the config file automatically and I will provide some details.

For those wondering what we are talking about please look at the following section in sandcastle.config file:


<component type="Microsoft.Ddue.Tools.CopyFromIndexComponent" assembly="..\..\ProductionTools\BuildComponents\BuildComponents.dll">
<index name="comments" value="/doc/members/member" key="@name" cache="100">
<data files="comments.xml" />
<data files="C:\WINDOWS\Microsoft.NET\Framework\v2.0.50727\*.xml" />
</index>

The comments.xml in sandcastle.config file can be replaced with any other file name such as foo.xml or multiple xml files with *.xml.

Anand..
<copy name="comments" source="*" target="/document/comments" />
</component>

re: Creating a Chm build using Sandcastle

Mikael Söderström — Sun, 30 Jul 2006 19:34:14 GMT

Okey, I get it.

I will keep experimenting.

Keep up the good work!

re: Creating a Chm build using Sandcastle

leppie — Sun, 30 Jul 2006 19:45:11 GMT

MRefBuilderStatic (v2.0.2397.42473)
Copyright Microsoft Corp. 2005
Error: Unresolved assembly reference: Microsoft.Build.Utilities (Microsoft.Build.Utilities, Version=2.0.0.0, Culture=neutral, PublicKeyToken=b03f5f7f11d50a3a) required by xacc

I have tried adding the dep, no luck... :(

re: Creating a Chm build using Sandcastle

aram — Sun, 30 Jul 2006 19:51:52 GMT

Leppie,
The dependencies can be at a separate folder called dependency.
We invoke MrefBuilder with the /dep switch as below:

MRefBuilder foo.dll /out:reflection.org /dep:dependency\*.dll

MrefBuilder also takes wildcards like the following:

MRefBuilder dll\*.dll /out:reflection.org /dep:dependency\*.dll

That is, I put all the assemblies I want to reflect over in a directory named dll and tell it to get them from there.

I have a blog coming out shortly documenting these FAQs and I promise better detailed documentation in a week.

Anand..

SandCastle CTP

Luc Gauthier's Weblogs — Sun, 30 Jul 2006 20:54:19 GMT

Si vous avez toujours voulu créer une documentation comme MSDN pour vos assemblies, vous voudrez sûrement...

Generate documentation for .Net 2.0, Sandcastle CTP released

Jan Schreuder on .Net — Mon, 31 Jul 2006 09:14:03 GMT

It was due to arrive, and it finally has. Microsoft have released the first CTP of Sandcastle this weekend....

Born 2 Code .NET » Blog Archive » Sandcastle CTP Released!

Born 2 Code .NET » Blog Archive » Sandcastle CTP Released! — Mon, 31 Jul 2006 10:23:41 GMT

PingBack from http://born2code.net/?p=41

Building a chm using Sandcastle

Andrew Stopford's Weblog — Mon, 31 Jul 2006 11:31:16 GMT

Aram has a post onhow to build a help file using Sandcastle. The MSBuild extension is not in this CTP

Jaros??aw Kowalski » Blog Archive » Automating Sandcastle CTP with NAnt

Jaros??aw Kowalski » Blog Archive » Automating Sandcastle CTP with NAnt — Mon, 31 Jul 2006 12:02:24 GMT

PingBack from http://blog.jkowalski.net/?p=52

re: Creating a Chm build using Sandcastle

zhlee — Mon, 31 Jul 2006 16:43:18 GMT

oh, My god!

Microsoft Sandcastle July 2006 CTP Released

Distribute This — Mon, 31 Jul 2006 17:20:33 GMT

Please see the Sandcastle CTP announcement here. Additionally, Arnand (Sandcastle team PM) has posted...

re: Creating a Chm build using Sandcastle

destinyml — Wed, 02 Aug 2006 14:34:15 GMT

Is it posible to exclude classes from the documentation? Eg. by adding an attribute?

Thank you

Joe in Iowa – <i>A Sandcastle Scenario:</i>

Sandcastle — Sun, 06 Aug 2006 22:59:41 GMT

This post provides steps to create CHM using Sandcastle. Some of the users have automated these steps....

Sandcastle : Joe in Iowa ??? A Sandcastle Scenario

Sandcastle : Joe in Iowa ??? A Sandcastle Scenario — Sun, 06 Aug 2006 23:00:57 GMT

PingBack from https://blogs.msdn.com:443/sandcastle/archive/2006/08/06/690260.aspx

Sandcastle, a documentation tool for the .Net 2.0 Framework

Jan Schreuder on .Net — Fri, 11 Aug 2006 16:02:15 GMT

I've spent some time playing with Microsoft's solution to build documentation based on XML tags in your code. This post gives a brief recap of what I experienced as well as providing links to help you get started.

Sandcastle, a documentation tool for the .Net 2.0 Framework

Jan Schreuder on .Net — Mon, 14 Aug 2006 23:19:27 GMT

MSBuild script for Sandcastle

Smöråkning — Sat, 16 Sep 2006 18:39:09 GMT

Update After installing the August CPT of Sandcastle, you'll need to update to the latest version of

re: Creating a Chm build using Sandcastle

derekgreer — Wed, 27 Sep 2006 01:09:09 GMT

I doesn't appear that step 5 will work even with a pipe. It seems XslTransform requires an input file for the second transform applied.

Derek

re: Creating a Chm build using Sandcastle

aram — Wed, 27 Sep 2006 02:42:40 GMT

Step 5 should work. You can email me directly by clicking the Email menu at the top of this page and I will be happy to help.

Anand..

re: Creating a Chm build using Sandcastle

davidhernandez — Wed, 27 Sep 2006 18:58:55 GMT

The sample worked great, the doc generated looks superb. Can't wait to see the finished product!

Is there a way/script to generate a single chm file from a solution (.sln)

re: Creating a Chm build using Sandcastle

AristonDarmayuda — Fri, 20 Oct 2006 20:52:40 GMT

This tools really need the GUI, to complex steps, confusing, and to much error or misunderstanding running the steps.

re: Creating a Chm build using Sandcastle

aram — Sat, 21 Oct 2006 01:58:27 GMT

Ariston,

Please visit http://www.sandcastledocs.com or http://codeplex.com/Tagging/TagDetail.aspx?TagName=Sandcastle to download the GUI created by customers.

Anand..

Generating frindly HTM file names from Sandcastle

Sandcastle — Sat, 11 Nov 2006 18:24:01 GMT

Sandcastle generates GUID file names for HTM. With the release of November CTP you can generated friendly

re: Creating a Chm build using Sandcastle

CaptNemo — Sat, 18 Nov 2006 05:55:36 GMT

Holy cow, 12 complex steps?!?! Isn't there a way to make this easier to run? You should take a look at Javadoc, it makes this type of thing really easy. Just one command and you get your HTML help.

re: Creating a Chm build using Sandcastle

EntitySpaces — Wed, 22 Nov 2006 18:48:32 GMT

Check out our help, way cool

http://www.entityspaces.net/blog/EntitySpaces152NewSandcastleHelp.aspx

We used the Gui builder program, works very well.

re: Creating a Chm build using Sandcastle

sumans — Tue, 27 Feb 2007 11:54:01 GMT

I get the following result when i try use XslTransform. Why? what could be wrong?

am not a techie person, btw, just trying to find out if a writer can use this one:

C:\Program Files\Sandcastle\Examples\Sandcastle> ..\..\productionTools\XslTransf

orm ..\..\ProductionTransforms\AddOverloads.xsl reflection.org

XslTransform (v2.2.61208.1447)

Specify one input XML input file.

re: Creating a Chm build using Sandcastle

CWeiss — Sat, 10 Mar 2007 02:54:33 GMT

Is it possible to produce an HTML web page from these manual steps, rather than (or preferably in addition to) a compiled CHM file? I'm sure there's some obvious flag or setting, but I'm not finding it.

re: Creating a Chm build using Sandcastle

lkarafantis — Wed, 14 Mar 2007 23:07:51 GMT

I'm stuck at the second step!

After typing typing csc ... at the prompt, I receive a message that csc is not recognized as an internal or external command, operable program or batch file.

Suggestions, please?

re: Creating a Chm build using Sandcastle

tmaisnam — Thu, 26 Apr 2007 05:19:41 GMT

"Specify one input XML input file"

Make sure the XslTRansform commands have the /xsl: argument encloded in "" as in -

XslTransform /xsl:"C:\Program Files\Sandcastle\ProductionTransforms\TocToChmContents.xsl" toc.xml /out:Output\EnergyWorkbench.hhc

and not

XslTransform /xsl:C:\Program Files\Sandcastle\ProductionTransforms\TocToChmContents.xsl toc.xml /out:Output\EnergyWorkbench.hhc

ScriptDoc 1.0 for extractiong Javascript code comments is now available at Codeplex

Sandcastle — Thu, 28 Jun 2007 10:06:21 GMT

In April I blogged about Bertrand Leroy 's, cool document extraction tool (ScriprDoc 1.0) that will generate

re: Creating a Chm build using Sandcastle

binni — Mon, 03 Sep 2007 13:09:47 GMT

I can't get past step 2 either. I get the message that csc is not recognized as an internal or external command, operable program or batch file.

Any ideas?

SandCastle+DocProject=CHMv1+RUNTIME_ERROR

Danni Afasyah — Thu, 06 Sep 2007 08:21:33 GMT

Anda mungkin sudah membaca tentang SandCastle (gimana ga, tiap buka IDE Visual Studio pasti nongol di

re: Step 2

DorothyM — Wed, 03 Oct 2007 13:40:39 GMT

Add the path to csc.exe (most probably C:\WINDOWS\Microsoft.NET\Framework\v2.0.50727\) to your environment variables. Open up System from control panel, choose the advanced tab, click on Environment variables. Select Path from System Variables and choose edit. Add the path to the end of that list (don't forget to put a semi colon in before to separate it from the existing path).

Problem with BuildAssembler command in Step 8

dinahc — Fri, 19 Oct 2007 01:54:47 GMT

I got stuck at step 8.

When I tried to run the BuildAssembler command from the ProductionTools directory, I got a message that only one xml file could be specified.

I then copied the sandcastle.config into the ProductionTools directory, but BuildAssembler failed. Following is the relevant part of the stack trace:

Info: CopyFromIndexComponent: Instantiating component.

Info: CopyFromIndexComponent: Searching for files that match '*.xml'.

Error: BuildAssembler: An error occured while initializing the build component 'Microsoft.Ddue.Tools.CopyFromIndexComponent' in the component assembly 'C:\Program Files\Sandcastle\\ProductionTools\BuildComponents.dll'. The error message and stack trace follows: System.IO.DirectoryNotFoundException: Could not find a part of the path 'C:\Program Files\Sandcastle\Data\Reflection'.

I don't find a ..\Data\Reflection subdirectory. Was it supposed to be included with the install package or somehow generated in a previous step?

RESOLVED--Problem with Build Assembler in Step 8

dinahc — Fri, 19 Oct 2007 01:59:32 GMT

OOPS! I just found the article on generating reflection data. I think this might solve my problem.

Chm on Vista

dinahc — Fri, 19 Oct 2007 10:23:52 GMT

I've heard numerous reports about problems with Chm files Vista. Can you tell me if Chm and HTML Help 1.x are supported on Vista and whether Chm is likely to be replaced by "AML-next"?

re: Creating a Chm build using Sandcastle

Kaizenn — Fri, 23 Nov 2007 15:29:29 GMT

Hi, I just tried using the Help builder for the first time. I have just specified the dlls that I need to document, and also the dependencies. When I build, I get the error

Error: BuildAssembler: An error occured while initializing the build component 'Microsoft.Ddue.Tools.CopyFromIndexComponent' in the component assembly 'C:\Program Files\Sandcastle\ProductionTools\BuildComponents.dll'. The error message and stack trace follows: System.IO.DirectoryNotFoundException: Could not find a part of the path 'C:\Program Files\Sandcastle\Data\Cpref_reflection'.

at System.IO.__Error.WinIOError(Int32 errorCode, String maybeFullPath)

at System.IO.Directory.InternalGetFileDirectoryNames(String path, String userPathOriginal, String searchPattern, Boolean includeFiles, Boolean includeDirs, SearchOption searchOption)

at System.IO.Directory.GetFiles(String path, String searchPattern, SearchOption searchOption)

at System.IO.Directory.GetFiles(String path, String searchPattern)

at Microsoft.Ddue.Tools.IndexedDocumentCache.AddDocuments(String wildcardPath)

at Microsoft.Ddue.Tools.IndexedDocumentCache.AddDocuments(String baseDirectory, String wildcardPath, Boolean recurse)

at Microsoft.Ddue.Tools.CopyFromIndexComponent..ctor(BuildAssembler assembler, XPathNavigator configuration)

I do see a mention of the same problem by dinah. Please help.

re: Creating a Chm build using Sandcastle

izotov — Tue, 11 Dec 2007 16:40:11 GMT

Hi,

is it possible to avoid protected members being listed in the result?

re: Creating a Chm build using Sandcastle

Prasanna.Samuel — Wed, 13 Aug 2008 18:38:15 GMT

I got everything working. I tried the AddIn, but it doesn't do anything. Not listing any of my files from the project. The release seems to be outdated. Is that project still alive?

Documentation for the AjaxControlToolkit

With Great Power comes Great Response.write("Ability") — Wed, 27 Aug 2008 07:07:26 GMT

Ready for some documentation for the ATK controls ? To skip my journey to create this , download the

re: Creating a Chm build using Sandcastle

timmischkin — Thu, 29 Jan 2009 13:09:46 GMT

I always get the same error after running step 2

error cs1024:Preprocessor directive expected.

It is in cause of my regions in my code. Is there a possibility to give some argument or something like that to csc.exe that my region will be ignored?

Creating a Chm build using Sandcastle

re: Creating a Chm build using Sandcastle

re: Creating a Chm build using Sandcastle

re: Creating a Chm build using Sandcastle

re: Creating a Chm build using Sandcastle

Interesting Finds: July 29, 2006

re: Creating a Chm build using Sandcastle

re: Creating a Chm build using Sandcastle

re: Creating a Chm build using Sandcastle

re: Creating a Chm build using Sandcastle

re: Creating a Chm build using Sandcastle

re: Creating a Chm build using Sandcastle

Sandcastle - Microsoft CTP of a Help CHM file generator on the tails of the deat

re: Creating a Chm build using Sandcastle

re: Creating a Chm build using Sandcastle

re: Creating a Chm build using Sandcastle

Sandcastle - Documenting Managed Class Libraries

re: Creating a Chm build using Sandcastle

re: Creating a Chm build using Sandcastle

re: Creating a Chm build using Sandcastle

re: Creating a Chm build using Sandcastle

re: Creating a Chm build using Sandcastle

re: Creating a Chm build using Sandcastle

re: Creating a Chm build using Sandcastle

re: Creating a Chm build using Sandcastle

SandCastle CTP

Generate documentation for .Net 2.0, Sandcastle CTP released

Born 2 Code .NET » Blog Archive » Sandcastle CTP Released!

Building a chm using Sandcastle

Jaros??aw Kowalski » Blog Archive » Automating Sandcastle CTP with NAnt

re: Creating a Chm build using Sandcastle

Microsoft Sandcastle July 2006 CTP Released

re: Creating a Chm build using Sandcastle

Joe in Iowa – &lt;i&gt;A Sandcastle Scenario:&lt;/i&gt;

Sandcastle : Joe in Iowa ??? A Sandcastle Scenario

Sandcastle, a documentation tool for the .Net 2.0 Framework

Sandcastle, a documentation tool for the .Net 2.0 Framework

MSBuild script for Sandcastle

re: Creating a Chm build using Sandcastle

re: Creating a Chm build using Sandcastle

re: Creating a Chm build using Sandcastle

re: Creating a Chm build using Sandcastle

re: Creating a Chm build using Sandcastle

Generating frindly HTM file names from Sandcastle

re: Creating a Chm build using Sandcastle

re: Creating a Chm build using Sandcastle

re: Creating a Chm build using Sandcastle

re: Creating a Chm build using Sandcastle

re: Creating a Chm build using Sandcastle

re: Creating a Chm build using Sandcastle

ScriptDoc 1.0 for extractiong Javascript code comments is now available at Codeplex

re: Creating a Chm build using Sandcastle

SandCastle+DocProject=CHMv1+RUNTIME_ERROR

re: Step 2

Problem with BuildAssembler command in Step 8

RESOLVED--Problem with Build Assembler in Step 8

Chm on Vista

re: Creating a Chm build using Sandcastle

re: Creating a Chm build using Sandcastle

re: Creating a Chm build using Sandcastle

Documentation for the AjaxControlToolkit

re: Creating a Chm build using Sandcastle

Joe in Iowa – <i>A Sandcastle Scenario:</i>