Fix for incorrect ApplyVSDocModel.xls transformation
Hi,
I would like to thank all users that provided me with their feedback.
SandcastleGUI (v1.19) is available for download at
http://www.inchl.nl.
version 1.19 features:
- Added class members for the vs2005 template.
- Workaround for several Sandcastle bugs (usage of Sandcastles ApplyVSDocModel.xls did not produce correct table of contents)
version 1.18 features:
- Table of contents and search capabilities for website output type.
- Resolved generic typenames (Dictionary<string, int> instead of Dictionary~2).
- Scrollable/resizable userinterface.
TIP:
Add video examples into your documentation to really impress your customers!
For more information see inchl framework preview documentation:
http://www.inchl.nl/help/e08e8df3-c5d1-19f6-4b32-5c2b97cad4cc.htm (OpenFileDialog)
http://www.inchl.nl/help/531e6a17-d1da-455c-496a-eca1958cabab.htm (OpenPictureDialog)
Kind regards,
Stephan Smetsers
stephansmetsers@hotmail.comhttp://www.inchl.nl
Hi Anand,
Sandcastle has the following bug/incorrect behaviour:
1.
CHM-table of contents does not show class members when applying the ApplyVSDocModel.xls.
I have fixed this (workaround) by create the reflection.xml twice.
step1: applying ApplyVSDocModel.xls --> resulting in a reflection.xml that is being used for the BuildAssembler.exe
step2: applying AddOverloads.xls --> resulting in a reflection2.xml that I provided the XslTransform with to create a .hhc-file using the ReflectionToChmContents.xsl file.
Lucky the .hhc file (that was created with the AddOverloads.xls transformation) maps on the created content (that was created with the ApplyVSDocModel.xls transformation).
2.
Generic typenames are sometimes displayed as Dictionary~2 and sometimes as Dictionary<string, int>. SandcastleGUI replaces (text) those incorrect names.
3.
The reference_content.xml file is missing some keys. SandcastleGUI fixes this by adding a fixed file as the first in the list of "resolve shared content" items.
This reference_content_fixed.xml file contains all keys (including the missing ones). Because it is the first file in the list all user-customized key override the keys
in this fixed file.
<!-- resolve shared content -->
component type=""Microsoft.Ddue.Tools.SharedContentComponent"" assembly=""" + GetSandcastlePath(lsettings) + @"ProductionTools\BuildComponents.dll"">
workaround --> <content file=""" + loutputPath + @"reference_content_fixed.xml"" />
<content file=""" + GetSandcastlePath(lsettings) + @"Presentation\" + ltemplate + @"\content\shared_content.xml"" />
<content file=""" + GetSandcastlePath(lsettings) + @"Presentation\" + ltemplate + @"\content\reference_content.xml"" />
<content file=""" + GetSandcastlePath(lsettings) + @"Presentation\" + ltemplate + @"\content\syntax_content.xml"" />
</component>
4.
The class inheritance tree is displayed incorrectly when using inner classes. SandcaslteGUI fixes this tree. (bug is reported on msdn).
5.
The border of empty <td> elements are not rendered (IE issue). SandcastleGUI adds an <br> in all empty <td> elements.
6.
SandcastleGUI fixes the size for the first 3 or 4 columns in the output documentation by adding absolute widths. The width of the description column will be the remaining size till 100%.
This improves the user experience when 4 tables are being displayed on a single page (properties, methods, fields and events). All columns (over multiple tables) are now perfectly being aligned.
7.
SandcastleGUI add a href-target for a MSDN-links. This will force a new window to be opened when a MSDN-link is being clicked.
(MSDN-help is sometimes preventing the user to press back/navigate back)
8.
Example code sections in VS2005 template is having incorrect background-color and font (compared with prototype template).
9.
When using firefox the method signatures is being displayed in very small font size, although the rest is displayed ok.
10.
Not all page titles and base-class names are having a fully qualified name when using innerclasses (it appears as the class is a normal class).
11.
SandcastleGUI sorts the classnames in the namespace overview.
12.
SandcastleGUI changes the table of contents displaying all public innerclasses at the same level as the parent class.
13.
Some sandcastle images don't have a transparent background.
Kind regards,
Stephan Smetsers
stephansmetsers@hotmail.com
http://www.inchl.nl