Unpacking Software Livestream

Join our monthly Unpacking Software livestream to hear about the latest news, chat and opinion on packaging, software deployment and lifecycle management!

Learn More

Chocolatey Product Spotlight

Join the Chocolatey Team on our regular monthly stream where we put a spotlight on the most recent Chocolatey product releases. You'll have a chance to have your questions answered in a live Ask Me Anything format.

Learn More

Chocolatey Coding Livestream

Join us for the Chocolatey Coding Livestream, where members of our team dive into the heart of open source development by coding live on various Chocolatey projects. Tune in to witness real-time coding, ask questions, and gain insights into the world of package management. Don't miss this opportunity to engage with our team and contribute to the future of Chocolatey!

Learn More

Calling All Chocolatiers! Whipping Up Windows Automation with Chocolatey Central Management

Webinar from
Wednesday, 17 January 2024

We are delighted to announce the release of Chocolatey Central Management v0.12.0, featuring seamless Deployment Plan creation, time-saving duplications, insightful Group Details, an upgraded Dashboard, bug fixes, user interface polishing, and refined documentation. As an added bonus we'll have members of our Solutions Engineering team on-hand to dive into some interesting ways you can leverage the new features available!

Watch On-Demand
Chocolatey Community Coffee Break

Join the Chocolatey Team as we discuss all things Community, what we do, how you can get involved and answer your Chocolatey questions.

Watch The Replays
Chocolatey and Intune Overview

Webinar Replay from
Wednesday, 30 March 2022

At Chocolatey Software we strive for simple, and teaching others. Let us teach you just how simple it could be to keep your 3rd party applications updated across your devices, all with Intune!

Watch On-Demand
Chocolatey For Business. In Azure. In One Click.

Livestream from
Thursday, 9 June 2022

Join James and Josh to show you how you can get the Chocolatey For Business recommended infrastructure and workflow, created, in Azure, in around 20 minutes.

Watch On-Demand
The Future of Chocolatey CLI

Livestream from
Thursday, 04 August 2022

Join Paul and Gary to hear more about the plans for the Chocolatey CLI in the not so distant future. We'll talk about some cool new features, long term asks from Customers and Community and how you can get involved!

Watch On-Demand
Hacktoberfest Tuesdays 2022

Livestreams from
October 2022

For Hacktoberfest, Chocolatey ran a livestream every Tuesday! Re-watch Cory, James, Gary, and Rain as they share knowledge on how to contribute to open-source projects such as Chocolatey CLI.

Watch On-Demand

Downloads:

32,004

Downloads of v 2019.6.24.0:

669

Last Update:

26 Jun 2019

Package Maintainer(s):

Software Author(s):

  • Eric Woodruff

Tags:

shfb documentation sandcastle help xml comments file builder admin

Sandcastle Help File Builder and Tools (Install)

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

  • 1
  • 2
  • 3

2019.6.24.0 | Updated: 26 Jun 2019

Downloads:

32,004

Downloads of v 2019.6.24.0:

669

Maintainer(s):

Software Author(s):

  • Eric Woodruff

Sandcastle Help File Builder and Tools (Install) 2019.6.24.0

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

Legal Disclaimer: Neither this package nor Chocolatey Software, Inc. are affiliated with or endorsed by Eric Woodruff. The inclusion of Eric Woodruff trademark(s), if any, upon this webpage is solely to identify Eric Woodruff goods or services and not for commercial purposes.

  • 1
  • 2
  • 3

All Checks are Passing

3 Passing Tests


Validation Testing Passed


Verification Testing Passed

Details

Scan Testing Successful:

No detections found in any package files

Details
Learn More

Deployment Method: Individual Install, Upgrade, & Uninstall

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

>

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

>

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

>

Deployment Method:

NOTE

This applies to both open source and commercial editions of Chocolatey.

1. Enter Your Internal Repository Url

(this should look similar to https://community.chocolatey.org/api/v2/)


2. Setup Your Environment

1. Ensure you are set for organizational deployment

Please see the organizational deployment guide

2. Get the package into your environment

  • Open Source or Commercial:
    • Proxy Repository - Create a proxy nuget repository on Nexus, Artifactory Pro, or a proxy Chocolatey repository on ProGet. Point your upstream to https://community.chocolatey.org/api/v2/. Packages cache on first access automatically. Make sure your choco clients are using your proxy repository as a source and NOT the default community repository. See source command for more information.
    • You can also just download the package and push it to a repository Download

3. Copy Your Script

choco upgrade sandcastle -y --source="'INTERNAL REPO URL'" --version="'2019.6.24.0'" [other options]

See options you can pass to upgrade.

See best practices for scripting.

Add this to a PowerShell script or use a Batch script with tools and in places where you are calling directly to Chocolatey. If you are integrating, keep in mind enhanced exit codes.

If you do use a PowerShell script, use the following to ensure bad exit codes are shown as failures:


choco upgrade sandcastle -y --source="'INTERNAL REPO URL'" --version="'2019.6.24.0'" 
$exitCode = $LASTEXITCODE

Write-Verbose "Exit code was $exitCode"
$validExitCodes = @(0, 1605, 1614, 1641, 3010)
if ($validExitCodes -contains $exitCode) {
  Exit 0
}

Exit $exitCode

- name: Install sandcastle
  win_chocolatey:
    name: sandcastle
    version: '2019.6.24.0'
    source: INTERNAL REPO URL
    state: present

See docs at https://docs.ansible.com/ansible/latest/modules/win_chocolatey_module.html.


chocolatey_package 'sandcastle' do
  action    :install
  source   'INTERNAL REPO URL'
  version  '2019.6.24.0'
end

See docs at https://docs.chef.io/resource_chocolatey_package.html.


cChocoPackageInstaller sandcastle
{
    Name     = "sandcastle"
    Version  = "2019.6.24.0"
    Source   = "INTERNAL REPO URL"
}

Requires cChoco DSC Resource. See docs at https://github.com/chocolatey/cChoco.


package { 'sandcastle':
  ensure   => '2019.6.24.0',
  provider => 'chocolatey',
  source   => 'INTERNAL REPO URL',
}

Requires Puppet Chocolatey Provider module. See docs at https://forge.puppet.com/puppetlabs/chocolatey.


4. If applicable - Chocolatey configuration/installation

See infrastructure management matrix for Chocolatey configuration elements and examples.

Package Approved

This package was approved as a trusted package on 29 Jul 2019.

Description

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.


update.ps1
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
tools\helpers.ps1
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
}
tools\chocolateyInstall.ps1
$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 = '2019.6.24.0'
$url           = 'https://github.com/EWSoftware/SHFB/releases/download/2019.6.24.0/SHFBInstaller_v2019.6.24.0.zip' # download url
$checksum      = 'e96ac344fb7007abd9401b1c7929e5325897d587c1995f519149f7df4c32bc07'
$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
README.md
# 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.

Log in or click on link to see number of positives.

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.

Add to Builder Version Downloads Last Updated Status
Sandcastle Help File Builder and Tools (Install) 2022.1.22.0 1237 Sunday, January 23, 2022 Approved
Sandcastle Help File Builder and Tools (Install) 2021.11.7.0 543 Monday, November 8, 2021 Approved
Sandcastle Help File Builder and Tools (Install) 2021.10.23.0 204 Sunday, October 31, 2021 Approved
Sandcastle Help File Builder and Tools (Install) 2021.4.9.0 2511 Monday, May 17, 2021 Approved
Sandcastle Help File Builder and Tools (Install) 2021.4.5.0 106 Monday, May 17, 2021 Approved
Sandcastle Help File Builder and Tools (Install) 2021.3.29.0 486 Tuesday, March 30, 2021 Approved
Sandcastle Help File Builder and Tools (Install) 2020.3.6.0 1392 Friday, December 18, 2020 Approved
Sandcastle Help File Builder and Tools (Install) 2019.11.17.0 3616 Thursday, November 28, 2019 Approved
Sandcastle Help File Builder and Tools (Install) 2019.9.15.0 457 Thursday, September 19, 2019 Approved
Sandcastle Help File Builder and Tools (Install) 2019.8.24.0 257 Thursday, September 12, 2019 Approved
Sandcastle Help File Builder and Tools (Install) 2019.6.24.0 669 Wednesday, June 26, 2019 Approved
Sandcastle Help File Builder and Tools (Install) 2019.4.14.0 432 Friday, April 19, 2019 Approved
Sandcastle Help File Builder and Tools (Install) 2019.4.7.0 262 Friday, April 12, 2019 Approved
Sandcastle Help File Builder and Tools (Install) 2019.3.31.0 304 Monday, April 1, 2019 Approved
Sandcastle Help File Builder and Tools (Install) 2018.12.10.0 469 Saturday, December 15, 2018 Approved
Sandcastle Help File Builder and Tools (Install) 2018.7.8.0 806 Tuesday, July 24, 2018 Approved
Sandcastle Help File Builder and Tools (Install) 2018.5.14.0 469 Saturday, May 26, 2018 Approved
Sandcastle Help File Builder and Tools (Install) 2017.12.30.2 909 Tuesday, January 16, 2018 Approved
Sandcastle Help File Builder and Tools (Install) 2017.12.30.0 431 Monday, January 8, 2018 Approved
Sandcastle Help File Builder and Tools (Install) 2017.5.15.0 1621 Wednesday, May 17, 2017 Approved
Sandcastle Help File Builder and Tools (Install) 2017.1.28.1 506 Sunday, April 9, 2017 Approved
Sandcastle Help File Builder and Tools (Install) 2017.1.28.0 516 Friday, March 10, 2017 Approved
Sandcastle Help File Builder and Tools (Install) 2016.9.17.0 795 Tuesday, December 20, 2016 Approved
Sandcastle Help File Builder and Tools (Install) 2015.10.10.0 814 Thursday, December 17, 2015 Approved
Sandcastle Help File Builder and Tools (Install) 2015.7.25.0 531 Thursday, December 17, 2015 Approved
Sandcastle Help File Builder and Tools (Install) 2015.5.2.0 2970 Wednesday, May 27, 2015 Approved

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