msbuildextasks Wiki & Documentation Rss Feed

UPDATED WIKI: Home

camalot — Fri, 27 Apr 2007 17:54:27 GMT

Latest Documentation (CHM) | Latest Documentation (Html) | Nightly Bits

This project was one affected by the outage that recently happened on codeplex. I will check in the latest code ASAP. Until then, you can get the latest from here

The aim of this project is to create a large collection of MSBuild tasks that can be used to perform actions to further automate the build process.

Tasks

MakeHttpRequest

Sandcastle

GenerateDocumentation

Support for NDoc NamespaceDoc class
Support for ProjectDoc class. Works like NamespaceDoc class except the information is used for the project page.
Generate documentation for your assemblies by calling 1 task
Support generation of a Table of Contents for viewing documentation via web browser.
Build Documentation in CHM format
Syntax highlighter for <code> blocks
Supports Prototype and VS2005 documentation Styles
Supports Friendly and Guid File names
Automatically Clean Sandcastle generated files (reflection.xml, sandcastle.config)
Automatically delete the generated html files.
Configurable Reference Link Resolving (None, Local, MSDN, Index)

Strings

WixAddFilesToComponent

UPDATED WIKI: WixAddFilesToComponent

camalot — Sat, 24 Feb 2007 19:15:57 GMT

Provides a way to dynamically generate file elements in a component defined in a Wix file.

Example Usage:

<WixAddFilesToComponent Files="@(ScriptFiles)" 
    XPath="$(JsBaseXPath)" NamespaceURI="$(Namespace)" 
    Namespaces="$(NamespaceManager)" XmlFile="$(WixFile)" />

Attribute	Description	Required	Type	Direction
XmlFile	The file to make the changes to	True	String	Input
XPath	The XPath to find the component to add the files to	True	String	Input
NamespaceURI	The default namespace. This is set to http://schemas.microsoft.com/wix/2006/wi by default.	False	String	Input
Namespaces	A string array of prefix:namespace strings.	False	String[]	Input
Files	An array of files to add.	True	String[]	Input
Compressed	Indicates if the files should be marked compressed	False	Boolean	Input
Disk	The disk id to assign the files to	True	Integer	Input
KeyPath	Indicates if the files should be marked as a KeyPath	False	Boolean	Input
Vital	Indicates if the files should be marked as Vital	False	Boolean	Input
Hidden	Indicates if the files should be marked as Hidden	False	Boolean	Input
SystemFile	Indicates if the files should be marked as system files	False	Boolean	Input
ReadOnly	Indicates if the files should be marked as readonly	False	Boolean	Input

Note: Namespaces contains "wix:http://schemas.microsoft.com/wix/2006/wi" by default. Since the document has a default namespace, the "wix" prefix is used to perform an XPath Query.

Here is an example XPath query to pass to this task to find the component.

 //wix:Component[@Guid='$(MyComponentGuid)']

UPDATED WIKI: WixAddFilesToComponent

camalot — Sat, 24 Feb 2007 19:15:18 GMT

Provides a way to dynamically generate file elements in a component defined in a Wix file.

Example Usage:

 <WixAddFilesToComponent Files="@(ScriptFiles)" XPath="$(JsBaseXPath)" NamespaceURI="$(Namespace)" Namespaces="$(NamespaceManager)" XmlFile="$(WixFile)" />

Attribute	Description	Required	Type	Direction
XmlFile	The file to make the changes to	True	String	Input
XPath	The XPath to find the component to add the files to	True	String	Input
NamespaceURI	The default namespace. This is set to http://schemas.microsoft.com/wix/2006/wi by default.	False	String	Input
Namespaces	A string array of prefix:namespace strings.	False	String[]	Input
Files	An array of files to add.	True	String[]	Input
Compressed	Indicates if the files should be marked compressed	False	Boolean	Input
Disk	The disk id to assign the files to	True	Integer	Input
KeyPath	Indicates if the files should be marked as a KeyPath	False	Boolean	Input
Vital	Indicates if the files should be marked as Vital	False	Boolean	Input
Hidden	Indicates if the files should be marked as Hidden	False	Boolean	Input
SystemFile	Indicates if the files should be marked as system files	False	Boolean	Input
ReadOnly	Indicates if the files should be marked as readonly	False	Boolean	Input

 //wix:Component[@Guid='$(MyComponentGuid)']

UPDATED WIKI: WixAddFilesToComponent

camalot — Sat, 24 Feb 2007 19:13:36 GMT

Provides a way to dynamically generate file elements in a component defined in a Wix file.

Example Usage:
<WixAddFilesToComponent Files="@(ScriptFiles)" XPath="$(JsBaseXPath)" NamespaceURI="$(Namespace)" Namespaces="$(NamespaceManager)" XmlFile="$(WixFile)" />

Attribute	Description	Required	Type	Direction
XmlFile	The file to make the changes to	True	String	Input
XPath	The XPath to find the component to add the files to	True	String	Input
NamespaceURI	The default namespace. This is set to http://schemas.microsoft.com/wix/2006/wi by default.	False	String	Input
Namespaces	A string array of prefix:namespace strings.	False	String[]	Input
Files	An array of files to add.	True	String[]	Input
Compressed	Indicates if the files should be marked compressed	False	Boolean	Input
Disk	The disk id to assign the files to	True	Integer	Input
KeyPath	Indicates if the files should be marked as a KeyPath	False	Boolean	Input
Vital	Indicates if the files should be marked as Vital	False	Boolean	Input
Hidden	Indicates if the files should be marked as Hidden	False	Boolean	Input
SystemFile	Indicates if the files should be marked as system files	False	Boolean	Input
ReadOnly	Indicates if the files should be marked as readonly	False	Boolean	Input

UPDATED WIKI: CreateXmlDocument

camalot — Sat, 24 Feb 2007 19:03:03 GMT

This creates an XmlDocument and a root element.

Example Usage:

  <CreateXmlDocument  Name="Project" XmlVersion="1.0" XmlEncoding="UTF-8"
      XmlFile="$(MSBuildProjectDirectory)\$(OutputPath)Test.xml" 
      NamespaceURI="http://schemas.microsoft.com/developer/msbuild/2003"
    />

Attribute	Description	Required	Type	Direction
Name	The name of the root element	True	String	Input
NamespaceURI	The default namespaceURI of the root element	False	String	Input
Namespaces	an array of prefix:namespace strings	False	String	Input
XmlFile	The path and file name of the xml file that will be created	True	String	Input
XmlVersion	The version string of the xml document ( default: "1.0" )	False	String	Input
XmlEncoding	The encoding of the xml document ( default: "UTF-8" )	False	String	Input
Standalone	The standalone attribute of the xml document ( default: "" )	False	String	Input
ErrorIfFileExists	Indicates if an error should occur if the file already exists	False	Boolean	Input

UPDATED WIKI: Home

camalot — Sat, 24 Feb 2007 15:55:40 GMT

Latest Documentation (CHM) | Latest Documentation (Html) | Nightly Bits

The aim of this project is to create a large collection of MSBuild tasks that can be used to perform actions to further automate the build process.

Tasks

MakeHttpRequest

Sandcastle

GenerateDocumentation

Support for NDoc NamespaceDoc class
Support for ProjectDoc class. Works like NamespaceDoc class except the information is used for the project page.
Generate documentation for your assemblies by calling 1 task
Support generation of a Table of Contents for viewing documentation via web browser.
Build Documentation in CHM format
Syntax highlighter for <code> blocks
Supports Prototype and VS2005 documentation Styles
Supports Friendly and Guid File names
Automatically Clean Sandcastle generated files (reflection.xml, sandcastle.config)
Automatically delete the generated html files.
Configurable Reference Link Resolving (None, Local, MSDN, Index)

Strings

WixAddFilesToComponent

UPDATED WIKI: Home

camalot — Thu, 22 Feb 2007 03:43:55 GMT

Tasks

MakeHttpRequest

Sandcastle

GenerateDocumentation

Support for NDoc NamespaceDoc class
Support for ProjectDoc class. Works like NamespaceDoc class except the information is used for the project page.
Generate documentation for your assemblies by calling 1 task
Support generation of a Table of Contents for viewing documentation via web browser.
Build Documentation in CHM format
Syntax highlighter for <code> blocks
Supports Prototype and VS2005 documentation Styles
Supports Friendly and Guid File names
Automatically Clean Sandcastle generated files (reflection.xml, sandcastle.config)
Automatically delete the generated html files.
Configurable Reference Link Resolving (None, Local, MSDN, Index)

Strings

UPDATED WIKI: Home

camalot — Thu, 22 Feb 2007 01:50:37 GMT

The aim of this project is to create a large collection of MSBuild tasks that can be used to perform actions to further automate the build process.

Tasks

MakeHttpRequest

Sandcastle

GenerateDocumentation

Support for NDoc NamespaceDoc class
Support for ProjectDoc class. Works like NamespaceDoc class except the information is used for the project page.
Generate documentation for your assemblies by calling 1 task
Support generation of a Table of Contents for viewing documentation via web browser.
Build Documentation in CHM format
Syntax highlighter for <code> blocks
Supports Prototype and VS2005 documentation Styles
Supports Friendly and Guid File names
Automatically Clean Sandcastle generated files (reflection.xml, sandcastle.config)
Automatically delete the generated html files.
Configurable Reference Link Resolving (None, Local, MSDN, Index)

Strings

UPDATED WIKI: Home

camalot — Thu, 22 Feb 2007 00:55:52 GMT

The aim of this project is to create a large collection of MSBuild tasks that can be used to perform actions to further automate the build process.

Tasks

MakeHttpRequest

Sandcastle

GenerateDocumentation

Support for NDoc NamespaceDoc class
Support for ProjectDoc class. Works like NamespaceDoc class except the information is used for the project page.
Generate documentation for your assemblies by calling 1 task
Support generation of a Table of Contents for viewing documentation via web browser.
Build Documentation in CHM format
Syntax highlighter for <code> blocks
Supports Prototype and VS2005 documentation Styles
Supports Friendly and Guid File names
Automatically Clean Sandcastle generated files (reflection.xml, sandcastle.config)
Automatically delete the generated html files.
Configurable Reference Link Resolving (None, Local, MSDN, Index)

Strings

Features

Generate documentation for your assemblies by calling 1 task
Support generation of a Table of Contents for viewing documentation via web browser.
Build Documentation in CHM format
Syntax highlighter for <code> blocks
Supports Prototype and VS2005 documentation Styles

UPDATED WIKI: Home

camalot — Thu, 22 Feb 2007 00:27:02 GMT

The aim of this project is to create a large collection of MSBuild tasks that can be used to perform actions to further automate the build process.

Tasks

MakeHttpRequest

Sandcastle

GenerateDocumentation

Support for NDoc NamespaceDoc class
Generate documentation for your assemblies by calling 1 task
Support generation of a Table of Contents for viewing documentation via web browser.
Build Documentation in CHM format
Syntax highlighter for <code> blocks
Supports Prototype and VS2005 documentation Styles
Supports Friendly and Guid File names
Automatically Clean Sandcastle generated files (reflection.xml, sandcastle.config)
Automatically delete the generated html files.
Configurable Reference Link Resolving (None, Local, MSDN, Index)

Strings

Features

Generate documentation for your assemblies by calling 1 task
Support generation of a Table of Contents for viewing documentation via web browser.
Build Documentation in CHM format
Syntax highlighter for <code> blocks
Supports Prototype and VS2005 documentation Styles

UPDATED WIKI: Home

camalot — Tue, 20 Feb 2007 01:50:13 GMT

The aim of this project is to create a large collection of MSBuild tasks that can be used to perform actions to further automate the build process.

Tasks

MakeHttpRequest

Sandcastle

GenerateDocumentation

Strings

UPDATED WIKI: GenerateDocumentation

camalot — Mon, 19 Feb 2007 13:47:04 GMT

The GenerateDocumentation Task uses sandcastle to generate documentation from assemblies and the xml comments file.

Example Usage:

	<GenerateDocumentation SandcastlePath="C:\Program Files\Sandcastle" HelpName="MSBuild.Extended.Tasks"
		OutputPath="$(MSBuildProjectDirectory)\Help" Assemblies="$(MSBuildProjectDirectory)\Test.dll"
		XmlDocumentationFiles="@(DocFiles)" BuildCHM="True"
		FileNameStyle="Friendly" />

Attribute	Description	Required	Type	Direction
SandcastlePath	The install path of Sandcastle	True	String	Input
FileNameStyle	The type of file names to use.	False	FileNameStyle	Input
DocumentStyle	The document stlye to use.	False	DocumentStyle	Input
PresentationType	The presentation style to use.	False	PresentationType	Input
HelpName	The name of the compiled help file without an extension	True	String	Input
OutputPath	Path where to build the documentation to.	True	String	Input
HtmlHelpCompilerBinPath	Path to the Html Help Compiler	False	String	Input
HXCompilerBinPath	Path to the HX Help Compiler	False	String	Input
BuildCHM	Indicates if a CHM file should be built. (default:True)	False	Boolean	Input
BuildHxS	Indicates if HxS help file should be built. (default:False)	False	Boolean	Input
Dependencies	Array of dependencies.	False	String	Input
Assemblies	Array of assemblies	True	String	Input
XmlDocumentationFiles	Array of xml documentation files.	True	String	Input
CleanUpDocumentationFiles	Will clean up any files generated by or for Sandcastle after complete.	False	Boolean	Input
DeleteHtml	If true, the generated Html will be deleted after documentation generation.	False	Boolean	Input
UseCodeSyntaxHighlighterComponent	Use the CodeSyntaxHighlighterComponent component when build documentation.	False	Boolean	Input
GenerateHtmlToc	If true, a TOC will be created, but not added to compiled docs. This is a html toc to allow navigation through the docs via a web broweser.	False	Boolean	Input
ReflectionToHtmlTocTransform	Path to the Html TOC Xsl file.	False	String	Input

FileNameStyle

Friendly
Guid

PresentationType

Prototype
VS2005

DocumentStyle

Standard
VisualStudio

UPDATED WIKI: GenerateDocumentation

camalot — Sun, 18 Feb 2007 06:31:33 GMT

The GenerateDocumentation Task uses sandcastle to generate documentation from assemblies and the xml comments file.

Example Usage:

	<GenerateDocumentation SandcastlePath="C:\Program Files\Sandcastle" HelpName="MSBuild.Extended.Tasks"
		OutputPath="$(MSBuildProjectDirectory)\Help" Assemblies="$(MSBuildProjectDirectory)\Test.dll"
		XmlDocumentationFiles="@(DocFiles)" BuildCHM="True"
		FileNameStyle="Friendly" />

Attribute	Description	Required	Type	Direction
SandcastlePath	The install path of Sandcastle	True	String	Input
FileNameStyle	The type of file names to use.	False	FileNameStyle	Input
DocumentStyle	The document stlye to use.	False	DocumentStyle	Input
PresentationType	The presentation style to use.	False	PresentationType	Input
HelpName	The name of the compiled help file without an extension	True	String	Input
OutputPath	Path where to build the documentation to.	True	String	Input
HtmlHelpCompilerBinPath	Path to the Html Help Compiler	False	String	Input
HXCompilerBinPath	Path to the HX Help Compiler	False	String	Input
BuildCHM	Indicates if a CHM file should be built. (default:True)	False	Boolean	Input
BuildHxS	Indicates if HxS help file should be built. (default:False)	False	Boolean	Input
Dependencies	Array of dependencies.	False	String	Input
Assemblies	Array of assemblies	True	String	Input
XmlDocumentationFiles	Array of xml documentation files.	True	String	Input

FileNameStyle

Friendly
Guid

PresentationType

Prototype
VS2005

DocumentStyle

Standard
VisualStudio

UPDATED WIKI: GenerateDocumentation

camalot — Sun, 18 Feb 2007 06:27:36 GMT

The GenerateDocumentation Task uses sandcastle to generate documentation from assemblies and the xml comments file.

Example Usage:

	<GenerateDocumentation SandcastlePath="C:\Program Files\Sandcastle" HelpName="MSBuild.Extended.Tasks"
		OutputPath="$(MSBuildProjectDirectory)\Help" Assemblies="$(MSBuildProjectDirectory)\Test.dll"
		XmlDocumentationFiles="@(DocFiles)" BuildCHM="True"
		FileNameStyle="Friendly" />

Attribute	Description	Required	Type	Direction
SandcastlePath	The install path of Sandcastle	True	String	Input
FileNameStyle	The type of file names to use.	False	FileNameStyle	Input
DocumentStyle	The document stlye to use.	False	DocumentStyle	Input
PresentationType	The presentation style to use.	False	PresentationType	Input
HelpName	The name of the compiled help file without an extension	True	String	Input
OutputPath	Path where to build the documentation to.	True	String	Input
HtmlHelpCompilerBinPath	Path to the Html Help Compiler	False	String	Input
HXCompilerBinPath	Path to the HX Help Compiler	False	String	Input
BuildCHM	Indicates if a CHM file should be built. (default:True)	False	Boolean	Input
BuildHxS	Indicates if HxS help file should be built. (default:False)	False	String	Input
Dependencies	Array of dependencies.	False	String	Input
Assemblies	Array of assemblies	True	String	Input
XmlDocumentationFiles	Array of xml documentation files.	True	String	Input

UPDATED WIKI: Home

camalot — Sun, 18 Feb 2007 06:15:39 GMT

The aim of this project is to create a large collection of MSBuild tasks that can be used to perform actions to further automate the build process.

Tasks

Sandcastle

GenerateDocumentation

Strings

UPDATED WIKI: Home

camalot — Sat, 17 Feb 2007 20:24:25 GMT

The aim of this project is to create a large collection of MSBuild tasks that can be used to perform actions to further automate the build process.

Tasks

Sandcastle

GenerateDocumentation

Strings

UPDATED WIKI: StringFormat

camalot — Sat, 17 Feb 2007 20:18:24 GMT

The StringFormat Task provides functionality to take a format string and a list of values to produce a new string.

Example Usage:

    <StringFormat Format="Old Version: {0} New Version: {1}" 
          Parameters="$(OldVersion);$(NewVersion)">
      <Output PropertyName="ResultFormat" TaskParameter="Result" />
    </StringFormat>

Attribute	Description	Required	Type	Direction
Format	The format string	True	String	Input
Parameters	The list of values to use	False	String[]	Input
Result	The formated string	N/A	String	Output

UPDATED WIKI: Home

camalot — Sat, 17 Feb 2007 20:10:44 GMT

The aim of this project is to create a large collection of MSBuild tasks that can be used to perform actions to further automate the build process.

Tasks

Strings

UPDATED WIKI: XmlNodeExists

camalot — Sat, 17 Feb 2007 07:09:36 GMT

The XmlNodeExists Task will check if a node exists in an xml document based on an XPath query.

Example Usage:

  <XmlNodeExists XmlFile="$(MSBuildProjectDirectory)\$(OutputPath)Test.xml"
      XPath="/Project/Output">
    <Output PropertyName="OutputNodeExists" TaskParameter="Exists" />
  </XmlNodeExists>
  <Message Text="Output node exists = $(OutputNodeExists)" />

Attribute	Description	Required	Type	Direction
Name	The name of the node	N/A	String	Output
NamespaceURI	The namespace URI for the node	False	String	Input
Prefix	The namespace prefix for the node	False	String	Input
XmlFile	The path and file name of the xml document	True	String	Input
XPath	The XPath that is used to check if a node exists.	True	String	Input
Exists	An indicator if the node that was checked exists in the xml document	N/A	Boolean	Output

UPDATED WIKI: XmlNodeExists

camalot — Sat, 17 Feb 2007 07:09:11 GMT

The XmlNodeExists Task will check if a node exists in an xml document based on an XPath query.

Example Usage:

  <XmlNodeExists XmlFile="$(MSBuildProjectDirectory)\$(OutputPath)Test.xml"
      XPath="/Project/Output">
    <Output PropertyName="OutputNodeExists" TaskParameter="Exists" />
  </XmlNodeExists>
  <Message Text="Output node exists = $(OutputNodeExists)" />

Attribute	Description	Required	Type	Direction
Name	The name of the node	True	String	Output
NamespaceURI	The namespace URI for the node	False	String	Input
Prefix	The namespace prefix for the node	False	String	Input
XmlFile	The path and file name of the xml document	True	String	Input
XPath	The XPath that is used to check if a node exists.	False	String	Input
Exists	An indicator if the node that was checked exists in the xml document	N/A	Boolean	Output