샌드캐슬(소프트웨어)

Sandcastle (software)
샌드캐슬
개발자마이크로소프트
초기 릴리즈2006; 16년 전(2006)
안정적 해제
2.6.10621.1 / 2010년 6월 23일; 11년 전(2010-06-23)
리포지토리github.com/EWSoftware/SHFB
기록 위치C#
운영 체제마이크로소프트 윈도
플랫폼.NET Framework
유형문서 생성기
면허증마이크로소프트 공용 라이선스
웹사이트github.com/EWSoftware/SHFB

샌드캐슬은 마이크로소프트사의 문서 생성기다.의 반영 정보에서 MSDN 스타일의 코드 문서를 자동으로 생성한다.NET 조립품 및 XML 문서 설명은 이 조립품의 소스 코드에서 찾을 수 있다.또한 마이크로소프트 지원 마크업 언어(MAML)에서 참조 문서와 동일한 모양과 느낌으로 사용자 설명서를 작성하는 데 사용할 수 있다.

개요

샌드캐슬은 XML 기반 문서를 도움말 시스템에서 보기에 적합한 도움말 항목으로 변환하기 위해 함께 작동하는 명령줄 프로그램, 구성 파일, 빌드 구성 요소 및 XSLT 파일 모음입니다.Sandcastle은 일반적으로 의 3가지 기본 제공 프레젠테이션 스타일 중 하나로 웹 지원 XML 호환 HTML 문서를 자동으로 생성하는 데 사용된다.컴파일러에서 생성된 NET 어셈블리 및 XML 문서 파일.그 결과 HTML 파일은 해당 컴퓨터 프로그램과 함께 배포를 위한 컴파일된 도움말을 생산하기 위해 HTML 도움말 워크샵과 같은 도구에 대한 입력으로 사용된다.

샌드캐슬은 현재 MSBuild 프로젝트, 배치 스크립트 및 Windows PowerShell 스크립트 대안으로 경량 그래픽 사용자 인터페이스(GUI)를 탑재하고 있다.샌드캐슬에는 몇 가지 커뮤니티 GUI 툴도 제공되어 추가 기능을 제공하고 사용을 단순화한다.[1]

2005년과 2008년의 Visual Studio SDK에는 GitHub에서 최신 릴리즈가 제공되지만 Sandcastle의 이전 CTP 버전이 포함되어 있다.[2]

샌드캐슬 도구

샌드캐슬은 몇 개의 프로그램으로 구성되는데, 이 모든 프로그램이 일반적인 도움 구축 과정에서 사용되는 것은 아니다.일반적으로 사용되는 도구는 다음과 같다.

  • MrefBuilder는 CCI(Common Compiler Infrastructure)를 사용하여 관리되는 어셈블리에 대해 반사하고 출력 파일을 생성한다.
  • XslTransform은 XML 파일에 XSL 변환을 적용한다.일반적으로 지정된 입력 파일은 MRefBuilder에서 생성된 파일에서 파생된다.
  • 빌드어셈블러는 XML 매니페스트에 정의된 각 항목에 대해 한 번씩 빌드 구성요소 스택을 실행한다.빌드 구성 요소 스택은 확장자가 .config인 XML 파일에 정의된다.샌드캐슬은 빌드 컴포넌트 스택에 사용되는 여러 빌드 컴포넌트를 제공하여 메모리 내 데이터 인덱스 생성, 공유 콘텐츠를 포함한 링크 해결, XSL 변환 실행, 최종 출력물 파일 저장 등의 작업을 수행한다.

커뮤니티 도구

현재 상태의 샌드캐슬은 그 자체로 사용하기에 다소 복잡하기 때문에, 사람들은 그들을 위해 작업을 자동화할 수 있는 도구와 스크립트를 고안해냈다.이 섹션에는 이러한 도구 및 스크립트의 목록이 포함되어 있다.

출력

Sandcastle은 XML 기반 HTML 파일을 선택한 프리젠테이션 스타일로 생산한다. (그러나 이는 파일이 XHTML 호환이라는 의미는 아니다.HTML은 사용 중인 특정 프리젠테이션 스타일에 포함된 XSL 변환 파일로 정의된다.빌드는 일반적으로 한 번에 하나의 프리젠테이션 스타일만 사용한다.

샌드캐슬이 생산하는 HTML 파일은 MAML(Microsoft Assistance Markup Language) 주제에서 변환한 결과물인 개념(사용자) 문서이거나, 반사 데이터와 XML 문서 주석에서 자동으로 생성되는 참조 문서다.이 두 가지 다른 유형의 HTML 출력은 동일한 프리젠테이션 스타일을 공유하며 혼합 사용자/참조 문서를 작성하기 위해 함께 컴파일할 수 있다.

개념 문서와 참조 문서를 작성하는 프로세스는 유사하며, 개념 문서화는 MRefBuilder 프로그램을 사용할 필요가 없다는 것이 주된 차이점이다.

개념 설명서는 방법, 단계별, 문제 해결 등 MAML 문서 유형 스키마를 사용하여 작성한 항목으로 구성된다.샌드캐슬은 공유 콘텐츠와 링크를 해결하는 개념 빌드 컴포넌트 스택(conception.config)을 제공하고, XSL 파일을 활용해 MAML 요소를 HTML로 변환한다.

참조 문서는 반사 데이터와 XML 문서 주석에서 관리되는 API(응용 프로그램 프로그래밍 인터페이스)에 대해 자동으로 생성된다.선택한 프리젠테이션 스타일에 의해 제공되는 "doc model" XSL 변환이 적용되어 생성될 파일을 정의한다.샌드캐슬은 데이터의 인메모리 인덱스를 구축하고 공유 콘텐츠와 링크를 해결하며 XSL을 사용하여 최종 HTML 출력을 생성하는 참조 빌드 구성요소 스택(샌드캐슬.config)을 제공한다.

컴파일된 도움말

샌드캐슬은 컴파일된 도움말 출력 자체를 생산하지 않는다(단, 자신이 생산하는 HTML 파일은 HTML 도움말 워크샵이나 마이크로소프트 도움말 2와 같은 HTML 도움말 컴파일러의 입력으로 사용될 수 있다).

예를 들어 일반적인 도움말 1.x 빌드 프로세스는 MrefBuilder를 실행하는 것으로 시작한다.하나 이상의 어셈블리에 대한 XML 반사 파일을 생성하려면 exe.그런 다음 XslTransform.exe 도구에 의해 반사 파일이 여러 번 처리되어 "doc 모델" 및 선택적 버전 정보와 같은 데이터를 추가하는 다양한 XSL 변환을 적용한다.다음으로 XML 기반 주제 매니페스트가 생성되어 BuildAssemblyler에 의해 사용된다.반영 데이터와 XML 문서 주석에서 HTML 주제 파일을 생성하는 exe 프로그램.XML 기반 TOC(목차) 파일이 생성되어 빌드어셈블러에서 생산한 HTML 파일과 함께 CHMBuilder.exe가 사용하며 HTML 도움말 워크샵 프로젝트, 색인 및 TOC 파일을 생성한다.마지막으로 HTML 도움말 워크샵을 사용하여 컴파일된 도움말 파일(.chm)을 생성한다.

XslTransform 및 BuildAssembly와 같은 일부 도구는 단일 빌드 중에 여러 번 사용된다.요건에 따라, 샌드캐슬의 출력을 수정하기 위해 프로세스 동안 다양한 단계에서 다른 도구와 XSL 변환을 사용할 수 있다.

배경

Sandcastle 애플리케이션은 마이크로소프트가 API 설명서에 사용할 확장 가능하고 성능이 뛰어난 문서 생성기를 만들기 위해 개발했다.[3][4]NDoc, 케빈 다운스의 작가는 이메일 그의 인기 있는 도구 커뮤니티 지원의 부족, 재정적인 측면과 개발 속임수로서 개발을 해지하는 그의 메일링 리스트 이유들을 보내에서 인용된 며칠 전 NDoc 죽은이라 공표되었다 마이크로 소프트 공동체 기술 미리 보기(사이티 딘 삼인산염)버전으로 2006년 7월, 샌드 캐슬을 발표했다.trib그의 공개 이메일 주소와 NDoc2 메일링 리스트 주소에 대한 자동 우편 폭탄 공격, 그리고 샌드캐슬이 "사실상의 표준이 될 것이고 NDoc은 서서히 정체된 사이드워터가 될 것"이라는 그의 인상.

샌드캐슬은 2010년 9월 한 달 동안 하루 평균 217건의 다운로드가 이뤄져 코드플렉스(CodePlex)에서 가장 많이 다운로드된 프로젝트 25위 안에 들었다.

2008년 6월 6일 CodePlex 사이트의 토론 쓰레드가 CodePlex가 이것을 요구하고 SandCastle 프로젝트가 "오픈 소스"[7]로 선전되었음에도 불구하고 소스 코드를 사용할 수 없다는 지적에 따라 SandCastle 프로젝트는 CodePlex 웹사이트에서[6] 삭제되었다.7월 2일 프로젝트는 CodePlex로 돌아왔고 소스 코드가 발행되었다.[8]

역사

  • 2006년 7월 29일 — 2006년 7월 CTP 버전이 출시되었으며, 이 버전은 주로 성능과 확장성에 초점을 맞췄다.GUI가 아직 존재하지 않았으며 응용 프로그램에 GAC DLL을 해결할 수 있는 기능이 아직 포함되어 있지 않다.
  • 2006년 8월 28일 — 2006년 8월 CTP 버전이 출시되었으며, 이 버전에서 고정된 버그는 주로 애플리케이션의 충돌을 수정하기 위한 것으로 보인다.애플리케이션의 HTML 출력은 이제 Firefox와 호환된다.명령줄 인터페이스가 일부 변경되었다.
  • 2006년 10월 1일 — 2006년 9월 CTP 버전이 출시되었으며, 버그 수정은 주로 출력물의 버그를 수정하고 일부 XML 주석 태그에 대한 더 나은 지원을 추가하는 데 초점을 맞춘 것으로 보인다.
  • 2006년 11월 11일 — 2006년 11월 CTP 버전이 출시되었으며, 버그 수정과 함께 지원되는 다른 품목은 몇 개의 nDoc 태그가 있으며, 지원 Firefox도 변환된다.
  • 2006년 12월 10일 — 2006년 12월 CTP 버전이 출시되었으며, 구성 파일에 사용되는 DXROUT 환경 변수, API "리핑" 기능, 패스스루 HTML 및 VS 2005 스타일에서 Firefox에 대한 지원이 포함된 프레젠테이션 업데이트를 제공한다.
  • 2007년 3월 6일 — 2007년 3월 CTP 버전이 출시되어 4개의 XSL 변환을 새로 추가하고 3개의 XSL 변환, 일괄 빌드 스크립트 및 성능 향상을 제거했다.
  • 2007년 3월 17일 — 2007년 3월 CTP Technical Refresh 버전이 출시되었으며, "리핑" 기능과 유틸리티 버그를 수정했으며, 이전에 출시된 설치 프로그램으로부터 누락된 파일을 포함했다.
  • 2007년 6월 19일 — MSBuild 프로젝트, CCI(Common Compiler Infrastructure) 반사 엔진의 새 버전, "VS ORCAS"라는 새로운 프레젠테이션 스타일, 새로운 빌드 구성요소, 새로운 실행 가능한 유틸리티 및 기타 개선 사항을 제공하는 2007년 6월 CTP 버전이 출시되었다.
  • 2007년 6월 27일 — 2007년 6월 CTP Refresh 버전이 출시되었으며, MSDN에서 Orcas 베타 2와 RTM 문서 발송이 VS 2005 프리젠테이션 스타일로 계속 구축될 예정이었기 때문에 혼란을 방지하기 위해 이전에 출시된 "VS ORCAS" 프리젠테이션 스타일의 이름을 "하나"로 변경하였다.
  • 2007년 10월 1일 - CHMBuilder, VersionBuilder 및 DBCSFix 도구가 처음 등장하고 Windows PowerShell 빌드 스크립트, 프레젠테이션 스타일 업데이트(대부분 특히 VS 2005 스타일)가 없는 2007년 9월 CTP 버전이 출시되었다.일반적으로 이전 설치 프로그램에 포함되었던 NET Framework 반영 파일.
  • 2007년 10월 30일 — 를 포함한 2007년 10월 CTP 버전이 출시되었다.이전 릴리스에서 누락된 NET Framework 파일, Microsoft MAML(지원 마크업 언어) 주제가 입력되어야 하는 새로운 개념 문서 작성 프로세스 및 Firefox 지원도 개선되었다.
  • 2008년 1월 16일 — Sandcastle 2.4.10115 버전이 출시되었으며, 웹(RTW)에 공개된 최초의 공식 비 CTP 버전이다.스크립트#에 대한 XSL 변환 및 ASP 출력 옵션을 포함한 그래픽 사용자 인터페이스(GUI)의 예가 제공되었다.NET 웹 사이트.

참고 항목

참조

  1. ^ 샌드캐슬 도움말
  2. ^ 샌드캐슬 발표: 샌드캐슬 블로그
  3. ^ Sandcastle – NDoc이 사망함에 따라 도움말 CHM 파일 생성기의 Microsoft CTP
  4. ^ NDOC 2는 공식적으로 사망함
  5. ^ 샌드캐슬 통계
  6. ^ Codeplex에서 Sandcastle 프로젝트 제거
  7. ^ "Sandcastle 'open source'?". Retrieved 2008-07-02.
  8. ^ "Sandcastle Source Code published in Codeplex". 2008-07-02. Retrieved 2008-07-02.

외부 링크