The help file is currently only for internal usage, so I prefere MS Help1
file (one file, easy to use).
New file structure
I changed my file structure, if I want to produce other help-formats. I imported the [images]-folder into shfb
, and marked the images as CopyToMedia=True
. I use
.NET Framework 4.5
[help] (shfb-output, temprary folder)
[images]\ (images-folder, to use in shfb-build)
<appname>.chm (copied from [help]-folder)
[projname]\ (the VS project)
And the [help]-folder (shfb-output) is only used as a temprary folder.
Source code documentation
The path is relative to the [help] (shfb-output) folder, i guess after your description.
The images is referenced from XML documentation in source code, like this:
<img src="..\images\ControlBox.png" alt="ControlBox Class Diagram" />
I have tryed all build formats, and the only one that I can get to work is Website (HTML/ASP.NET)
, if I manually copy the [images]-folder into the [help]-folder, after a shfb-build. And its okey with a html help. I could do a batch, containing:
xcopy images\*.* help\images\*.* /q /y
And in shfb proj change to include the [projname]<projname>.csproj insted of <appname>.sln, because I get some error running the batch, no problen running in shbf gui. (SHFB : error BE0042: You must specify at least one documentation source)
I have not tryed adding/using MAML-pages, but it maybe a better aproach, then I could extend code documentation, with custom Welcome-, History-, Class description-pages, before the code documentation.