Error Initializing SandcastleBuilder.Components.ShowMissingComponent

Topics: Developer Forum
Aug 6, 2010 at 4:01 PM

I'm running a newly-installed copy of SHFB (July 7 2010 with 2008 compliler, and lastest Styles patch), on Win7-x64 with VS 2010 RTM.  I'm using a .shfb file which was successfully run by another project member earlier, on VS 2008.  Our project has been updated to target dotNet Framework 4 RTM.  My build is failing on the following:

BUILDASSEMBLER : error : BuildAssembler: An error occured while initializing the build component 'SandcastleBuilder.Components.ShowMissingComponent' in the component assembly 'C:\Program Files (x86)\EWSoftware\Sandcastle Help File Builder\SandcastleBuilder.Components.dll'. The error message and stack trace follows: System.Xml.XmlException: An error occurred while parsing EntityName. Line 8, position 38.

The build then terminates with:

SHFB: Error BE0043: Unexpected error detected in last build step.  See output above for details.

Below you will find an excerpted version of the build log.  Note that it doesn't seem to have any reference to 4.0.  The snips all refer to repeated lines of similar pattern(s).

-------------------------------
[Sandcastle Help File Builder Utilities, version 1.9.1.0]
Creating output and working folders...
-------------------------------
Clearing working folder...
-------------------------------
Finding tools...
Found Sandcastle tools in 'C:\Program Files (x86)\Sandcastle\'
Searching for HTML Help 1 compiler...
Found HTML Help 1 compiler in 'C:\Program Files (x86)\HTML Help Workshop\'
-------------------------------
Validating and copying documentation source information
Source: C:\Users\fjames.LEVITJAMES\Documents\A TFS Projects\LJFramework1\_Release\LevitJames.Core.dll
    Found assembly 'C:\Users\fjames.LEVITJAMES\Documents\A TFS Projects\LJFramework1\_Release\LevitJames.Core.dll'

(snip)

Source: C:\Users\fjames.LEVITJAMES\Documents\A TFS Projects\LJFramework1\_Release\LevitJames.WinForms.dll
    Found assembly 'C:\Users\fjames.LEVITJAMES\Documents\A TFS Projects\LJFramework1\_Release\LevitJames.WinForms.dll'
Source: C:\Users\fjames.LEVITJAMES\Documents\A TFS Projects\LJFramework1\_Release\LevitJames.WinForms.xml

(snip)

Copying XML comments files
    C:\Users\fjames.LEVITJAMES\Documents\A TFS Projects\LJFramework1\_Release\LevitJames.Core.xml -> C:\Users\fjames.LEVITJAMES\Documents\A TFS Projects\LJFramework1\_Documentation\Help\Working\LevitJames.Core.xml

    C:\Users\fjames.LEVITJAMES\Documents\A TFS Projects\LJFramework1\_Release\LevitJames.WinForms.xml -> C:\Users\fjames.LEVITJAMES\Documents\A TFS Projects\LJFramework1\_Documentation\Help\Working\LevitJames.WinForms.xml
-------------------------------
Generating shared content files (en-US, English (United States))...
    Last step completed in 00:00:00.1110
-------------------------------
Generating API filter for MRefBuilder...
    Last step completed in 00:00:00.0220
-------------------------------
Generating reflection information...
[C:\Windows\Microsoft.NET\Framework64\v3.5\MSBuild.exe]
GenerateRefInfo:
  MrefBuilder (v2.6.10621.1)
  Copyright c Microsoft 2006
  Info: Loaded 7 assemblies for reflection and 0 dependency assemblies.
  Info: Wrote information on 12 namespaces, 214 types, and 4116 members
  XslTransform (v2.6.10621.1)
  Copyright c Microsoft 2005-2006
  Info: Applying XSL transformation 'C:\Program Files (x86)\Sandcastle\ProductionTransforms\MergeDuplicates.xsl'.
  reflection.all -> reflection.org
    Last step completed in 00:00:17.0820
-------------------------------
Generating namespace summary information...
    Last step completed in 00:00:00.0380
-------------------------------
Applying visibility properties to reflection information file
    408 attribute nodes removed
    62 explicit interface implementations removed
    331 local and base class EII elements removed
    6256 inherited member elements removed
    Last step completed in 00:00:00.2090
-------------------------------
Generating inherited documentation...
[C:\Windows\Microsoft.NET\Framework64\v3.5\MSBuild.exe]
Sandcastle Help File Builder Generate Inherited Documentation, version 1.9.1.0
Copyright c 2006-2010, Eric Woodruff, All Rights Reserved
E-Mail: Eric@EWoodruff.us

Reflection information will be retrieved from 'reflection.org'
Inherited documentation will be written to '_InheritedDocs_.xml'
Indexing C:\Windows\Microsoft.NET\Framework\v2.0.50727\en\*.xml
Indexing C:\Program Files (x86)\Reference Assemblies\Microsoft\Framework\v3.0\en\*.xml
Indexing C:\Program Files (x86)\Reference Assemblies\Microsoft\Framework\v3.5\\*.xml
Indexing C:\Users\fjames.LEVITJAMES\Documents\A TFS Projects\LJFramework1\_Documentation\Help\Working\LevitJames.Core.xml

(snip)

Indexing C:\Users\fjames.LEVITJAMES\Documents\A TFS Projects\LJFramework1\_Documentation\Help\Working\LevitJames.WinForms.xml
Indexed 129854 members in 112 file(s).  7 file(s) to scan for <inheritdoc /> tags.
Merging inherited documentation...

SHFB: Warning GID0004: No comments found for member 'M:LevitJames.Rtf.Storage.TextRangeStore.Dispose(System.Boolean)'
SHFB: Warning GID0004: No comments found for member 'M:LevitJames.WinForms.EnumListBox.OnItemChecked(System.Windows.Forms.ItemCheckEventArgs)'

Documentation merged successfully
    Last step completed in 00:00:04.2510
-------------------------------
Transforming reflection output...
[C:\Windows\Microsoft.NET\Framework64\v3.5\MSBuild.exe]
TransformManifest:
  XslTransform (v2.6.10621.1)
  Copyright c Microsoft 2005-2006
  Info: Applying XSL transformation 'C:\Program Files (x86)\Sandcastle\ProductionTransforms\ApplyVSDocModel.xsl'.
  reflection.org -> C:\Users\fjames.LEVITJAMES\AppData\Local\Temp\tmp4F50.tmp
  Info: Applying XSL transformation 'C:\Program Files (x86)\Sandcastle\ProductionTransforms\AddGuidFilenames.xsl'.
  C:\Users\fjames.LEVITJAMES\AppData\Local\Temp\tmp4F50.tmp -> reflection.xml
  XslTransform (v2.6.10621.1)
  Copyright c Microsoft 2005-2006
  Info: Applying XSL transformation 'C:\Program Files (x86)\Sandcastle\ProductionTransforms\ReflectionToManifest.xsl'.
  reflection.xml -> manifest.xml
    Last step completed in 00:00:02.6540
-------------------------------
Modifying help topic filenames in reflection information file
    No changes required
    Last step completed in 00:00:00.1980
-------------------------------
Copying standard help content...
C:\Program Files (x86)\Sandcastle\Presentation\vs2005\icons\adm.gif -> C:\Users\fjames.LEVITJAMES\Documents\A TFS Projects\LJFramework1\_Documentation\Help\Working\Output\HtmlHelp1\icons\adm.gif
C:\Program Files (x86)\Sandcastle\Presentation\vs2005\icons\adm_arch.gif -> C:\Users\fjames.LEVITJAMES\Documents\A TFS Projects\LJFramework1\_Documentation\Help\Working\Output\HtmlHelp1\icons\adm_arch.gif

(snip)

C:\Program Files (x86)\Sandcastle\Presentation\vs2005\styles\Presentation.css -> C:\Users\fjames.LEVITJAMES\Documents\A TFS Projects\LJFramework1\_Documentation\Help\Working\Output\HtmlHelp1\styles\Presentation.css
C:\Program Files (x86)\Sandcastle\Presentation\vs2005\styles\Whidbey\presentation.css -> C:\Users\fjames.LEVITJAMES\Documents\A TFS Projects\LJFramework1\_Documentation\Help\Working\Output\HtmlHelp1\styles\Whidbey\presentation.css
    Last step completed in 00:00:00.5040
-------------------------------
Copying additional content files...
C:\Users\fjames.LEVITJAMES\Documents\A TFS Projects\LJFramework1\_Documentation\Getting Started\OfficeInterop.htm -> C:\Users\fjames.LEVITJAMES\Documents\A TFS Projects\LJFramework1\_Documentation\Help\Working\Output\HtmlHelp1\Getting Started\OfficeInterop.htm
C:\Users\fjames.LEVITJAMES\Documents\A TFS Projects\LJFramework1\_Documentation\Getting Started\OfficeInteropGettingStarted_image001.jpg -> C:\Users\fjames.LEVITJAMES\Documents\A TFS Projects\LJFramework1\_Documentation\Help\Working\Output\HtmlHelp1\Getting Started\OfficeInteropGettingStarted_image001.jpg

(snip)

C:\Users\fjames.LEVITJAMES\Documents\A TFS Projects\LJFramework1\_Documentation\Getting Started\Undo.htm -> C:\Users\fjames.LEVITJAMES\Documents\A TFS Projects\LJFramework1\_Documentation\Help\Working\Output\HtmlHelp1\Getting Started\Undo.htm
C:\Users\fjames.LEVITJAMES\Documents\A TFS Projects\LJFramework1\_Documentation\Getting Started\UndoGettingStarted_image001.png -> C:\Users\fjames.LEVITJAMES\Documents\A TFS Projects\LJFramework1\_Documentation\Help\Working\Output\HtmlHelp1\Getting Started\UndoGettingStarted_image001.png
    Last step completed in 00:00:00.1740
-------------------------------
Merging conceptual and additional tables of contents...
    Last step completed in 00:00:00.0050
-------------------------------
Generating intermediate table of contents file...
[C:\Windows\Microsoft.NET\Framework64\v3.5\MSBuild.exe]
GenerateIntermediateTOC:
  XslTransform (v2.6.10621.1)
  Copyright c Microsoft 2005-2006
  Info: Applying XSL transformation 'C:\Program Files (x86)\Sandcastle\ProductionTransforms\CreateVSToc.xsl'.
  reflection.xml -> toc.xml
Generating conceptual content intermediate TOC file...
    Last step completed in 00:00:00.5500
-------------------------------
Creating Sandcastle configuration files...
    sandcastle.config
    Last step completed in 00:00:00.0490
-------------------------------
Merging custom build component configurations
C:\Users\fjames.LEVITJAMES\Documents\A TFS Projects\LJFramework1\_Documentation\Help\Working\sandcastle.config
    Last step completed in 00:00:00.0600
-------------------------------
Building reference help topics...
[C:\Windows\Microsoft.NET\Framework64\v3.5\MSBuild.exe]
BuildReferenceTopics:
  BuildAssembler (v2.6.10621.1)
  Copyright c Microsoft 2006
  Info: CopyFromFileComponent: Instantiating component.
  Info: CopyFromFileComponent: Loading data file 'C:\Program Files (x86)\Sandcastle\Presentation\vs2005\Transforms\skeleton.xml'.
  Info: CopyFromIndexComponent: Instantiating component.
  Info: CopyFromIndexComponent: Searching for files that match '*.xml'.
  Info: CopyFromIndexComponent: Searching for files that match 'reflection.xml'.
  Info: CopyFromIndexComponent: Indexed 207553 elements in 409 files.
  Info: CopyFromIndexComponent: Loaded 0 copy components.
  Info: CopyFromIndexComponent: Instantiating component.
  Info: CopyFromIndexComponent: Loaded 0 copy components.
  Info: ForEachComponent: Instantiating component.
  Info: ForEachComponent: Loading subcomponents.
  Info: CopyFromIndexComponent: Instantiating component.
  Info: CopyFromIndexComponent: Loaded 0 copy components.
  Info: ForEachComponent: Loaded 1 subcomponents.
  Info: ForEachComponent: Instantiating component.
  Info: ForEachComponent: Loading subcomponents.

(snip)

  Info: ForEachComponent: Loaded 1 subcomponents.
  Info: IfThenComponent: Instantiating component.
  Info: SyntaxComponent: Instantiating component.
  Info: SyntaxComponent: Loaded 2 syntax generators.
  Info: CopyFromIndexComponent: Instantiating component.
  Info: CopyFromIndexComponent: Searching for files that match 'C:\Windows\Microsoft.NET\Framework\v2.0.50727\en\*.xml'.
  Info: CopyFromIndexComponent: Searching for files that match 'C:\Program Files (x86)\Reference Assemblies\Microsoft\Framework\v3.0\en\*.xml'.
  Info: CopyFromIndexComponent: Searching for files that match 'C:\Program Files (x86)\Reference Assemblies\Microsoft\Framework\v3.5\*.xml'.
  Warn: CopyFromIndexComponent: Entries for the key 'T:Microsoft.Build.BuildEngine.BuildItem' occur in both 'C:\Windows\Microsoft.NET\Framework\v2.0.50727\en\Microsoft.Build.Engine.xml' and 'C:\Program Files (x86)\Reference Assemblies\Microsoft\Framework\v3.5\Microsoft.Build.Engine.xml'. The last entry will be used.
  Warn: CopyFromIndexComponent: Entries for the key 'M:Microsoft.Build.BuildEngine.BuildItem.#ctor(System.String,Microsoft.Build.Framework.ITaskItem)' occur in both 'C:\Windows\Microsoft.NET\Framework\v2.0.50727\en\Microsoft.Build.Engine.xml' and 'C:\Program Files (x86)\Reference Assemblies\Microsoft\Framework\v3.5\Microsoft.Build.Engine.xml'. The last entry will be used.
  Warn: CopyFromIndexComponent: Entries for the key 'M:Microsoft.Build.BuildEngine.BuildItem.#ctor(System.String,System.String)' occur in both 'C:\Windows\Microsoft.NET\Framework\v2.0.50727\en\Microsoft.Build.Engine.xml' and 'C:\Program Files (x86)\Reference Assemblies\Microsoft\Framework\v3.5\Microsoft.Build.Engine.xml'. The last entry will be used.
  Warn: CopyFromIndexComponent: Entries for the key 'M:Microsoft.Build.BuildEngine.BuildItem.Clone' occur in both 'C:\Windows\Microsoft.NET\Framework\v2.0.50727\en\Microsoft.Build.Engine.xml' and 'C:\Program Files (x86)\Reference Assemblies\Microsoft\Framework\v3.5\Microsoft.Build.Engine.xml'. The last entry will be used.

(snip)

  Warn: CopyFromIndexComponent: Entries for the key 'M:LevitJames.WinForms.TreeViewGridNodeRichTextCell.ParseFormattedValue(System.Object,System.Windows.Forms.DataGridViewCellStyle,System.ComponentModel.TypeConverter,System.ComponentModel.TypeConverter)' occur in both 'C:\Users\fjames.LEVITJAMES\Documents\A TFS Projects\LJFramework1\_Documentation\Help\Working\LevitJames.WinForms.xml' and 'C:\Users\fjames.LEVITJAMES\Documents\A TFS Projects\LJFramework1\_Documentation\Help\Working\_InheritedDocs_.xml'. The last entry will be used.
  Warn: CopyFromIndexComponent: Entries for the key 'M:LevitJames.WinForms.TreeViewGridNodeRichTextCell.GetFormattedValue(System.Object,System.Int32,System.Windows.Forms.DataGridViewCellStyle@,System.ComponentModel.TypeConverter,System.ComponentModel.TypeConverter,System.Windows.Forms.DataGridViewDataErrorContexts)' occur in both 'C:\Users\fjames.LEVITJAMES\Documents\A TFS Projects\LJFramework1\_Documentation\Help\Working\LevitJames.WinForms.xml' and 'C:\Users\fjames.LEVITJAMES\Documents\A TFS Projects\LJFramework1\_Documentation\Help\Working\_InheritedDocs_.xml'. The last entry will be used.
  Warn: CopyFromIndexComponent: Entries for the key 'M:LevitJames.WinForms.TreeViewGridTextBoxColumn.Clone' occur in both 'C:\Users\fjames.LEVITJAMES\Documents\A TFS Projects\LJFramework1\_Documentation\Help\Working\LevitJames.WinForms.xml' and 'C:\Users\fjames.LEVITJAMES\Documents\A TFS Projects\LJFramework1\_Documentation\Help\Working\_InheritedDocs_.xml'. The last entry will be used.
  Info: CopyFromIndexComponent: Indexed 129854 elements in 113 files.
  Info: CopyFromIndexComponent: Loaded 0 copy components.
  Info: ForEachComponent: Instantiating component.
  Info: ForEachComponent: Loading subcomponents.
  Info: IfThenComponent: Instantiating component.
  Info: CopyFromIndexComponent: Instantiating component.
  Info: CopyFromIndexComponent: Loaded 0 copy components.
  Info: CopyFromIndexComponent: Instantiating component.
  Info: CopyFromIndexComponent: Loaded 0 copy components.
  Info: ForEachComponent: Loaded 2 subcomponents.
  Info: CopyFromIndexComponent: Instantiating component.
  Info: CopyFromIndexComponent: Loaded 0 copy components.
  Info: ShowMissingComponent: Instantiating component.
  Info: ShowMissingComponent:
      [Sandcastle Help File Builder BuildAssembler Components, version 1.9.1.0]
      Show Missing Documentation Component. Copyright c 2006-2010, Eric Woodruff, All Rights Reserved
      http://SHFB.CodePlex.com
BUILDASSEMBLER : error : BuildAssembler: An error occured while initializing the build component 'SandcastleBuilder.Components.ShowMissingComponent' in the component assembly 'C:\Program Files (x86)\EWSoftware\Sandcastle Help File Builder\SandcastleBuilder.Components.dll'. The error message and stack trace follows: System.Xml.XmlException: An error occurred while parsing EntityName. Line 8, position 38.
     at System.Xml.XmlTextReaderImpl.Throw(Exception e)
     at System.Xml.XmlTextReaderImpl.HandleEntityReference(Boolean isInAttributeValue, EntityExpandType expandType, Int32& charRefEndPos)
     at System.Xml.XmlTextReaderImpl.ParseText(Int32& startPos, Int32& endPos, Int32& outOrChars)
     at System.Xml.XmlTextReaderImpl.ParseText()
     at System.Xml.XmlTextReaderImpl.ParseElementContent()
     at System.Xml.XPath.XPathDocument.LoadFromReader(XmlReader reader, XmlSpace space)
     at System.Xml.XPath.XPathDocument..ctor(String uri, XmlSpace space)
     at SandcastleBuilder.Components.ShowMissingComponent..ctor(BuildAssembler assembler, XPathNavigator configuration)
    Last step completed in 00:00:22.0040
-------------------------------

SHFB: Error BE0043: Unexpected error detected in last build step.  See output above for details.

 

Aug 7, 2010 at 4:04 PM

This phase of the problem has been partially solved -- I removed an ampersand (&) from three places in the project file, and it got past that problem  I hope I can encode that character (will try later) since it's part of our company name (Levit & James, Inc.) and really should be in the Copyright notice.  (I also removed the (c) copyright symbol, but I doubt that's the problem.)

Now, I'm getting much, much further and crapping out on a BE0065 for an EntityName, which I will be researching.

Coordinator
Aug 7, 2010 at 9:18 PM

Properties such as HeaderText and FooterText support HTML tags within their values so any encodable characters within them must be specified in encoded form such as the ampersand (&amp;).  See the help topics for the properties to see which ones support HTML and thus need encoding.

Eric