/// <summary>
/// The creates the configuration information or settings required by the
/// target component for the build process.
/// </summary>
/// <param name="group">
/// A build group, <see cref="BuildGroup"/>, representing the documentation
/// target for configuration.
/// </param>
/// <param name="writer">
/// An <see cref="XmlWriter"/> object used to create one or more new
/// child nodes at the end of the list of child nodes of the current node.
/// </param>
/// <returns>
/// Returns <see langword="true"/> for a successful configuration;
/// otherwise, it returns <see langword="false"/>.
/// </returns>
/// <remarks>
/// The <see cref="XmlWriter"/> writer passed to this configuration object
/// may be passed on to other configuration objects, so do not close or
/// dispose it.
/// </remarks>
public override bool Configure(BuildGroup group, XmlWriter writer)
{
BuildExceptions.NotNull(group, "group");
BuildExceptions.NotNull(writer, "writer");
if (!this.Enabled || !this.IsInitialized)
{
return(false);
}
Debug.Assert(_settings != null, "The settings object is required.");
if (_settings == null || _context == null)
{
return(false);
}
BuildStyle buildStyle = _settings.Style;
Debug.Assert(buildStyle != null, "The style object cannot be null (or Nothing).");
if (buildStyle == null)
{
return(false);
}
//<component type="Sandcastle.Components.ReferenceCodeComponent" assembly="$(SandAssistComponent)">
// <options mode="IndirectIris" tabSize="4" lineNumbers="true" outlining="false" storage="Sqlite" separator="..."/>
//
// <!--The following options are for processing codeReference tags in the
// reference help.
// It is a replacement of the ExampleComponent, providing better coloring,
// minimum memory usage etc.
//
// $codeSnippets
// @storage: * Indicates where the code snippets should be stored after loading
// * Possible values are
// - Memory: the snippets are stored in memory similar to
// the ExampleComponent.
// - Database: the snippets are stored in Sqlite database.
// * Default: Database
// @separator: * For multi-parts snippets, this defines the separator...
// * Default: ...-->
//
// <!--<codeSnippets>
// <codeSnippet source=".\CodeSnippetSample.xml" format="Sandcastle" />
// </codeSnippets>-->
// <SandcastleItem name="%CodeSnippets%" />
//</component>
writer.WriteStartElement("options"); //start: options
writer.WriteAttributeString("mode", _highlightMode);
writer.WriteAttributeString("tabSize", _tabSize.ToString());
writer.WriteAttributeString("lineNumbers", _showLineNumbers.ToString());
writer.WriteAttributeString("outlining", _showOutlining.ToString());
writer.WriteAttributeString("storage", _snippetStorage.ToString());
writer.WriteAttributeString("separator", _snippetSeparator);
writer.WriteEndElement(); //end: options
IList <CodeSnippetContent> listSnippets = group.SnippetContents;
if (listSnippets != null && listSnippets.Count != 0)
{
writer.WriteStartElement("codeSnippets"); // start - codeSnippets
int contentCount = listSnippets.Count;
for (int i = 0; i < contentCount; i++)
{
CodeSnippetContent snippetContent = listSnippets[i];
if (snippetContent == null || snippetContent.IsEmpty)
{
continue;
}
writer.WriteStartElement("codeSnippet"); // start - codeSnippet
writer.WriteAttributeString("source", snippetContent.ContentFile);
writer.WriteAttributeString("format", "Sandcastle");
writer.WriteEndElement(); // end - codeSnippet
}
writer.WriteEndElement(); // end - codeSnippets
}
SnippetContent snippets = buildStyle.Snippets;
if (snippets != null && snippets.Count != 0)
{
writer.WriteStartElement("codeSources"); // start - codeSources
for (int i = 0; i < snippets.Count; i++)
{
SnippetItem snippetItem = snippets[i];
if (snippetItem == null || snippetItem.IsEmpty)
{
continue;
}
writer.WriteStartElement("codeSource"); // start - codeSource
writer.WriteAttributeString("source", snippetItem.Source);
writer.WriteAttributeString("format", "Sandcastle");
writer.WriteEndElement(); // end - codeSource
}
// The excludedUnits is required by the SnippetComponent,
// we maintain that...
writer.WriteStartElement("excludedUnits"); // start - excludedUnits
IList <string> excludedUnits = snippets.ExcludedUnitFolders;
if (excludedUnits != null && excludedUnits.Count != 0)
{
for (int i = 0; i < excludedUnits.Count; i++)
{
string unitFolder = excludedUnits[i];
if (String.IsNullOrEmpty(unitFolder))
{
continue;
}
writer.WriteStartElement("unitFolder"); // start - unitFolder
writer.WriteAttributeString("name", unitFolder);
writer.WriteEndElement(); // end - unitFolder
}
}
writer.WriteEndElement(); // end - excludedUnits
writer.WriteStartElement("languages"); // start - languages
IList <SnippetLanguage> languages = snippets.Languages;
if (languages != null && languages.Count != 0)
{
for (int i = 0; i < languages.Count; i++)
{
SnippetLanguage language = languages[i];
if (!language.IsValid)
{
continue;
}
writer.WriteStartElement("language"); // start - language
writer.WriteAttributeString("unit", language.Unit);
writer.WriteAttributeString("languageId", language.LanguageId);
writer.WriteAttributeString("extension", language.Extension);
writer.WriteEndElement(); // end - language
}
}
writer.WriteEndElement(); // end - languages
writer.WriteEndElement(); // end - codeSources
}
return(true);
}
/// <summary>
/// The creates the configuration information or settings required by the
/// target component for the build process.
/// </summary>
/// <param name="group">
/// A build group, <see cref="BuildGroup"/>, representing the documentation
/// target for configuration.
/// </param>
/// <param name="writer">
/// An <see cref="XmlWriter"/> object used to create one or more new
/// child nodes at the end of the list of child nodes of the current node.
/// </param>
/// <returns>
/// Returns <see langword="true"/> for a successful configuration;
/// otherwise, it returns <see langword="false"/>.
/// </returns>
/// <remarks>
/// The <see cref="XmlWriter"/> writer passed to this configuration object
/// may be passed on to other configuration objects, so do not close or
/// dispose it.
/// </remarks>
public override bool Configure(BuildGroup group, XmlWriter writer)
{
BuildExceptions.NotNull(group, "group");
BuildExceptions.NotNull(writer, "writer");
IBuildNamedList <BuildGroupContext> groupContexts = _context.GroupContexts;
if (groupContexts == null || groupContexts.Count == 0)
{
throw new BuildException(
"The group context is not provided, and it is required by the build system.");
}
ReferenceGroupContext groupContext = groupContexts[group.Id]
as ReferenceGroupContext;
if (groupContext == null)
{
throw new BuildException(
"The group context is not provided, and it is required by the build system.");
}
if (!this.Enabled || !this.IsInitialized)
{
return(false);
}
BuildFramework framework = groupContext.Framework;
BuildFrameworkKind kind = framework.FrameworkType.Kind;
ReferenceEngineSettings referenceSettings = _settings.EngineSettings[
BuildEngineType.Reference] as ReferenceEngineSettings;
BuildSpecialSdkType webSdkType = referenceSettings.WebMvcSdkType;
writer.WriteStartElement("options"); // start - options
writer.WriteAttributeString("locale",
_settings.CultureInfo.Name.ToLower());
if (kind == BuildFrameworkKind.Silverlight)
{
writer.WriteAttributeString("version", "VS.95");
}
else if (kind == BuildFrameworkKind.Compact)
{
// The framework 3.5 is the last version of Windows CE...
writer.WriteAttributeString("version", "VS.90");
}
if (webSdkType != BuildSpecialSdkType.Null &&
webSdkType != BuildSpecialSdkType.None)
{
switch (webSdkType.Value)
{
case 10: // ASP.NET MVC 1.0: Supported in .NET 3.5
writer.WriteAttributeString("mvcVersion", "VS.90");
break;
case 20: // ASP.NET MVC 2.0: Supported in .NET 3.5 SP1
// This is currently the default documentation for
// the ASP.NET MVC Framework...
writer.WriteAttributeString("mvcVersion", "");
break;
case 30: // ASP.NET MVC 3.0: Supported in .NET 4.0
writer.WriteAttributeString("mvcVersion", "VS.98");
break;
case 40: // ASP.NET MVC 4.0: Supported in .NET 4.5
writer.WriteAttributeString("mvcVersion", "VS.108");
break;
}
}
writer.WriteAttributeString("linkTarget",
"_" + _format.ExternalLinkTarget.ToString().ToLower());
writer.WriteEndElement(); // end - options
bool isEmbeddedGroup = false;
bool frameworkAvailable = false;
bool isEmbeddedScript = groupContext.IsEmbeddedGroup;
string tempText = _context["$EmbeddedScriptSharp"];
if (!String.IsNullOrEmpty(tempText))
{
isEmbeddedScript = Convert.ToBoolean(tempText);
}
List <DataSource> dataSources = new List <DataSource>();
if (kind == BuildFrameworkKind.Silverlight)
{
string silverlightDir = groupContext["$SilverlightDataDir"];
if (!String.IsNullOrEmpty(silverlightDir) &&
Directory.Exists(silverlightDir))
{
frameworkAvailable = true;
writer.WriteStartElement("targets");
writer.WriteAttributeString("base", silverlightDir);
writer.WriteAttributeString("recurse", "false");
writer.WriteAttributeString("system", "true");
writer.WriteAttributeString("files", "*.xml");
writer.WriteAttributeString("type",
_format.ExternalLinkType.ToString().ToLower());
// Write the data source...
Version latestVersion = BuildFrameworks.LatestSilverlightVersion;
if (latestVersion == null)
{
latestVersion = framework.Version;
}
this.WriteDataSource(writer, DataSourceType.Silverlight,
silverlightDir, latestVersion, true, true, dataSources);
writer.WriteEndElement();
}
}
else if (kind == BuildFrameworkKind.Portable)
{
string portableDir = groupContext["$PortableDataDir"];
if (!String.IsNullOrEmpty(portableDir) && Directory.Exists(portableDir))
{
frameworkAvailable = true;
writer.WriteStartElement("targets");
writer.WriteAttributeString("base", portableDir);
writer.WriteAttributeString("recurse", "false");
writer.WriteAttributeString("system", "true");
writer.WriteAttributeString("files", "*.xml");
writer.WriteAttributeString("type",
_format.ExternalLinkType.ToString().ToLower());
// Write the data source...
Version latestVersion = BuildFrameworks.LatestPortableVersion;
if (latestVersion == null)
{
latestVersion = framework.Version;
}
this.WriteDataSource(writer, DataSourceType.Portable,
portableDir, latestVersion, true, false, dataSources);
writer.WriteEndElement();
}
}
else if (kind == BuildFrameworkKind.ScriptSharp)
{
string scriptSharpDir = groupContext["$ScriptSharpDataDir"];
if (!String.IsNullOrEmpty(scriptSharpDir) && Directory.Exists(scriptSharpDir))
{
frameworkAvailable = true;
if (!isEmbeddedGroup)
{
writer.WriteStartElement("targets");
writer.WriteAttributeString("base", scriptSharpDir);
writer.WriteAttributeString("recurse", "false");
writer.WriteAttributeString("system", "true");
writer.WriteAttributeString("files", "*.xml");
if (isEmbeddedScript)
{
writer.WriteAttributeString("type",
BuildLinkType.Local.ToString().ToLower());
}
else
{
writer.WriteAttributeString("type",
BuildLinkType.None.ToString().ToLower());
}
// Write the data source...
Version latestVersion = BuildFrameworks.LatestScriptSharpVersion;
if (latestVersion == null)
{
latestVersion = framework.Version;
}
this.WriteDataSource(writer, DataSourceType.ScriptSharp,
scriptSharpDir, latestVersion, true, false, dataSources);
writer.WriteEndElement();
}
}
}
// If not specialized framework, then write the default...
if (!frameworkAvailable || kind == BuildFrameworkKind.None ||
kind == BuildFrameworkKind.DotNet || kind == BuildFrameworkKind.Compact)
{
string dotNetDataDir = Path.GetFullPath(
Environment.ExpandEnvironmentVariables(ReferenceEngine.ReflectionDirectory));
writer.WriteStartElement("targets");
writer.WriteAttributeString("base", dotNetDataDir);
writer.WriteAttributeString("recurse", "true");
writer.WriteAttributeString("system", "true");
writer.WriteAttributeString("files", "*.xml");
writer.WriteAttributeString("type",
_format.ExternalLinkType.ToString().ToLower());
// Write the data source...
this.WriteDataSource(writer, DataSourceType.Framework,
dotNetDataDir, ReferenceEngine.ReflectionVersion, true,
false, dataSources);
writer.WriteEndElement();
}
// The Portable and ScriptSharp do not support Blend...
if (kind != BuildFrameworkKind.Portable &&
kind != BuildFrameworkKind.Compact &&
kind != BuildFrameworkKind.ScriptSharp)
{
string blendDir = groupContext["$BlendDataDir"];
if (!String.IsNullOrEmpty(blendDir) && Directory.Exists(blendDir))
{
writer.WriteStartElement("targets");
writer.WriteAttributeString("base", blendDir);
writer.WriteAttributeString("recurse", "false");
writer.WriteAttributeString("system", "true");
writer.WriteAttributeString("files", "*.xml");
writer.WriteAttributeString("type",
_format.ExternalLinkType.ToString().ToLower());
// Write the data source...
BuildSpecialSdk latestBlendSdk = null;
if (kind == BuildFrameworkKind.Silverlight)
{
latestBlendSdk = BuildSpecialSdks.LatestBlendSilverlightSdk;
}
else
{
latestBlendSdk = BuildSpecialSdks.LatestBlendWpfSdk;
}
Version latestVersion = (latestBlendSdk == null) ?
null : latestBlendSdk.Version;
if (latestVersion == null)
{
latestVersion = framework.Version;
}
this.WriteDataSource(writer, DataSourceType.Blend, blendDir,
latestVersion, true, kind == BuildFrameworkKind.Silverlight,
dataSources);
writer.WriteEndElement();
}
}
IList <string> linkDirs = _context.GetValue(
"$ReferenceLinkDirectories") as IList <string>;
IList <ReferenceLinkSource> linkSources = _context.GetValue(
"$ReferenceLinkSources") as IList <ReferenceLinkSource>;
if ((linkDirs != null && linkDirs.Count != 0) &&
(linkSources != null && linkSources.Count == linkDirs.Count))
{
for (int i = 0; i < linkDirs.Count; i++)
{
ReferenceLinkSource linkSource = linkSources[i];
BuildLinkType sourceLinkType = linkSource.LinkType;
writer.WriteStartElement("targets");
writer.WriteAttributeString("base", linkDirs[i]);
writer.WriteAttributeString("recurse", "true");
writer.WriteAttributeString("system", "false");
writer.WriteAttributeString("files", "*.xml");
writer.WriteAttributeString("type",
sourceLinkType.ToString().ToLower());
writer.WriteEndElement();
}
}
BuildLinkType linkType = _format.LinkType;
string linkTypeText = linkType.ToString().ToLower();
// For the embedded group, we will not link to the other groups...
if (!isEmbeddedGroup)
{
for (int i = 0; i < groupContexts.Count; i++)
{
ReferenceGroupContext aContext = groupContexts[i]
as ReferenceGroupContext;
if (aContext == null || aContext.IsLinkGroup)
{
continue;
}
if (aContext.GroupType != BuildGroupType.Reference ||
aContext == groupContext)
{
continue;
}
string linkFile = aContext["$ReflectionFile"];
if (!String.IsNullOrEmpty(linkFile))
{
writer.WriteStartElement("targets");
writer.WriteAttributeString("base", @".\");
writer.WriteAttributeString("recurse", "false");
writer.WriteAttributeString("system", "false");
writer.WriteAttributeString("files", @".\" + linkFile);
writer.WriteAttributeString("type", linkTypeText);
writer.WriteEndElement();
}
}
}
//<targets base=".\" recurse="false"
// files=".\reflection.xml" type="local" />
writer.WriteStartElement("targets");
writer.WriteAttributeString("base", @".\");
writer.WriteAttributeString("recurse", "false");
writer.WriteAttributeString("system", "false");
writer.WriteAttributeString("files", @".\" + groupContext["$ReflectionFile"]);
if (isEmbeddedGroup)
{
writer.WriteAttributeString("type",
BuildLinkType.Local.ToString().ToLower());
}
else
{
writer.WriteAttributeString("type", linkTypeText);
}
writer.WriteEndElement();
// Provide the information for the MSDN link resolvers...
writer.WriteStartElement("linkResolver"); // start - linkResolver
writer.WriteAttributeString("storage", _linkStorage.ToString().ToLower());
writer.WriteAttributeString("cache", _cacheLinks ? "true" : "false");
if (dataSources != null && dataSources.Count != 0)
{
for (int i = 0; i < dataSources.Count; i++)
{
DataSource dataSource = dataSources[i];
this.WriteDataSource(writer, dataSource.SourceType,
dataSource.InputDir, dataSource.Version,
dataSource.IsDatabase, dataSource.IsSilverlight, true);
}
}
writer.WriteEndElement(); // end - linkResolver
// Finally, provide the information for the conceptual links
// in reference documents, if any...
bool hasConceptualContext = _settings.BuildConceptual;
if (hasConceptualContext)
{
hasConceptualContext = false;
for (int i = 0; i < groupContexts.Count; i++)
{
BuildGroupContext aContext = groupContexts[i];
if (aContext.GroupType == BuildGroupType.Conceptual)
{
hasConceptualContext = true;
break;
}
}
}
if (hasConceptualContext)
{
ConceptualEngineSettings conceptualSettings = _settings.EngineSettings[
BuildEngineType.Conceptual] as ConceptualEngineSettings;
Debug.Assert(conceptualSettings != null,
"The settings does not include the reference engine settings.");
if (conceptualSettings == null)
{
return(false);
}
ConceptualLinkConfiguration linkConfig =
conceptualSettings.ConceptualLinks;
Debug.Assert(linkConfig != null,
"There is no conceptual link configuration available.");
if (linkConfig == null)
{
return(false);
}
writer.WriteStartElement("conceptualLinks"); //start: conceptualLinks
writer.WriteAttributeString("enabled", "true");
writer.WriteAttributeString("showText",
linkConfig.ShowLinkText.ToString());
writer.WriteAttributeString("showBrokenLinkText",
linkConfig.ShowBrokenLinkText.ToString());
writer.WriteAttributeString("type", linkTypeText);
for (int i = 0; i < groupContexts.Count; i++)
{
BuildGroupContext aContext = groupContexts[i];
if (aContext.GroupType == BuildGroupType.Conceptual)
{
writer.WriteStartElement("conceptualTargets"); // start - conceptualTargets
writer.WriteAttributeString("base", String.Format(
@".\{0}", aContext["$DdueXmlCompDir"]));
writer.WriteAttributeString("type", linkTypeText);
writer.WriteEndElement(); // end - conceptualTargets
}
}
writer.WriteEndElement(); //end: conceptualLinks
}
return(true);
}
