Notices: This section not yet converted to new layout. Download stats are rolling back out.

This is not the latest version of Sandcastle Help File Builder and Tools (Install) available.

Sandcastle Help File Builder and Tools (Install)

2015.7.25.0

Package test results are passing.

This package was approved by moderator ferventcoder on 12/28/2015.

Sandcastle is composed of two separate parts that work together: the Sandcastle tools and the Sandcastle Help File Builder. The Sandcastle tools are used to create help files for managed class libraries containing both conceptual and API reference topics. API reference topics are created by combining the XML comments that are embedded in your source code with the syntax and structure of the types which is acquired by reflecting against the associated .NET Framework assemblies. Conceptual topics are created by converting XML documents that you author containing Microsoft Assistance Markup Language (MAML). The Sandcastle tools are command-line based and have no GUI front-end, project management features, or an automated build process.

The Sandcastle Help File Builder was created to fill in the gaps, provide the missing NDoc-like features that are used most often, and provide standalone GUI and command line based tools to build a help file in an automated fashion. A Visual Studio integration package is also available for it so that help projects can be created and managed entirely from within Visual Studio.

To install Sandcastle Help File Builder and Tools (Install), run the following command from the command line or from PowerShell:

C:\> choco install sandcastle --version 2015.7.25.0

To upgrade Sandcastle Help File Builder and Tools (Install), run the following command from the command line or from PowerShell:

C:\> choco upgrade sandcastle --version 2015.7.25.0

Files

Hide
  • tools\chocolateyinstall.ps1 Show
    # stop on all errors
    $ErrorActionPreference = 'Stop';
    
    $versionNumber = '2015.7.25.0'
    $packageName = 'sandcastle' # arbitrary name for the package, used in messages
    $registryUninstallerKeyName = 'sandcastle' #ensure this is the value in the registry
    $installerType = 'MSI' #only one of these: exe, msi, msu
    $url = 'https://github.com/EWSoftware/SHFB/releases/download/v' + $versionNumber + '/SHFBInstaller_v' + $versionNumber + '.zip' # download url
    $silentArgs = '/quiet'
    $validExitCodes = @(0) #please insert other valid exit codes here, exit codes for ms http://msdn.microsoft.com/en-us/library/aa368542(VS.85).aspx
    $toolsDir = "$(Split-Path -parent $MyInvocation.MyCommand.Definition)"
    $zipFile = Join-Path $toolsDir ('SHFBInstaller_v' + $versionNumber + '.zip')
    $zipDir = Join-Path $toolsDir ('SHFBInstaller_v' + $versionNumber)
    
    Get-ChocolateyWebFile "$packageName" "$zipFile" "$url" 
    Get-ChocolateyUnzip "$zipFile" "$zipDir"
    
    $file = Join-Path $zipDir "InstallResources\SandcastleHelpFileBuilder.msi"
    Install-ChocolateyPackage "$packageName" "$installerType" "$silentArgs" "$file"
  • tools\chocolateyuninstall.ps1 Show
    # stop on all errors
    $ErrorActionPreference = 'Stop';
    
    $packageName = 'sandcastle'
    
    try
    {
    	$msiPackageGuid = '{07BAE775-6B29-4D6D-974B-57C5BFA5EF59}'
    	$msiArgs = "/x $msiPackageGuid /qn REBOOT=ReallySuppress"
    
    	Start-ChocolateyProcessAsAdmin "$msiArgs" 'msiexec'
    	Write-ChocolateySuccess $package
    } catch {
    	Write-ChocolateyFailure $packageName "$($_.Exception.Message)"
    }

Virus Scan Results

In cases where actual malware is found, the packages are subject to removal. Software sometimes has false positives. Moderators do not necessarily validate the safety of the underlying software, only that a package retrieves software from the official distribution point and/or validate embedded software against official distribution point (where distribution rights allow redistribution).

Chocolatey Pro provides runtime protection from possible malware.

Dependencies

Package Maintainer(s)

Software Author(s)

  • Eric Woodruff

Copyright

Eric Woodruff (c) 2006-2015

Tags

Release Notes

https://github.com/EWSoftware/SHFB/releases/tag/v2015.7.25.0

Version History

Version Downloads Last updated Status
Sandcastle Help File Builder and Tools (Install) 2018.7.8.0 383 Tuesday, July 24, 2018 approved
Sandcastle Help File Builder and Tools (Install) 2018.5.14.0 205 Saturday, May 26, 2018 approved
Sandcastle Help File Builder and Tools (Install) 2017.12.30.2 393 Tuesday, January 16, 2018 approved
Sandcastle Help File Builder and Tools (Install) 2017.12.30.0 202 Monday, January 8, 2018 approved
Sandcastle Help File Builder and Tools (Install) 2017.5.15.0 1340 Wednesday, May 17, 2017 approved
Sandcastle Help File Builder and Tools (Install) 2017.1.28.1 273 Sunday, April 9, 2017 approved
Sandcastle Help File Builder and Tools (Install) 2017.1.28.0 277 Friday, March 10, 2017 approved
Sandcastle Help File Builder and Tools (Install) 2016.9.17.0 522 Tuesday, December 20, 2016 approved
Show More

Discussion for the Sandcastle Help File Builder and Tools (Install) Package

Ground rules:

  • This discussion is only about Sandcastle Help File Builder and Tools (Install) and the Sandcastle Help File Builder and Tools (Install) package. If you have feedback for Chocolatey, please contact the google group.
  • This discussion will carry over multiple versions. If you have a comment about a particular version, please note that in your comments.
  • The maintainers of this Chocolatey Package will be notified about new comments that are posted to this Disqus thread, however, it is NOT a guarantee that you will get a response. If you do not hear back from the maintainers after posting a message below, please follow up by using the link on the left side of this page or follow this link to contact maintainers. If you still hear nothing back, please follow the package triage process.
  • Tell us what you love about the package or Sandcastle Help File Builder and Tools (Install), or tell us what needs improvement.
  • Share your experiences with the package, or extra configuration or gotchas that you've found.
  • If you use a url, the comment will be flagged for moderation until you've been whitelisted. Disqus moderated comments are approved on a weekly schedule if not sooner. It could take between 1-5 days for your comment to show up.

comments powered by Disqus
Chocolatey.org uses cookies to enhance the user experience of the site.
Ok