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)

2018.5.14.0

Package test results are passing.

This package was approved as a trusted package on 7/6/2018.

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 2018.5.14.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 2018.5.14.0

Files

Hide
  • README.md Show
    # Sandcastle Help File Builder and Tools
    
    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.
  • tools\chocolateyInstall.ps1 Show
    $toolsPath = Split-Path $MyInvocation.MyCommand.Definition
    . $toolsPath\helpers.ps1
    
    # stop on all errors
    $ErrorActionPreference = 'Stop';
    
    $packageName   = 'sandcastle' # arbitrary name for the package, used in messages
    $versionNumber = '2018.5.14.0'
    $url           = 'https://github.com/EWSoftware/SHFB/releases/download/v2018.5.14.0/SHFBInstaller_v2018.5.14.0.zip' # download url
    $checksum      = 'eb06f74d4673a804f4d8f722c532eb73ba0d1490743946ac899e10bdf08ffacf'
    $checksumType  = 'sha256'
    
    $chocTempDir   = Join-Path $env:TEMP "chocolatey"
    $tempDir       = Join-Path $chocTempDir "$packageName"
    
    $zipFile = Join-Path $tempDir ('SHFBInstaller_v' + $versionNumber + '.zip')
    $zipDir = Join-Path $toolsPath ('SHFBInstaller_v' + $versionNumber)
    
    Get-ChocolateyWebFile "$packageName" "$zipFile" "$url" `
                          -Checksum "$checksum" -ChecksumType "$checksumType"
    Get-ChocolateyUnzip "$zipFile" "$zipDir"
    
    $packageArgs = @{
      packageName    = $packageName
      fileType       = 'MSI' # only one of these: exe, msi, msu
      file           = $(Join-Path $zipDir "InstallResources\SandcastleHelpFileBuilder.msi")
    
      silentArgs     = '/quiet'
      validExitCodes = @(0, 3010, 1641) # please insert other valid exit codes here, exit codes for ms http://msdn.microsoft.com/en-us/library/aa368542(VS.85).aspx
      softwareName   = 'Sandcastle*' #ensure this is the value in the registry
    }
    Install-ChocolateyInstallPackage @packageArgs
    
    # Install-ChocolateyVsixPackage requires a URL, so build one out of the file path
    $vsix = Join-Path $zipDir "InstallResources\SHFBVisualStudioPackage_VS2015AndLater.vsix"
    $vsixUrl = "file:///" + $(Convert-Path $vsix).Replace("\", "/")
    
    # Install-ChocolateyVsixPackage doesn't let us provide a list of supported versions for a package, unfortunately
    # Check for each version supported by the Sandcastle tools VSIX and call the function repeatedly as needed
    Get-VisualStudio | Where-Object { $_.installationVersion.Major -ge 14 } | ForEach-Object {
      $vsver = $_.installationVersion.ToString(2)
      Write-Host "Installing VSIX package for Visual Studio $vsver"
    
      if ( $_.installationVersion.Major -ge 15 ) {
        $vssku = Split-Path $_.installationPath -Leaf
        $vsixInstaller = Join-Path $_.installationPath 'Common7\IDE\VSIXInstaller.exe'
    
        # Otherwise VSIXInstaller.exe exits with error code 2003: NoApplicableSKUsException
        if ( $_.installationVersion.Major -eq 15 ) { $vsver = '15.0' }
    
        Write-Host "    SKU is '$vssku'"
        Write-Host "    Installation path is " $_.installationPath
    
        $exitCode = Install-VsixEXT "$vsixInstaller" "$vsix" "$vsver" "$vssku"
        if ($exitCode -eq 2004) { #2004: Blocking Process (need to close VS)
          throw "A process is blocking the installation of the Sandcastle extension for " + $_.displayName + ". Please close all instances and try again."
        }
        if ($exitCode -gt 0 -and $exitCode -ne 1001) { #1001: Already installed
          throw "There was an error installing the Sandcastle extension for " + $_.displayName + ". The exit code returned was $exitCode."
        }
      } elseif ( $_.installationVersion.Major -eq 14 ) {
        Install-ChocolateyVsixPackage "$packageName" "$vsixUrl" -VsVersion 14
      }
    }
    
    New-Item "$zipDir\SandcastleInstaller.exe.ignore" -Type file -Force | Out-Null
    
  • tools\helpers.ps1 Show
    function Get-VisualStudio {
      $versions = vswhere.exe -legacy -format json | ConvertFrom-Json
      $versions = $versions | Where-Object { ($_.installationPath -ne $null) -and (Test-Path $(Join-Path $_.installationPath 'Common7\IDE\devenv.exe')) }
      $versions | ForEach-Object {
        $_.installationVersion = [System.Version]($_.installationVersion)
        $_
      }
    }
    
    function Install-VsixEXT {
    param(
      [parameter(Mandatory=$true, Position=0)] $installer,
      [parameter(Mandatory=$true, Position=1)] $installFile,
      [parameter(Mandatory=$true, Position=2)] $version = '15.0',
      [parameter(Mandatory=$true, Position=3)] $sku = 'Community',
      [parameter(ValueFromRemainingArguments = $true)][Object[]] $ignoredArguments
    )
    
      # use original function for pre-2017
      if (([System.Version]$version).Major -lt 15) {
        return Install-Vsix "$installer" "$installFile"
      }
    
      Write-FunctionCallLogMessage -Invocation $MyInvocation -Parameters $PSBoundParameters
    
      if ($env:chocolateyPackageName -ne $null -and $env:chocolateyPackageName -eq $env:ChocolateyInstallDirectoryPackage) {
        Write-Warning "Install Directory override not available for VSIX packages."
      }
    
      Write-Host "Installing $installFile using $installer for Visual Studio $sku $version"
      $psi = New-Object System.Diagnostics.ProcessStartInfo
      $psi.FileName = $installer
      $psi.Arguments = "/q /v:$version /s:$sku $installFile"
      $s = [System.Diagnostics.Process]::Start($psi)
      $s.WaitForExit()
    
      return $s.ExitCode
    }
    
  • update.ps1 Show
    Import-Module au
    . $PSScriptRoot\..\_scripts\all.ps1
    
    $domain =   'https://github.com'
    $releases = "$domain/EWSoftware/SHFB/releases/latest"
    
    function global:au_SearchReplace {
      @{
        ".\$($Latest.PackageName).nuspec" = @{
          "\<releaseNotes\>.+" = "<releaseNotes>$($Latest.ReleaseNotes)</releaseNotes>"
        }
        ".\tools\chocolateyInstall.ps1" = @{
          "(?i)(^\s*[$]packageName\s*=\s*)('.*')" = "`$1'$($Latest.PackageName)'"
          "(?i)(^\s*[$]versionNumber\s*=\s*)('.*')" = "`$1'$($Latest.Version)'"
          "(?i)(^\s*[$]url\s*=\s*)('.*')" = "`$1'$($Latest.URL32)'"
          "(?i)(^\s*[$]checksum\s*=\s*)('.*')" = "`$1'$($Latest.Checksum32)'"
          "(?i)(^\s*[$]checksumType\s*=\s*)('.*')" = "`$1'$($Latest.ChecksumType32)'"
        }
      }
    }
    
    function global:au_GetLatest {
      $download_page = Invoke-WebRequest -Uri $releases -UseBasicParsing
      $regex   = 'SHFBInstaller_v.*\.zip$'
      $url    = $download_page.links | Where-Object href -Match $regex | Select-Object -First 1 -Expand href
      $version = $url -split '_v|.zip' | Select-Object -Last 1 -Skip 1
    
      $url32 = $domain + $url
    
      $releaseNotesUrl = "$domain/EWSoftware/SHFB/releases/tag/v" + $version
    
      return @{
        Version = $version
    
        URL32 = $url32
    
        ReleaseNotes = $releaseNotesUrl
      }
    }
    
    Update-Package
    

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-2017

Tags

Release Notes

https://github.com/EWSoftware/SHFB/releases/tag/v2018.5.14.0

Version History

Version Downloads Last updated Status
Sandcastle Help File Builder and Tools (Install) 2019.4.14.0 201 Friday, April 19, 2019 approved
Sandcastle Help File Builder and Tools (Install) 2019.4.7.0 58 Friday, April 12, 2019 approved
Sandcastle Help File Builder and Tools (Install) 2019.3.31.0 91 Monday, April 1, 2019 approved
Sandcastle Help File Builder and Tools (Install) 2018.12.10.0 246 Saturday, December 15, 2018 approved
Sandcastle Help File Builder and Tools (Install) 2018.7.8.0 423 Tuesday, July 24, 2018 approved
Sandcastle Help File Builder and Tools (Install) 2018.5.14.0 223 Saturday, May 26, 2018 approved
Sandcastle Help File Builder and Tools (Install) 2017.12.30.2 419 Tuesday, January 16, 2018 approved
Sandcastle Help File Builder and Tools (Install) 2017.12.30.0 230 Monday, January 8, 2018 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