Microsoft 도움말 뷰어 SDKMicrosoft Help Viewer SDK

이 문서에는 Visual Studio 도움말 뷰어 통합자를 위한 다음과 같은 작업이 포함 되어 있습니다.This article contains the following tasks for Visual Studio Help Viewer integrators:

  • 토픽 만들기 (F1 지원)Creating a topic (F1 support)

  • 도움말 뷰어 콘텐츠-브랜딩 패키지 만들기Creating a Help Viewer content-branding package

  • 아티클 집합 배포Deploying a set of articles

  • Visual Studio 셸에 도움말 추가 (통합 또는 격리)Adding help to the Visual Studio shell (integrated or isolated)

  • 추가 리소스Additional Resources

토픽 만들기 (F1 지원)Create a topic (F1 support)

이 섹션에서는 표시 된 항목의 구성 요소에 대 한 개요, 토픽 요구 사항, 토픽을 만드는 방법에 대 한 간단한 설명 (F1 지원 요구 사항 포함) 및 마지막으로 렌더링 된 결과가 포함 된 예제 항목을 제공 합니다.This section provides an overview of the components of a presented topic, topic requirements, a short description for how to create a topic (including F1 support requirements) and finally, an example topic with its rendered result.

도움말 뷰어 항목 개요Help Viewer Topic Overview

항목을 렌더링 하기 위해 호출 하는 경우 도움말 뷰어는 항목 XHTML과 함께 설치 또는 마지막 업데이트 시 토픽에 연결 된 브랜딩 패키지 요소를 가져오고, 두 항목을 결합 된 콘텐츠 보기 (브랜딩 데이터 + 토픽 데이터)로 결합 합니다.When a topic is called for rendering, the Help Viewer gets the branding package elements that are associated with the topic at the time of install or last update, along with the topic XHTML, and combines the two to result in the presented content view (branding data + topic data). 브랜딩 패키지에는 로고, 콘텐츠 동작 지원 및 브랜딩 텍스트 (저작권 등)가 포함 되어 있습니다.The branding package contains logos, support for content behaviors, and branding text (copyright, etc.). 브랜딩 패키지 요소에 대 한 자세한 내용은 아래의 "브랜딩 패키지 만들기"를 참조 하세요.See "Creating Branding Package" below for more information about the branding package elements. 항목에 연결 된 브랜딩 패키지가 없는 경우 도움말 뷰어는 도움말 뷰어 응용 프로그램 루트 Branding_en (.mshc)에 있는 대체 (fallback) 브랜딩 패키지를 사용 합니다.In the event there is no branding package associated with the topic, the Help Viewer will use the fallback branding package located in the Help Viewer application root (Branding_en-US.mshc).

도움말 뷰어 토픽 요구 사항Help Viewer Topic Requirements

도움말 뷰어 내에서 올바르게 렌더링 되려면 원시 토픽 콘텐츠가 W3C Basic 1.1 XHTML 이어야 합니다.To be rendered correctly within the Help Viewer, raw topic content must be W3C Basic 1.1 XHTML.

토픽에는 일반적으로 다음 두 섹션이 포함 되어 있습니다.A topic typically contains two sections:

  • 메타 데이터 (콘텐츠 메타 데이터 참조 참조): 항목에 대 한 데이터 (예: 고유 ID, 키워드 값, 항목 TOC ID, 부모 노드 ID 등)입니다.Metadata (see Content Metadata Reference): data about the topic, for example, the topic unique ID, keyword value, the topic TOC ID, parent node ID, etc.

  • 본문 내용: 지원 되는 콘텐츠 동작 (축소 가능 영역, 코드 조각 등)을 포함 하는 W3C Basic 1.1 XHTML과 호환 됩니다. 전체 목록은 아래와 같습니다.Body content: compliant with W3C Basic 1.1 XHTML, which includes supported content behaviors (collapsible area, code snippet, etc. A full list is shown below).

Visual Studio 브랜딩 패키지 지원 컨트롤:Visual Studio Branding Package supported controls:

  • 링크Links

  • CodeSnippetCodeSnippet

  • CollapsibleAreaCollapsibleArea

  • 상속 된 멤버Inherited Member

  • LanguageSpecificTextLanguageSpecificText

지원 되는 언어 문자열 (대/소문자 구분 안 함):Supported language strings (not case sensitive):

  • javascriptjavascript

  • csharp 또는 c #csharp or c#

  • cplusplus 또는 visualc + + 또는 c + +cplusplus or visualc++ or c++

  • jscriptjscript

  • microsoft.visualbasic 또는 vbvisualbasic or vb

  • f # 또는 fsharp.core 또는 fsf# or fsharp or fs

  • 기타-언어 이름을 나타내는 문자열입니다.other - a string that represents a language name

도움말 뷰어 항목 만들기Creating a Help Viewer topic

ContosoTopic4.htm 이라는 새 XHTML 문서를 만들고 title 태그 (아래)를 포함 합니다.Create a new XHTML document named ContosoTopic4.htm, and include the title tag (below).

<html>
<head>
<title>Contoso Topic 4</title>
</head>

<body>

</body>
</html>

다음으로, 데이터를 추가 하 여 토픽을 표시 하는 방법 (자체 브랜드 또는 not), F1에 대해이 항목을 참조 하는 방법,이 항목이 TOC 내에 존재 하는 방법, 해당 ID (다른 토픽에서 링크 참조) 등을 정의 합니다. 지원 되는 메타 데이터의 전체 목록은 아래의 "콘텐츠 메타 데이터" 표를 참조 하세요.Next, add data to define how the topic is to be presented (self branded or not), how to reference this topic for F1, where this topic exists within the TOC, its ID (for link reference by other topics), etc. See the "Content Metadata" table below for a complete list of supported metadata.

  • 이 경우 Visual Studio 도움말 뷰어 브랜딩 패키지의 변형 인 고유한 브랜딩 패키지를 사용 합니다.In this case, we will use our own branding package, a variant of the Visual Studio Help Viewer branding package.

  • IDE 속성 모음에서 제공 된 F1 값과 일치 하는 F1 meta 이름 및 값 ("ContosoTopic4")을 추가 합니다.Add the F1 meta name and value ("Microsoft.Help.F1" content=" ContosoTopic4") that will match the supplied F1 value in the IDE property bag. 자세한 내용은 F1 지원 섹션을 참조 하십시오. Ide에서 f1 키를 선택할 때이 항목을 표시 하기 위해 IDE 내에서 F1 호출에 일치 하는 값입니다.(See the F1 Support section for more information.) This is the value that is matched to the F1 call from within the IDE to display this topic when F1 is chosen in the IDE.

  • 토픽 ID를 추가 합니다.Add the topic ID. 다른 토픽에서이 항목에 연결 하는 데 사용 하는 문자열입니다.This is the string that is used by other topics to link to this topic. 이 항목의 도움말 뷰어 ID입니다.It is the Help Viewer ID for this topic.

  • TOC의 경우이 항목의 부모 노드를 추가 하 여이 토픽 TOC 노드가 표시 되는 위치를 정의 합니다.For the TOC, add this topic's parent node to define where this topic TOC node will appear.

  • TOC의 경우이 항목의 노드 순서를 추가 합니다.For the TOC, add this topic's node order. 부모 노드에 n 자식 노드가 여러 개 있는 경우이 항목의 위치를 자식 노드의 순서로 정의 합니다.When the parent node has n number of children nodes, define in the order of child nodes this topic's location. 예를 들어이 항목은 4 개 자식 항목의 숫자 4입니다.For example, this topic is number 4 of 4 child topics.

예제 메타 데이터 섹션:Example metadata section:

<html>
<head>
<title>Contoso Topic 4</title>

<meta name="SelfBranded" content="false" />
    <meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
    <meta name="Microsoft.Help.Id" content="ContosoTopic4" />
<meta name="Microsoft.Help.F1" content=" ContosoTopic4" />
    <meta name="Language" content="en-us" />
<meta name="Microsoft.Help.TocParent" content="ContosoTopic0" />
<meta name="Microsoft.Help.TocOrder" content="4" />

</head>

<body>

</body>
</html>

항목 본문The Topic Body

항목의 본문 (머리글 및 바닥글 제외)에는 페이지 링크, 메모 섹션, 축소 가능한 영역, 코드 조각, 언어별 텍스트의 섹션이 포함 됩니다.The body (not including the header and footer) of the topic will contain page links, a note section, a collapsible area, a code snippet, and a section of language-specific text. 제공 된 항목의 해당 영역에 대 한 자세한 내용은 브랜딩 섹션을 참조 하세요.See the branding section for information about those areas of the presented topic.

  1. 토픽 제목 태그를 추가 합니다. <div class="title">Contoso Topic 4</div>Add a topic title tag: <div class="title">Contoso Topic 4</div>

  2. 참고 섹션 추가: <div class="alert"> add your table tag and text </div>Add a note section: <div class="alert"> add your table tag and text </div>

  3. 축소 가능한 영역 추가: <CollapsibleArea Expanded="1" Title="Collapsible Area Test Heading"> add text </CollapsibleArea>Add a collapsible area: <CollapsibleArea Expanded="1" Title="Collapsible Area Test Heading"> add text </CollapsibleArea>

  4. 코드 조각을 추가 합니다. <CodeSnippet EnableCopyCode="true" Language="CSharp" ContainsMarkup="false" DisplayLanguage="C#" > a block of code </CodeSnippet>Add a code snippet: <CodeSnippet EnableCopyCode="true" Language="CSharp" ContainsMarkup="false" DisplayLanguage="C#" > a block of code </CodeSnippet>

  5. 코드 언어 관련 텍스트 추가: <LanguageSpecificText devLangcs="CS" devLangvb="VB" devLangcpp="C++" devLangnu="F#" /> devLangnu= 다른 언어를 입력할 수 있습니다.Add code language-specific text: <LanguageSpecificText devLangcs="CS" devLangvb="VB" devLangcpp="C++" devLangnu="F#" /> Note that devLangnu= allows you to enter other languages. 예를 들어 devLangnu="Fortran" 는 코드 조각 DisplayLanguage = 포트란 인 경우 포트란을 표시 합니다.For example, devLangnu="Fortran" displays Fortran when the code snippet DisplayLanguage = Fortran

  6. 페이지 링크 추가: <a href="ms-xhelp:///?Id=ContosoTopic1">Main Topic</a>Add page links: <a href="ms-xhelp:///?Id=ContosoTopic1">Main Topic</a>

참고

참고: 지원 되지 않는 새 "표시 언어" (예: F #, Cobol, 포트란)의 경우 코드 조각에서 코드 색 지정은 단색입니다.Note: for non-supported new "Display Language" (example, F#, Cobol, Fortran) code colorization in the code snippet will be monochrome.

예제 도움말 뷰어 항목 코드는 메타 데이터, 코드 조각, 축소 가능한 영역 및 언어별 텍스트를 정의 하는 방법을 보여 줍니다.Example Help Viewer Topic The code illustrates how to define metadata, a code snippet, a collapsible area, and language-specific text.

<?xml version="1.0" encoding="utf-8"?>
<html>
<head>
<title>Contoso Topic 4</title>

    <meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
    <meta name="Microsoft.Help.Id" content="ContosoTopic4" />
<meta name="Microsoft.Help.F1" content=" ContosoTopic4" />
    <meta name="Language" content="en-us" />
<meta name="Microsoft.Help.TocParent" content="ContosoTopic0" />
<meta name="Microsoft.Help.TocOrder" content="4" />
<meta name="SelfBranded" content="false" />
</head>

<body>
<div class="title">Contoso Topic 4</div>

  <div id="header">
<table id="bottomTable" cellpadding="0" cellspacing="0"  width="100%">
        <tr id="headerTableRow2"><td align="left">
            <span id="nsrTitle">Contoso Topic 1</span>
          </td>
<td align="right">
</td></tr>
<tr id="headerTableRow1"><td align="left">
            <span id="runningHeaderText">Contoso Widgets & Sprockets</span>
          </td></tr>
      </table>
</div>

<h2>Table of Contents</h2>

<ul class="toc">
<li class="tocline1"><a href="#introduction" target="_self">1.0 Introduction</a></li>
<li class="tocline1"><a href="#seealso" target="_self">See Also</a></li>
</ul>

<div class="topic">

<div id="mainSection">
<div id="mainBody">

<a name="introduction"></a>
<h2>1.0 Introduction</h2>
<p>[This documentation is for sample purposes only.]</p>

<p>Contoso Topic 1 contains examples of:
<ul>
<li>Collapsible Area</li>
<li>Bookmark ("See also")</li>
<li>Code Snippets from Branding Package</li>
</ul>
 </p>
<div class="alert"><table><tr><th>
<strong>Note </strong></th></tr>
<tr><td>
<p>This is an example of a <span class="label">Note </span>section.
Call out important items for your reader in this <span class="label">Note </span>box.
</p></td></tr>
</table>
</div>
</div>

<CollapsibleArea Expanded="1" Title="Collapsible Area Test Heading">

            <a id="sectionToggle0"><!----></a>

<div>
Example of Collapsible Area
<br/>
Lorem ipsum dolor sit amet...
</div>
</CollapsibleArea>

<div id="snippetGroup" >
<CodeSnippet EnableCopyCode="true" Language="VisualBasic" ContainsMarkup="false" DisplayLanguage="Visual Basic" >
Private Sub ToolStripRenderer1_RenderGrip(sender as Object, e as ToolStripGripRenderEventArgs) _ Handles ToolStripRenderer1.RenderGrip
Dim messageBoxVB as New System.Text.StringBuilder()
    messageBoxVB.AppendFormat("{0} = {1}", "GripBounds", e.GripBounds)
    messageBoxVB.AppendLine()
 ...
    MessageBox.Show(messageBoxVB.ToString(),"RenderGrip Event")
End Sub
</CodeSnippet>

<CodeSnippet EnableCopyCode="true" Language="CSharp" ContainsMarkup="false" DisplayLanguage="C#" >
private void ToolStripRenderer1_RenderGrip(Object sender, ToolStripGripRenderEventArgs e)
{
System.Text.StringBuilder messageBoxCS = new System.Text.StringBuilder();
messageBoxCS.AppendFormat("{0} = {1}", "GripBounds", e.GripBounds );
messageBoxCS.AppendLine();
...
MessageBox.Show(messageBoxCS.ToString(), "RenderGrip Event" );
}
</CodeSnippet>

<CodeSnippet EnableCopyCode="true" Language="fsharp" ContainsMarkup="false" DisplayLanguage="F#" >
some F# code
</CodeSnippet>
</div>

<h4 class="subHeading">Example of code specific text</h4>Language = <LanguageSpecificText devLangcs="CS" devLangvb="VB" devLangcpp="C++" devLangnu="F#" />

<a name="seealso"></a>
<h1 class="heading">See Also</h1>

    <div id="seeAlsoSection" class="section">
    <div class="seeAlsoStyle">
        <a href="ms-xhelp:///?Id=ContosoTopic1">Main Topic</a>
    </div>
 </div>
</div>
</div>
</body>
</html>

F1 지원F1 Support

Visual Studio에서 F1 키를 선택 하면 IDE 내에서 커서를 배치 하 여 제공 된 값이 생성 되 고 "속성 모음"이 커서 위치에 기반 하 여 제공 된 값으로 채워집니다.In Visual Studio, selecting F1 generates values supplied from the placement of the cursor within the IDE and populates a "property bag" with the supplied values (based on cursor location. 커서가 x 기능을 사용 하는 경우에는 기능 x가 활성 상태이 고 포커스가 있을 때 속성 모음을 값으로 채웁니다.When the cursor is over feature x, feature x is active/in focus and populates property bag with values. F1 키를 선택 하면 속성 모음이 채워지고 Visual Studio F1 코드는 고객의 기본 도움말 원본이 로컬 또는 온라인 인지 확인 합니다 (온라인이 기본값). 그런 다음 사용자 설정 (온라인)-셸 실행을 기반으로 적절 한 문자열을 만듭니다. 로컬 도움말이 기본값 인 경우에는 속성 모음에서 로컬 도움말 뷰어 + 키워드에 대 한 매개 변수를 사용 합니다 (exe 시작 매개 변수에 대 한 도움말 관리자 가이드 참조). 또는 매개 변수 목록에서 키워드를 사용 하는 MSDN URLWhen F1 is selected the property bag is populated and Visual Studio F1 code looks to see if the customers default Help source is local or online (online is the default), then creates the appropriate string based on the users setting (online is the default) - shell execute (see the Help Administrator Guide for exe launch parameters) with parameters for the local help viewer + keyword(s) from the property bag if local help is the default, or the MSDN URL with the keyword in the parameter list.

다중 값 문자열 이라고 하는 F1에 대해 3 개의 문자열을 반환 하는 경우 첫 번째 용어를 사용 하 고 적중 항목을 찾은 후 완료 되 면 완료 됩니다. 그렇지 않은 경우 다음 문자열로 이동 합니다.If three strings are returned for F1, referred to as a multi-value string, take the first term, look for a hit, and if found, we are done; if not, move to the next string. 순서가 중요 합니다.Order matters. 다중값 키워드의 프레젠테이션은 가장 짧은 문자열에 가장 긴 문자열 이어야 합니다.Presentation of the multi-value keywords should be longest string to shortest string. 다중 값 키워드의 경우이를 확인 하려면 온라인 F1 URL 문자열을 확인 합니다. 여기에는 선택한 키워드가 포함 됩니다.To verify this in the case for multi-value keywords, look at the online F1 URL string, which will include the chosen keyword.

Visual Studio 2012에서 의도적으로 온라인 및 오프 라인 간에 더 강력한 분할을 만들었습니다. 따라서 사용자 설정이 온라인 인 경우 Visual Studio 2010에 있던 도움말 라이브러리 에이전트를 통해 라우팅하는 대신 F1 요청을 MSDN의 온라인 쿼리 서비스로 직접 전달 합니다.In Visual Studio 2012, we intentionally made a stronger divide between online and offline, so that if the user's setting was for Online, then we simply passed the F1 request directly to our online query service on MSDN rather than routing through the Help Library Agent that we had in Visual Studio 2010. 그런 다음 "공급 업체 콘텐츠 설치 됨 = true" 상태를 사용 하 여 해당 컨텍스트에서 다른 작업을 수행할지 여부를 결정 합니다.We then rely on a state of "vendor content installed = true" to determine whether to do something different in that context. True 이면 고객에 대 한 지원 대상에 따라이 구문 분석 및 라우팅 논리를 수행 합니다.If true, we then perform this parsing and routing logic depending on what you wish to support for your customers. False 이면 MSDN으로 이동 하면 됩니다.If false, then we just go to MSDN. 사용자 설정이 Local 인 경우 모든 호출은 로컬 도움말 엔진으로 이동 합니다.If the user's setting is to Local, then all calls go to the local help engine.

F1 흐름 다이어그램:F1 Flow Diagram:

F1 흐름F1 flow

도움말 뷰어 기본 도움말 콘텐츠 원본이 온라인으로 설정 된 경우 (브라우저에서 시작):When the Help Viewer default help content source is set to online (Launch in browser):

  • VSP (Visual Studio Partner) 기능은 F1 속성 모음 (속성 모음 접두사. 키워드 및 레지스트리에서 찾은 접두사의 온라인 URL)에 값을 내보냅니다. F1 키를 누르면 VSP URL + 매개 변수가 브라우저에 전송 됩니다.Visual Studio Partner (VSP) features emit a value to the F1 property bag (property bag prefix.keyword and online URL for the prefix found in the registry): F1 sends a VSP URL+ parameters to the browser.

  • Visual Studio 기능 (언어 편집기, Visual Studio 특정 메뉴 항목 등): F1 키를 누르면 Visual Studio URL이 브라우저에 전송 됩니다.Visual Studio features (language editor, Visual Studio specific menu items, etc.): F1 sends a Visual Studio URL to the browser.

도움말 뷰어 기본 도움말 콘텐츠 원본이 로컬 도움말로 설정 된 경우 (도움말 뷰어에서 시작):When the Help Viewer default help content source is set to local Help (Launch in Help Viewer):

  • .VSP 기능 F1 속성 모음과 로컬 저장소 인덱스 (즉, 속성 모음 접두사. keyword = 로컬 저장소 인덱스에 있는 값) 간에 키워드가 일치 하는 경우 F1 키를 누르면 도움말 뷰어에서 항목이 렌더링 됩니다.VSP features where keyword match between F1 property bag and local store index (that is, the property bag prefix.keyword = the value found in the local store index): F1 renders the topic in the Help Viewer.

  • Visual Studio 기능 (VSP에서 Visual Studio 기능에서 내보낸 속성 모음을 재정의 하는 옵션 없음): F1 도움말 뷰어에서 Visual Studio 항목을 렌더링 합니다.Visual Studio features (no option for the VSP to override the property bag emitted from Visual Studio features): F1 renders a Visual Studio topic in the Help Viewer.

공급 업체 도움말 콘텐츠에 대해 F1 대체를 사용 하도록 설정 하려면 다음 레지스트리 값을 설정 합니다.Set the following registry values to enable F1 Fallback for vendor Help content. F1 대체 (Fallback)는 도움말 뷰어가 F1 도움말 콘텐츠를 온라인으로 찾도록 설정 되어 있으며, 공급 업체 콘텐츠가 사용자의 하드 드라이브에 로컬로 설치 되어 있음을 의미 합니다.F1 Fallback means that the Help Viewer is set to look for F1 Help content online, and the vendor content is installed locally to the users' hard drive. 도움말 뷰어는 온라인 도움말에 대 한 기본 설정인 경우에도 콘텐츠에 대 한 로컬 도움말을 확인 해야 합니다.The Help Viewer should look at local Help for the content even though the default setting is for online help.

  1. Help 2.3 레지스트리 키 아래에서 VendorContent 값을 설정 합니다.Set the VendorContent value under the Help 2.3 registry key:

    • 32 비트 운영 체제의 경우:For 32-bit operating systems:

      HKEY_LOCAL_MACHINE\SOFTWARE\Microsoft\Help\v2.3\Catalogs\VisualStudio15HKEY_LOCAL_MACHINE\SOFTWARE\Microsoft\Help\v2.3\Catalogs\VisualStudio15

      "VendorContent" = dword: 00000001"VendorContent"=dword:00000001

    • 64 비트 운영 체제의 경우:For 64-bit operating systems:

      HKEY_LOCAL_MACHINE\SOFTWARE\Wow6432Node\Microsoft\Help\v2.3\Catalogs\VisualStudio15HKEY_LOCAL_MACHINE\SOFTWARE\Wow6432Node\Microsoft\Help\v2.3\Catalogs\VisualStudio15

      "VendorContent" = dword: 00000001"VendorContent"=dword:00000001

  2. Help 2.3 레지스트리 키 아래에 partner 네임 스페이스를 등록 합니다.Register the partner namespace under the Help 2.3 registry key:

    • 32 비트 운영 체제의 경우:For 32-bit operating systems:

      HKEY_LOCAL_MACHINE\SOFTWARE\Microsoft\Help\v2.3\Partner \<네임 > 스페이스HKEY_LOCAL_MACHINE\SOFTWARE\Microsoft\Help\v2.3\Partner\<namespace>

      "location" = "offline""location"="offline"

    • 64 비트 운영 체제의 경우:For 64-bit operating systems:

      HKEY_LOCAL_MACHINE\SOFTWARE\Wow6432Node\Microsoft\Help\v2.3\Partner \<네임 > 스페이스HKEY_LOCAL_MACHINE\SOFTWARE\Wow6432Node\Microsoft\Help\v2.3\Partner\<namespace>

      "location" = "offline""location"="offline"

기본 네이티브 네임 스페이스 구문 분석Base Native Namespace Parsing

기본 네이티브 네임 스페이스 구문 분석을 켜려면 레지스트리의 새 DWORD를 이름: BaseNativeNamespaces에 추가 하 고 해당 값을 1 (지원 하려는 카탈로그 키 아래)로 설정 합니다.To turn on base native namespace parsing, in the registry add a new DWORD by the name of: BaseNativeNamespaces and set its value to 1 (under the catalog key that they want to support). 예를 들어 Visual Studio 카탈로그를 사용 하려는 경우 다음 경로에 키를 추가할 수 있습니다.For example, if you want to use the Visual Studio catalog, you could add the key to the path:

HKEY_LOCAL_MACHINE\SOFTWARE\Wow6432Node\Microsoft\Help\v2.3\Catalogs\VisualStudio15HKEY_LOCAL_MACHINE\SOFTWARE\Wow6432Node\Microsoft\Help\v2.3\Catalogs\VisualStudio15

Format 헤더/메서드에서 F1 키워드를 발견 하면 '/' 문자가 구문 분석 되어 다음 구문이 생성 됩니다.When an F1 keyword in the format HEADER/METHOD is encountered, the '/' character will be parsed out, resulting in the following construct:

  • 헤더:는 레지스트리에 등록 하는 데 사용할 수 있는 네임 스페이스가 됩니다.HEADER: will be the namespace that can be used to register in the registry

  • 메서드:이는 전달 되는 키워드가 됩니다.METHOD: this will become the keyword that gets passed through.

예를 들어 CustomLibrary 라는 사용자 지정 라이브러리와 MyTestMethod 라는 메서드가 지정 된 경우 F1 요청이 들어오면로 형식이 지정 됩니다 CustomLibrary/MyTestMethod .For example, given a custom library called CustomLibrary and a method called MyTestMethod, when an F1 request comes in it will be formatted as CustomLibrary/MyTestMethod.

그런 다음 사용자는 CustomLibrary를 파트너 hive 아래에 네임 스페이스로 등록 하 고 원하는 위치 키를 제공할 수 있으며 쿼리에 전달 되는 키워드는 MyTestMethod가 됩니다.A user can then register CustomLibrary as the namespace under the Partners hive, and provide whatever location key they desire, and the keyword passed to the query will be MyTestMethod.

IDE에서 도움말 디버깅 도구 사용Enable Help debugging tool in the IDE

다음 레지스트리 키 및 값을 추가 합니다.Add the following registry key and value:

HKEY_CURRENT_USER\Software\Microsoft\VisualStudio\15.0\Dynamic HelpHKEY_CURRENT_USER\Software\Microsoft\VisualStudio\15.0\Dynamic Help

HKEY_CURRENT_USER\Software\Microsoft\VisualStudio\16.0\Dynamic HelpHKEY_CURRENT_USER\Software\Microsoft\VisualStudio\16.0\Dynamic Help

값: 소매 데이터에서 디버그 출력 표시: 예Value: Display Debug Output in Retail Data: YES

IDE의 도움말 메뉴 항목에서 디버그 도움말 컨텍스트 를 선택 합니다.In the IDE, under the Help menu item, select Debug Help Context.

콘텐츠 메타 데이터Content Metadata

다음 표에서 대괄호 사이에 표시 되는 모든 문자열은 인식 된 값으로 바꾸어야 하는 자리 표시자입니다.In the following table, any string that appears between brackets is a placeholder that must be replaced by a recognized value. 예를 들어에서 <meta name="Microsoft.Help.Locale" content="[language code]" /> "[언어 코드]"는 "en-us"와 같은 값으로 바꾸어야 합니다.For example, in <meta name="Microsoft.Help.Locale" content="[language code]" />, "[language code]" must be replaced by a value such as "en-us".

속성 (HTML 표시)Property (HTML Representation) DescriptionDescription
< meta name="Microsoft.Help.Locale" content="[language-code]" /> 이 항목에 대 한 로캘을 설정 합니다.Sets a locale for this topic. 이 태그가 토픽에서 사용 되는 경우 한 번만 사용 해야 하며 다른 Microsoft 도움말 태그 위에 삽입 해야 합니다.If this tag is used in a topic, it must be used just once and it must be inserted above any other Microsoft Help tags. 이 태그를 사용 하지 않으면 제품 로캘과 연결 된 단어 분리기 (지정 된 경우)를 사용 하 여 항목의 본문 텍스트가 인덱싱됩니다. 그렇지 않으면 en-us 단어 분리기가 사용 됩니다.If this tag is not used, the body text of the topic is indexed by using word breaker that is associated with the product locale, if it is specified; otherwise, the en-us word breaker is used. 이 태그는 ISOC RFC 4646을 준수 합니다.This tag conforms to ISOC RFC 4646. Microsoft 도움말이 제대로 작동 하도록 하려면 일반 언어 특성 대신이 속성을 사용 합니다.To ensure that Microsoft Help works correctly, use this property instead of the general Language attribute.
< meta name="Microsoft.Help.TopicLocale" content="[language-code]" /> 다른 로캘이 사용 될 때이 항목에 대 한 로캘을 설정 합니다.Sets a locale for this topic when other locales are also used. 이 태그가 토픽에서 사용 되는 경우 한 번만 사용 해야 합니다.If this tag is used in a topic, it must be used just once. 카탈로그에 둘 이상의 언어로 된 콘텐츠가 포함 된 경우이 태그를 사용 합니다.Use this tag when the catalog contains content in more than one language. 카탈로그의 여러 항목은 동일한 ID를 가질 수 있지만 각 항목은 고유한 TopicLocale를 지정 해야 합니다.Multiple topics in a catalog can have the same ID, but each must specify a unique TopicLocale. 카탈로그의 로캘과 일치 하는 TopicLocale를 지정 하는 항목은 목차에 표시 되는 항목입니다.The topic that specifies a TopicLocale that matches the locale of the catalog is the topic that is displayed in the table of contents. 그러나 항목의 모든 언어 버전은 검색 결과에 표시 됩니다.However, all language versions of the topic are displayed in Search results.
< title>제목과</title>< title>[Title]</title> 이 항목의 제목을 지정 합니다.Specifies the title of this topic. 이 태그는 필수 이며 항목에서 한 번만 사용 해야 합니다.This tag is required, and must be used just once in a topic. 토픽 본문에 제목 섹션이 포함 되어 있지 않은 경우에는 <div> 이 제목이 토픽 및 목차에 표시 됩니다.If the body of the topic does not contain a title <div> section, this Title is displayed in the topic and in the table of contents.
< meta name=" Microsoft.Help.Keywords" content="[aKeywordPhrase]"/> 도움말 뷰어의 인덱스 창에 표시 되는 링크 텍스트를 지정 합니다.Specifies the text of a link that is displayed in the index pane of the Help Viewer. 링크를 클릭 하면 항목이 표시 됩니다.When the link is clicked, the topic is displayed. 토픽에 대해 여러 인덱스 키워드를 지정 하거나이 항목에 대 한 링크가 인덱스에 표시 되지 않도록 하려면이 태그를 생략할 수 있습니다.You can specify multiple index keywords for a topic, or you can omit this tag if you do not want links to this topic to appear in the index. 이전 버전 도움말의 "K" 키워드를이 속성으로 변환할 수 있습니다."K" keywords from earlier versions of Help can be converted to this property.
< meta name="Microsoft.Help.Id" content="[TopicID]"/> 이 항목에 대 한 식별자를 설정 합니다.Sets the identifier for this topic. 이 태그는 필수 이며 항목에서 한 번만 사용 해야 합니다.This tag is required, and must be used just once in a topic. ID는 동일한 로캘 설정을 가진 카탈로그의 토픽에서 고유 해야 합니다.The ID must be unique among topics in the catalog that have the same locale setting. 다른 항목에서는이 ID를 사용 하 여이 항목에 대 한 링크를 만들 수 있습니다.In another topic, you can create a link to this topic by using this ID.
< meta name="Microsoft.Help.F1" content="[System.Windows.Controls.Primitives.IRecyclingItemContainerGenerator]"/> 이 항목에 대 한 F1 키워드를 지정 합니다.Specifies the F1 keyword for this topic. 토픽에 대해 여러 F1 키워드를 지정 하거나 응용 프로그램 사용자가 F1 키를 누를 때이 항목을 표시 하지 않으려면이 태그를 생략할 수 있습니다.You can specify multiple F1 keywords for a topic, or you can omit this tag if you do not want this topic to be displayed when an application user presses F1. 일반적으로 토픽에는 하나의 F1 키워드만 지정 됩니다.Typically, just one F1 keyword is specified for a topic. 이전 버전의 도움말에서 "F" 키워드를이 속성으로 변환할 수 있습니다."F" keywords from earlier versions of Help can be converted to this property.
< meta name="Description" content="[topic description]" /> 이 항목의 내용에 대 한 간략 한 요약을 제공 합니다.Provides a short summary of the content in this topic. 이 태그가 토픽에서 사용 되는 경우 한 번만 사용 해야 합니다.If this tag is used in a topic, it must be used just once. 이 속성은 쿼리 라이브러리에서 직접 액세스 합니다. 인덱스 파일에 저장 되지 않습니다.This property is accessed directly by the query library; it is not stored in the index file.
meta name = "Microsoft. Help. TocParent" content = "[parent_Id]"/>meta name="Microsoft.Help.TocParent" content="[parent_Id]"/> 목차의이 항목에 대 한 부모 항목을 지정 합니다.Specifies the parent topic of this topic in the table of contents. 이 태그는 필수 이며 항목에서 한 번만 사용 해야 합니다.This tag is required, and must be used just once in a topic. 값은 부모의 Microsoft.Help.Id입니다.The value is the Microsoft.Help.Id of the parent. 토픽의 목차에는 하나의 위치만 있을 수 있습니다.A topic can have just one location in the table of contents. "-1"은 TOC 루트의 토픽 ID로 간주 됩니다."-1" is considered the topic ID for the TOC root. 에서 Visual Studio 2013Visual Studio 2013 이 페이지는 도움말 뷰어 홈 페이지입니다.In Visual Studio 2013Visual Studio 2013, that page is Help Viewer home page. 이는 특정 항목에 TocParent =-1을 추가 하 여 최상위 수준에 표시 되도록 하는 것과 같은 이유입니다.This is the same reason we specifically add TocParent=-1 to some topics to ensure that they show up at the top level. 도움말 뷰어 홈 페이지는 시스템 페이지 이므로 대체 불가능 합니다.The Help Viewer home page is a system page and so non-replaceable. VSP에서 ID가-1 인 페이지를 추가 하려고 하면 콘텐츠 집합에 추가 될 수 있지만 도움말 뷰어는 항상 시스템 페이지-도움말 뷰어 홈을 사용 합니다.If a VSP tries to add a page with an ID of -1, it may get added to the content set, but Help Viewer will always use the system page - Help Viewer Home
< meta name="Microsoft.Help.TocOrder" content="[positive integer]"/> 이 항목의 목차에서 피어 항목을 기준으로 표시 되는 위치를 지정 합니다.Specifies where in the table of contents this topic appears relative to its peer topics. 이 태그는 필수 이며 항목에서 한 번만 사용 해야 합니다.This tag is required, and must be used just once in a topic. 이 값은 정수입니다.The value is an integer. 하위 값 정수를 지정 하는 토픽은 상위 값 정수를 지정 하는 토픽 위에 표시 됩니다.A topic that specifies a lower-value integer appears above a topic that specifies a higher-value integer.
< meta name="Microsoft.Help.Product" content="[product code]"/> 이 항목에서 설명 하는 제품을 지정 합니다.Specifies the product that this topic describes. 이 태그가 토픽에서 사용 되는 경우 한 번만 사용 해야 합니다.If this tag is used in a topic, it must be used just once. 이 정보는 도움말 인덱서에 전달 되는 매개 변수로 제공 될 수도 있습니다.This information can also be supplied as a parameter that is passed to the Help Indexer.
< meta name="Microsoft.Help.ProductVersion" content="[version number]"/> 이 항목에서 설명 하는 제품의 버전을 지정 합니다.Specifies the version of the product that this topic describes. 이 태그가 토픽에서 사용 되는 경우 한 번만 사용 해야 합니다.If this tag is used in a topic, it must be used just once. 이 정보는 도움말 인덱서에 전달 되는 매개 변수로 제공 될 수도 있습니다.This information can also be supplied as a parameter that is passed to the Help Indexer.
< meta name="Microsoft.Help.Category" content="[string]"/> 제품에서 콘텐츠의 하위 섹션을 식별 하는 데 사용 됩니다.Used by products to identify subsections of content. 토픽의 여러 하위 섹션을 식별 하거나, 링크를 통해 하위 섹션을 식별 하지 않으려면이 태그를 생략할 수 있습니다.You can identify multiple subsections for a topic, or you can omit this tag if you do not want links to identify any subsections. 이 태그는 이전 버전의 도움말에서 토픽을 변환할 때 TargetOS 및 TargetFrameworkMoniker에 대 한 특성을 저장 하는 데 사용 됩니다.This tag is used to store the attributes for TargetOS and TargetFrameworkMoniker when a topic is converted from an earlier version of Help. 콘텐츠 형식은 AttributeName: AttributeValue입니다.The format of the content is AttributeName:AttributeValue.
< meta name="Microsoft.Help.TopicVersion content="[topic version number]"/> 카탈로그에 여러 버전이 있을 경우이 항목의 버전을 지정 합니다.Specifies this version of the topic when multiple versions exist in a catalog. Microsoft.Help.Id은 고유성이 보장 되지 않기 때문에 카탈로그에 여러 버전의 항목이 있는 경우 (예: 카탈로그에 .NET Framework 3.5에 대 한 토픽 및 .NET Framework 4에 대 한 항목이 포함 되어 있고 둘 다 동일한 Microsoft.Help.Id 경우)이 태그가 필요 합니다.Because Microsoft.Help.Id is not guaranteed to be unique, this tag is required when more than one version of a topic exists in a catalog, for example, when a catalog contains a topic for the .NET Framework 3.5 and a topic for the .NET Framework 4 and both have the same Microsoft.Help.Id.
< meta name="SelfBranded" content="[TRUE or FALSE]"/> 이 항목에서 도움말 라이브러리 관리자 시작 브랜딩 패키지를 사용할지 아니면 항목에 해당 하는 브랜딩 패키지를 사용할지를 지정 합니다.Specifies whether this topic uses the Help Library Manager start-up branding package or a branding package that is specific to the topic. 이 태그는 TRUE 또는 FALSE 여야 합니다.This tag must be either TRUE or FALSE. TRUE 인 경우 관련 항목에 대 한 브랜딩 패키지는 도움말 라이브러리 관리자가 시작 될 때 설정 된 브랜딩 패키지를 재정의 하 여 항목이 다른 콘텐츠의 렌더링과 다른 경우에도 의도 한 대로 렌더링 되도록 합니다.If it is TRUE, then the branding package for the associated topic overrides the branding package that is set when Help Library Manager starts so that the topic is rendered as intended even if it differs from the rendering of other content. FALSE 이면 도움말 라이브러리 관리자가 시작 될 때 설정 된 브랜딩 패키지에 따라 현재 항목이 렌더링 됩니다.If it is FALSE, the current topic is rendered according to the branding package that is set when Help Library Manager starts. 기본적으로 SelfBranded 변수가 TRUE로 선언 되지 않은 경우 도움말 라이브러리 관리자는 자체 브랜딩을 false로 가정 합니다. 따라서를 선언할 필요가 없습니다 <meta name="SelfBranded" content="FALSE"/> .By default, Help Library Manager assumes self-branding to be false unless the SelfBranded variable is declared as TRUE; therefore, you do not have to declare <meta name="SelfBranded" content="FALSE"/>.

브랜딩 패키지 만들기Create a branding package

Visual studio 릴리스는 Visual Studio 파트너를 위한 격리 된 셸 및 통합 셸을 비롯 한 다양 한 Visual Studio 제품을 포함 합니다.The Visual Studio release encompasses a number of different Visual Studio products, including the Isolated and Integrated shells for Visual Studio Partners. 이러한 각 제품에는 제품에 고유한 특정 수준의 토픽 기반 도움말 콘텐츠 브랜딩 지원이 필요 합니다.Each of these products requires some degree of topic-based Help content branding support, unique to the product. 예를 들어, Visual Studio 토픽은 일관 된 브랜드 프레젠테이션을 포함 해야 하는 반면, ISO 셸을 래핑하는 SQL Studio에는 각 항목에 대 한 고유한 도움말 콘텐츠 브랜딩이 필요 합니다.For example, Visual Studio topics need to have a consistent brand presentation, whereas SQL Studio, which wraps ISO Shell, requires its own unique Help content branding for each topic. 통합 셸 파트너는 자신의 토픽 브랜딩을 유지 하면서 해당 도움말 항목이 부모 Visual Studio 제품 도움말 콘텐츠 내에 포함 되도록 할 수 있습니다.An Integrated Shell Partner may want their Help topics to be within the parent Visual Studio product Help content while maintaining their own topic branding.

브랜딩 패키지는 도움말 뷰어를 포함 하는 제품에 의해 설치 됩니다.Branding packages are installed by the product containing the Help Viewer. Visual Studio 제품의 경우:For Visual Studio products:

  • 대체 (fallback) 브랜딩 패키지 Branding_ (.mshc)는 도움말 뷰어 <locale> 언어 팩에서 도움말 뷰어 2.3 앱 루트 (예: C:\Program files (x86) \Microsoft Help Viewer\v2.3)에 설치 됩니다.A fallback branding package (Branding_<locale>.mshc) is installed in the Help Viewer 2.3 app root (example: C:\Program Files (x86)\Microsoft Help Viewer\v2.3) by the Help Viewer language pack. 제품 브랜딩 패키지가 설치 되지 않았거나 (콘텐츠가 설치 되지 않음) 설치 된 브랜딩 패키지가 손상 된 경우에 사용 됩니다.This is used for cases where either the product branding package is not installed (no content has been installed) or where the installed branding package is corrupted. 앱 루트 대체 (fallback) 브랜딩 패키지를 사용 하는 경우 Visual Studio 요소 (로고 및 피드백)는 무시 됩니다.The Visual Studio elements (logo and Feedback) are ignored when the app root fallback branding package is used.

  • 콘텐츠 패키지 서비스에서 Visual Studio 콘텐츠가 설치 될 때 브랜딩 패키지 (최초 콘텐츠 설치 시나리오의 경우)도 설치 됩니다.When Visual Studio content is installed from the content package service, a branding package is also installed (for the first time content installation scenario). 브랜딩 패키지에 대 한 업데이트가 있는 경우 업데이트는 다음 콘텐츠 업데이트 또는 추가 패키지 설치 작업을 수행할 때 설치 됩니다.If there is an update to the branding package, the update is installed when the next content update or additional package install action happens.

Microsoft 도움말 뷰어는 토픽 메타 데이터를 기반으로 토픽의 브랜딩을 지원 합니다.The Microsoft Help Viewer supports the branding of topics based on topic metadata.

  • 여기서 토픽 메타 데이터는 자체 브랜드 = true를 정의 하 고 항목을 있는 그대로 렌더링 합니다. (브랜딩 만큼) 아무 작업도 수행 하지 않습니다.Where topic metadata defines self branded = true, render the topic as is, do nothing (as far as branding).

  • 토픽 메타 데이터는 자체 브랜드 = false를 정의 하 고 TopicVendor 메타 데이터 값과 연결 된 브랜딩 패키지를 사용 합니다.Where topic metadata defines self branded = false, use the branding package associated with TopicVendor metadata value.

  • 토픽 메타 데이터에서 name = "TopicVendor" content =를 정의 하는 경우 < branding package name in vendor MSHA> 콘텐츠 값에 정의 된 브랜딩 패키지를 사용 합니다.Where topic metadata defines name="Microsoft.Help.TopicVendor" content=< branding package name in vendor MSHA>, use the branding package defined in the content value.

  • Visual Studio 카탈로그 내에는 브랜딩 패키지의 우선 순위가 적용 됩니다.Within the Visual Studio catalog, there is a priority application of Branding Packages. 첫 번째 Visual Studio 기본 브랜딩이 적용 된 후 토픽 메타 데이터에 정의 되어 있고 연결 된 브랜딩 패키지 (설치 msha에 정의 된 대로)에서 지원 되는 경우 공급 업체에서 정의한 브랜딩이 재정의로 적용 됩니다.First Visual Studio default branding is applied, and then, if defined in the topic metadata and supported with the associated branding package (as defined in the installation msha), the vendor defined branding is applied as an override.

일반적으로 브랜딩 요소는 세 가지 주요 범주로 나뉩니다.Branding elements typically fall into three main categories:

  • Header 요소 (예를 들어 피드백 링크, 조건부 고 지 사항 텍스트, 로고)Header elements (examples include feedback link, conditional disclaimer text, logo)

  • 콘텐츠 동작 (예를 들어, 컨트롤 텍스트 요소 및 코드 조각 요소 확장/축소)Content behaviors (examples include expand/collapse control text elements and code snippet elements)

  • 바닥글 요소 (예: 저작권)Footer elements (example Copyright)

브랜드 요소로 간주 되는 항목은 (이 사양에 자세히 설명 되어 있습니다.)Items considered as branded elements include (detailed in this spec):

  • 카탈로그/제품 로고 (예: Visual Studio)Catalog/product logo (example, Visual Studio)

  • 피드백 링크 및 전자 메일 요소Feedback link and e-mail elements

  • 고 지 사항 텍스트Disclaimer text

  • 저작권 텍스트Copyright text

Visual Studio 도움말 뷰어 브랜딩 패키지의 지원 파일은 다음과 같습니다.Supporting files in the Visual Studio Help Viewer branding package include:

  • 그래픽 (로고, 아이콘 등)Graphics (logos, icons, etc.)

  • Branding.js-콘텐츠 동작을 지 원하는 스크립트 파일Branding.js - script files supporting content behaviors

  • Branding.xml-카탈로그 내용에서 일관 되 게 사용 되는 문자열입니다.Branding.xml - strings that are consistently used across catalog content. 참고: branding.xml의 Visual Studio 지역화 텍스트 요소에 대해 _locID = ""를 포함 합니다. <unique value>Note: for Visual Studio localization text elements in the branding.xml, include _locID="<unique value>"

  • 브랜딩. 프레젠테이션 일관성을 위한 css 스타일 정의Branding.css - style definitions for presentation consistency

  • 인쇄. 일관 된 인쇄 된 프레젠테이션을 위한 css 스타일 정의Printing.css - style definitions for consistent printed presentation

위에서 설명한 것 처럼 브랜딩 패키지는 토픽에 연결 됩니다.As noted above, Branding Packages are associated with the topic:

  • 메타 데이터에 SelfBranded = false가 정의 되 면 토픽은 카탈로그 브랜딩 패키지를 상속 합니다.When SelfBranded = false is defined in the metadata, the topic inherits the catalog branding package

  • 또는 SelfBranded = false 인 경우 MSHA에 정의 된 고유한 브랜딩 패키지가 있고 콘텐츠가 설치 될 때 사용할 수 있습니다.Or when SelfBranded = false and there is a unique Branding Package defined in the MSHA and available when the content is installed

사용자 지정 브랜딩 패키지 (.VSP content, SelfBranded = True)를 구현 하는 .Vsps의 경우 계속 하는 한 가지 방법은 대체 브랜딩 패키지 (도움말 뷰어와 함께 설치 됨)로 시작 하 고 파일의 이름을 적절 하 게 변경 하는 것입니다.For VSPs implementing custom branding packages (VSP content, SelfBranded=True), one way to proceed is to start with the fallback branding package (installed with the Help Viewer), and change the name of the file as appropriate. <locale>.Mshc 파일은 파일 확장명이. .mshc로 변경 된 zip 파일 이므로 .mshc를 .zip으로 변경 하 고 내용을 추출 하기만 하면 됩니다. Branding_The Branding_<locale>.mshc file is a zip file with the file extension changed to .mshc, so simply change the extension from .mshc to .zip and extract the contents. 아래에서 브랜딩 패키지 요소를 확인 하 고 적절 하 게 수정 합니다. 예를 들어, 로고를 VSP 로고로 변경 하 고 Branding.xml 파일의 로고에 대 한 참조를 변경 하 고, VSP 별 특성 등을 업데이트 Branding.xml 합니다.See below for branding package elements and modify as appropriate (for example, change the logo to the VSP logo and the reference to the logo in the Branding.xml file, update Branding.xml per VSP specifics, etc.).

모든 수정 작업이 완료 되 면 원하는 브랜딩 요소를 포함 하는 zip 파일을 만들고 확장을. .mshc로 변경 합니다.When all modifications are done, create a zip file containing the desired branding elements and change the extension to .mshc.

사용자 지정 브랜딩 패키지를 연결 하려면 콘텐츠 .mshc (토픽 포함)와 함께 브랜딩 .mshc 파일에 대 한 참조를 포함 하는 MSHA를 만듭니다.To associate the custom branding package, create the MSHA, which contains the reference to the branding mshc file along with the content mshc (containing the topics). 기본 MSHA를 만드는 방법은 아래 "MSHA"를 참조 하십시오.See below "MSHA" for how to create a basic MSHA.

Branding.xml 파일에는 토픽에이 포함 되어 있을 때 토픽의 특정 항목을 일관 되 게 렌더링 하는 데 사용 되는 요소의 목록이 포함 되어 있습니다 <meta name="Microsoft.Help.SelfBranded" content="false"/> .The Branding.xml file contains a list of elements used for consistently rendering specific items in a topic when the topic contains <meta name="Microsoft.Help.SelfBranded" content="false"/>. Branding.xml 파일의 Visual Studio 요소 목록은 다음과 같습니다.The Visual Studio list of elements in the Branding.xml file is listed below. 이 목록은 사용자가 자신의 제품 브랜딩 요구를 충족 하기 위해 이러한 요소 (예: 로고, 피드백 및 저작권)를 수정 하는 ISO 셸를 위한 템플릿으로 사용 하기 위한 것입니다.This list is intended to be used as a template for ISO Shell adopters, where they modify these elements (for example logo, feedback, and Copyright) to meet their own product branding needs.

참고: "{n}"에 의해 확인 된 변수에는 코드 종속성이 있습니다. 이러한 값을 제거 하거나 변경 하면 오류가 발생 하 고 응용 프로그램의 작동이 중단 될 수 있습니다.Note: variables noted by "{n}" have code dependencies - removing or changing these values will cause errors and possibly application crash. 지역화 식별자 (예: _locID = "codesnippet. n")는 Visual Studio 브랜딩 패키지에 포함 되어 있습니다.Localization identifiers (example _locID="codesnippet.n") are included in the Visual Studio Branding Package.

Branding.xmlBranding.xml

요소Element DescriptionDescription
기능:Feature: CollapsibleAreaCollapsibleArea
사용:Use: 축소 콘텐츠 컨트롤 텍스트 확장Expand collapses content control text
요소Element Value
ExpandTextExpandText ExpandExpand
CollapseTextCollapseText 축소Collapse
기능:Feature: CodeSnippetCodeSnippet
사용:Use: 코드 조각 컨트롤 텍스트입니다.Code snippet control text. 참고: "중단 없는" 공간이 있는 코드 조각 콘텐츠가 공백으로 변경 됩니다.Note: Code snippet content with "Non-Breaking" space will be changed to space.
요소Element Value
CopyToClipboardCopyToClipboard 클립보드로 복사Copy to Clipboard
ViewColorizedTextViewColorizedText 색 보기View Colorized
CombinedVBTabDisplayLanguageCombinedVBTabDisplayLanguage Visual Basic (샘플)Visual Basic (Sample)
VBDeclarationVBDeclaration 선언Declaration
VBUsageVBUsage 사용량Usage
기능:Feature: 사용자 의견, 바닥글 및 로고Feedback, Footer, and Logo
사용:Use: 고객이 전자 메일을 통해 현재 항목에 대 한 피드백을 제공할 수 있도록 피드백 컨트롤을 제공 합니다.Provide a Feedback control for customer to supply feedback on the current topic via e-mail. 콘텐츠의 저작권 텍스트입니다.Copyright text for the content. 로고 정의.Logo definition.
요소Element 값 (이러한 문자열은 콘텐츠 도입자 요구를 충족 하도록 수정할 수 있습니다.)Value (These strings can be modified to meet content adopter need.)
저작권이CopyRight © 2013 Microsoft Corporation.© 2013 Microsoft Corporation. All rights reserved.All rights reserved.
SendFeedbackSendFeedback <a href="{0}" {1}></a>Microsoft에이 항목에 대 한 사용자 의견을 보냅니다.<a href="{0}" {1}>Send Feedback</a> on this topic to Microsoft.
No-results-found-feedbacklinkFeedbackLink
LogoTitleLogoTitle Visual Studio 2013Visual Studio 2013
LogoFileNameLogoFileName vs_logo_bk.gifvs_logo_bk.gif
LogoFileNameHCLogoFileNameHC vs_logo_wh.gifvs_logo_wh.gif
기능:Feature: 내용을Disclaimer
사용:Use: 기계 번역 콘텐츠에 대 한 대/소문자 관련 대/소문자 집합입니다.A set of case-specific disclaimers for machine translated content.
요소Element Value
MT_EditableMT_Editable 이 문서는 기계 번역 되었습니다.This article was machine translated. 인터넷에 연결 되어 있는 경우 "온라인에서이 항목 보기"를 선택 하면이 페이지를 편집 가능 모드에서 원본 영어 콘텐츠와 함께 볼 수 있습니다.If you have an Internet connection, select "View this topic online" to view this page in editable mode with the original English content at the same time.
MT_NonEditableMT_NonEditable 이 문서는 기계 번역 되었습니다.This article was machine translated. 인터넷에 연결 되어 있는 경우 "온라인에서이 항목 보기"를 선택 하면이 페이지를 편집 가능 모드에서 원본 영어 콘텐츠와 함께 볼 수 있습니다.If you have an Internet connection, select "View this topic online" to view this page in editable mode with the original English content at the same time.
MT_QualityEditableMT_QualityEditable 이 문서는 수동으로 번역 되었습니다.This article was manually translated. 인터넷에 연결 되어 있는 경우 "온라인에서이 항목 보기"를 선택 하면이 페이지를 편집 가능 모드에서 원본 영어 콘텐츠와 함께 볼 수 있습니다.If you have an Internet connection, select "View this topic online" to view this page in editable mode with the original English content at the same time.
MT_QualityNonEditableMT_QualityNonEditable 이 문서는 수동으로 번역 되었습니다.This article was manually translated. 인터넷에 연결 되어 있는 경우 "온라인에서이 항목 보기"를 선택 하면이 페이지를 편집 가능 모드에서 원본 영어 콘텐츠와 함께 볼 수 있습니다.If you have an Internet connection, select "View this topic online" to view this page in editable mode with the original English content at the same time.
MT_BetaContentsMT_BetaContents 이 문서는 예비 릴리스에 대해 기계 번역 되었습니다.This article was machine translated for a preliminary release. 인터넷에 연결 되어 있는 경우 "온라인에서이 항목 보기"를 선택 하면이 페이지를 편집 가능 모드에서 원본 영어 콘텐츠와 함께 볼 수 있습니다.If you have an Internet connection, select "View this topic online" to view this page in editable mode with the original English content at the same time.
MT_BetaRecycledContentsMT_BetaRecycledContents 이 문서는 예비 릴리스에 대해 수동으로 번역 되었습니다.This article was manually translated for a preliminary release. 인터넷에 연결 되어 있는 경우 "온라인에서이 항목 보기"를 선택 하면이 페이지를 편집 가능 모드에서 원본 영어 콘텐츠와 함께 볼 수 있습니다.If you have an Internet connection, select "View this topic online" to view this page in editable mode with the original English content at the same time.
기능:Feature: LinkTableLinkTable
사용:Use: 온라인 항목 링크에 대 한 지원Support for online topic links
요소Element Value
LinkTableTitleLinkTableTitle 테이블 연결Link Table
TopicEnuLinkTextTopicEnuLinkText </a>컴퓨터에서 사용할 수 있는이 항목의 영어 버전을 확인 합니다.View the English version</a> of this topic that is available on your computer.
TopicOnlineLinkTextTopicOnlineLinkText 온라인으로이 항목 보기 <a href="{0}" {1}></a>View this topic <a href="{0}" {1}>online</a>
OnlineTextOnlineText 온라인Online
기능:Feature: 비디오 오디오 컨트롤Video Audio control
사용:Use: 비디오 콘텐츠의 표시 요소 및 텍스트Display elements and text for video content
요소Element Value
Multimedian이상 지원 됨MultiMediaNotSupported 콘텐츠를 지원 하려면 Internet Explorer 9 이상이 설치 되어 있어야 합니다 {0} .Internet Explorer 9 or greater must be installed to support {0} content.
비디오 텍스트VideoText 비디오 표시displaying video
텍스트 텍스트AudioText 오디오 스트리밍streaming audio
OnlineVideoLinkTextOnlineVideoLinkText <p>이 항목과 관련 된 비디오를 보려면 여기를 클릭 {0} <a href="{1}"> {2} </a> 하세요.</p><p>To view the video associated with this topic, click {0}<a href="{1}">{2}here</a>.</p>
OnlineAudioLinkTextOnlineAudioLinkText <p>이 항목과 연결 된 오디오를 수신 하려면 여기를 클릭 {0} <a href="{1}"> {2} </a> 하세요.</p><p>To listen to the audio associated with this topic, click {0}<a href="{1}">{2}here</a>.</p>
기능:Feature: 콘텐츠가 설치 되지 않은 컨트롤Content Not Installed control
사용:Use: contentnotinstalled.htm 렌더링에 사용 되는 텍스트 요소 (문자열)Text elements (strings) used for the rendering of contentnotinstalled.htm
요소Element Value
ContentNotInstalledTitleContentNotInstalledTitle 컴퓨터에서 콘텐츠를 찾을 수 없습니다.No content was found on your computer.
ContentNotInstalledDownloadContentTextContentNotInstalledDownloadContentText <p>컴퓨터에 콘텐츠를 다운로드 하려면 <a href="{0}" {1}> 관리 탭을 클릭 </a> 합니다.</p><p>To download content to your computer, <a href="{0}" {1}>click the Manage tab</a>.</p>
ContentNotInstalledTextContentNotInstalledText <p>컴퓨터에 콘텐츠가 설치 되어 있지 않습니다.<p>No content is installed on your computer. 로컬 도움말 콘텐츠 설치는 관리자에 게 문의 하십시오.</p>See your Administrator for local Help content installation.</p>
기능:Feature: 항목을 찾을 수 없음 컨트롤Topic Not Found control
사용:Use: topicnotfound.htm 렌더링에 사용 되는 텍스트 요소 (문자열)Text elements (strings) used for the rendering of topicnotfound.htm
요소Element Value
TopicNotFoundTitleTopicNotFoundTitle 컴퓨터에서 요청한 항목을 찾을 수 없습니다.Cannot find requested topic on your computer.
TopicNotFoundViewOnlineTextTopicNotFoundViewOnlineText <p>요청한 항목을 컴퓨터에서 찾을 수 없지만 온라인에서 항목을 볼 수 있습니다 <a href="{0}" {1}> </a> .</p><p>The topic you requested was not found on your computer, but you can <a href="{0}" {1}>view the topic online</a>.</p>
TopicNotFoundDownloadContentTextTopicNotFoundDownloadContentText <p>유사한 항목에 대 한 링크를 보려면 탐색 창을 참조 하거나, <a href="{0}" {1}> [관리] 탭을 클릭 </a> 하 여 컴퓨터에 콘텐츠를 다운로드 하십시오.</p><p>See the navigation pane for links to similar topics, or <a href="{0}" {1}>click the Manage tab</a> to download content to your computer.</p>
TopicNotFoundTextTopicNotFoundText <p>요청한 항목을 컴퓨터에서 찾을 수 없습니다.</p><p>The topic you requested was not found on your computer.</p>
기능:Feature: 항목 손상 된 컨트롤Topic Corrupted Control
사용:Use: topiccorrupted.htm 렌더링에 사용 되는 텍스트 요소 (문자열)Text elements (strings) used for the rendering of topiccorrupted.htm
요소Element Value
TopicCorruptedTitleTopicCorruptedTitle 요청한 항목을 표시할 수 없습니다.Unable to display the requested topic.
TopicCorruptedViewOnlineTextTopicCorruptedViewOnlineText <p>도움말 뷰어에서 요청한 항목을 표시할 수 없습니다.<p>Help Viewer is unable to display the requested topic. 항목의 내용 또는 기본 시스템 종속성에 오류가 있을 수 있습니다.</p>There may be an error in the topic's content or an underlying system dependency.</p>
기능:Feature: 홈 페이지 컨트롤Home Page control
사용:Use: 도움말 뷰어 최상위 노드 콘텐츠의 표시를 지 원하는 텍스트입니다.Text supporting the display of the Help Viewer top-level node content.
요소Element Value
HomePageTitleHomePageTitle 도움말 뷰어 홈Help Viewer Home
HomePageIntroductionHomePageIntroduction <p>Microsoft 도구, 제품, 기술 및 서비스를 사용 하는 모든 사용자에 게 필수적인 정보 원본인 Microsoft 도움말 뷰어를 시작 합니다.<p>Welcome to the Microsoft Help Viewer, an essential source of information for everyone who uses Microsoft tools, products, technologies, and services. 도움말 뷰어를 사용 하면 방법 및 참조 정보, 샘플 코드, 기술 문서 등에 액세스할 수 있습니다.The Help Viewer gives you access to how-to and reference information, sample code, technical articles, and more. 필요한 콘텐츠를 찾으려면 목차를 찾아보거나 전체 텍스트 검색을 사용 하거나 키워드 인덱스를 사용 하 여 콘텐츠를 탐색 합니다.</p>To find the content you need, browse the table of contents, use full-text search, or navigate through content using the keyword index.</p>
HomePageContentInstallTextHomePageContentInstallText <p><br /><a href="{0}" {1}>콘텐츠 관리 </a> 탭을 사용 하 여 다음 작업을 수행할 수 <ul> <li> 있습니다. 컴퓨터에 콘텐츠를 추가 합니다. </li> <li> 로컬 콘텐츠에 대 한 업데이트를 확인 합니다. </li> <li> 컴퓨터에서 콘텐츠를 제거 합니다.</li></ul></p><p><br />Use the <a href="{0}" {1}>Manage Content</a> tab to do the following:<ul><li>Add content to your computer.</li><li>Check for updates to your local content.</li><li>Remove content from your computer.</li></ul></p>
HomePageInstalledBooksHomePageInstalledBooks 설치 된 서적Installed Books
HomePageNoBooksInstalledHomePageNoBooksInstalled 컴퓨터에서 콘텐츠를 찾을 수 없습니다.No content was found on your computer.
HomePageHelpSettingsHomePageHelpSettings 도움말 콘텐츠 설정Help Content Settings
HomePageHelpSettingsTextHomePageHelpSettingsText <p>현재 설정은 로컬 도움말입니다.<p>Your current setting is local help. 도움말 뷰어에는 컴퓨터에 설치한 콘텐츠가 표시 됩니다. <br /> 도움말 콘텐츠의 소스를 변경 하려면 Visual Studio 메뉴 모음에서 <span style="{0}"> 도움말, 도움말 기본 설정 지정을 선택 </span> 합니다.<br /></p>The Help Viewer displays content that you have installed on your computer.<br />To change your source of Help content, on the Visual Studio menu bar, choose <span style="{0}">Help, Set Help Preference</span>.<br /></p>
200MbMegaByte MBMB

branding.jsbranding.js

branding.js 파일에는 Visual Studio 도움말 뷰어 브랜딩 요소에 사용 되는 JavaScript가 포함 되어 있습니다.The branding.js file contains JavaScript used by the Visual Studio Help Viewer branding elements. 다음은 브랜딩 요소 및 지원 JavaScript 함수 목록입니다.Below is a list of the branding elements and the supporting JavaScript function. 이 파일에 대해 지역화할 모든 문자열은이 파일의 맨 위에 있는 "지역화할 수 있는 문자열" 섹션에 정의 되어 있습니다.All strings to be localized for this file are defined in the "Localizable Strings" section at the top of this file. branding.js 파일 내에서 loc 문자열에 대해 ICL 파일이 생성 되었습니다.ICL file has been created for loc strings within the branding.js file.

브랜딩 기능Branding Feature JavaScript 함수JavaScript Function 설명Description
Var ...Var ... 변수 정의Define variables
사용자 코드 언어 가져오기Get the user code language setUserPreferenceLangsetUserPreferenceLang 인덱스 #에 코드 언어 매핑maps an index # to code language
쿠키 값 설정 및 가져오기Set and Get cookie values getCookie, setCookiegetCookie, setCookie
상속 된 멤버Inherited Member changeMembersLabelchangeMembersLabel 상속 된 멤버 확장/축소Expand/collapse inherited member
When SelfBranded = FalseWhen SelfBranded=False onLoadonLoad 쿼리 문자열을 읽어 인쇄 요청 인지 확인 합니다.Read the query string to check if it's a print request. 모든 codesnippets를 설정 하 여 사용자의 기본 설정 탭에 집중 합니다. 인쇄 요청 인 경우 isPrinterFriendly를 true로 설정 합니다.Set all the codesnippets to focus the user preferred tab. If it's a print request, then set isPrinterFriendly to true. 고대비 모드를 확인 합니다.Check for high contrast mode.
코드 조각Code Snippet addSpecificTextLanguageTagSetaddSpecificTextLanguageTagSet
getIndexFromDevLanggetIndexFromDevLang
ChangeTabChangeTab
setCodesnippetLangsetCodesnippetLang
setCurrentLangsetCurrentLang
CopyToClipboardCopyToClipboard
CollapsibleAreaCollapsibleArea addToCollapsibleControlSetaddToCollapsibleControlSet 축소 가능한 모든 컨트롤 개체를 목록에 씁니다.write all the collapsible control object into list.
CA_ClickCA_Click 축소할 수 있는 영역의 상태를 기준으로, 표시할 이미지 및 텍스트를 정의 합니다.based on state of collapsible area, defines which image and text to present
로고에 대 한 대비 지원Contrast support for Logo Is블랙 배경 ()isBlackBackground() 배경이 검은색 인지 여부를 확인 하기 위해 호출 됩니다.Called to determine if background is black. 고대비 모드의 경우에만 정확 합니다.Only accurate when in high contrast mode.
isHighContrast()isHighContrast() 색이 지정 된 범위를 사용 하 여 고대비 모드 검색use a colored span to detect high contrast mode
onHighContrast (검정)onHighContrast(black) 고대비가 검색 되 면 호출 됩니다.Called when high contrast is detected
.LST 기능LST functionality
addToLanSpecTextIdSet (id)addToLanSpecTextIdSet(id)
updateLST (currentLang)updateLST(currentLang)
getDevLangFromCodeSnippet (lang)getDevLangFromCodeSnippet(lang)
멀티미디어 기능MultiMedia functionality 캡션 (시작, 끝, 텍스트, 스타일)caption(begin, end, text, style)
findAllMediaControls(normalizedId)findAllMediaControls(normalizedId)
getActivePlayer (normalizedId)getActivePlayer(normalizedId)
captionsOnOff (id)captionsOnOff(id)
toSeconds (t)toSeconds(t)
getAllComments (노드)getAllComments(node)
styleRectify (styleName, styleValue)styleRectify(styleName, styleValue)
showCC (id)showCC(id)
부제목 (id)subtitle(id)

HTM 파일HTM FILES

브랜딩 패키지에는 콘텐츠 사용자에 게 유용한 정보를 제공 하는 기능을 지 원하는 HTM 파일 집합이 포함 되어 있습니다. 예를 들어, 설치 되는 콘텐츠 집합을 설명 하는 섹션과 항목의 로컬 항목에서 항목을 찾을 수 없는 경우 사용자에 게 알려 주는 페이지가 포함 된 홈 페이지가 있습니다.The branding package contains a set of HTM files that support scenarios for communicating key information to Help content users, for example a homepage that contains a section describing which content sets are installed and pages telling the user when topics cannot be found in the local set of topics. 이러한 HTM 파일은 제품 별로 수정할 수 있습니다.These HTM files can be modified per product. ISO 셸 공급 업체는 기본 브랜딩 패키지를 사용 하 여 이러한 페이지의 동작과 콘텐츠를 요구 사항에 맞게 변경할 수 있습니다.ISO Shell vendors are able to take the default branding package and change the behavior and content of these pages to suite their need. 이러한 파일은 브랜딩 태그가 branding.xml 파일에서 해당 콘텐츠를 가져오기 위해 각 브랜딩 패키지를 참조 합니다.These files refer to their respective branding package in order for the branding tags to get the corresponding content from the branding.xml file.

파일File 사용Use 표시 된 콘텐츠 원본Displayed Content Source
homepage.htmhomepage.htm 현재 설치 된 콘텐츠를 표시 하는 페이지 및 해당 콘텐츠에 대 한 사용자에 게 제공 되는 기타 모든 메시지입니다.This is a page that displays currently installed content, and any other message appropriate to present to the user about their content. 이 파일에는이 콘텐츠를 로컬 콘텐츠 TOC의 맨 위에 배치 하는 추가 메타 데이터 특성 "Microsoft.Help.Id" content = "-1"이 있습니다.This file has the additional meta data attribute "Microsoft.Help.Id" content="-1" which places this content at the top of the local content TOC.
<META_HOME_PAGE_TITLE_ADD/><META_HOME_PAGE_TITLE_ADD /> Branding.xml, 태그 <HomePageTitle>Branding.xml, tag <HomePageTitle>
<HOME_PAGE_INTRODUCTION_SECTION_ADD/><HOME_PAGE_INTRODUCTION_SECTION_ADD /> Branding.xml, 태그 <HomePageIntroduction>Branding.xml, tag <HomePageIntroduction>
<HOME_PAGE_CONTENT_INSTALL_SECTION_ADD/><HOME_PAGE_CONTENT_INSTALL_SECTION_ADD /> Branding.xml, 태그 <HomePageContentInstallText>Branding.xml, tag <HomePageContentInstallText>
<HOME_PAGE_BOOKS_INSTALLED_SECTION_ADD/><HOME_PAGE_BOOKS_INSTALLED_SECTION_ADD /> 책을 설치 하지 않은 경우 제목 섹션 Branding.xml 태그 <HomePageInstalledBooks> , 응용 프로그램에서 생성 된 데이터 <HomePageNoBooksInstalled> 입니다.Heading section Branding.xml tag<HomePageInstalledBooks>, the data generated from application, <HomePageNoBooksInstalled> when no books are installed.
<HOME_PAGE_SETTINGS_SECTION_ADD/><HOME_PAGE_SETTINGS_SECTION_ADD /> 제목 섹션 Branding.xml 태그 <HomePageHelpSettings> , 섹션 텍스트 <HomePageHelpSettingsText> 입니다.Heading section Branding.xml tag <HomePageHelpSettings>, section text <HomePageHelpSettingsText>.
topiccorrupted.htmtopiccorrupted.htm 항목이 로컬 집합에 있지만 어떤 이유로 든 표시할 수 없는 경우 (손상 된 콘텐츠)When a topic exists in the local set, but for some reason cannot be displayed (corrupted content).
<META_TOPIC_CORRUPTED_TITLE_ADD/><META_TOPIC_CORRUPTED_TITLE_ADD /> Branding.xml, 태그 <TopicCorruptedTitle>Branding.xml, tag <TopicCorruptedTitle>
<TOPIC_CORRUPTED_SECTION_ADD/><TOPIC_CORRUPTED_SECTION_ADD /> Branding.xml, 태그 <TopicCorruptedViewOnlineText>Branding.xml, tag <TopicCorruptedViewOnlineText>
topicnotfound.htmtopicnotfound.htm 로컬 콘텐츠 집합에 항목이 없거나 온라인에서 사용할 수 없는 경우When a topic is not found in the local content set, nor available online
<META_TOPIC_NOT_FOUND_TITLE_ADD/><META_TOPIC_NOT_FOUND_TITLE_ADD /> Branding.xml, 태그 <TopicNotFoundTitle>Branding.xml, tag <TopicNotFoundTitle>
<META_TOPIC_NOT_FOUND_ID_ADD/><META_TOPIC_NOT_FOUND_ID_ADD /> Branding.xml, 태그 <TopicNotFoundViewOnlineText> + <TopicNotFoundDownloadContentText>Branding.xml, tag <TopicNotFoundViewOnlineText> + <TopicNotFoundDownloadContentText>
<TOPIC_NOT_FOUND_SECTION_ADD/><TOPIC_NOT_FOUND_SECTION_ADD /> Branding.xml, 태그 <TopicNotFoundText>Branding.xml, tag <TopicNotFoundText>
contentnotinstalled.htmcontentnotinstalled.htm 제품에 대 한 로컬 콘텐츠가 설치 되어 있지 않은 경우When there is no local content installed for the product.
<META_CONTENT_NOT_INSTALLED_TITLE_ADD/><META_CONTENT_NOT_INSTALLED_TITLE_ADD /> Branding.xml, 태그 <ContentNotInstalledTitle>Branding.xml, tag <ContentNotInstalledTitle>
<META_CONTENT_NOT_INSTALLED_ID_ADD/><META_CONTENT_NOT_INSTALLED_ID_ADD /> Branding.xml, 태그 <ContentNotInstalledDownloadContentText>Branding.xml, tag <ContentNotInstalledDownloadContentText>
<CONTENT_NOT_INSTALLED_SECTION_ADD/><CONTENT_NOT_INSTALLED_SECTION_ADD /> Branding.xml, 태그 <ContentNotInstalledText>Branding.xml, tag <ContentNotInstalledText>

CSS 파일CSS Files

Visual Studio 도움말 뷰어 브랜딩 패키지에는 일관성 있는 Visual Studio 도움말 콘텐츠 프레젠테이션을 지 원하는 두 개의 css 파일이 포함 되어 있습니다.The Visual Studio Help Viewer Branding Package contains two css files to support consistent Visual Studio Help content presentation:

  • SelfBranded = false 인 렌더링을 위한 css 요소를 포함 합니다.Branding.css - contains css elements for rendering where SelfBranded=false

  • 프린터인-SelfBranded = false 인 렌더링을 위한 css 요소를 포함 합니다.Printer.css - contains css elements for rendering where SelfBranded=false

브랜딩 .css 파일에는 Visual Studio 토픽 프레젠테이션 정의가 포함 되어 있습니다. 즉, 패키지 서비스의 .mshc Branding_에 포함 된에 포함 된 내용이 <locale> 변경 될 수 있습니다.Branding.css files include definitions for Visual Studio topic presentation (caveat is that the branding.css contained in the Branding_<locale>.mshc from the package service may change).

그래픽 파일Graphic Files

Visual Studio 콘텐츠는 Visual Studio 로고 및 기타 그래픽을 표시 합니다.Visual Studio content displays a Visual Studio logo as well as other graphics. Visual Studio 도움말 뷰어 브랜딩 패키지의 전체 그래픽 파일 목록은 아래와 같습니다.The complete list of graphic files in the Visual Studio Help Viewer branding package is shown below.

파일File 사용Use Examples
clear.gifclear.gif 축소 가능한 영역을 렌더링 하는 데 사용 됩니다.Used to render Collapsible Area
footer_slice.giffooter_slice.gif 바닥글 프레젠테이션Footer presentation
info_icon.gifinfo_icon.gif 정보를 표시할 때 사용 됩니다.Used when displaying information 고지 사항Disclaimer
online_icon.gifonline_icon.gif 이 아이콘은 온라인 링크와 연결 됩니다.This icon is to be associated with online links
tabLeftBD.giftabLeftBD.gif 코드 조각 컨테이너를 렌더링 하는 데 사용 됩니다.Used to render the code snippet container
tabRightBD.giftabRightBD.gif 코드 조각 컨테이너를 렌더링 하는 데 사용 됩니다.Used to render the code snippet container
vs_logo_bk.gifvs_logo_bk.gif Branding.xml 태그에 정의 된 일반 대비 로고 참조에 사용 <LogoFileName> 됩니다.Used for normal contrast logo references as defined in Branding.xml tag <LogoFileName>. Visual Studio 제품의 경우 로고 이름이 vs_logo_bk.gif 됩니다.For Visual Studio products, logo name is vs_logo_bk.gif.
vs_logo_wh.gifvs_logo_wh.gif Branding.xml 태그에 정의 된 일반적인 고품질 로고 참조에 사용 <LogoFileNameHC> 됩니다.Used for normal high logo references as defined in Branding.xml tag <LogoFileNameHC>. Visual Studio 제품의 경우 로고 이름이 vs_logo_wh.gif 됩니다.For Visual Studio products, logo name is vs_logo_wh.gif.
ccOff.pngccOff.png 캡션 그래픽Captioning graphic
ccOn.pngccOn.png 캡션 그래픽Captioning graphic
ImageSprite.pngImageSprite.png 축소 가능한 영역을 렌더링 하는 데 사용 됩니다.Used to render Collapsible Area 확장 또는 축소 그래픽expanded or collapse graphic

항목 집합 배포Deploy a set of topics

MSHA 파일과 토픽을 포함 하는 cab 또는 MSHCs 집합으로 구성 된 도움말 뷰어 콘텐츠 배포 집합을 만드는 간단한 자습서입니다.This is a simple and quick tutorial for creating a Help Viewer content deployment set comprised of an MSHA file and the set of cabs or MSHCs containing the topics. MSHA는 cab 또는 .MSHC 파일 집합을 설명 하는 XML 파일입니다.The MSHA is an XML file that describes a set of cabs or MSHC files. 도움말 뷰어는 MSHA를 읽어 콘텐츠 목록을 가져올 수 있습니다 (. CAB 또는. .MSHC files)를 로컬 설치에 사용할 수 있습니다.The Help Viewer can read the MSHA to obtain a list of content (the .CAB or .MSHC files) available for local installation.

이는 도움말 뷰어 MSHA의 기본 XML 스키마를 설명 하는 입문에 불과합니다.This is only a primer describing the very basic XML schema for the Help Viewer MSHA. 이 간략 한 개요 및 샘플 HelpContentSetup에 대 한 예제 구현이 있습니다.There is an example implementation below this brief overview and sample HelpContentSetup.msha.

이 입문의 목적을 위해 MSHA의 이름은 HelpContentSetup. msha (확장명이 인 모든 이름일 수 있습니다. MSHA).The name of the MSHA, for the purposes of this primer, is HelpContentSetup.msha (the name of the file can be anything, with the extension .MSHA). HelpContentSetup. msha (아래 예제)에는 사용 가능한 cab 또는 MSHCs 목록이 포함 되어 있어야 합니다.HelpContentSetup.msha (example below) should contain a list of the cabs or MSHCs available. 파일 형식은 MSHA 내에서 일치 해야 합니다 (MSHA 및 CAB 파일 형식의 조합을 지원 하지 않음).The file type must be consistent within the MSHA (does not support a combination of MSHA and CAB file types). 각 CAB 또는 .mshc에 대해 ... <div class="package"> </div> (아래 예제 참조)가 있어야 합니다.For each CAB or MSHC, there should be a <div class="package">...</div> (see example below).

참고: 아래 구현 예제에서는 브랜딩 패키지를 포함 했습니다.Note: in the implementation example below, we have included the branding package. 필요한 Visual Studio 콘텐츠 렌더링 요소 및 콘텐츠 동작을 얻기 위해이를 포함 하는 것이 중요 합니다.This is critical to include in order to get the needed Visual Studio content rendering elements and content behaviors.

샘플 HelpContentSetup. msha 파일: ("content set name 1" 및 "content set name 2" 등을 파일 이름으로 바꿉니다.)Sample HelpContentSetup.msha file: (Replace "content set name 1" and "content set name 2" etc. with your file names.)

<html>
<head />
<body class="vendor-book">
<div class="details">
<span class="vendor">Your Company</span>
<span class="locale">en-us</span>
<span class="product">Your Company Help Content</span>
<span class="name">Your Company Help Content</span>
</div>
<div class="package-list">
<div class="package">
<span class="name">Your_Company _Content_Set_1</span>
<span class="deployed">True</span>
<a class="current-link" href="Your_Company _Content_Set_1.mshc">Your_Company _Content_Set_1.mshc </a>
</div>
<div class="package">
<span class="name">Your_Company _Content_Set_2</span>
<span class="deployed">True</span>
<a class="current-link"href=" Your_Company _Content_Set_2.mshc "> Your_Company _Content_Set_2.mshc </a>
</div>.
  1. "C:\SampleContent"와 같은 로컬 폴더를 만듭니다.Create local folder, something like "C:\SampleContent"

  2. 이 예제에서는 .MSHC 파일을 사용 하 여 항목을 포함 합니다.For this example, we will use MSHC files to contain the topics. .MSHC는 파일 확장명이 .zip에서로 변경 된 zip입니다. .MSHC.An MSHC is a zip with the file extension changed from .zip to .MSHC.

  3. 아래 HelpContentSetup. msha를 텍스트 파일로 만들고 (메모장을 사용 하 여 파일을 만든 후) 위의 설명 된 폴더에 저장 합니다 (1 단계 참조).Create the below HelpContentSetup.msha as a text file (notepad was used to create the file) and save it to the above noted folder (see step 1).

"브랜딩" 클래스가 있으며 고유 합니다.The class "Branding" exists and is unique. 브랜딩 .mshc 설치 된 콘텐츠에 브랜딩이 포함 되 고 MSHCs에 포함 된 콘텐츠 동작에 브랜딩 패키지에 포함 된 적절 한 지원 요소가 포함 되도록이 입문에 포함 됩니다.The Branding mshc is included in this primer so that the installed content will have branding, and the content behaviors that are contained in the MSHCs will have the appropriate support elements contained in the branding package. 이렇게 하지 않으면 시스템이 리핑한 (설치 된) 콘텐츠의 일부가 아닌 지원 항목을 찾을 때 오류가 발생 합니다.Without this, errors will result when the system looks for support items that are not part of the ripped (installed) content.

Visual Studio 브랜딩 패키지를 가져오려면 C:\Program Files (x86) \Microsoft Help Viewer\v2.3\의 Branding_en-.mshc 파일을 작업 폴더에 복사 합니다.To obtain the Visual Studio branding package, copy Branding_en-US.mshc file at C:\Program Files (x86)\Microsoft Help Viewer\v2.3\ to your working folder.

<html>
<head />
<body class="vendor-book">
<div class="details">
<span class="vendor">Your Company</span>
<span class="locale">en-us</span>
<span class="product">Your Company Help Content</span>
<span class="name">Your Company Help Content</span>
</div>
<div class="package-list">
<div class="package">
<span class="name">Your_Company _Content_Set_1</span>
<span class="deployed">True</span>
<a class="current-link" href="Your_Company _Content_Set_1.mshc">Your_Company _Content_Set_1.mshc </a>
</div>
<div class="package">
<span class="name">Your_Company _Content_Set_2</span>
<span class="deployed">True</span>
<a class="current-link"href=" Your_Company _Content_Set_2.mshc "> Your_Company _Content_Set_2.mshc </a>
</div>
<div class="package">
<span class="packageType">branding</span>
<span class="name">Branding_en-US</span>
<span class="deployed">True</span>
<a class="current-link" href="Branding_en-US.mshc">Branding_en-US.mshc</a>
</div>
</div>
</body>
</html>

요약Summary

위의 단계를 사용 하 고 확장 하면 .Vsps에서 Visual Studio 도움말 뷰어에 대 한 콘텐츠 집합을 배포할 수 있습니다.Using and extending the above steps will enable VSPs to deploy their content sets for the Visual Studio Help Viewer.

Visual Studio 셸에 도움말 추가 (통합 및 격리)Add help to the Visual Studio Shell (Integrated and Isolated)

소개Introduction

이 연습에서는 Visual Studio Shell 응용 프로그램에 도움말 콘텐츠를 통합 한 다음 배포 하는 방법을 보여 줍니다.This walkthrough demonstrates how to incorporate Help content into a Visual Studio Shell application and then deploy it.

RequirementsRequirements

  1. Visual Studio 2013Visual Studio 2013

  2. Visual Studio 2013 격리 된 셸 재배포 가능 패키지Visual Studio 2013 Isolated Shell Redist

개요Overview

Visual Studio 2013Visual Studio 2013셸은 Visual Studio 2013Visual Studio 2013 응용 프로그램의 기반으로 사용할 수 있는 IDE의 버전입니다.The Visual Studio 2013Visual Studio 2013 Shell is a version of the Visual Studio 2013Visual Studio 2013 IDE on which you can base an application. 이러한 응용 프로그램에는 사용자가 만든 확장과 함께 격리 셸이 포함 되어 있습니다.Such applications contain the Isolated Shell together with extensions that you create. SDK에 포함 된 격리 된 셸 프로젝트 템플릿을 사용 Visual Studio 2013Visual Studio 2013 하 여 확장을 빌드합니다.Use Isolated Shell project templates, which are included in the Visual Studio 2013Visual Studio 2013 SDK, to build extensions.

격리 된 셸 기반 응용 프로그램 및 해당 도움말을 만드는 기본 단계는 다음과 같습니다.The basic steps for creating an Isolated Shell-based application and its Help:

  1. Visual Studio 2013Visual Studio 2013ISO 셸 재배포 가능 패키지 (Microsoft 다운로드)를 다운로드 합니다.Obtain the Visual Studio 2013Visual Studio 2013 ISO Shell redistributable (a Microsoft download).

  2. Visual Studio에서이 연습의 뒷부분에서 설명 하는 Contoso Help extension과 같은 Isolated 셸을 기반으로 하는 도움말 확장을 만듭니다.In Visual Studio, create a Help extension that is based on the Isolated Shell, for example, the Contoso Help extension that is described later in this walkthrough.

  3. 확장 및 ISO 셸 재배포 가능 패키지를 배포 MSI (응용 프로그램 설치)로 래핑합니다.Wrap the extension and the ISO Shell redistributable into a deployment MSI (an application setup). 이 연습에는 설치 단계가 포함 되지 않습니다.This Walkthrough does not include a setup step.

Visual Studio 콘텐츠 저장소를 만듭니다.Create a Visual Studio content store. 통합 셸 시나리오의 경우 다음과 같이 Visual Studio12를 제품 카탈로그 이름으로 변경 합니다.For the Integrated Shell scenario, change Visual Studio12 to the product catalog name as follows:

  • C:\ProgramData\Microsoft\HelpLibrary2\Catalogs\VisualStudio15. 폴더 만들기Create folder C:\ProgramData\Microsoft\HelpLibrary2\Catalogs\VisualStudio15.

  • CatalogType.xml 라는 파일을 만들고 폴더에 추가 합니다.Create a file named CatalogType.xml and add it to the folder. 파일에는 다음 코드 줄이 포함 되어야 합니다.The file should contain the following lines of code:

    <?xml version="1.0" encoding="UTF-8"?>
    <catalogType>UserManaged</catalogType>
    

레지스트리에서 콘텐츠 저장소를 정의 합니다.Define the content store in the registry. 통합 셸에서 VisualStudio15을 제품 카탈로그 이름으로 변경 합니다.For the Integrated Shell, change VisualStudio15 to the product catalog name:

  • HKLM\SOFTWARE\Wow6432Node\Microsoft\Help\v2.3\Catalogs\VisualStudio15HKLM\SOFTWARE\Wow6432Node\Microsoft\Help\v2.3\Catalogs\VisualStudio15

    키: LocationPath 문자열 값: C:\ProgramData\Microsoft\HelpLibrary2\Catalogs\VisualStudio15Key: LocationPath String value: C:\ProgramData\Microsoft\HelpLibrary2\Catalogs\VisualStudio15\

  • HKLM\SOFTWARE\Wow6432Node\Microsoft\Help\v2.3\Catalogs\VisualStudio15\en-USHKLM\SOFTWARE\Wow6432Node\Microsoft\Help\v2.3\Catalogs\VisualStudio15\en-US

    키: CatalogName 문자열 값: Visual Studio 2013Visual Studio 2013 설명서Key: CatalogName String value: Visual Studio 2013Visual Studio 2013 Documentation

프로젝트 만들기Create the Project

격리 된 셸 확장을 만들려면 다음을 수행 합니다.To create an Isolated Shell extension:

  1. Visual Studio의 파일 에서 새 프로젝트 를 선택 하 고 기타 프로젝트 형식 에서 확장성 을 선택한 다음 Visual Studio Shell 격리 를 선택 합니다.In Visual Studio, under File, choose New Project, under Other Project Types choose Extensibility, and then choose Visual Studio Shell Isolated. 프로젝트 이름 ContosoHelpShell )을 사용 하 여 Visual Studio 격리 셸 템플릿을 기반으로 하는 확장성 프로젝트를 만듭니다.Name the project ContosoHelpShell) to create an extensibility project based on the Visual Studio Isolated Shell template.

  2. 솔루션 탐색기의 ContosoHelpShellUI 프로젝트에 있는 리소스 파일 폴더에서 ApplicationCommands. vsct를 엽니다.In Solution Explorer, in the ContosoHelpShellUI project, in the Resource Files folder, open ApplicationCommands.vsct. 이 줄이 주석 처리 되었는지 확인 합니다 ("No_Help" 검색). <!-- <define name="No_HelpMenuCommands"/> -->Make sure this line is commented out (search for "No_Help"): <!-- <define name="No_HelpMenuCommands"/> -->

  3. F5 키를 선택 하 여 컴파일하고 디버그 를 실행 합니다.Choose the F5 key to compile and run Debug. 격리 된 셸 IDE의 실험적 인스턴스에서 도움말 메뉴를 선택 합니다.In the experimental instance of the Isolated Shell IDE, choose the Help menu. 도움말 보기, 도움말 콘텐츠 추가 및 제거도움말 기본 설정 명령 설정이 표시 되는지 확인 합니다.Make sure that the View Help, Add and Remove Help Content, and Set Help Preference commands appear.

  4. 솔루션 탐색기의 ContosHelpShell 프로젝트에 있는 Shell 사용자 지정 폴더에서 ContosoHelpShell. .pkgdef를 엽니다.In Solution Explorer, in the ContosHelpShell project, in the Shell Customization folder, open ContosoHelpShell.pkgdef. Contoso Help catalog를 정의 하려면 다음 줄을 추가 합니다.To define the Contoso Help catalog, add the following lines:

     [$RootKey$\Help]
    "Product"="Contoso"
    "Catalog"="Contoso"
    "Version"="100"
    "BrandingPackage"="ContosoBrandingPackage.mshc"
    
  5. 솔루션 탐색기의 ContosHelpShell 프로젝트에 있는 Shell 사용자 지정 폴더에서 ContosoHelpShell .pkgdef를 엽니다.In Solution Explorer, in the ContosHelpShell project, in the Shell Customization folder, open ContosoHelpShell.Application.pkgdef. F1 도움말을 사용 하려면 다음 줄을 추가 합니다.To enable F1 Help, add the following lines:

    // F1 Help Provider
    
    [$RootKey$\HelpProviders\{C99BDC23-FF29-46bf-9658-ADD634CCAED8}]
    "Name"="13407"
    "Package"="{DA9FB551-C724-11d0-AE1F-00A0C90FFFC3}"
    @="Help3 Provider"
    [$RootKey$\HelpProviders]
    @="{C99BDC23-FF29-46bf-9658-ADD634CCAED8}"
    [$RootKey$\Services\{C99BDC23-FF29-46bf-9658-ADD634CCAED8}]
    "Name"="Help3 Provider"
    @="{4A791146-19E4-11D3-B86B-00C04F79F802}"
    
  6. 솔루션 탐색기의 ContosoHelpShell 솔루션에 대 한 상황에 맞는 메뉴에서 속성 메뉴 항목을 선택 합니다.In Solution Explorer, on the context menu of the ContosoHelpShell solution, choose the Properties menu item. 구성 속성 에서 Configuration Manager 를 선택 합니다.Under Configuration Properties, select Configuration Manager. 구성 열에서 모든 "Debug" 값을 "Release"로 변경 합니다.In the Configuration column, change every "Debug" value to "Release".

  7. 솔루션을 빌드합니다.Build the solution. 그러면 다음 섹션에서 사용 되는 릴리스 폴더에 파일 집합이 만들어집니다.This creates a set of files in a release folder, which will be used in the next section.

배포 된 경우로 테스트 하려면 다음을 수행 합니다.To test this as if deployed:

  1. Contoso를 배포 하는 컴퓨터에서 다운로드 한 (위) ISO 셸을 설치 합니다.On the machine you are deploying Contoso to, install the downloaded (from above) ISO Shell.

  2. Filefiles \ (x86)에서 폴더를 만들고 \ 이름을로 Contoso 합니다.Create a folder in \\Program Files (x86)\, and name it Contoso.

  3. ContosoHelpShell release 폴더의 콘텐츠를 \ filefiles (x86) \Contoso\ 폴더에 복사 합니다.Copy the contents from the ContosoHelpShell release folder to \\Program Files (x86)\Contoso\ folder.

  4. 시작 메뉴에서 실행 을 선택 하 고를 입력 하 여 레지스트리 편집기를 시작 Regedit 합니다.Start Registry Editor by choosing Run in the Start menu and entering Regedit. 레지스트리 편집기에서 파일, 가져오기 를 차례로 선택 합니다.In the registry editor, choose File, and then Import. ContosoHelpShell 프로젝트 폴더로 이동 합니다.Browse to the ContosoHelpShell project folder. ContosoHelpShell 하위 폴더에서 ContosoHelpShell를 선택 합니다.In the ContosoHelpShell subfolder, choose ContosoHelpShell.reg.

  5. 콘텐츠 저장소를 만듭니다.Create a content store:

    ISO Shell-Contoso content store C:\ProgramData\Microsoft\HelpLibrary2\Catalogs\ContosoDev12 만들기For ISO Shell - create a Contoso content store C:\ProgramData\Microsoft\HelpLibrary2\Catalogs\ContosoDev12

    Visual Studio 2013Visual Studio 2013통합 셸의 경우 C:\ProgramData\Microsoft\HelpLibrary2\Catalogs\VisualStudio15 폴더를 만듭니다.For Visual Studio 2013Visual Studio 2013 Integrated Shell, create folder C:\ProgramData\Microsoft\HelpLibrary2\Catalogs\VisualStudio15

  6. CatalogType.xml를 만들고 다음을 포함 하는 콘텐츠 저장소 (이전 단계)에를 추가 합니다.Create CatalogType.xml and add to the content store (previous step) containing:

    <?xml version="1.0" encoding="UTF-8"?>
    <catalogType>UserManaged</catalogType>
    
  7. 다음 레지스트리 키를 추가 합니다.Add the following registry keys:

    HKLM\SOFTWARE\Wow6432Node\Microsoft\Help\v2.3\Catalogs\VisualStudio15Key: LocationPath 문자열 값:HKLM\SOFTWARE\Wow6432Node\Microsoft\Help\v2.3\Catalogs\VisualStudio15Key: LocationPath String value:

    ISO Shell의 경우:For ISO Shell:

    C:ProgramDataMicrosoftHelpLibrary2CatalogsVisualStudio15C:ProgramDataMicrosoftHelpLibrary2CatalogsVisualStudio15

    Visual Studio 2013Visual Studio 2013 통합 셸:Integrated Shell:

    C:ProgramDataMicrosoftHelpLibrary2CatalogsVisualStudio15en-USC:ProgramDataMicrosoftHelpLibrary2CatalogsVisualStudio15en-US

    키: CatalogName 문자열 값: Visual Studio 2013Visual Studio 2013 설명서.Key: CatalogName String value: Visual Studio 2013Visual Studio 2013 Documentation. ISO 셸에서는 카탈로그의 이름입니다.For ISO Shell, this is the name of your catalog.

  8. 콘텐츠 (cab 또는 .MSHC 및 MSHA)를 로컬 폴더에 복사 합니다.Copy your content (cabs or MSHC and MSHA) to a local folder.

  9. 콘텐츠 저장소 테스트에 대 한 예제 통합 셸 명령줄입니다.Example Integrated Shell command line for testing content store. ISO 셸에서 카탈로그 및 launchingApp 값을 제품 일치에 적합 하 게 변경 합니다.For ISO Shell, change the catalog and launchingApp values as appropriate to match the product.

    "C:\Program Files (x86) \Microsoft Help Viewer\v2.3\HlpViewer.exe"/catalogName VisualStudio15/helpQuery method = "page&id = ContosoTopic0"/launchingApp Microsoft, VisualStudio, 12.0"C:\Program Files (x86)\Microsoft Help Viewer\v2.3\HlpViewer.exe" /catalogName VisualStudio15 /helpQuery method="page&id=ContosoTopic0" /launchingApp Microsoft,VisualStudio,12.0

  10. Contoso 앱 루트에서 Contoso 응용 프로그램을 시작 합니다.Launch the Contoso application (from the Contoso app root). ISO Shell 내에서 도움말 메뉴 항목을 선택 하 고 도움말 기본 설정 지정을 로컬 도움말 사용 으로 변경 합니다.Within ISO Shell, choose the Help menu item, and change the Set Help Preference to Use Local Help.

  11. 셸 내에서 도움말 메뉴 항목을 선택 하 고 도움말을 봅니다.Within the shell, choose the Help menu item, then View Help. 로컬 도움말 뷰어를 시작 해야 합니다.The local Help viewer should launch. 콘텐츠 관리 탭을 선택 합니다. 설치 원본 에서 디스크 옵션 단추를 선택 합니다.Choose the Manage Content tab. Under Installation Source, choose the Disk option button. ... 단추를 선택 하 고 위의 단계에서 로컬 폴더에 복사 된 Contoso 콘텐츠를 포함 하는 로컬 폴더로 이동 합니다.Choose the ... button and browse to the local folder containing Contoso content (copied to the local folder in the above step). HelpContentSetup. msha를 선택 합니다.Choose the HelpContentSetup.msha. 이제 Contoso는 책 선택 항목에 책으로 표시 되어야 합니다.Contoso should now show up as a book in the book selections. 추가 를 선택한 다음 업데이트 단추 (오른쪽 아래 모서리)를 선택 합니다.Choose Add, and then choose the Update button (bottom right corner).

  12. Contoso IDE 내에서 f1 키를 선택 하 여 F1 기능을 테스트 합니다.Within the Contoso IDE, choose the F1 key to test F1 functionality.

추가 자료Additional resources

런타임 API에 대 한 자세한 내용은 Windows 도움말 API를 참조 하세요.For the Runtime API, see Windows Help API.

도움말 API를 활용 하는 방법에 대 한 자세한 내용은 도움말 뷰어 코드 예제를 참조 하세요.For more information on how to leverage the Help API, see Help Viewer code examples.

개발자 커뮤니티에서 기능 제안을 제출할 수 있습니다.You can submit feature suggestions on Developer Community.