Create different help formats in one assembly in Sandcastle Help File Builder

I am trying to use Sandcastle Builder Builder to generate documentation from my C # codebase.

I would like to create both a CHM (compiled HTML help file), offline HTML help files, and an OpenXml document *.docx

from a code base.

I cannot find a set of configuration settings that allow me to do this in one step. I installed the Visual Studio package and I can edit the project properties of the Sandcastle project file from VS.

If I select "HTML Help 1 (chm)", "Open XML (docx)" and "Website (HTML / ASP.NET)" as "Build These Help Formats" from Project Properties / Build Tab

enter image description here

I faced this problem:

if I select "VS2013" from the "Help File" / "Presentation Style" dropdown, then I can just create CHM and HTML files, but * .docx is not built, causing this error:

The selected presentation style (VS2013) does not support one or more of the selected Help file formats. Supported formats: HtmlHelp1, MSHelp2, MSHelpViewer, Website

and if I switch to "Presentation Style" = "Open XML" then I get

The selected presentation style (OpenXML) does not support one or more of the selected Help file formats. Supported formats: OpenXml

So, are there any settings that can create all three formats (HTML 1 = CHM, HTML / ASP.NET, DOCX) at the same time?

enter image description here

It's quite tedious to set these settings manually, build the project and re-set other settings, choose the correct formats and build again - there is no way to tell Sandcastle to use "Presentation Style" = VS2013 "for HTML 1 (CHM) and HTML / ASP.NET and" Presentation style = Open XML "to output Open XML (* .docx) and then just create once?

+3


source to share


1 answer


For a correct assembly, the selected presentation style must support all of the selected Help output file formats. Some styles may be written for specific help file formats or, as in the case of the Prototype and Hana styles, are deprecated and not updated to support later file formats such as MS Help Viewer. Either deselect the unsupported format (s), or choose a different presentation style that supports the selected format (s).

For SHFB errors and warnings see http://ewsoftware.github.io/SHFB/html/46d1f76e-a97e-4ee6-971c-fdeab725ff09.htm



To create a CHM file and WebSite in one step, I chose the VS2013 presentation style . The third build for OpenXML was done by selecting Open XML Document and I had to click the Generate Help File icon again.

For more information, please block: http://broadcast.oreilly.com/2010/09/build-html-documentation-for-y.html#MSBuild and search Use MSBuild to run Sandcastle from the command line .

+3


source







All Articles