This build component is a companion to the CodeBlockComponent. It is used to add the stylesheet and JavaScript links to the rendered HTML if the topic contains colorized code. In addition, it can insert a logo image at the top of each help topic and, for the Prototype presentation style, hide the language combo box if only one language appears in the Syntax section. With a modification to the Sandcastle reference content files, it will also add version information to each topic.

Namespace: SandcastleBuilder.Components
Assembly: SandcastleBuilder.Components (in SandcastleBuilder.Components.dll) Version: 1.9.3.0

Syntax

C#
public class PostTransformComponent : BuildComponent
Visual Basic
Public Class PostTransformComponent _
	Inherits BuildComponent

Remarks

The colorizer files are only copied once and only if code is actually colorized. If the files already exist (i.e. additional content has replaced them), they are not copied either. That way, you can customize the color stylesheet as you see fit without modifying the default stylesheet.

By adding "Version: {2}" to the locationInformation entry and the assemblyNameAndModule entry in the reference_content.xml file in the Prototype, VS2005, and Hana style content files, you can add version information to each topic. The help file builder uses a composite file with this fix already in place.

Examples

CopyExample configuration
<!-- Post-transform component configuration.  This must
     appear after the TransformComponent.  See also:
     CodeBlockComponent. -->
<component type="SandcastleBuilder.Components.PostTransformComponent"
  assembly="C:\SandcastleComponents\SandcastleBuilder.Components.dll" >
    <!-- Code colorizer files (required).
         Attributes:
            Stylesheet file (required)
            Script file (required)
            "Copy" image file (required) -->
    <colorizer stylesheet="highlight.css" scriptFile="highlight.js"
       copyImage="CopyCode.gif" />

    <!-- Base output paths for the files (required).  These should
         match the parent folder of the output path of the HTML files
         (see each of the SaveComponent instances below). -->
    <outputPaths>
      <path value="Output\HtmlHelp1\" />
      <path value="Output\MSHelp2\" />
      <path value="Output\MSHelpViewer\" />
      <path value="Output\Website\" />
    </outputPaths>

    <!-- Logo image file (optional).  Filename is required.  The
         height, width, altText, placement, and alignment attributes
         are optional. -->
    <logoFile filename="Logo.jpg" height="64" width="64"
       altText="Test Logo" placement="left" alignment="left" />
</component>

Inheritance Hierarchy

System..::..Object
  Microsoft.Ddue.Tools..::..BuildComponent
    SandcastleBuilder.Components..::..PostTransformComponent

See Also