sandcastleshfb

Ordered list with Sandcastle Help File Builder


How do I make a list in xmldoc blocks render as an ordered list when I create a chm with Sandcastle Helpfile Builder?

The following does not work:

/// <list type="numbered">
///     <item>Built in support for foobar</item>
///     <item>Client gooblygook and associated javascript support</item>
///     <item>Client side ability to read values from control</item>
///     <item>AJAX support via ASP.NET callbacks</item>
///     <item>Smaller HTML and Javascript footprint when compared to the crappy thirdparty control we paid too much for.</item>
/// </list>

In the particular case I am trying to solve for, the list is within a <summary/> element.


Solution

  • Just in case anyone runs across this question - the correct implementation is:

        /// <list type="number">
        ///     <item>Built in support for foobar</item>
        ///     <item>Client gooblygook and associated javascript support</item>
        ///     <item>Client side ability to read values from control</item>
        ///     <item>AJAX support via ASP.NET callbacks</item>
        ///     <item>Smaller HTML and Javascript footprint when compared to the crappy thirdparty control we paid too much for.</item>
        /// </list>
    

    It does not have to be in the <remarks> section.

    Read more at <list> (C# Programming Guide)