Hi, I'm trying to generate a help file using SandCastle Help File builder in msbuild but I am getting the following error: SandcastleBuilder.Utils.BuilderException: Invalid or missing SchemaVersion What does it mean? And how can I resolve this error? ...
Hi, The question is as above... ...
Hi, I am trying to build the documentation for my application using Sandcastle Help File Builder. I added the Msdn cache component to the .shfbproj file as follows: <ComponentConfigurations> <ComponentConfig id="Cached MSDN URL References" enabled="True" xmlns=""> <component id="Cached MSDN URL References" type="SandcastleBuilder...
Hi, I am trying to build the documentation for my application using Sandcastle Help File Builder. One requirement is that I must specify the documentation source for e.g.: <DocumentationSources> <DocumentationSource sourceFile="@(DocumentationSourceFiles)" xmlns="" /> </DocumentationSources> I have defined @(DocumentationSourceFiles...
I am building the documentation for our C# API containing: A general overview and description of the current state as a doc/pdf file. A class library API in a .chm file using Sandcastle. Questions: Should I merge these two into the same .chm file? What is a good way to merge them? I need to exclude certain classes/packages. How ...
My .chm is generated but my comments for classes, namespaces, fields, members are not. What can I do to fix this? ...
Curious question. I'm using Microsoft's Sandcastle to generate documentation from the XML comments in my C# code. Several of my classes are implementing interfaces which already have commented methods. I'd rather not duplicate the documentation in both the interface method and the public implemented method. Is there some kind of tag ...
In a web based .Net solution which uses compiled help documentation made with Sandcastle we get an error when accessing the help documentation. The web applikation is run on https wich creates a problem since the help documents link to a css file through ms-help:// and according to the webapplication this is not a secure location. In th...
I'm trying to add the output of a Sandcastle compilation into source control, but Sandcastle has issues trying to output directly into a subversion-controlled directory structure. So, what I was trying to do is output into a non-controlled directory and then robocopy into the svn-controlled structure. I'd prefer to use /MIR to remove an...
how to add a sandcastle help file builder project (.shfbproj) to a visual studio 2008 solution? ...
I am using Sandcastle to create some API documentation as a website. By default, the title of this (set in the generated index.html page) is Table of Content. I expected this to respect the HelpTitle setting in Sandcastle, but it does not appear to. Can anyone tell me how to set the website title? ...
Hello. I'm looking for a help/documentation generation tool which would satisfy such requirements: it should support xmldoc comment produced by c# compiler or (even better) directly support sandcastle it should support importing of MS Word documents. it should support creating links from conceptual documentation to reference documenta...
I'm using SandCastle Help File Builder 1.8.0.1 with its MAML content editor. I want an ordered list starting from a value other than the default of 1. 10. Some data 11. Other data I even tried the following and it does not work as it is from HTML for the OL element: <list class="ordered"> <listItem value="10">some data<...
I have a large project with long namespaces, like CompanyName.Product.Component.Class Using Sandcastle to build the documentation for the namespaces, but those long namespaces really screw up the display of the contents pane in the final chm file. How can I get it to display just Component.Class in at least the Treeview panel? And...
i'm generating documentation files from the xml comments of my c# code, by using sandcastle help file builder. do you know how to include code examples into the help file, like msdn style? ...
How do I make a list in xmldoc blocks render as an ordered list when I create a chm with Sandcastle Helpfile Builder? The following does not work: /// <list type="numbered"> /// <item>Built in support for foobar</item> /// <item>Client gooblygook and associated javascript support</item> /// <item>Client side ability to read...
I'm just wondering - the last release of Sandcastle is from May 2008, and it's still listed as Pre-Release Software/CTP and it's not even licensed anymore, as the EULA specifially says: 2.TERM. The term of this agreement is until September 1, 2007, or commercial release of the software, whichever is first. As Sandcastle is rather ...
Turns out proper process is hard. I've got two questions that are bugging me in my quest to integrate the above-mentioned tools into my process. Sandcastle - well, actually, this happened with NDoc as well, so I'm just puzzled. Half the time, when it generates a .chm file, half the links in it are 'dead', or lead to a page not found e...
(Using the GUI builder) Does anyone have any idea what this thing wants from the Html Help 2.x feature set? It keeps throwing up "access is denied" errors in any non-local .chm file it generates, specifying the "ms-help://hx/hxruntime/hxlink.htc". Same error for a generated website. Let's not get into the fact that if I generate a .chm...
I've generated a website documentation of my project with Sandcastle. This website uses frames so when I click though sites my URL in browser does not change. I would like to have URL changed in browser when I browse through website documentation generated with Sandcastle. Why? Because I would like to link to concrete subpages of docume...