다음을 통해 공유

온라인 도움말 지원

  • 아티클

비고

XML 기반 도움말의 수동 작성은 매우 어렵습니다. PlatyPS 모듈을 사용하면 Markdown에서 도움말을 작성한 다음 XML 기반 도움말로 변환할 수 있습니다. 이렇게 하면 도움말을 훨씬 쉽게 작성하고 유지 관리할 수 있습니다. PlatyPS 업데이트 가능한 도움말 패키지를 만들 수도 있습니다. 자세한 내용은 PlatyPS사용하여 XML 기반 도움말 만들기를 참조하세요.

PowerShell 3.0부터 PowerShell 명령에 대한 Get-Help Online 기능을 지원하는 두 가지 방법이 있습니다. 이 항목에서는 다양한 명령 유형에 대해 이 기능을 구현하는 방법을 설명합니다.

온라인 도움말 정보

온라인 도움말은 항상 PowerShell의 중요한 부분이었습니다. Get-Help cmdlet은 명령 프롬프트에 도움말 항목을 표시하지만 많은 사용자는 색 코딩, 하이퍼링크, 커뮤니티 콘텐츠 및 위키 기반 문서에서 아이디어 공유를 포함하여 온라인으로 읽는 환경을 선호합니다. 가장 중요한 것은 업데이트 가능한 도움말이 등장하기 전에 온라인 도움말이 도움말 파일의 가장 up-to최신 버전을 제공했다는 것입니다.

PowerShell 3.0의 업데이트 가능한 도움말이 등장하면서 온라인 도움말은 여전히 중요한 역할을 합니다. 유연한 사용자 환경 외에도 온라인 도움말은 업데이트 가능한 도움말을 다운로드할 수 없거나 사용할 수 없는 사용자에게 도움말을 제공합니다.

Get-Help -Online 작동 방식

사용자가 명령에 대한 온라인 도움말 항목을 찾을 수 있도록 Get-Help 명령에는 사용자의 기본 인터넷 브라우저에서 명령에 대한 도움말 항목의 온라인 버전을 여는 Online 매개 변수가 있습니다.

예를 들어 다음 명령은 Invoke-Command cmdlet에 대한 온라인 도움말 항목을 엽니다.

Get-Help Invoke-Command -Online

Get-Help -Online구현하기 위해 Get-Help cmdlet은 다음 위치에서 온라인 버전 도움말 항목에 대한 URI(Uniform Resource Identifier)를 찾습니다.

  • 명령에 대한 도움말 항목의 관련 링크 섹션의 첫 번째 링크입니다. 도움말 항목은 사용자의 컴퓨터에 설치해야 합니다. 이 기능은 PowerShell 2.0에서 도입되었습니다.

  • 명령의 HelpUri 속성입니다. 명령에 대한 도움말 항목이 사용자의 컴퓨터에 설치되어 있지 않은 경우에도 HelpUri 속성에 액세스할 수 있습니다. 이 기능은 PowerShell 3.0에서 도입되었습니다.

    Get-Help HelpUri 속성 값을 가져오기 전에 관련 링크 섹션의 첫 번째 항목에서 URI를 찾습니다. 속성 값이 잘못되었거나 변경된 경우 첫 번째 관련 링크에 다른 값을 입력하여 재정의할 수 있습니다. 그러나 첫 번째 관련 링크는 도움말 항목이 사용자의 컴퓨터에 설치된 경우에만 작동합니다.

명령에 대한 XML 기반 도움말 항목의 관련 링크 섹션에 있는 첫 번째 항목에 유효한 URI를 추가하여 명령에 대한 Get-Help -Online 지원할 수 있습니다. 이 옵션은 XML 기반 도움말 항목에서만 유효하며 도움말 항목이 사용자의 컴퓨터에 설치된 경우에만 작동합니다. 도움말 항목이 설치되고 URI가 채워지면 이 값이 명령의 HelpUri 속성보다 우선합니다.

이 기능을 지원하려면 URI가 maml:relatedLinks 요소의 첫 번째 maml:relatedLinks/maml:navigationLink 요소 아래 maml:uri 요소에 나타나야 합니다.

다음 XML은 URI의 올바른 배치를 보여줍니다. maml:linkText 요소의 Online version: 텍스트는 모범 사례이지만 필수는 아닙니다.

<maml:relatedLinks>
    <maml:navigationLink>
        <maml:linkText>Online version:</maml:linkText>
        <maml:uri>https://go.microsoft.com/fwlink/?LinkID=113279</maml:uri>
    </maml:navigationLink>
    <maml:navigationLink>
        <maml:linkText>about_History</maml:linkText>
        <maml:uri/>
    </maml:navigationLink>
</maml:relatedLinks>

명령에 HelpUri 속성 추가

이 섹션에서는 HelpUri 속성을 다양한 형식의 명령에 추가하는 방법을 보여 줍니다.

Cmdlet에 HelpUri 속성 추가

C#으로 작성된 cmdlet의 경우 Cmdlet 클래스에 HelpUri 특성을 추가합니다. 특성 값은 http 또는 https시작하는 URI여야 합니다.

다음 코드는 Get-History cmdlet 클래스의 HelpUri 특성을 보여줍니다.

[Cmdlet(VerbsCommon.Get, "History", HelpUri = "https://go.microsoft.com/fwlink/?LinkID=001122")]

고급 함수에 HelpUri 속성 추가

고급 함수의 경우 CmdletBinding 특성에 HelpUri 속성을 추가합니다. 속성 값은 "http" 또는 "https"로 시작하는 URI여야 합니다.

다음 코드는 New-Calendar 함수의 HelpUri 특성을 보여줍니다.

function New-Calendar {
    [CmdletBinding(SupportsShouldProcess=$true,
    HelpUri="https://go.microsoft.com/fwlink/?LinkID=01122")]

Cim 명령에 HelpUri 특성 추가

CIM 명령의 경우 HelpUri 특성을 CDXML 파일의 CmdletMetadata 요소에 추가합니다. 특성 값은 http 또는 https시작하는 URI여야 합니다.

다음 코드는 Start-Debug CIM 명령의 HelpUri 특성을 보여줍니다.

<CmdletMetadata Verb="Debug" HelpUri="https://go.microsoft.com/fwlink/?LinkID=001122"/>

워크플로에 HelpUri 특성 추가

PowerShell 언어로 작성된 워크플로의 경우 워크플로 코드에 .EXTERNALHELP 주석 키워드를 추가합니다. 키워드의 값은 http 또는 https시작하는 URI여야 합니다.

비고

HelpUri 속성은 PowerShell의 XAML 기반 워크플로에 대해 지원되지 않습니다.

다음 코드는 워크플로 파일의 .EXTERNALHELP 키워드를 보여줍니다.

# .EXTERNALHELP "https://go.microsoft.com/fwlink/?LinkID=138338"