Sandcastle - March 2007 Community Technology Preview (CTP)
Sandcastle produces accurate, MSDN style, comprehensive documentation by reflecting over the source assemblies and optionally integrating XML Documentation Comments. Sandcastle has the following key features:
Works with or without authored comments
Supports Generics and .NET Framework 2.0
Sandcastle has 2 main components (MrefBuilder and Build Assembler)
MrefBuilder generates reflection xml file for Build Assembler
Build Assembler includes syntax generation, transformation..etc
Sandcastle is used internally to build .Net Framework documentation
What's new in this version:
- Added 4 new transforms under production tools folder. They are ApplyVSDocModel.Xsl, ApplyPrototypeDocModel.xsl, CreateVSToc.xsl and CreatePrototypeToc.xsl.
- Deleted 3 transforms under production tools folder. They are AddOverloads.xsl, ReflectionToChmContents.xsl and ReflectionToHxSContnets.xsl.
- Added Build_sandcastle.bat under Examples/Sandcastle folder. This batch file will generate chm/Hxs build from test.cs. Usage - Build_sandcastle.bat [vs2005/prototype].
- Perf improvements during CHM generation. Please see
> .Changes in this version:
- Changes to steps in CHM/HxS generation process. Please see Build_sandcastle.bat under Examples/Sandcastle folder
- Added 4 new transforms under production tools folder. They are ApplyVSDocModel.Xsl, ApplyPrototypeDocModel.xsl, CreateVSToc.xsl and CreatePrototypeToc.xsl.
- Deleted 3 transforms under production tools folder. They are AddOverloads.xsl, ReflectionToChmContents.xsl and ReflectionToHxSContnets.xsl.
Issues fixed in this version (Reported by Customers):
Sandcastle: MSHelp Index, apiname attributes: namespace and type name of members isn't showing up
Sandcastle: MSHelp F Index does not have an entry for typename.membername
Sandcastle:Issues with Sandcastle and .NETCF
Sandcastle: ApplyVsDocModel - Missing items: constructorsTopicTitle, membersTopicTitle, etc.
Sandcastle: not showing the "obsolete" messages for items with an ObsoleteAttribute.
Sandcastle: The <br/> and <hr/> HTML tags are getting stripped in Prototype transforms
Sandcastle: error message of ResolveReferenceLinksComponent is not correct
Sandcastle: property keyword is missing in managed cpp syntax
Sandcastle: apiIcon template issue
Sandcastle: Javascript error on members page in vs2005 transform
Sandcastle: December CTP - Wrong icons shown on member pages
Sandcastle: suggestion for GetMsdnUrl() method
Sandcastle: MrefBuilder fails when /internal+ switch is used on
Sandcastle: The reference_content.xml file is missing some keys
Sandcastle: syntax for Indexed Properties is not correct in managed cpp
Sandcastle: When using firefox the method signatures is being displayed in very small font size
Sandcastle: Is it possible to get rid of fully qualified type names?
Sandcastle: February CTP should have a version number higher than 2.2.61208.0
Sandcastle:Split the big framework reflection data file per assembly for shipping.
Sandcastle:CHM-table of contents does not show class members when applying the ApplyVSDocModel.xls
Sandcastle: Ignore CompilerGenerated attribute
Sandcastle: The border of empty <td> elements are not rendered (IE issue).
Sandcastle: parameter types not shown if it is an array (vs2005 theme)
Sandcastle: Some sandcastle images don't have a transparent background.
Sandcastle: extended character not supported in productTitle
Sandcastle: Update the setup script for MSI to get new files and changes.
Sandcastle: bug in K-keyword generation logic
Sandcastle: tables with icons have "Icon" as column header
Sandcastle: member Syntax section: Visual Basic (Usage) is not showing (looks like there is no generator for that, yet)
Sandcastle: MRefBuilder Namespace Ripping Still Broken
Sandcastle: performance issue related to ReflectionToChmContents.xsl
Sandcastle: Mref ripping feature doesn't work
Sandcastle: SandcastleGUI changes the table of contents displaying all public innerclasses at the same level as the parent class.
Sandcastle: html page is too wide in firefox
Sandcastle: Provide support for code Example
Sandcastle: MSHelp DevLang, codelang, Technology attributes are not present
Sandcastle:F1 context sensitive help does not work for sandcastle.
Sandcastle: Check in changeset of TocToChmContents.xsl into main tree
Sandcastle: Inherited from self info is showing up (vs2005 theme)
Sandcastle: Transform changes for Prototype and VS2005
Issues fixed in this version (Features and Bugs as a part of Orcas Beta 1):
MrefBuilder fails against the Orcas Cpref Assemblies
in pathname makes HHC.EXE generate bad CHM-file
DCR: Change "C++" to "Visual C++" in managed reference topic syntax blocks, language filter and code blocks
BuildAssembler: If the output path does not exist as specified in the .config, tool should create it for you
VTP: K keywords containing angle brackets < or > do not appear in Index
VTP: Code displayed incorrectly (on one line)
Overloads pages do not include boilerplate text for overloads supported by the .NET Compact Framework
Dynamic generated links show up twice, with one working and one broken link
Index item broken in half; second half appears as subindex of first half; first half goes to Empty Index Entry
Internal Only boilerplate text does not cascade to members when set at type level
Sandcastle:Split the big framework reflection data file per assembly for shipping.
Square brackets are not showing properly in syntax section for VB
Mref Attached Event syntax is wrong in all non XAML syntaxes (regression)
Mref Attached Property syntax is wrong in all non XAML syntaxes (regression)
Index shows "unattached" properties
Index does not always support navigation to type members
J# compiler options and operators are missing from index
Link text is not correct in 'see also/other resource'
See Also section links not sorted under subheadings
Authored “XAML Attribute Usage” sections of Attached Property and Attached Event pages do not appear
No reflection going on for NETCF Orcas assemblies
See Also does not have subdivisions
Text should be bold in the "Inheritance Hierarchy" sections of managed ref
The word "Namespace" appearing in TOC instead of the actual namespace name.
URL of topics have GUID in them.
Classes in TOC appear out of order
"Inheritance Hierarchy" appearing after "Thread Safety" in managed ref
Attributes appearing above declarations in managed ref.
Bold appearing in Syntax section of managed ref
copy code text missing
Remove Single Bullet
Missing Header text for a section
Link Text in table appears bold
in-topic links are not displaying as links
Gray box with link options appears after clicking link
& in VB sample code is replaced with &
< and > in Code Reference in List 1 are replaced with < and >
Icon display problems
Clicking Link creates Popup
Interface member declarative syntax now has "abstract" keywording - bug or feature?
Method member appearing twice in cpref TOC
Graphic icons missing on the page
Property members appearing twice in cpref TOC
Dynamic links don't work
Members tables are not showing protected internal members
Keyword "true" should be "True" for VB
Missing graphics on some topics
XAML snippets appear twice
Titles of member tables have swapped text for "Icon" and "Type" columns
Index entries for members are missing for many CLR types
In managed ref C++ code examples, member-selection operator -> renders as ->
Manifest: language filter not appearing
When filter is set to Visual C#, the System.Linq* namespaces disappear from the Class Library Reference
Microsoft.VisualStudio.Profiler Namespace missing protected methods and properties
Configuration schema hierarchies not displaying hierarchically
Unable to distinguish between topics in Index Results pane
Incorrect Version Information for new types
Managed reference missing running header text
Attached property and attached event topics appear twice in TOC
event table missing from Events topics
wrong column headings in member list topics
Angle brackets for C# generic types are incorrectly displayed in code snippets
All APIs supported by 3.5 package should indicate 3.5 in Version section
mref topics need frlrf A keywords
link resolution failure warnings should identify topic in which the error occurred
Parameters: type line is not correct for generics
Bold text has taken over topic
HostProtectionAttribute boilerplate
Indices for some classes are missing
"Obsolete" words are gone for all obsolete types.
Rendering Empty XAML syntax blocks
Assembly information is missing on namespace pages
Version info incorrect for WPF assemblies on all pages
Odd indentation in rendering of XAML syntax when it is text vs. code
BuildAssembler: Namespace top-level pages are dispaying the
Constructor node incorrectly displays at the end of member list topics
problem with constructors in the TOC
XSLTTransform: When building the HXT for Orcas, System.Data.Entity.dll and members are not being added
Manifold test Builds: brackets in code samples rendering as escape characters
Manifold builds: copy code produces script error on hover
NSR "Example" link throws script error
namespace wording in topic titles
nested types not in correct alpha location
method names always include param list
param lists use param name, should be param type
generic apis have no indicator of genericness
HxComp: Error HXC3031: A group of keywords for a single Help link or KTable exceeds 4,096 bytes.
XML Namespace info missing
Version Info section: missing data
Namespace/Assembly lines incorrect on type topics and missing on member topics
In Parameters section, param names followed by empty parens
Return Value section is missing on method topics
missing Property Value section
mref topics need MSHelp:RLTitle for search results
Phoenix Reference CHM - Class name not listed
See Also autogenerated links should have descriptor, e.g. "System.Window Namespace", not just "System.Window"
Specialized type pages (derived from generics) not showing
Inheritance Hierarchy for classes derived from generic specialization shows incorrect link text for ancestor class
Method names in links and NSR title should show param list only for overloads
param lists in titles and tocs should use param type, not param name
Manifold Build produces only part of hyperlink text in a hrefs
Syntax boilerplate tokens not resolved, e.g. UnsupportedGeneric_JSharp
Intro boilerplate missing on member list topics
Member lists missing CF and XNA icons
Missing Type Parameter section for generic types
XSLTransform: XLSTs: Default Namespace should be labelled
BuildAssembler.SharedComponent: If a USC file is not well-formed, we may want to log it and move on to at least get a build
BuildAssembler: SharedContentComponent: Tool is not expanding the PlatformNote and Assembly SSC items
BuildAssembler: CopyFromIndexComponent does not recursively search for the files as specified via the ./index/data@files
BuildAssembler: XSLTs: Syntax block for Visual Basic (Declaration) missing "Visual Basic" text
BuildAssembler / VersionBuilder: XSLT: Running the steps for versioning, it appears that basic text is appearing on the built pages
Sandcastle: DXROOT is not system environment variable
Sandcastle: virtual keyword is not in the right place for managed cpp property syntax
MrefBuilder addin creates attached property node with incorrect content
MrefBuilder addin creates attached event node with incorrect content
XSLTransform: XSLT (DocModelTOCFormat) for building HXT for CHM is causing Out of Memory for Orcas (WinSDK will be bigger)
XAML in page filtering behavior
Dependency Property Information sections
Routed Event Information sections
autogenerated XAML syntax boilerplate for classes and properties
BuildAssembler: XSLT -> Type page headings should be qualified (ex: BuildPropertyGroupCollection.CopyTo Method)
BuildAssembler: XSLT -> Namespace and Assembly information missing from top of member pages
need custom sections (XAML Syntax, Dependency Property, Event Routing)
need to support Attached Properties
need to support Attached Events
Syntax color coding applied oddly to text in syntax blocks
Missing technology qualifiers for the index
BuildAssembler: ResolveArtLinksComponent should not terminate if output directory does not eixt
BuildAssembler: TransformComponent -> Support for VisualBasicDeclarationSyntax needed
BuildAssembler: TransformComponent -> Support for CPlusPlusDeclarationSyntax
BuildAssembler: What exactly does Warn: ResolveReferenceLinksComponent message mean?
need links in NSR to See Also, Example, Members
Need multiple assembly info for duplicates like Theme APIs
Need to support all required keywords (xml data island attributes)
Terms in Inheritance Hierarchy section need to have fully qualified names
Need support for "Version Information" section
Namespace topics have a syntax block section; not part of the original design
UCER Style not appearing in build
XAML Syntax Autogeneration & Authored Section Overrides
No separate Derived Classes topic for inheritance hierarchy section
Missing Visual Basic (Usage) syntax
Missing JScript syntax
no Index entries for mref build
no member list topics, e.g. Methods, Properties, etc.
no member list filtering, e.g. for inherited, CF, XNA, protected
Manifold BuildAssembler: If the output path does not exist as specified in the .config, tool should create it for you
TextureLoader.FromFile has not been updating in any of the builds
Environment variable is not parsed in ExampleComponent
Sandcastle Nov CTP - <list type="number"> generated as bullet list
Examples code is not well formatted in vs2005 transform
Escape Characters in Codesnippet.xml are not converted back to original characters
Manifold ExampleComponent drops every other code sample
Manifold ExampleComponent double escapes HTML entities
DS Bug: Enumeration members are not ordered by value in the built page, they are ordered alphabetically.
Manifold Explicit Interface Implements rendering behavior does not follow CPLT guidelines
The requirements section on WPF reference pages should include XML namespace information
SandCastle:Presentation\Prototype\Scripts\StyleUtilities.js file that causes pages to throw JavaScript errors when it tries to access a style sheet with an ms-help URL
Sandcastle: CHM tab Index are untranslated.
Ability to rip NS, Types and members from Reflection.xml
BuildAssembler: .config (BuildComponents.dll) - SyntaxGenerators.dll - Support for XAML syntax
Syntax Builder VB Syntax: Class name in Interface implementation example should be in PascalCase.
Syntax Builder VB Syntax: There should be a newline between the parameter declarations and method call for Method Usage Syntax
Syntax Builder UETP: Syntax for generic types that implement generic interfaces is lacking the generic interfaces
Syntax Builder Generics: Property marked as virtual by class implementing a generic interface
Syntax Builder UETP: VB, C#, and C++ syntax for properties of explicit interface implementations on generic classes is incorrect
Syntax Builder NDP: UETP: Bad link in VB usage syntax for some explicit interface implementations on System.Windows.Forms.Control class
Syntax Attribute filtering not working
Visual Basic Usage syntax is missing boilerplate for static classes
Syntax Builder interface implementation should be marked virtual only if the keywork "final" does not appear in its IL;
Syntax Builder Add support for Operator and Type Conversion methods
Syntax Builder ConditionalAttribute should not be displayed in C++ syntax section because it is ignored by the compiler
Syntax Builder - links to HIS instead of MSDN for DataRelationCollection and DataTableCollection
Syntax Builder generates incorrect MSDN type links for ADODB types and MSXMLLib.DOMDocument
Syntax Builder Generics: Missing syntax block for type that inherits from generic ICollection
Span class=UI needs to be bolded
Tables too wide
The Abstract/Description attribute is missing
Investigate missing index keywords in dv_fxtools?
Blue text in topic
"Copy Code" Text missing next to the copy code icon
Content Dropout: Namespace topics need to include text from both Summary and Remarks
namespace/Assembly note should not be in namespace topics
Poor XAML "Not Applicable" notes layout
K and F Index transforms for managed ref content are not rendering specific enough information
See Also section has formatting problem on namespaces pages
need XAML F-keywords for F1 Help
Some art in tables drops out
Issues not fixed in this version:
Wiki:
http://www.sandcastledocs.com/Wiki%20Pages/Home.aspx
Forum:
http://forums.microsoft.com/MSDN/ShowForum.aspx?ForumID=66&SiteID=1
March 2007 Sandcastle CTP Technical Refresh
Issues fixed in this version (Reported by Customers):
- Sandcastle: Mref ripping feature doesn't work
- Sandcastle: copycodeHighlight.gif is not included in installer for March CTP
- Sandcastle: BuildAssembler is throwing StackOverflowException when applyinig /internal+ switch to Mrefbuilder