Sandcastle Extensions

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

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 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

Source code checked in

darilek — Sun, 04 May 2008 16:34:50 GMT

NEW POST: Meta Attribute Configuration

darilek — Sat, 03 May 2008 11:55:09 GMT

Hello, I'm using this component without any problems on Help2 and VS2005 presentation configuration. Your problem is in empty meta attribute definition list. Please try open MetaAttributeComponent configuration dialog via SHFB UI, check default settings and click OK button to serialize settings into project settings (shfb) file.

MaD

NEW POST: Meta Attribute Configuration

DarrylP — Mon, 28 Apr 2008 21:41:32 GMT

I am trying to use the MetaAttributeComponent with my .shfb file.
I've extracted the Sandcastle extension files into my SHFB folder. I've also added the Meta Attribute Component to my .sfhb file using the "Select and Configure Build Components" dialog. I've set the component properties like 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>

Whenever I run the build though, I don't see the correct attribute. In the log file it says:
Info: MetaAttributeComponent: Instantiating component.
Info: MetaAttributeComponent:
Meta Attribute Component * Sandcastle Extensions, version 1.0.3.2]
Copyright c 2007, Martin Darilek, http://www.codeplex.com/sandextensions
Info: MetaAttributeComponent: Loaded 0 meta attribute definition(s)

Any ideas what I'm missing?

Thanks.

Source code checked in

darilek — Tue, 11 Mar 2008 17:26:53 GMT

Source code checked in

darilek — Tue, 11 Mar 2008 17:03:03 GMT

COMMENTED TASK: KeywordsFilterComponent + Plugin

mogens — Wed, 20 Feb 2008 15:38:03 GMT

Thanks for taking the component on board.

You may change the namespaces to unify the sources. We accept the application of the license to the source code.
I built this on company time, so it is: Copyright 2008 SuperOffice ASA

Plugin info:
This component removes excess keywords from the documentation. This avoids Help2 compiler error HXC3031. Useful if you have hundreds of methods with the same name.

NEW POST: MetaAttributeComponent can't find XML node?

darilek — Wed, 20 Feb 2008 12:21:38 GMT

This discussion has been copied to a work item. Click here to go to the work item and continue the discussion.

CREATED TASK: KeywordsFilterComponent + Plugin

darilek — Wed, 20 Feb 2008 12:21:35 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]

NEW POST: MetaAttributeComponent can't find XML node?

darilek — Wed, 20 Feb 2008 12:13:08 GMT

mogens wrote:
Done!

Mogens,
I will include your patch into Sandcastle Extensions in next release. With Your approval, I will change namespaces to unify Sandcastle Extensions sources. Can You send me copyright info, which You would like to see in plugin info? :-)

MaD

NEW POST: MetaAttributeComponent can't find XML node?

mogens — Tue, 19 Feb 2008 16:42:51 GMT

Done!