I've generated my help files but get an error when I try to filter my integrated help files in VS. I placed an attribute directly below the locale example in utilities_metadata.xsl like this
<MSHelp:Attr Name="FriendlyName" Value="MyAssemblyName.Help" />
where MyAssemblyName.Help is the namespace of the help collection I'm creating.
then when I use the help integration wizard I create a filter to search for Name="FriendlyName"
All I would like to do is select my help in the VS "Filtered By" drop down list so that only my help is visible in the tree view. I'm obviously doing somthing wrong but I can't seem to work out the correct combination of the Name, Value pair and how to filter on these.
Can anyone point me in the right direction
<MSHelp:Attr> for Filter
CodeMann
Hi Paul,
Firstly, my sincere apologies for not replying sooner. I was diverted to other projects and just haven't had an oppurtunity to do any work with Sandcastle for the past six weeks or so. This has been very frustrating since the filtering was the last piece of the puzzle for what was I tasked to achieve with this technology.
However, I have now had an oppurtunity to revisit this and following my upgrade to the November CTP, and review of your advice, everything is now working smoothly.
Thank you for your assistance in this matter. It was gratefully appreciated.
Kind regards,
Trev
ackermsb
Nate00
Hi Paul,
In the Filter section of the help integration wizard I set the filter as
"Name"="Friendly Name"
I thought this would match the attribute defined in
<MSHelp:Attr Name="Friendly Name" Value="CompanyName.CollectionName.Help" />
Trev
Sergio.Rykov
yazad_gandhi
vahdam_mn
Hello Trev,
The way the filter definitions work is based on name/value pairs. In the example you quoted:
<MSHelp:Attr Name="Friendly Name" Value="CompanyName.CollectionName.Help" />
"Friendly Name" would refer to a particular attribute class, and "CompanyName.CollectionName.Help" would refer to a value specific to that attribute class.
A more specific example would be:
<MSHelp:Attr Name="DevLang" Value="CSharp" />
<MSHelp:Attr Name="DocSet" Value="C#" />
We use these attributes to define documentation specific to C#. The filter for C# then has a definition that includes the following:
"DocSet"="C#" OR "DevLang"="CSharp"
In other scenarios, we have topics attributed with:
Name="DocSet" Value="Visual Basic"
The filter then has:
"DocSet"="Visual Basic"
Does that make it a little clearer as to how these are used
PMMS
Hi Paul,
Apologies for the slow response. I've haven't been in the office for a few days.
I'm not actually getting the error now (from memory it was something about the filter not being correct - I'll keep trying to recreate).
My filter is currently appearing in the drop down list but when selected nothing is shown in the tree view, although the hourglass is shown and it waits for a time before displaying nothing.
Here is the section from the utilities_metadata.xml where CompanyName.CollectionName.Help is the name of the help collection created through the help integration wizard.
<xsl:template name="insertMetadata">
<xsl:if test="$metadata='true'">
<xml>
<MSHelp:Attr Name="AssetID" Value="{$key}" />
<!-- toc metadata -->
<xsl:call-template name="linkMetadata" />
<xsl:call-template name="indexMetadata" />
<xsl:call-template name="helpMetadata" />
<MSHelp:Attr Name="TopicType" Value="apiref" />
<xsl:call-template name="apiTaggingMetadata" />
<MSHelp:Attr Name="Locale">
<includeAttribute name="Value" item="locale" />
</MSHelp:Attr>
<MSHelp:Attr Name="Friendly Name" Value="CompanyName.CollectionName.Help" />
<xsl:if test="boolean($summary) and (string-length($summary) < 255)">
<MSHelp:Attr Name="Abstract">
<xsl:attribute name="Value"><xsl:value-of select="$summary" /></xsl:attribute>
</MSHelp:Attr>
</xsl:if>
</xml>
</xsl:if>
</xsl:template>
Any help to get me pointed in the right direction would be gratefully received.
Trev