Downloads:
32,004
Downloads of v 2019.4.14.0:
432
Last Update:
19 Apr 2019
Package Maintainer(s):
Software Author(s):
- Eric Woodruff
Tags:
shfb documentation sandcastle help xml comments file builder admin- Software Specific:
- Software Site
- Software Source
- Software License
- Software Docs
- Software Issues
- Package Specific:
- Package Source
- Package outdated?
- Package broken?
- Contact Maintainers
- Contact Site Admins
- Software Vendor?
- Report Abuse
- Download
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.4.14.0 | Updated: 19 Apr 2019
- Software Specific:
- Software Site
- Software Source
- Software License
- Software Docs
- Software Issues
- Package Specific:
- Package Source
- Package outdated?
- Package broken?
- Contact Maintainers
- Contact Site Admins
- Software Vendor?
- Report Abuse
- Download
Downloads:
32,004
Downloads of v 2019.4.14.0:
432
Software Author(s):
- Eric Woodruff
Sandcastle Help File Builder and Tools (Install) 2019.4.14.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
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:
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
Option 1: Cached Package (Unreliable, Requires Internet - Same As Community)-
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
-
Open Source
-
Download the package:
Download - Follow manual internalization instructions
-
-
Package Internalizer (C4B)
-
Run: (additional options)
choco download sandcastle --internalize --version=2019.4.14.0 --source=https://community.chocolatey.org/api/v2/
-
For package and dependencies run:
choco push --source="'INTERNAL REPO URL'"
- Automate package internalization
-
Run: (additional options)
3. Copy Your Script
choco upgrade sandcastle -y --source="'INTERNAL REPO URL'" --version="'2019.4.14.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.4.14.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.4.14.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.4.14.0'
end
See docs at https://docs.chef.io/resource_chocolatey_package.html.
cChocoPackageInstaller sandcastle
{
Name = "sandcastle"
Version = "2019.4.14.0"
Source = "INTERNAL REPO URL"
}
Requires cChoco DSC Resource. See docs at https://github.com/chocolatey/cChoco.
package { 'sandcastle':
ensure => '2019.4.14.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.
This package was approved as a trusted package on 02 Jun 2019.
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.
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
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
}
# 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.
- sandcastle.2019.4.14.0.nupkg (e13a689a0e98) - ## / 58
- SandcastleHelpFileBuilder.msi (995ee1d79333) - ## / 49
- SandcastleInstaller.exe (42ad7f92c878) - ## / 68
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.
Eric Woodruff (c) 2006-2017
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.