/// <summary>
/// This specifies the shared items used in the conceptual topics, both the
/// Sandcastle style defaults and the user-defined items.
/// </summary>
/// <param name="sender"></param>
/// <param name="args"></param>
private void WriteSharedContent(XmlWriter writer)
{
ReferenceSharedConfiguration sharedConfig = _engineSettings.Shared;
Debug.Assert(sharedConfig != null,
"There is no conceptual shared configuration available.");
if (sharedConfig == null)
{
return;
}
sharedConfig.Initialize(this.Context, this.Format);
//<component type="Microsoft.Ddue.Tools.SharedContentComponent" assembly="%DXROOT%\ProductionTools\BuildComponents.dll">
// <!-- 6. Include the reference shared content files -->
// <content file="%DXROOT%\Presentation\Vs2005\Content\shared_content.xml" />
// <content file="%DXROOT%\Presentation\Vs2005\Content\reference_content.xml" />
// <content file="%DXROOT%\Presentation\Shared\Content\syntax_content.xml" />
// <content file="%DXROOT%\Presentation\Vs2005\Content\feedBack_content.xml" />
// <!-- Overrides the contents to customize it... -->
// <content file="ApiSharedContent.xml" />
//</component>
writer.WriteComment(" Resolve shared content ");
writer.WriteStartElement("component"); // start - component
writer.WriteAttributeString("type", "Microsoft.Ddue.Tools.SharedContentComponent");
writer.WriteAttributeString("assembly", "$(SandcastleComponent)");
sharedConfig.Configure(this.Group, writer);
writer.WriteEndElement(); // end - component
sharedConfig.Uninitialize();
}
/// <summary>
/// Initializes a new instance of the <see cref="ReferenceEngineSettings"/> class
/// with the default parameters.
/// </summary>
public ReferenceEngineSettings()
: base("Sandcastle.References.ReferenceEngineSettings", BuildEngineType.Reference)
{
_webMvcSdkType = BuildSpecialSdkType.Null;
_rootContainer = false;
_embedScriptSharp = true;
_includeAllMembersTopic = true;
_includeInheritedOverloadTopics = true;
_refNamer = ReferenceNamer.Orcas;
_refNaming = ReferenceNamingMethod.Guid;
IBuildNamedList <BuildConfiguration> configurations = this.Configurations;
if (configurations != null)
{
// For the ReferenceVisitors...
ReferenceCommentConfiguration comments =
new ReferenceCommentConfiguration();
ReferenceSpellCheckConfiguration spellCheck =
new ReferenceSpellCheckConfiguration();
ReferenceVisibilityConfiguration documentVisibility =
new ReferenceVisibilityConfiguration();
ReferenceXPathConfiguration pathDocumentVisibility =
new ReferenceXPathConfiguration();
pathDocumentVisibility.Enabled = false;
// For the ReferenceTocVistors...
ReferenceTocExcludeConfiguration excludeToc =
new ReferenceTocExcludeConfiguration();
ReferenceTocLayoutConfiguration layoutToc =
new ReferenceTocLayoutConfiguration();
configurations.Add(comments);
configurations.Add(documentVisibility);
configurations.Add(pathDocumentVisibility);
configurations.Add(spellCheck);
configurations.Add(excludeToc);
configurations.Add(layoutToc);
}
IBuildNamedList <BuildComponentConfiguration> componentConfigurations
= this.ComponentConfigurations;
if (componentConfigurations != null)
{
ReferencePreTransConfiguration preTrans =
new ReferencePreTransConfiguration();
ReferenceMissingTagsConfiguration missingTags =
new ReferenceMissingTagsConfiguration();
ReferenceAutoDocConfiguration autoDocument =
new ReferenceAutoDocConfiguration();
ReferenceIntelliSenseConfiguration intelliSense =
new ReferenceIntelliSenseConfiguration();
ReferencePlatformsConfiguration platforms =
new ReferencePlatformsConfiguration();
ReferenceCloneConfiguration cloneDocument =
new ReferenceCloneConfiguration();
ReferencePostTransConfiguration postTrans =
new ReferencePostTransConfiguration();
ReferenceCodeConfiguration codeComponent =
new ReferenceCodeConfiguration();
ReferenceMathConfiguration mathComponent =
new ReferenceMathConfiguration();
ReferenceMediaConfiguration mediaComponent =
new ReferenceMediaConfiguration();
ReferenceLinkConfiguration linkComponent =
new ReferenceLinkConfiguration();
ReferenceSharedConfiguration sharedComponent =
new ReferenceSharedConfiguration();
componentConfigurations.Add(preTrans);
componentConfigurations.Add(autoDocument);
componentConfigurations.Add(missingTags);
componentConfigurations.Add(intelliSense);
componentConfigurations.Add(platforms);
componentConfigurations.Add(cloneDocument);
componentConfigurations.Add(postTrans);
componentConfigurations.Add(codeComponent);
componentConfigurations.Add(mathComponent);
componentConfigurations.Add(mediaComponent);
componentConfigurations.Add(linkComponent);
componentConfigurations.Add(sharedComponent);
}
}
/// <summary>
/// Initializes a new instance of the <see cref="ReferenceSharedConfiguration"/> class
/// with parameters copied from the specified instance of the
/// <see cref="ReferenceSharedConfiguration"/> class, a copy constructor.
/// </summary>
/// <param name="source">
/// An instance of the <see cref="ReferenceSharedConfiguration"/> class from which the
/// initialization parameters or values will be copied.
/// </param>
/// <exception cref="ArgumentNullException">
/// If the parameter <paramref name="source"/> is <see langword="null"/>.
/// </exception>
public ReferenceSharedConfiguration(ReferenceSharedConfiguration source)
: base(source)
{
}
/// <summary>
/// This creates a new build object that is a deep copy of the current
/// instance.
/// </summary>
/// <returns>
/// A new build object that is a deep copy of this instance.
/// </returns>
public override BuildComponentConfiguration Clone()
{
ReferenceSharedConfiguration options = new ReferenceSharedConfiguration(this);
return(options);
}