MSBuildSandcastle Work Item Rss Feed

CREATED ISSUE: How to change compiled file name option in hhp file

succhu — Wed, 24 Oct 2007 17:58:31 GMT

hi,

I am trying to build the chm file through msbuild and using the Documentation.proj provided in the release for it. I want to generate the chm with the naming I want and don't want the system to assign the default name of 'test.chm'. I looked through the code and I believe the issue is with this line of code in ReflectionToChmProject.xsl file

<xsl:param name="project" select="string('test')" />

In the absence of a help file name, the xsl provides a default name of test.chm as shown from the test.hhp file generated by the above transformation. I am not sure how to pass a file name to the above transformation so it uses it.

ompatibility=1.1 or later
Compiled file=test.chm
Contents file=test.hhc
Index file=test.hhk
Default Topic=html/.htm
Full-text search=Yes
Language=0x409 English (United States)
[FILES]
icons\*.gif
art\*.gif
media\*.gif
scripts\*.js
styles\*.css
html\*.htm
[INFOTYPES]

COMMENTED ISSUE: ReflectionToChmContents.xsl Removed from March CTP

succhu — Tue, 16 Oct 2007 18:05:23 GMT

I am trying to get the MSBuild script for Sandcastle working with the March CTP, but I am not sure what transform replaces the removed ReflectionToChmContents.xsl

I am new to Sandcastle and trying to get to grips with a lot of new concepts. The MSBuild script chokes if I leave in the line
<Exec Command=""$(SandcastleBin)\XslTransform" /xsl:"$(SandcastleTransforms)\ReflectionToChmContents.xsl" reflection.xml /arg:html=$(HelpOutputPath)\html /out:$(HelpOutputPath)\$(HelpName).hhc"/>

If I comment it out no hhc file is genereated for the Help compiler contents. I am sure I need to replace the transform with another but can't find which one.

Has anyone else had any luck with the March CTP yet?

Thanks
Comments: ** Comment from web user: succhu **

hi I tried the above and end of getting the following error

Target GenerateHHTOC:
"C:\Program Files\Sandcastle\\ProductionTools\XslTransform" /xsl:"C:\Program Files\Sandcastle\\ProductionTransforms\createvstoc.xsl" "C:\Program Files\Sandcastle\\Examples\Sandcastle\reflection.xml" /out:Help\toc.xml
XslTransform (v2.2.64000.4)
Copyright c Microsoft 2005-2006
Info: Applying XSL transformation 'C:\Program Files\Sandcastle\\ProductionTransforms\createvstoc.xsl'.
"C:\Program Files\Sandcastle\\ProductionTools\XslTransform" /xsl:"C:\Program Files\Sandcastle\\ProductionTransforms\TocToChmContents.xsl" "Help\toc.xml" /arg:html=Help\html /out:Help\test.hhc
XslTransform (v2.2.64000.4)
Copyright c Microsoft 2005-2006
Info: Applying XSL transformation 'C:\Program Files\Sandcastle\\ProductionTransforms\TocToChmContents.xsl'.
"C:\Program Files\Sandcastle\\ProductionTools\XslTransform" /xsl:"C:\Program Files\Sandcastle\\ProductionTransforms\ReflectionToChmIndex.xsl" "C:\Program Files\Sandcastle\\Examples\Sandcastle\reflection.xml" /arg:html=Help\html /out:Help\test.hhk
XslTransform (v2.2.64000.4)
Copyright c Microsoft 2005-2006
Info: Applying XSL transformation 'C:\Program Files\Sandcastle\\ProductionTransforms\ReflectionToChmIndex.xsl'.
"C:\Program Files\Sandcastle\\ProductionTools\XslTransform" /xsl:"C:\Program Files\Sandcastle\\ProductionTransforms\ReflectionToChmProject.xsl" "C:\Program Files\Sandcastle\\Examples\Sandcastle\reflection.xml" /arg:html=Help\html /out:Help\test.hhp
XslTransform (v2.2.64000.4)
Copyright c Microsoft 2005-2006
Info: Applying XSL transformation 'C:\Program Files\Sandcastle\\ProductionTransforms\ReflectionToChmProject.xsl'.
Target CompileCHM:
"C:\Program Files\HTML Help Workshop\hhc" test.hhp
Microsoft HTML Help Compiler 4.74.8702

Compiling c:\SandcastleTest\Help\test.chm

HHC5003: Error: Compilation failed while compiling html\.htm.

HHC6000: Error: An internal file could not be created. Make certain there is enough disk space on the drive where you are compiling your file.

HHC5007: Error: Fatal navigational compilation error. This is likely the result of an invalid contents (.hhc) file.

The following files were not compiled:

html\.htm

and my toc.xml is empty.

CREATED ISSUE: compilation failed error

succhu — Thu, 11 Oct 2007 22:00:32 GMT

hi,

I am getting the following error when trying to build chm file on the sandcastletest solution

Compiling c:\SandcastleTest\Help\test.chm

HHC5003: Error: Compilation failed while compiling test.hhc.

HHC5003: Error: Compilation failed while compiling test.hhk.

HHC5003: Error: Compilation failed while compiling html\.htm.

I am attaching the error log file
I also noticed that no htm files were created during the process. Processed topics 0

COMMENTED ISSUE: ReflectionToChmContents.xsl Removed from March CTP

evahala — Tue, 01 May 2007 11:46:19 GMT

I am trying to get the MSBuild script for Sandcastle working with the March CTP, but I am not sure what transform replaces the removed ReflectionToChmContents.xsl I am new to Sandcastle and trying to get to grips with a lot of new concepts. The MSBuild script chokes if I leave in the line If I comment it out no hhc file is genereated for the Help compiler contents. I am sure I need to replace the transform with another but can't find which one. Has anyone else had any luck with the March CTP yet? Thanks Comments: ** Comment from web user: evahala **

You can get rid of the error if you edit the targets file to include calls to "createvstoc.xsl /arg.. /out:toc.xml" (or createPrototypetoc) followed by "TocToChmContents.xsl toc.xml /arg.. /out:$(HelpOutputPath)\$(HelpName).hhc" instead of ReflectionToChmContents.

CREATED ISSUE: ReflectionToChmContents.xsl Removed from March CTP

denniswoodruff — Wed, 14 Mar 2007 17:06:42 GMT

COMMENTED ISSUE: Add support for Team Build

andlju — Wed, 07 Feb 2007 14:33:25 GMT

As Buck Hodges points out in a blog post, it should be fairly easy to get this target to work together with Team Build. http://blogs.msdn.com/buckh/archive/2007/02/03/generating-documentation-from-code-with-team-build.aspx Please vote for this issue if you think so too, and I'll put it higher up on the list.. Comments: ** Comment from web user: andlju **

Actually, this is a Feature, not an issue...

CREATED ISSUE: Add support for Team Build

andlju — Wed, 07 Feb 2007 09:06:11 GMT

CREATED ISSUE: Allow for custom location of SandcastleConfigurator.vbs

dmiser — Mon, 22 Jan 2007 18:48:43 GMT

As a best practice here, we put all of the custom MSBuild extensions in source control for each project we use. By doing this, we can get up and running without modifying multiple directories on a new box. The only place $(MSBuildExtensionsPath) is used in Sandcastle.targets is when trying to execute the SandcastleConfigurator.vbs. I propose that a new property be created, and use that instead to allow the Sandcastle extenstion to live anywhere you want, e.g.: In the PropertyGroup: $(MSBuildExtensionsPath)\Sandcastle Later on:

CREATED ISSUE: HtmlHelpCompilerBin override

dmiser — Fri, 19 Jan 2007 16:57:04 GMT

Other properties in the targets file are protected by only setting them if they are not already set. This means that the Import needs to be done after you set your properties in your main build.proj file. That's fine, but this property is missing the same treatment. If you could add it, that would help. Thanks. C:\Program Files\HTML Help Workshop

CLOSED ISSUE: Ability to change copyright notice

andlju — Thu, 04 Jan 2007 16:57:56 GMT

It would be nice if you could customize the copyright notice that shows up at the bottom of each page. For example, with the Prototype presentation, it says: (c) Microsoft Corporation. All rights reserved. Send comments about this topic to Microsoft. If I'm documenting my own library, it would be nice if users would send their comments to me, not Microsoft :) Comments: Resolved with changeset 15429.

CLOSED FEATURE: Ability to change pre-release status

andlju — Thu, 04 Jan 2007 16:57:55 GMT

The CHM help files that are produced have this at the top: [This topic is pre-release documentation and is subject to change in future releases. Blank topics are included as placeholders.] It would be nice to be able to turn that on/off from the MSBuild scripts. Comments: Resolved with changeset 15429.

CLOSED FEATURE: Support for separate member pages (similar to VS2005)

andlju — Thu, 04 Jan 2007 16:57:23 GMT

From the Sandcastle blog: * Support for separate member pages (similar to VS2005). In order to have separate member pages, you have to run a new transform ApplyVsDocModel.xsl instead of AddOverloads.xsl: XslTransform /xsl:..\..\ProductionTransforms\ApplyVSDocModel.xsl reflection.org /xsl:..\..\ProductionTransforms\AddGuidFilenames.xsl /out:reflection.xml Separate pages will be created for members, methods, properties, events, fields and constructors. Comments: Resolved with changeset 15428.

CLOSED TASK: Investigate the DXROOT variable

andlju — Thu, 04 Jan 2007 16:57:23 GMT

Investigate the DXROOT variable in sandcastle.config and see if it's possible to simplify the .vbs-script Comments: Resolved with changeset 15428.

CLOSED ISSUE: Crash if no Dependencies specified

andlju — Thu, 04 Jan 2007 16:57:22 GMT

The build will crash if no Dependencies are specified. Specifically, if this code is left out: Then a /out:"" argument gets passed to MRefBuilder which throws an ArgumentException that says: Unhandled Exception: System.ArgumentException: The path is not of a legal form. at System.IO.Path.NormalizePathFast(String path, Boolean fullCheck) at System.IO.Path.GetDirectoryName(String path) at Microsoft.Ddue.Tools.Reflection.ApiVisitor.LoadAccessoryAssemblies(String filePattern) at Microsoft.Ddue.Tools.MRefBuilder.Main(String[] args) C:\Program Files\MSBuild\Sandcastle\Sandcastle.targets(89,5): error MSB3073: The command ""c:\Program Files\Sandcastle\ProductionTools\MRefBuilder" "D:\Path\To\DLL.dll" /dep:"" /out:reflection.org" exited with code -532459699. Just including a Dependency of a dummy DLL (as in the example), like fixes the problem. Comments: Resolved with changeset 15428.

CREATED TASK: Investigate the DXROOT variable

andlju — Thu, 04 Jan 2007 15:37:47 GMT

Investigate the DXROOT variable in sandcastle.config and see if it's possible to simplify the .vbs-script

CREATED FEATURE: Support the namespace ripping feature

andlju — Thu, 04 Jan 2007 15:36:31 GMT

http://forums.microsoft.com/MSDN/ShowPost.aspx?PostID=935512&SiteID=1

CREATED FEATURE: Support for separate member pages (similar to VS2005)

andlju — Thu, 04 Jan 2007 15:34:34 GMT

COMMENTED ISSUE: Ability to change copyright notice

andlju — Thu, 04 Jan 2007 15:23:13 GMT

COMMENTED FEATURE: Ability to change pre-release status

andlju — Thu, 04 Jan 2007 15:22:42 GMT

CREATED ISSUE: Ability to change copyright notice

mattman206 — Tue, 12 Dec 2006 19:24:00 GMT