Click here to Skip to main content
15,892,965 members
Articles / Operating Systems / Windows

Sandcastle Help File Builder

Rate me:
Please Sign up or sign in to vote.
4.93/5 (131 votes)
17 May 2007Ms-PL45 min read 1M   5.3K   291  
A GUI for creating projects to build help files with Sandcastle and a console mode tool to build them as well.
<?xml version="1.0" encoding="utf-8"?>
<!-- Translations provided by Dessiatov Anton -->
<content xml:space="preserve" xmlns:MSHelp="http://msdn.microsoft.com/mshelp">

	<!-- paths -->
	<item id="iconPath">../icons/{0}</item>
	<item id="scriptPath">../scripts/{0}</item>
	<item id="stylePath">../styles/{0}</item>
	<item id="artPath">../media/{0}</item>

	<!-- locale -->
	<item id="locale">{@Locale}</item>

	<item id="desktopTechnologyAttribute">kbNetFramewk</item>
	<item id="netcfTechnologyAttribute">kbNetCompactFramewk</item>
	<item id="netcfDocSetAttribute">NetCompactFramework</item>

	<!-- header -->
	<item id="header"><div id="header">{@HeaderText} {@Preliminary}</div></item>
	<item id="preliminary"><p style="color: #dc143c; font-size: 8.5pt; font-weight: bold;">[This is preliminary documentation and is subject to change.]</p></item>

	<!-- alert titles -->
	<item id="cautionTitle"><b>Caution:</b></item>
	<item id="securityTitle"><b>Security Note:</b></item>
	<item id="noteTitle"><b>Note:</b></item>
	<item id="importantTitle"><b>Important Note:</b></item>
	<item id="visualBasicTitle"><b>Visual Basic Note:</b></item>
	<item id="visualC#Title"><b>C# Note:</b></item>
	<item id="visualC++Title"><b>C++ Note:</b></item>
	<item id="visualJ#Title"><b>J# Note:</b></item>

	<!-- alert alt text -->
	<item id="cautionAltText">Caution note</item>
	<item id="securityAltText">Security note</item>
	<item id="noteAltText">Note</item>
	<item id="importantAltText">Important note</item>
	<item id="visualBasicAltText">Visual Basic note</item>
	<item id="visualC#AltText">C# note</item>
	<item id="visualC++AltText">C++ note</item>
	<item id="visualJ#AltText">J# note</item>

	<!-- code labels -->
	<item id="CSharpLabel">C#</item>
	<item id="VisualBasicLabel">Visual Basic</item>
	<item id="ManagedCPlusPlusLabel">Managed C++</item>
	<item id="JSharpLabel">J#</item>
	<item id="JScriptLabel">JScript</item>
	<item id="VisualBasicUsageLabel">Visual Basic (Usage)</item>

	<!-- product labels -->
	<item id="framework">.NET Framework</item>
	<item id="compact">.NET Compact Framework</item>
	<item id="everett">1.1</item>
	<item id="whidbey">2.0</item>

	<item id="copyCode">Copy</item>
	<item id="CopyCodeImage">Copy</item>

	<!-- dynamic Link Information -->
	<item id="mshelpKTable"><MSHelp:ktable keywords='{0}' locHeader='Location' topicHeader = 'Topic' disambiguator='table' indexMoniker='!DefaultDynamicLinkIndex' /></item>
	<item id="dynamicLinkInlinePreFixText">For more information, see </item>
	<item id="dynamicLinkInlinePostFixText">.</item>
	<item id="dynamicLinkInlineSeperatorText"> and </item>

	<item id="remarksTitle">Remarks</item>

	<!-- transforms insert K Index Technology qualifiers based on a conceptual topic's //metadata/attribute[@name='DocSet'] value />-->
	<!-- If you add new docset values, the item/@id must = "kIndexTechTag_" + the lower-case DocSet name. -->
	<item id="kIndexTermWithTechQualifier">{0}<include item="kIndexTechTag_{1}" />{2}</item>
	<item id="kIndexTechTag_avalon"> [Windows Presentation Foundation]</item>
	<item id="kIndexTechTag_wpf"> [Windows Presentation Foundation]</item>
	<item id="kIndexTechTag_wcf"> [Windows Communication Foundation]</item>
	<item id="kindextechtag_windowsforms"> [Windows Forms]</item>

	<!-- footer -->
	<item id="footer"><div id="footer">{@FooterText}{@Comments} {@Copyright}</div></item>
	<item id="comments"><p/>Send comments on this topic to
        <a id="HT_MailLink" href="mailto:{@UrlEncFeedbackEMailAddress}?Subject={@UrlEncHelpTitle}">{@HtmlEncFeedbackEMailAddress}</a>
        <script type="text/javascript">
        var HT_mailLink = document.getElementById("HT_MailLink");
        var HT_mailLinkText = HT_mailLink.innerHTML;
        HT_mailLink.href += ": " + document.title;
        HT_mailLink.innerHTML = HT_mailLinkText;
        </script></item>
    <!-- To format the copyright HREF and/or copyright text into a message of
         your choosing, you can specify @HtmlEncCopyrightHref and/or
         @HtmlEncCopyrightText in braces -->
	<item id="copyright">{@HtmlEncCopyrightInfo}</item>

</content>

By viewing downloads associated with this article you agree to the Terms of Service and the article's licence.

If a file you wish to view isn't highlighted, and is a text file (not binary), please let us know and we'll add colourisation support for it.

License

This article, along with any associated source code and files, is licensed under The Microsoft Public License (Ms-PL)


Written By
Software Developer (Senior)
United States United States
Eric Woodruff is an Analyst/Programmer for Spokane County, Washington where he helps develop and support various applications, mainly criminal justice systems, using Windows Forms (C#) and SQL Server as well as some ASP.NET applications.

He is also the author of various open source projects for .NET including:

The Sandcastle Help File Builder - A front end and project management system that lets you build help file projects using Microsoft's Sandcastle documentation tools. It includes a standalone GUI and a package for Visual Studio integration.

Visual Studio Spell Checker - A Visual Studio editor extension that checks the spelling of comments, strings, and plain text as you type or interactively with a tool window. This can be installed via the Visual Studio Gallery.

Image Map Controls - Windows Forms and web server controls that implement image maps.

PDI Library - A complete set of classes that let you have access to all objects, properties, parameter types, and data types as defined by the vCard (RFC 2426), vCalendar, and iCalendar (RFC 2445) specifications. A recurrence engine is also provided that allows you to easily and reliably calculate occurrence dates and times for even the most complex recurrence patterns.

Windows Forms List Controls - A set of extended .NET Windows Forms list controls. The controls include an auto-complete combo box, a multi-column combo box, a user control dropdown combo box, a radio button list, a check box list, a data navigator control, and a data list control (similar in nature to a continuous details section in Microsoft Access or the DataRepeater from VB6).

For more information see http://www.EWoodruff.us

Comments and Discussions