SHFB Source Control Rss Feed

Patch Applied: #14282

EWoodruff — Fri, 10 May 2013 19:27:24 GMT

EWoodruff has applied patch #14282.

Comment:
Patch applied. Thanks.

Patch Uploaded: #14282

JKaas — Thu, 11 Apr 2013 12:10:08 GMT

JKaas has uploaded a patch.

Description:
On 64-bit operating system, the 32-bit Program Files folder isn't always the 64-bit Program Files folder + " (x86)".

This patch uses Environment.SpecialFolder.ProgramFilesX86 and Environment.SpecialFolder.ProgramFiles and works even on 32-bit/64-bit Windows XP.

Source code checked in, #102391

EWoodruff — Sun, 07 Apr 2013 19:52:20 GMT

Added a couple of missing updated files.

Source code checked in, #102390

EWoodruff — Sun, 07 Apr 2013 19:42:58 GMT

Changes made in this release: Sandcastle: - Split the build component reference target classes out into their own assembly. This assembly is versioned independently of the other Sandcastle assemblies so that reference target caches do not have to be rebuilt with each new release of the Sandcastle tools. Sandcastle Help File Builder: - Fixed the presentation style configuration files so that family data is copied in as part of the container data so that the ASP.NET and XAML syntax writers include or exclude syntax sections correctly. - Added the CopyContentFrom member to the ConceptualContentSettings class to allow plug-ins to add content from a temporary project for inclusion in the current build. This prevents the temporary items from getting added to the project being built which is not wanted. Presentation Styles: - Fixed up handling of generic types in the Returns section in all presentation styles.

Source code checked in, #102308

EWoodruff — Sat, 30 Mar 2013 23:51:30 GMT

Changes made in this release: Sandcastle: - Added XML comments to the BuildAssemblerLibrary, BuildComponents, and SyntaxComponents projects. - Updated the documentation to reflect changes made in the latest release. Sandcastle Help File Builder: - Fixed an odd bug in the MPF project related to adding new items to deeply nested collapsed nodes. - Fixed a bug in the Topic Previewer window that prevented multiple tokens from being rendered properly when they appeared in the Related Topics section. - Added code to ignore missing framework folders when searching for XML comments files (i.e. missing F# folders). - Updated the Additional Reference Links plug-in to add the additional reflection information files to the GenerateInheritedDocs tool's configuration file. - Updated the GenerateInheritedDocs tool to support loading multiple reflection information files. This allows additional reflection information to be included for undocumented reference assemblies and enables inheriting documentation from members within them. - Updated GID0006 warning to include a note if the missing documentation is for a base member in a reference assembly not included for documentation. - Updated the documentation to reflect changes made in the latest release.

Source code checked in, #102164

EWoodruff — Mon, 18 Mar 2013 01:54:27 GMT

Changes made in this release: Sandcastle: - Updated all presentation styles so that fields, properties, events, and methods include a return type link even if no returns or value XML comments element is present. This makes it consistent with MSDN and allows for the removal of the type links within the Syntax section itself as the type links for the return value and parameter values are available elsewhere on the page. - Added support for a renderReferenceLinks attribute to the SyntaxComponent configuration's syntax element. By default the syntax component will not render links to types in the syntax section (not supported anymore by MS Help Viewer 2.0). By adding this attribute to the configuration and setting it to true, you can turn them back on again if wanted. - Added a condition to the SyntaxComponent's Apply method to skip group, project, and namespace pages in which a syntax section is of no use. This allows removal of the IfThenComponent wrapper around it in the configuration files which wasn't using an up-to-date condition anyway. Sandcastle Help File Builder: - Removed the IfThenComponent wrapper around the SyntaxComponent in the configuration files which wasn't using an up-to-date condition anyway. SyntaxComponent now ignores topics as needed.

Source code checked in, #102149

EWoodruff — Sat, 16 Mar 2013 22:53:06 GMT

Changes made in this release: Sandcastle: - Breaking Change: Moved the syntax writer classes into the SyntaxComponents assembly with their related classes. - Updated the Visual Basic and Visual Basic Usage syntax generators to omit the line continuation character by default. It can be enabled by adding the includeLineContinuation attribute to the generator element and setting it to true. - Moved the snippet related classes into their own namespace. - Added the Windows Phone 8.0 framework to the framework definition file. Sandcastle Help File Builder: - Breaking Change: Added the SupportsConfiguration property to the IPlugIn interface. This is used to indicate whether or not the plug-in supports configuration when added to the project. - If they support configuration, plug-ins will now automatically show their configuration dialog when first added to a project. - Updated the BuildAssembler configuration template files to use the HtmlEncVendorName tag. - Added check to abort the build if HtmlHelpName contains a period and MS Help Viewer output is being generated. MSHV does not support periods in the filename. - Added code to the build engine to adjust the search location for the assembly and XML comments file if the GenerateProjectSpecificOutputFolder MSBuild variable is set to true. - Updated the ESent and SQL caching build components to support caching of project data. - Added configuration dialogs for the ESent and SQL caching build components.

Source code checked in, #101989

EWoodruff — Thu, 07 Mar 2013 02:45:19 GMT

Merged the changes from the MPF 2012 project's code base into my copy of the MPF 2010 project. These changes let the project system handle the multi-threaded parts of VS 2012 without causing crashes (i.e. opening the VS 2012 Test Explorer window with a SHFB project loaded). The code is compatible with VS 2010 so one version of the package will still work in both versions of Visual Studio.

Source code checked in, #101978

EWoodruff — Wed, 06 Mar 2013 02:58:47 GMT

Changes made in this release: Sandcastle: - Removed the use of RegexOptions.Compiled in ExampleComponent which greatly improves its overall performance. The significant time and increased memory penalties outweighed any performance benefits over the course of the build. - Added a warning count to BuildAssembler which is displayed at the end of the build. Sandcastle Help File Builder: - Fixed a bug in removal of inherited members when the derived class's name matched the start of its parent class's name. - Fixed a bug that caused the plug in and components property pages to not pass a project reference to the component configuration dialogs. - Fixed a bug in the Output window that could cause it to crash under certain circumstances when the standalone GUI is closed. - Fixed the standalone GUI so that the property pages contain proper default values for new projects and for properties not present in existing projects when they are loaded. This matches the behavior of the property pages in Visual Studio. - Reworked how the Help 1 and website keyword index files were generated by the HTML extract tool to provide qualified class names in the titles of common entries (i.e. operators). - Updated the HTML extract tool to process the files in parallel to improve performance. - Reorganized some of the supporting build component classes by putting them in their own namespaces. - Applied changes from the related comments indexing classes in BuildAssembler to the comments indexing classes in SandcastleUtils to improve their performance when used by the Entity References window and the GenerateInheritedDocs tool. - Fixed the Solution Explorer context menu items in the VSPackage so that they are hidden when a SHFB project is unloaded. Presentation Styles: - Changed the <title> element in the presentation styles so that it shows the qualified member name. This is required to provide unique titles for index entries. This does have the side-effect of causing member titles in the MS Help Viewer TOC to be qualified with the class name as Help Viewer no longer supports a TOCTitle metadata attribute like Help 2 did. Help for base framework classes exhibits the same behavior so this appears to be by design. - Fixed the VS2010 style so that links work properly in Help 2.

Source code checked in, #101556

EWoodruff — Thu, 07 Feb 2013 03:04:32 GMT

Changes made in this release: Sandcastle: - In CopyFromIndexComponent, added a virtual method to create the index caches, added code to dispose of them when done, and exposed the context via a protected property. - Implemented IDisposable on IndexedCache. Sandcastle Help File Builder: - Fixed a bug in removal of inherited members when the derived class's name matched the start of its parent class's name. - Updated AdditionalReferenceLinksPlugIn to set the Configuration and Platform on the reference projects. - Fixed removal of inherited items so that it only removes members of classes matching the parent class and not those of other classes starting with the same name. - Added the ESentCopyFromIndexComponent. It works quite well but consider it a work in progress for the time being. Presentation Styles: - Fixed the VS2010 style so that links work properly in Help 2.

Source code checked in, #101283

EWoodruff — Mon, 21 Jan 2013 03:40:28 GMT

Changes made in this release: Sandcastle: - Added the BuildAssembler.Execute() method to contain the build process and reworked it to allow for parallel executon of component code. Components are still initialized and topics built sequentially for now but parallelism can be utilized now and is used in certain components when they are initialized. - Converted the BuildAssembler message logger to use BlockingCollection<string> to allow for parallel executon of component code without contention for the console when logging messages. - Reworked the target dictionaries to allow for loading of target information in parallel to speed initialization up a bit. - Moved the BuildAssembler command related classes to the Commands namespace and made them public. - Created a new CopyCommand abstract base class in BuildAssembler to make creating new copy commands possible. - Added a new IndexedCache abstract base class for use by the CopyFromIndexComponent and its subcomponents for the index data. - Renamed the IndexedDocumentCache to InMemoryIndexedCache and reworked it to support filtering by namespace to reduce the amount of reflection data that it needs to load and also added support for loading the index files in parallel. - Renamed SimpleTargetDictionary InMemoryTargetDictionary for consistency. Sandcastle Help File Builder: - Updated the ESent Resolve Reference Links component classes to utilize the new local cache option added the the PersistentDictionary class. - Added SQL Server versions of the Resolve Reference Links component classes. They work well but are experimental for now as I have a few ideas to try that may improve their performance and have not created the configuration dialogs necessary to configure them and create the cache table. - Updated the conceptual.config template to use CopyFromFilesComponent to copy the topic content into the target document. This is more efficient than using CopyFromIndexComponent to copy the topic data in as each topic is only used once and doesn't need to be cached. - Removed the CachedCopyFromIndexComponent which was used for the Cached Reflection and Cached Comments Data component configurations. After reworking the base component to allow filtering by namespace and loading the data in parallel, loading the index from a serialized cache was slighlty less efficient than just indexing the data in the files in each build. - Removed the obsolete build components from all SHFB documentation projects.

Source code checked in, #101187

EWoodruff — Sun, 13 Jan 2013 02:32:09 GMT

Changes made in this release: Sandcastle: - Made all reference link target classes serializable. - Made TargetDictionary an abstract bases class and added SimpleTargetDictionary as the basic implementation. This allows alternate implementations that use a different storage mechanism for the target data. - Added support for defining which namespace targets to load in ResolveReferenceLinksComponent2. This prevents loading unnecessary namespaces saving some memory and initialization time. Sandcastle Help File Builder: - Fixed the standalone GUI so that the property pages do not retain values from prior projects when a new project is loaded that does not contain properties present in the prior project. - Modified the build engine to get a list of all possible namespaces referenced by the project. This list is passed to the reference link build component to reduce the amount of information it has to load. Other components can eventually take advantage of this list too (i.e. CopyFromIndexComponent for comment and reflection info). - Added the Managed ESent (http://managedesent.codeplex.com/) reference assemblies and the source files I changed for it to the .\ReferenceAssemblies folder. This is a slightly modified version that allows persisting reference types and disabling column compression. - Added ESentTargetDictionary and ESentResolveReferenceLinksComponent. These can take the place of the standard SimpleTargetDictionary and ResolveReferenceLinksComponent2 to provide caching of reference link target and MSDN content ID info in an ESent database. This saves some memory at the expense of some build time. They work quite well but I still have a few ideas on how to improve the performance. I also need to add a configuration dialog to allow turning some of the options on or off which may help improve performance for certain projects. - Updated the code colorizer library to support rendering colorized code as flow document elements. The FlowDocumentTest project demonstrates its use. - Added code colorization to the code blocks rendered in the topic previewer. This helps identify problems with the code such as incorrect comment markers or incorrect language IDs. A Copy link was also added to allow copying the code blocks in the topic previewer to the clipboard. Line numbering is supported but collapsible sections are not. Presentation Styles: - Fixed VS2010\Branding\ps-body.xslt so that it doesn't add a "./" relative URL prefix to non-relative image URLs. - Commented out the templates in VS2010\Branding\ps-body.xslt that were stripping style attributes. These appear to be for use with non-self-branded content which doesn't apply anymore. Allowing the style attributes through fixes the problem of the "nobullet" list style not working.

Patch Uploaded: #13576

skonves — Fri, 04 Jan 2013 21:56:17 GMT

skonves has uploaded a patch.

Description:
Updated MRefBuilder: implemented IEnumerable<T> interfaces on each list class and implemented IEnumerator<T> on each list classes' internal enumerator struct. The original GetEnumerator() methods on each list class are now explicit implementations of the non-generic IEnumerable interface.

This allows the usage of Linq extension methods with all list classes defined in ListTemplate.cs.

Source code checked in, #101057

EWoodruff — Mon, 31 Dec 2012 00:04:14 GMT

Changes made in this release: Sandcastle: - Reimplemented how reference link targets are loaded and stored. This allows for sharing target data independent of type across multiple instances of ResolveReferenceLinksComponent2 reducing memory requirements and initialization time when building multiple output formats. The new implementation should also allow caching of the information once the target classes are made serializable (that's the next step in the process). Sandcastle Help File Builder: - Updated the BuildAssembler configuration files to allow sharing of target data across instances of ResolveReferenceLinksComponent2.

Source code checked in, #101042

EWoodruff — Sun, 30 Dec 2012 01:01:25 GMT

Changes made in this release: Sandcastle: - Deleted the unused reference and schema build configuration and XSL transformation files from all presentation styles. - Removed the duplicate items from shared_content_mshc.xml leaving only the overridden path elements. The MS Help Viewer configuration files where updated to include the shared_content.xml file ahead of it. - Reviewed and cleaned up a number of build components and split several classes out into their own source files. - Simplified the FileCreatedEventArgs and updated the HxFGeneraterComponent to make it responsible for figuring out where to put its files. - Moved all of the target classes into their own namespace and split them out into their own files. - Cleaned up and refactored the code in several of the reference type components. Most of this should be transparent to end users unless they've derived build components from them. - Moved MSDN URL caching from the SHFB component into ResolveReferenceLinksComponent2. The implementation will allow derived classes to utilize backing stores other than the serialized binary file used by default as long as the cache type implements IDictionary<string, string>. It also allows sharing the cache across multiple instances of the component. - Regenerated the MTPS Content Service classes. I decided to stay with the web service as the authentication issues have well-known solutions (see BuildAssembler.exe.config). Switching to a service type may introduce other authentication issues and since the web service works well enough, I left it as-is. Sandcastle Help File Builder: - Updated the SHFB BuildAssembler configuration files to include the shared_content.xml file for for MS Help Viewer builds to include the base set of shared content items. The shared_content_mshc.xml file was reduced to just the path elements to eliminate all of the duplicate items. - Moved the MSDN URL caching support from the CachedResolveReferenceLinksComponent into the base Sandcastle component. As a result, this component is obsolete and must be removed from any existing projects. The configuration template files now make use of the base component with the added cache configuration element.

Source code checked in, #101003

EWoodruff — Mon, 24 Dec 2012 23:04:39 GMT

Changes made in this release: Sandcastle: - Deleted CodeReference.cs, LiveExampleComponent.cs, and WdxResolveConceptualLinksComponent.cs as they appear to be for internal Microsoft use and do not appear to have much use for non-Microsoft users. - Deleted References.cs and Targets.cs from the BuildComponents project as they were unused. These were most likely replaced by the stuff in TargetCollection.cs. - Moved InheritDocumentationComponent into the main BuildComponents project and deleted the CopyComponents project as it was the only one in the project. - Updated the example and presentation style configuration files to reference InheritDocumentationComponent in the BuildComponents assembly. - Updated DisplayComponent to output the content as a diagnostic message using the WriteMessage() method rather than just dumping it to the console. - Updated ValidateComponent to include the key in its warning messages. - Deleted IntellisenseComponent2.cs and replaced IntellisenseComponent.cs with my version from SHFB. - Added the IntelliSenseComponent configuration dialog. - Moved the MSHelpAttrComponent from SHFB into the Sandcastle BuildComponents project. - Moved the ShowMissingComponent from SHFB into the Sandcastle BuildComponents project. - Added the ShowMissingComponent resource items to the reference_content.xml file in each presentation style. - Added support for the <markup> element in main_sandcastle.xsl in each presentation style. This allows a block of HTML or other elements such as "include" to pass through as-is to the topic. This allows build components to insert content before the TransformComponent runs and prevents it being removed as unrecognized content by the XSL transformations. The conceptual transformations already allow this so this makes the conceptual and reference builds consistent in supporting a markup element. - Added a Dispose() method to CloneComponent to properly dispose of all components in each branch. - Fixed up issues in the BuildAssembler projects found by FxCop (too many to list). The remaining issues will be dealt with as I review each component. Sandcastle Help File Builder: - Moved the IntelliSenseComponent and its configuration dialog to the Sandcastle BuildComponents project. - Moved the MSHelpAttrComponent into the Sandcastle BuildComponents project. - Moved the ShowMissingComponent into the Sandcastle BuildComponents project. - Moved the ShowMissingComponent resource items to the reference_content.xml file in each presentation style. - Removed the MultiFormatOutputComponent.CurrentFormat property as it was never used.

Source code checked in, #100889

EWoodruff — Mon, 17 Dec 2012 00:30:45 GMT

Changes made in this release: Sandcastle: - Updated XSL transformations so that they don't output an empty abstract for certain cases such as when it only contains a non-breaking space character. - Merged changes from ComponentOne to get rid of the unnecessary header borders in the VS2005 style in MS Help Viewer 1.0 and to prevent MRefBuilder crashes in certain conditions caused by obfuscated assemblies. - Fixed VS2005 CommonUtilities.js so that the <see langword=""> elements work properly. The prior HV 2.0 fix broke their handling in other formats. - Added support for the <event> XML comments element in all presentation styles. Sandcastle Help File Builder: - Fixed SandcastleProject so that it reuses existing MSBuild project instances if the project being loaded is already in the global collection. This prevents it from trying to unload a shared instance owned by MSBuild when disposed. - Fixed IntelliSenseComponent so that it uses a case-insensitive comparer for the assembly names in the writer dictionary to prevent it from trying to create the same file twice when the names differ by case. - Fixed the Topic Previewer so that it extracts the base path for imported code from the Code Block Component configuration if present in the project. - Fixed the Topic Previewer and Entity References windows so that they retain the SHFB project reference when a non-SHFB project is selected in the same solution. - Updated the Help 2 build task to suppress all informational warnings and updated the MS Help Viewer build task to reduce the number of informational messages. This significantly reduces both build time and log file size for projects with a large number of topics. - Added support for the conceptualLink XML comments TOC entry format in the Entity References tool window. - Changed the default for the BuildAssembler Verbosity project property from All Messages to Only Warnings and Errors. - Reduced the build log output when copying website files from all file names to just a file count as it progresses to reduce the volume of output on large help files. Extras: - Updated the MAML guide to remove references to the Sandcastle Help File Builder components and features that have been moved into the Sandcastle build components and presentation style XSL transformations. - Added the Sandcastle XML Comments Guide help file to provide a comprehensive set of documentation on the XML comments elements and how they are used with Sandcastle. - Added a What's New page to the guided installer

Source code checked in, #100599

EWoodruff — Tue, 27 Nov 2012 02:59:20 GMT

Changes made in this release: Sandcastle Help File Builder: - Added the ability to render imported code blocks to the MamlToFlowDocumentConverter.

Source code checked in, #100580

EWoodruff — Mon, 26 Nov 2012 04:45:54 GMT

Changes made in this release: Sandcastle Help File Builder: - Fixed issues with invalid characters in the vendor name project property. - Added support for the ignoreIfUnresolved element in the Assembly Binding Redirection plug-in.

Source code checked in, #100574

EWoodruff — Sun, 25 Nov 2012 22:14:04 GMT

Changes made in this release: Sandcastle: - Added MAML snippet definitions for the common block and inline elements and a related page to the guided installer to copy them to the local snippets cache for the various Visual Studio versions. Sandcastle Help File Builder: - Added documentation on how to use the snippets from within Visual Studio to the SHFB help file. - Updated the HTML Encode Selected Text editor command so that it no longer encodes single and double quotes. - Added the HTML Encode Selected Text command to the context menu of the Visual Studio text editor when editing HTML, MAML, and other XML files.