Click here to Skip to main content
15,892,269 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.
<html>
<head>
<link rel="stylesheet" type="text/css" href="../styles/Styles.css">
<title>Absolute and Relative Paths</title>
</head>

<body>

<h2>Absolute and Relative Paths</h2>
In the form that lets you edit the assembly and XML comment filenames and
for the path-related properties in the project, you can enter absolute
paths or relative paths.  When using the designer popups (accessed by
clicking the "..." button to the right of the filename/folder value in the
property grid when it is selected), absolute paths are always returned.
However, you can edit the returned path to make it a relative path.  The
key point to remember is that the help file builders (both the GUI and
console version) always expect that relative paths are relative to either
the folder in which the project file is saved or to the working folder used
for the build.  The expected relative location will be noted in the
description of each affected property.  A typical folder layout is shown
here:

<pre>
C:\HelpTest\        Solution folder.
  |
  +-TestAssembly    Application project folder.
  | |
  | +-Bin
  |   |
  |   +-Release     Location of assembly and comment files.
  |
  +-Doc             Help file builder project location.
    |
    |
    +-Help          The output folder for the help file.
      |
      +-Working     The intermediate working folder used
        |           during the build.
        |
        +-DLL       Dependencies folder for MRefBuilder
        |           (if needed).
        |
        +-Output    Help file project compilation folder.
          +-art
          +-html
          +-scripts
          +-styles
</pre>

The example above places the help file builder project in the
<i>C:\HelpTest\Doc\</i> folder.  As such, the relative path to the assembly
that will be documented and its comment file is
<i>..\TestAssembly\Bin\Release\</i>.  The default output folder for a project
is always <i>.\Help\</i>.  If you would prefer the help file to end up in a
different location, you can modify it using the <code>OutputPath</code>
property.

<br/><br/>
<include item="footer"/>

</body>
</html>
<!-- @SortOrder 2 -->

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