Missing and incomplete MSHelp attributes

It seems that the MSHelp attributes aren't generated correctly. The namespace and type name are missing. For example, the following attributes are generated for a hypothetical Namespace.Type.FieldName field:

<MSHelp:Attr Name="AssetID" Value="F:Namespace.Type.FieldName" />
<MSHelp:Keyword Index="A" Term="F:Namespace.Type.FieldName" />
<MSHelp:Keyword Index="K" Term="FieldName field"></MSHelp:Keyword>
<MSHelp:Keyword Index="K" Term=".FieldName field"></MSHelp:Keyword>
<MSHelp:Keyword Index="F" Term="FieldName" />
<MSHelp:Attr Name="TopicType" Value="apiref" />
<MSHelp:Attr Name="APIType" Value="Managed" />
<MSHelp:Attr Name="APILocation" Value="Assembly.dll" />
<MSHelp:Attr Name="APIName" Value="..FieldName" />
<MSHelp:Attr Name="Locale" Value="en-us"></MSHelp:Attr>
<MSHelp:Attr Name="Abstract" Value="The application name" />
<MSHelp:Attr Name="APIName" Value="..FieldName" />

The elements marked inredshow the unfortunate behavior. Is there a workaround or easy fix for the current (December) CTP?

In addition, the .NET BCL documentation contains some extra index entries and attributes, including:

<MSHelp:Keyword Index="F" Term="Namespace.Type.Member" />
<MSHelp:Keyword Index="F" Term="Type.Member" />
<MSHelp:Attr Name="Technology" Value="ManagedCode" />
<MSHelp:Attr Name="TechnologyVers" Value="netframework20" />
<MSHelp:Attr Name="DevLang" Value="CSharp" />
<MSHelp:Attr Name="DevLang" Value="VB" />
<MSHelp:Attr Name="DevLang" Value="C++" />
<MSHelp:Attr Name="Technology" Value="kbNetFramewk" />
<MSHelp:Attr Name="codelang" Value="kbLangVB" />
<MSHelp:Attr Name="codelang" Value="CSharp" />
<MSHelp:Attr Name="codelang" Value="kbLangCPP" />

Are there plans to add a more complete list of keywords and attributes such as the one above?

[2636 byte] By [JeffreySax] at [2007-12-30]
# 1

Jeffrey,

I responded to your email on this issue. We have a CTP releas scheduled for the end of this month to address this issue. Answers to others issues you has in email are below:

1. member Syntax section: Visual Basic (Usage) is not showing (looks like there is no generator for that, yet)

We will have a fix in the next CTP end of this month….

2. tables with icons have "Icon" as column header (online docs have no header) utilities_reference.xsl:

This is fixed now. February CTP

3. apiIcon template: when setting the membervisibility variable, has visibility='protected' instead of visibility='family' (line 864), also reported on MSDN forum.

This is also fixed. February CTP

4. same template, same location: if not public or protected, should be private (priv). (line 868)

This is a bug which needs to be fixed. I have opened a bug.

5. member Parameters section: parameter types not shown if it is an array (ok in Prototype)

Fixed now. February CTP

6. MSHelp F Index does not have an entry for typename.membername (unlike MSDN docs)

Fixed now. February CTP

7. MSHelp DevLang, codelang, Technology attributes are not present.

Fixed now. February CTP

8. MSHelp Index, apiname attributes: namespace and type name of members isn't showing up. (e.g. "..Epsilon" instead of "System.Double.Epsilon") This happens in both the VS2005 and the Prototype themes.

Working on a fix. February CTP.

Cheers.

Anand..

AnandRaman-MSFT at 2007-9-5 > top of Msdn Tech,Visual Studio,Developer Documentation and Help System...
# 2

Anand,

I think you have probably addressed the following issues... but just to be sure...

For correct support of F1 key in source editors: The keyword "F" index needs the fully qualified name (both on class/struct page and on member pages). Member pages currently do not have it, the class/struct pages do have it.

Also the fully qualified name for generic class pages is missing the generic parameter.

[Comments apply to the December CTP release.]

See also the following thread:

http://forums.microsoft.com/MSDN/ShowPost.aspx?PostID=1238330&SiteID=1

David Smith

Bucket at 2007-9-5 > top of Msdn Tech,Visual Studio,Developer Documentation and Help System...

Visual Studio

Site Classified