This project has moved and is read-only. For the latest updates, please go here.

Need Help with SandCastle Help file builder

Sep 11, 2008 at 2:25 AM


 I made my xml style comments like so.


  /// <summary>
        /// stuff here
        /// <remarks>
        ///     <authors id="123" email="">chobo2</authors>
        /// </remarks>
        /// </summary>

 I used sandCastle Help builder file to make it into a chm file. However I noticed that the tags that I made up such as "authors" or attrubues stuck as "id and email" don't show up. I don't know why.


Any ideas?

Sep 11, 2008 at 2:32 AM
Sandcastle only processes a specific set of XML comments tags.  See the XML Comments Guide for the list.  To implement support for your own custom tags, you need to modify the Sandcastle transformations.  See this blog entry for information:

Sep 11, 2008 at 5:11 AM
Edited Sep 11, 2008 at 5:38 AM
Ah ok that makes sense.

So how would I change the author tag to have those attributes? Would it look like this?

       <xsl:template match="author">
        <xsl:call-template name="section">
      <xsl:with-param name="toggleSwitch" select="'author'"/>
            <xsl:with-param name="id"><include item="id" /></xsl:with-param>
            <xsl:with-param name="content"><xsl:apply-templates /></xsl:with-param>
            <xsl:with-param name="email"><include item="email" /></xsl:with-param>
            <xsl:with-param name="content"><xsl:apply-templates /></xsl:with-param>

What I have is not working. I don't get the tutorial first there are 3 of these files "main_sandcastle.xsl"

So I am not sure which one I should be doing the editing in. Then ontop of it the tutorial really only shows how to do tags without attributes in them and I don't even fully understand that.
Sep 11, 2008 at 6:52 AM
Edited Sep 11, 2008 at 6:56 AM

I figured out how to do the one from the tutorial and which file to use but I still can't get a custom attribute in it. like I can't get the Id or email attributes to show up in author.
Sep 11, 2008 at 3:59 PM

Since this is specific to Sandcastle, please post over in the Discussion area in the Sandcastle project as you'll get a wider audience and somebody that's done it before may be able to help you out.  Thanks.