Jump to content

Sandcastle (software): Difference between revisions

From Wikipedia, the free encyclopedia
Browse history interactively
← Previous editNext edit →
Content deleted Content added
VisualWikitext
+ VS Category
+ quick update
Line 1: Line 1:
{{Infobox Software |
{{Infobox Software |
name = SandCastle |
name = Sandcastle |
developer = [[Microsoft Corporation]] |
developer = [[Microsoft Corporation]] |
latest_release_version = June 2007 CTP |
latest_release_version = (2.3.8000.26) October 2007 CTP |
latest_release_date = [[June 22]], [[2007]] |
latest_release_date = [[October 29]], [[2007]] |
operating_system = [[ Windows|Windows]] |
operating system = [[Microsoft Windows|Windows]] |
genre = [[Documentation generator]] |
genre = [[Documentation generator]] |
website = [http://www.microsoft.com/downloads/details.aspx?FamilyId=E82EA71D-DA89-42EE-A715-696E3A4873B2&displaylang=en www.microsoft.com] |
website = [http://www.microsoft.com/downloads/details.aspx?FamilyId=E82EA71D-DA89-42EE-A715-696E3A4873B2&displaylang=en http://www.microsoft.com] |
}}
}}


'''SandCastle''' produces [[MSDN]] style documentation out of reflection information of [[.NET]] assemblies and [[XML]] documentation comments found in the sourcecode of these assemblies.
'''Sandcastle''' is a [[documentation generator]] from [[Microsoft]] that produces [[MSDN]] style documentation out of reflection information of [[.NET]] [[.NET assembly|assemblies]] and [[XML]] documentation comments found in the [[source code]] of these assemblies.


==Overview==
==Overview==


The SandCastle application was developed by [[Microsoft]] to create a scalable and performing [[Documentation generator]] for their [[API Documentation]]. There is currently not much documentation on the application since it is still early in the development stage. It is known however that the application will become part of the [[Visual Studio]] [[SDK]].
The Sandcastle application was developed by [[Microsoft]] to create a scalable and performing [[documentation generator]] for their [[Application Programming Interface|API]] documentation. There is currently not much documentation on the application since it is still early in the development stage. It is however part of the [[Visual Studio]] [[SDK]]. <ref> [http://blogs.msdn.com/sandcastle/archive/2006/07/27/680793.aspx Announcing Sandcastle: Sandcastle blog] </ref>


The application currently does not feature a [[Graphical User Interface]], only 3 [[command line]] tools (MrefBuilder, XslTransform and BuildAssembler). MrefBuilder uses CCI to reflect against the assemblies and generate an output file, XslTransform transforms the output file to an [[XML]] file which is used as an input to BuildAssembler. This then creates the files that can work as an input to the Microsoft [[HTML Help Workshop]] compiler (HHC).
The application currently does not feature a [[Graphical User Interface]], only 3 [[command line]] tools (MrefBuilder, XslTransform and BuildAssembler). MrefBuilder uses CCI to reflect against the assemblies and generate an output file, XslTransform transforms the output file to an [[XML]] file which is used as an input to BuildAssembler. This then creates the files that can work as an input to the Microsoft [[HTML Help Workshop]] compiler (HHC). <ref> [http://blogs.msdn.com/sandcastle/archive/2006/07/29/682398.aspx Creating a Chm build using Sandcastle] </ref> Several community GUI tools are available for Sandcastle. <ref> [http://www.sandcastledocs.com/Wiki%20Pages/Sandcastle%20GUIs%20from%20Community.aspx Sandcastle GUIs from Community] </ref>


==Using SandCastle==
==Using Sandcastle==


Because in its current state SandCastle by itself is rather complex to use, people have come up with tools and scripts that can automate the task for them. This section contains a list of such tools and scripts.
Because in its current state Sandcastle by itself is rather complex to use, people have come up with tools and scripts that can automate the task for them. This section contains a list of such tools and scripts.


* [http://www.codeplex.com/SHFB SandCastle Help File Builder]
* [http://www.codeplex.com/SHFB Sandcastle Help File Builder]
* [http://www.codeplex.com/DocProject DocProject Visual Studio 2005]
* [http://www.codeplex.com/DocProject DocProject Visual Studio 2005]
* [http://www.dotnetjunkies.com/WebLog/mikaels/default.aspx SandCastle Helper]
* [http://www.dotnetjunkies.com/WebLog/mikaels/default.aspx Sandcastle Helper]
* [http://ixnay2infinity.blogspot.com/2006/07/batch-file-for-microsoft-sandcastle.html Batch file]
* [http://ixnay2infinity.blogspot.com/2006/07/batch-file-for-microsoft-sandcastle.html Batch file]
* [http://www.hanselman.com/blog/SandcastleMicrosoftCTPOfAHelpCHMFileGeneratorOnTheTailsOfTheDeathOfNDoc.aspx PowerShell script]
* [http://www.hanselman.com/blog/SandcastleMicrosoftCTPOfAHelpCHMFileGeneratorOnTheTailsOfTheDeathOfNDoc.aspx PowerShell script]
* [http://blog.ljusberg.com/2006/07/msbuild-script-for-sandcastle.html MSBuild script]
* [http://blog.ljusberg.com/2006/07/msbuild-script-for-sandcastle.html MSBuild script]
* [http://dotnetpret.blogspot.com/2006/08/sandcastle-continued-documentation.html SandCastle Visual Studio Add-In]
* [http://dotnetpret.blogspot.com/2006/08/sandcastle-continued-documentation.html Sandcastle Visual Studio Add-In]


==History==
==History==
{{update}}

* [[November 11]], [[2006]] the November 2006 CTP version was released, along with bug fixes other items being supported are a few [[nDoc]] tags, and also transforms support [[Firefox]].
* [[November 11]], [[2006]] the November 2006 CTP version was released, along with bug fixes other items being supported are a few [[nDoc]] tags, and also transforms support [[Firefox]].


Line 47: Line 47:
==External links==
==External links==
* [http://www.microsoft.com/downloads/details.aspx?FamilyID=E82EA71D-DA89-42EE-A715-696E3A4873B2&displaylang=en Official download page]
* [http://www.microsoft.com/downloads/details.aspx?FamilyID=E82EA71D-DA89-42EE-A715-696E3A4873B2&displaylang=en Official download page]
* [http://blogs.msdn.com/sandcastle/default.aspx Official SandCastle weblog]
* [http://blogs.msdn.com/sandcastle/default.aspx Official Sandcastle blog]
* [http://msdn2.microsoft.com/en-us/vstudio/bb608422.aspx SandCastle documentation site]
* [http://msdn2.microsoft.com/en-us/vstudio/bb608422.aspx Sandcastle documentation on MSDN]
* [http://www.sandcastledocs.com/Wiki%20Pages/Home.aspx SandcastleDocs.com wiki site]
* [http://www.sandcastledocs.com/Wiki%20Pages/Home.aspx SandcastleDocs.com wiki site]


==References==
==References==
{{reflist}}
⚫
* [http://blogs.msdn.com/sandcastle/archive/2006/07/29/682830.aspx SandCastle weblog], the first public version announced.
* [http://blogs.msdn.com/sandcastle/archive/2006/07/30/683352.aspx SandCastle weblog], A few faqs about SandCastle.
* [http://blogs.msdn.com/sandcastle/archive/2006/07/29/682830.aspx Sandcastle blog], the first public version announced.
⚫
* [http://blogs.msdn.com/sandcastle/archive/2006/07/30/683352.aspx Sandcastle blog], A few FAQs about Sandcastle.

<references />


[[Category:Documentation generators]]
[[Category:Documentation generators]]

Revision as of 06:52, 1 December 2007

Sandcastle
Developer(s)Microsoft Corporation
Stable release
(2.3.8000.26) October 2007 CTP / October 29, 2007
Operating systemWindows
TypeDocumentation generator
Websitehttp://www.microsoft.com

Sandcastle is a documentation generator from Microsoft that produces MSDN style documentation out of reflection information of .NET assemblies and XML documentation comments found in the source code of these assemblies.

Overview

The Sandcastle application was developed by Microsoft to create a scalable and performing documentation generator for their API documentation. There is currently not much documentation on the application since it is still early in the development stage. It is however part of the Visual Studio SDK. [1]

The application currently does not feature a Graphical User Interface, only 3 command line tools (MrefBuilder, XslTransform and BuildAssembler). MrefBuilder uses CCI to reflect against the assemblies and generate an output file, XslTransform transforms the output file to an XML file which is used as an input to BuildAssembler. This then creates the files that can work as an input to the Microsoft HTML Help Workshop compiler (HHC). [2] Several community GUI tools are available for Sandcastle. [3]

Using Sandcastle

Because in its current state Sandcastle by itself is rather complex to use, people have come up with tools and scripts that can automate the task for them. This section contains a list of such tools and scripts.

History

  • November 11, 2006 the November 2006 CTP version was released, along with bug fixes other items being supported are a few nDoc tags, and also transforms support Firefox.
  • October 1, 2006 the September 2006 CTP version was released, bug fixes primarily seem to focus on fixing bugs in the output, and adding better support for some XML comment tags.
  • August 28, 2006 the August 2006 CTP version was released, the bugs fixed in this release seem to primarily for fixing crashes of the application. HTML output of the application is now compatible with Firefox. Some changes were made to the command line interface.
  • July 29, 2006 the July 2006 CTP version was released, this version mainly focused on performance and scalability. No GUI was present yet, the application did not contain a feature to resolve GAC DLLs yet.

See also

References

  1. ^ Announcing Sandcastle: Sandcastle blog
  2. ^ Creating a Chm build using Sandcastle
  3. ^ Sandcastle GUIs from Community
Retrieved from "https://en.wikipedia.org/w/index.php?title=Sandcastle_(software)&oldid=175003396"