Sandcastle MS 도움말 뷰어 출력의 루트 컨테이너 지정

Question

Sandcastle 도움말 파일 작성기를 사용하여 SDK에 대한 세련된 설명서를 만듭니다. Visual Studio의 F1 기능을 지원하려면 출력 중 하나가 MS 도움말 뷰어 형식이어야합니다. 문제는 도움말 뷰어 1.0 (Visual Studio 2010) 또는 도움말 뷰어 2.0 (Visual Studio 2012)에 패키지를 설치할 때 문서가 루트 컨테이너에 배치되지 않는 경우입니다.

이미지에 표시된 "API 참조"노드 클래스 라이브러리 자체에 대한 컨테이너이다. 이 노드의 이름을 바꿀 수는 있지만 클래스 라이브러리 참조 외에 개념적 컨텐트를 포함 할 위치를 남겨 두지는 않습니다. 이것을 .NET Framework 4 도움말의 해당 노드 위치와 비교하십시오.

질문 : 다른 문서와 일관성을 위해, 우리는 어떻게 샌드캐슬 도움말이 현재 "API 참조로, 빌더는 우리의 프로젝트에 대한 사용자 지정 최상위 컨테이너에서 MS 도움말 뷰어 출력을 생성 파일 수 "그 노드의 자식 인 클래스 라이브러리 문서?

Answer 1

실제로 루트 노드는 개념적 내용 문서로 지정됩니다.

1. 문서 프로젝트에 콘텐츠 레이아웃 문서가 있는지 확인하십시오.

2. 개념 템플릿을 사용하여 문서 프로젝트에서 MSHelpViewerRoot.aml이라는 새로운 개념적 콘텐츠 문서를 만듭니다.

   <?xml version="1.0" encoding="utf-8"?> 
   <topic id="[Guid]" revisionNumber="1"> 
       <developerConceptualDocument 
        xmlns="http://ddue.schemas.microsoft.com/authoring/2003/5" 
        xmlns:xlink="http://www.w3.org/1999/xlink"> 
   
       <introduction> 
        <para>Welcome to the [My Topic] Reference</para> 
       </introduction> 
   
       <section> 
        <content> 
        <para>Select a topic from the table of contents.</para> 
        </content> 
       </section> 
   
       <relatedTopics/> 
       </developerConceptualDocument> 
   </topic> 
   

3. 는 컨텐츠 레이아웃 문서에 MSHelpViewerRoot.aml 개념적인 내용을 추가합니다 : 내용은 다음과 같이 (콘텐츠 항목과 생성 된 GUID와 [Guid] 및 [My Topic] 교체)를 볼 수 있었다.

   • 주제 속성에서, 주제 속성 아래에서 제목
   • 로 [My Topic] SDK를 지정 MS 도움말 뷰어 루트 컨테이너 인덱스 키워드에서
   • 로 사용에 대한 확인란을 선택, 와 함께 항목을 추가하십시오. 색인K 및 기간[My Topic] SDK

결과 구성은 다음과 유사 할 수 있습니다 : 최종 참고로

루트 노드에 추가로를, 당신은 다음을 수행 할 수 있습니다 :

1. Welcome.aml 개념 콘텐츠 문서 만들기
   • 는
2. 가 License.aml 개념 콘텐츠 문서를 추가 컨텐츠 레이아웃 설정의 기본 주제 요소로 사용으로 MSHelpViewerRoot.aml
3. 의 <relatedTopics> 요소에 오신 것을 환영합니다 문서에 설정 Welcome.aml을 링크를 추가