Sandcastle Help File Builder v1.3.0.0 Now Available RRS feed

  • General discussion

  • The latest update to the Sandcastle Help File Builder is available at http://www.codeplex.com/Release/ProjectReleases.aspx?ProjectName=SHFB

    v1.3.0.0 - Changes made in this release:

    • Improved the help file. The article was getting rather long so I have moved a lot of the information to the help file and expanded on it as needed to make it more useful. See it for more information on how to use the help file builder.
    • Added Website, Help1xAndWebsite, and Help2xAndWebsite options to the HelpFileFormat property to allow generating the help as a website, a website plus an HTML Help 1.x file, or a website plus an HTML Help 2.x file. The website output includes an index page complete with tree view for navigating the table of content.
    • The ContentItem class's IsDefaultPage and ContentDescription properties have been removed as they are now obtained along with a sort order while copying the additional content items and building table of content entries for them. See The Additional Content Property topic for more information on the new features.
    • Added a preview option to the Additional Content editor dialog box to preview the table of content entries for the additional content. You can also arrange items and set the default topic from it.
    • Added the ability to create links to namespace help content from the additional content files. See the Linking to Namespace Content topic for more information.
    • Modified the file I/O code to detect the encoding of the files when reading them and to use the same encoding when writing them back out to preserve the character encodings within the files.
    • The table of content file for HTML Help 1.x files is now saved using the default encoding based on the system's code page rather than UTF-8 encoding to ensure that the character encodings are correctly interpretted by the help compiler and viewer.
    • Some additional notes regarding encoding have been added to the information on how to create language resource files for other languages.
    • Added a command to the Documentation menu to clear the output window on the main form. The View Log form now loads the log text from the last build's log file.
    • Added a version check on MRefBuilder.exe to ensure that a valid version is being used. An exception is thrown if the version found is less than the expected version (you need to update Sandcastle). A warning is issued if the version found is greater than the expected version (you need to update the help file builder).
    • The New Project from Visual Studio Project option now recognizes VB.NET and J# solution files.
    • Fixed a bug that caused assembly loading to fail under certain circumstances when determining namespaces for the Namespace Summaries dialog box.
    • Fixed a bug that caused the build process to try and scan a drive that didn't exist when looking for the HTML Help 2.x compiler.
    • The Language property now only shows the list of languages for which resource files exist.
    • Thanks to Olaf Rittig for the German translation of the language resource files.
    • Thanks to Thierry Huguet and his colleagues for the French, Italian, and Spanish translations of the language resource files.
    Tuesday, September 26, 2006 6:40 AM

All replies

  • Hi,

    Sounds good, downloading as we speak.

    A question for you: do you know of a "preview" tool, similar to the now disappeared Documentor?


    Tuesday, September 26, 2006 7:14 PM
  • I'm not familiar with Documentor.  What did it do?


    Tuesday, September 26, 2006 8:15 PM
  • It provided a preview of the XML documentation, so that you didn't have to compile and build the help system to see the result.

    I think I found something:

    Installing now.
    Tuesday, September 26, 2006 8:17 PM
  • I downloaded and tried building a help website, CHM and HxS and Eric's help file builder rocks. It's amazing to see such a nice GUI for Sandcastle. Thanks Eric for all your hard work.

    Also thanks to Thierry and Olaf for helping Eric with the language resource file. Perhaps we can localize the GUI also?




    Wednesday, September 27, 2006 6:05 AM
  • Localization is on the To Do list but probably won't happen until I after Sandcastle's RTW and I add in the other features on my To Do list.


    Wednesday, September 27, 2006 3:18 PM