Sandcastle Extensions

Updated Wiki: Home

darilek — Mon, 17 Aug 2009 10:15:32 GMT

Project Description

A set of components that provide some missing features in original Sandcastle distribution.

This project is not aimed as next tool for user friendly help generation. Within this project I would like share following stuff with Sandcastle comunity:

Additional Build Components for Sandcastle
Addtional support for using build components in other Sandcastle related projects like DocProject or Sandcastle Help File Builder
Various help deployment issues solutions

Changes in version 1.0.3.3

Compatible with Sandcastle May 2008 release and Sandcastle Help File Builder 1.7.0.0
KeywordsFilterComponent - This component filter out keywords from HTML files when there are too many of the same keyword present in the corpus. This avoids Help2 compiler error HXC3031 (thanks mogens).
Some minor changes

Changes in version 1.0.3.2

update for Sandcastle January 2008 RTW and Sandcastle Help File Builder 1.6.0.4

Changes in version 1.0.3.1

Support for new SHFB 1.6.0.2 Build Component config
corrected language code replacement in templates for Help2RegistrationPlugin
corrected ResolveReferencePlugIn execution behavior

Changes in version 1.0.3.0

Breaking change - original SandcastleExtensions assembly was splitted into SandcastleExtensions.Components assembly (contains build components) and SandcastleExtensions.PlugIns assembly (contains additional components for higher-level tools like SHFB or DocProject)
Compatibility with Sandcastle October 2007 CTP and SHFB 1.6.0.1
Help2RegistrationPlugIn - SHFB plugin for generating Help2 collection, TOC, index and H2Reg.ini files. With H2Reg utility it is now possible plug Your generated documentation into MS.VSIPCC help structure
ResolveReferencePlugIn - SHFB plugin which provides simple management of additional targets for resolving index links to custom components. With this plugin You can add XML file or directory location as new targets for ResolveReferenceLinks2 component.

Changes in version 1.0.2.0

This version is just an update to the Sandcastle October CTP and SHFB 1.6.0.1

Changes in version 1.0.1.0

MetaAttributeComponent component is now configurable through Sandcastle Help File Builder UI.
fixed generated attributes naming in MetaAttributeComponent (help2 compiler will not show warnings anymore :-)
some minor optimizations

Changes in version 1.0.0.0

IndexLinkNamespaceComponent - this component decorates all index links in help file with additional 'namespace' attribute and fills them with configured help namespace. By using this component you can resolve problems with referencing locally installed help files. More about this problem see http://forums.microsoft.com/MSDN/ShowPost.aspx?PostID2201297&SiteID1
MetaAttributeComponent - component for adding custom meta attributes (like DocSet) into each help file header

Updated Wiki: Home

darilek — Mon, 17 Aug 2009 10:14:51 GMT

Project Description

Additional Build Components for Sandcastle
Addtional support for using build components in other Sandcastle related projects like DocProject or Sandcastle Help File Builder
Various help deployment issues solutions

Changes in version 1.0.3.3

Compatible with Sandcastle May 2008 release and Sandcastle Help File Builder 1.7.0.0
KeywordsFilterComponent - This component filter out keywords from HTML files when there are too many of the same keyword present in the corpus. This avoids Help2 compiler error HXC3031 (thanks mogens).
Some minor changes

Changes in version 1.0.3.2

update for Sandcastle January 2008 RTW and Sandcastle Help File Builder 1.6.0.4

Changes in version 1.0.3.1

Support for new SHFB 1.6.0.2 Build Component config
corrected language code replacement in templates for Help2RegistrationPlugin
corrected ResolveReferencePlugIn execution behavior

Changes in version 1.0.3.0

Breaking change - original SandcastleExtensions assembly was splitted into SandcastleExtensions.Components assembly (contains build components) and SandcastleExtensions.PlugIns assembly (contains additional components for higher-level tools like SHFB or DocProject)
Compatibility with Sandcastle October 2007 CTP and SHFB 1.6.0.1
Help2RegistrationPlugIn - SHFB plugin for generating Help2 collection, TOC, index and H2Reg.ini files. With H2Reg utility it is now possible plug Your generated documentation into MS.VSIPCC help structure
ResolveReferencePlugIn - SHFB plugin which provides simple management of additional targets for resolving index links to custom components. With this plugin You can add XML file or directory location as new targets for ResolveReferenceLinks2 component.

Changes in version 1.0.2.0

This version is just an update to the Sandcastle October CTP and SHFB 1.6.0.1

Changes in version 1.0.1.0

MetaAttributeComponent component is now configurable through Sandcastle Help File Builder UI.
fixed generated attributes naming in MetaAttributeComponent (help2 compiler will not show warnings anymore :-)
some minor optimizations

Changes in version 1.0.0.0

IndexLinkNamespaceComponent - this component decorates all index links in help file with additional 'namespace' attribute and fills them with configured help namespace. By using this component you can resolve problems with referencing locally installed help files. More about this problem see http://forums.microsoft.com/MSDN/ShowPost.aspx?PostID2201297&SiteID1
MetaAttributeComponent - component for adding custom meta attributes (like DocSet) into each help file header

New Post: Link to DocProject is incorrect

dblack — Tue, 02 Jun 2009 16:45:56 GMT

This must have been fixed. When I posted this, the link http://www.codeplex.com/docproject was not recognized and didn't redirect to the DocProject website.

New Post: Link to DocProject is incorrect

darilek — Tue, 02 Jun 2009 06:27:24 GMT

Hello, it does not matter. Both URLs are redirected to the same location.

Cheers

MaD

New Post: Link to DocProject is incorrect

dblack — Fri, 01 May 2009 14:42:48 GMT

The links you have listed everywhere for "DocProject for Sandcastle" is broken. You have it listed as http://www.codeplex.com/docproject

The correct link is: http://docproject.codeplex.com

Updated Release: 1.0.3.3 (Jun 25, 2008)

darilek — Wed, 05 Nov 2008 12:09:54 GMT

Updated version compatible with Sandcastle May 2008 release and Sandcastle Help File Builder 1.7.0.0

Build Components.zip

This archive contains only build components for Sandcastle and configuration fragments. Suitable for various build scripts and manual help compilation

SandcastleExtensions for SHFB.zip

Special edition for Sandcastle Help File Builder. It consists of build components and additional plugins. To use it, just extract archive into SHFB folder

Released: 1.0.3.3 (Jun 25, 2008)

Wed, 05 Nov 2008 12:09:53 GMT

Updated version compatible with Sandcastle May 2008 release and Sandcastle Help File Builder 1.7.0.0

Build Components.zip

This archive contains only build components for Sandcastle and configuration fragments. Suitable for various build scripts and manual help compilation

SandcastleExtensions for SHFB.zip

Special edition for Sandcastle Help File Builder. It consists of build components and additional plugins. To use it, just extract archive into SHFB folder

New Post: some Meta Attribute Docset questions

AJ_Owens — Wed, 08 Oct 2008 19:40:33 GMT

Thanks, the HelpAttributes in SHFB do the trick. It's worth noting that I didn't have to add a HelpAttribute to every conceptual content topic. It was enough to add it to a parent topic; all the children showed up in the collection as well, even though I didn't explicitly specify HelpAttribute values for them.

This is an indispensable tool. Thanks again for the good work.

New Post: some Meta Attribute Docset questions

EWoodruff — Sat, 04 Oct 2008 19:03:47 GMT

In SHFB, you don't need that attribute component from this project as one is built into SHFB. Use the project-level HelpAttributes property to add attributes common to all API topics and conceptual topics. For index keywords and topic-specific attributes in conceptual topics, add them to each topic in the Conceptual Content editor window. Select the topic and in the properties window for it you will see HelpAttributes and HelpKeywords properties. Once set, they will be added to the topics when the help file is built. Also note that SHFB generates the necessary Help 2 collection files when building Help 2 files so the related component from this project is also not needed.

Eric

New Post: some Meta Attribute Docset questions

AJ_Owens — Thu, 02 Oct 2008 20:54:14 GMT

I tried the plugin with the defaults. It went smoothly, but only our C# XML documentation shows up in the .NET Framework collection, although both our C# XML documentation and our conceptual content show up in the unfiltered collection. How can I add our conceptual content to the .NET Framework collection?

The default value supplied for DocSet (NETFramework) does not exactly match the filter name (.NET Framework). What value do I use to add our Help to the Visual C# collection? Are the DocSet values for existing filters documented anywhere?

When I deleted the Meta Attribute Collection from the SHFB project, our Help was removed from the .NET Framework filter, but also from the (unfiltered) collection. How do I restore it to the unfiltered collection only?

Source code checked in, #12302

darilek — Wed, 25 Jun 2008 19:31:12 GMT

RELEASED: 1.0.3.3 (Jun 25, 2008)

Wed, 25 Jun 2008 17:55:02 GMT

Updated version compatible with Sandcastle May 2008 release and Sandcastle Help File Builder 1.7.0.0

Build Components.zip

This archive contains only build components for Sandcastle and configuration fragments. Suitable for various build scripts and manual help compilation

SandcastleExtensions for SHFB.zip

Special edition for Sandcastle Help File Builder. It consists of build components and additional plugins. To use it, just extract archive into SHFB folder

UPDATED RELEASE: 1.0.3.3 (VI 25, 2008)

Wed, 25 Jun 2008 17:55:02 GMT

Updated version compatible with Sandcastle May 2008 release and Sandcastle Help File Builder 1.7.0.0

Build Components.zip

This archive contains only build components for Sandcastle and configuration fragments. Suitable for various build scripts and manual help compilation

SandcastleExtensions for SHFB.zip

Special edition for Sandcastle Help File Builder. It consists of build components and additional plugins. To use it, just extract archive into SHFB folder

Updated Wiki: Home

darilek — Wed, 25 Jun 2008 17:54:03 GMT

Project Description

Additional Build Components for Sandcastle
Addtional support for using build components in other Sandcastle related projects like DocProject or Sandcastle Help File Builder
Various help deployment issues solutions

Changes in version 1.0.3.3

Compatible with Sandcastle May 2008 release and Sandcastle Help File Builder 1.7.0.0
KeywordsFilterComponent - This component filter out keywords from HTML files when there are too many of the same keyword present in the corpus. This avoids Help2 compiler error HXC3031 (thanks mogens).
Some minor changes

Changes in version 1.0.3.2

update for Sandcastle January 2008 RTW and Sandcastle Help File Builder 1.6.0.4

Changes in version 1.0.3.1

Support for new SHFB 1.6.0.2 Build Component config
corrected language code replacement in templates for Help2RegistrationPlugin
corrected ResolveReferencePlugIn execution behavior

Changes in version 1.0.3.0

Breaking change - original SandcastleExtensions assembly was splitted into SandcastleExtensions.Components assembly (contains build components) and SandcastleExtensions.PlugIns assembly (contains additional components for higher-level tools like SHFB or DocProject)
Compatibility with Sandcastle October 2007 CTP and SHFB 1.6.0.1
Help2RegistrationPlugIn - SHFB plugin for generating Help2 collection, TOC, index and H2Reg.ini files. With H2Reg utility it is now possible plug Your generated documentation into MS.VSIPCC help structure
ResolveReferencePlugIn - SHFB plugin which provides simple management of additional targets for resolving index links to custom components. With this plugin You can add XML file or directory location as new targets for ResolveReferenceLinks2 component.

Changes in version 1.0.2.0

This version is just an update to the Sandcastle October CTP and SHFB 1.6.0.1

Changes in version 1.0.1.0

MetaAttributeComponent component is now configurable through Sandcastle Help File Builder UI.
fixed generated attributes naming in MetaAttributeComponent (help2 compiler will not show warnings anymore :-)
some minor optimizations

Changes in version 1.0.0.0

IndexLinkNamespaceComponent - this component decorates all index links in help file with additional 'namespace' attribute and fills them with configured help namespace. By using this component you can resolve problems with referencing locally installed help files. More about this problem see http://forums.microsoft.com/MSDN/ShowPost.aspx?PostID2201297&SiteID1
MetaAttributeComponent - component for adding custom meta attributes (like DocSet) into each help file header

UPDATED RELEASE: 1.0.3.3

Wed, 25 Jun 2008 17:46:29 GMT

Updated version compatible with Sandcastle May 2008 release and Sandcastle Help File Builder 1.7.0.0

Build Components.zip

This archive contains only build components for Sandcastle and configuration fragments. Suitable for various build scripts and manual help compilation

SandcastleExtensions for SHFB.zip

Special edition for Sandcastle Help File Builder. It consists of build components and additional plugins. To use it, just extract archive into SHFB folder

UPDATED RELEASE: 1.0.3.3

Wed, 25 Jun 2008 17:45:36 GMT

Updated version compatible with Sandcastle May 2008 release and Sandcastle Help File Builder 1.7.0.0

Build Components.zip

This archive contains only build components for Sandcastle and configuration fragments. Suitable for various build scripts and manual help compilation

SandcastleExtensions for SHFB.zip

Special edition for Sandcastle Help File Builder. It consists of build components and additional plugins. To use it, just extract archive into SHFB folder

UPDATED RELEASE: 1.0.3.3

Wed, 25 Jun 2008 17:44:56 GMT

Updated version compatible with Sandcastle May 2008 release and Sandcastle Help File Builder 1.7.0.0

!!Build Components.zip
This archive contains only build components for Sandcastle and configuration fragments. Suitable for various build scripts and manual help compilation

!!SandcastleExtensions for SHFB.zip
Special edition for Sandcastle Help File Builder. It consists of build components and additional plugins. To use it, just extract archive into SHFB folder

NEW POST: Meta Attribute Configuration

DarrylP — Wed, 07 May 2008 18:01:52 GMT

Yes, that's what I have done. In the SHFB UI, I set the Meta Attribute Component configuration settings to have all this:
<component
id="Meta Attribute Component"
type="Darilek.SandcastleExtensions.Components.MetaAttributeComponent"
assembly="{@SHFBFolder}BuildComponents\SandcastleExtensions.Components.dll" xml:space="preserve">
<description>This component adds predefined meta attributes into transformed help file. For example, meta attributes are used for filtering fuctionality in Help2 viewer (DocSet meta-attribute)</description>
<insert placement="before" type="Microsoft.Ddue.Tools.SaveComponent" />
<configureMethod name="ConfigureComponent" />
<defaultConfiguration>
<attributes>
<attribute name="DocSet" value="Test123" />
</attributes>
</defaultConfiguration>
</component>

Is that the correct place to put the attribute definition list? Or should it go somewhere else?

Thanks.

UPDATED RELEASE: 1.0.3.3

Mon, 05 May 2008 09:46:40 GMT

updated version

CLOSED TASK: KeywordsFilterComponent + Plugin

darilek — Mon, 05 May 2008 09:44:28 GMT

Component for removing excess Keyword nodes. This could be temporary fix for problem described at http://www.codeplex.com/Sandcastle/Thread/View.aspx?ThreadId=22049
Comments: implemented & ready to distribution