강좌/Help File 제작2010. 3. 23. 10:47

하나의 요리를 완성하기 위해 준비한 식재료들을 한데 모아 조리해야 하는 것처럼 HTML Help 프로젝트를 모두 구성한 다음 완성된 HTML Help를 얻으려면 컴파일 과정을 거쳐야 한다.

컴파일은 작업자가 직접 관여할 수 없는 과정이기 때문에 전문 저작 프로그램을 사용하여 HTML Help를 컴파일해야 한다. 이번 시간에는 HTML Help Workshop을 이용하여 지금까지 작업한 파일들을 컴파일하고 테스트하는 방법에 대해 살펴보겠다.


프로젝트 컴파일하기
이미 토픽 파일들(*.html)과 프로젝트 파일(*.hhp), 목차 파일(*.hhc), 색인 파일(*.hhk) 등이 완성되어 있다면 바로 컴파일하여 HTML Help를 만들 수 있다. 하지만 자신이 원하는 결과물을 얻기 위해서는 컴파일 과정에 앞서 관련 옵션 설정이 제대로 되어 있는지 확인해 두는 것이 좋다. 기본적인 옵션에 대한 설정은 Project 탭에서 Change project options 단추를 누르면 나타나는 Options 대화 상자와 Add/Modify window definitions 단추를 누르면 나타나는 Window Types 대화 상자에서 확인할 수 있다.
  • 각 탭에 대한 설정을 확인한다.Options 대화 상자의 Files 탭과 Window Types 대화 상자의 Files 탭에서 HTML Help의 목차 파일과 색인 파일이 제대로 연결되어 있는지 확인한다. 그리고 Window Types 대화 상자의 Navigation Pane 탭에서 검색 탭과 즐겨찾기 탭에 대한 설정을 확인한다. HTML Help에서 검색 기능을 제대로 사용하려면 Options 대화 상자의 Compiler 탭에서 'Compile full-text search infomation'을 선택해야 한다.
  • HTML Help가 생성되는 위치와 파일 이름을 확인한다.Options 대화 상자 Files 탭의 'Compiled file'에 지정된 경로와 파일 이름(*.chm)이 올바른지 확인한다.
  • 윈도우 설정을 확인한다.Options 대화 상자 Default 탭의 'Default window'에서 HTML Help를 표시할 윈도우 이름을 확인한다. 그리고 Window Types 대화 상자의 General 탭과 Navigation Pane 탭을 열어 'Window Type'에 동일한 윈도우 이름이 지정되어 있는지 확인한다.
  • 시작 파일이 제대로 설정되어 있는지 확인한다.시작 파일이란 HTML Help를 실행했을 때 토픽 창에 처음 나타나는 파일을 의미한다. 시작 파일을 별도로 지정하지 않은 경우 Project 탭의 FILES 섹션 가장 위에 있는 파일이 자동으로 지정된다. 시작 파일은 Options 대화 상자 General 탭의 'Default File'과 Window Types 대화 상자 Files 탭의 'Default'에서 확인하거나 변경할 수 있다.
  • 토픽 파일이 모두 추가되어 있는지 확인한다.Project 탭의 FILES 섹션에서 파일 목록을 확인하고 문제가 있다면 도구 막대에서 Add/Remove topic files 단추를 눌러 파일을 추가하거나 삭제한다. 토픽 파일(*.html)에 사용한 스타일 시트(*.css)와 스크립트 파일(*.js), 스타일이나 스크립트를 이용하여 삽입한 그림 파일을 HTML Help에서 제대로 확인하려면 이 파일들도 목록에 추가해야 한다.
위와 같은 컴파일 관련 옵션을 살펴보았다면 다음과 같은 방법으로 프로젝트를 컴파일한다.
  1. HTML Help Workshop에서 컴파일할 프로젝트 파일(*.hhp)을 연다.
  2. 메뉴에서 File > Compile을 선택하거나 Project 탭의 도구 막대에서 Save all files and compile 단추를 누른다.
  3. Create compiled file 대화 상자가 나타나면 프로젝트 파일의 경로를 확인하거나 Browse 단추를 눌러 프로젝트 파일을 선택한다. 컴파일하기 전에 파일을 저장하려면 'Save all files before compiling'을 선택한다.
  4. Compile 단추를 눌러 컴파일을 시작한다. 컴파일 과정 및 결과 메시지가 프로그램 오른쪽 창에 나타난다.
 
<그림 1>정상적으로 컴파일이 진행된 경우   <그림 2>컴파일 중에 오류가 발생한 경우

정상적으로 컴파일된 경우에는 프로그램 오른쪽 창에 <그림 1>과 같이 나타나지만 경우에 따라 <그림 2>와 같이 오류 메시지가 나타나는 경우도 있다. 오류 메시지가 나타나는 경우에는 오류 메시지의 원인을 확인하고 문제를 수정한 뒤 다시 컴파일을 해야 한다. HTML Help Workshop에서 확인할 수 있는 오류 메시지 종류와 원인은 대략 다음과 같다.
   

종류 설명
Note 컴파일된 HTML Help를 실행했을 때 심각한 문제가 발생하지는 않지만 작성자가 알고 있어야 하는 정보를 표시한다. 1000에서 2999에 해당하는 메시지 번호를 갖는다.
Warning HTML Help에 결함이 있는 경우에 나타나며 3000에서 4999에 해당하는 메시지 번호를 갖는다.
Error HTML Help가 빌드될 수 없거나 빌드 중에 문제가 발생했을 때 나타나며 5000에서 6999에 해당하는 메시지 번호를 갖는다. 대표적인 Error 메시지의 종류와 해결 방법은 다음과 같다.
  • HHC5003: Error: Compilation failed while compiling dlg-preview.htm. 메시지에 나타난 파일(예: dlg-preview.htm)이 프로젝트 파일에는 지정되어 있지만 실제 폴더에는 없거나 파일 이름이 프로젝트 파일에 지정된 이름과 다른 경우에 발생한다.
  • HHC5010: Error: Cannot open "c:\Zdnet\GIF-help\namoanigif.chm". Compilation stopped.프로젝트 파일에 지정해 놓은 HTML Help에 접근할 수 없어 컴파일이 중단된 경우 나타난다. 지정해 놓은 이름의 HTML Help(*.chm)가 열려있는지 확인하거나 해당 파일의 속성이 읽기 전용으로 되어 있는지 확인한다.
  • HHC5013: Error: URL reference in the TOC cannot be resolved: "sample.htm".목차 파일에서 연결한 토픽 파일이 실제 폴더에 없거나 파일 이름이 목차 파일에 지정된 이름과 다른 경우에 발생한다.
Internal Error HTML Help Workshop 프로그램의 내부 오류로 인해 나타나며 7000번 이상의 메시지 번호를 갖는다.


HTML Help 테스트하기
컴파일이 완료되었으면 작업 폴더에서 생성된 HTML Help(*.chm)를 직접 더블 클릭하여 실행하거나 HTML Help Workshop의 도구 막대에서 View compiled file 단추를 눌러 확인한다. 프로젝트가 성공적으로 컴파일되었으면 <그림 3>과 같은 HTML Help가 실행될 것이다.

<그림 3>컴파일된 HTML Help

실행된 HTML Help에서 모든 기능이 제대로 작동하는지 확인해 본다. 특히 HTML Help를 단순한 자료 백업이나 개인 용도가 아닌 소프트웨어의 도움말로서 제공할 목적이라면 테스트 가이드라인을 구체적으로 정리하여 꼼꼼하게 테스트해야 한다.
  • 내비게이션 창에 각 탭이 제대로 나타나는지 확인한다.
  • 목차 탭에서 각 목차 항목에 대한 토픽이 토픽 창에 제대로 나타나는지 확인한다.
  • 색인 탭에서 선택한 키워드에 대한 토픽이 토픽 창에 나타나는지 확인한다.
  • 검색 탭에서 검색이 제대로 되는지 확인한다.
  • 도구 모음의 버튼이 제대로 실행되는지 확인한다.
  • 각 토픽 파일에 삽입한 하이퍼링크가 제대로 작동하는지 확인한다.
  • 토픽 파일에 스타일이나 스크립트, 그림 등이 제대로 나타나는지 확인한다.
  • 토픽 파일에서 맞춤법이나 표현이 올바른지 확인한다.
이번 시간에는 프로젝트를 컴파일하고 테스트하는 방법에 대해서 살펴보았다. 지금까지의 작업 과정에서는 대부분 프로그램의 기본 설정을 사용했기 때문에 원하는 것과 다른 형태의 HTML Help가 만들어졌을 수도 있다. 따라서 다음 시간에는 작업자의 취향이나 목적에 맞는 HTML Help를 만들 수 있도록 HTML Help Workshop에서 관련 옵션을 설정하는 방법과 완성된 HTML Help를 디컴파일하는 방법에 대해서 살펴보겠다.


출처 : 김유진 ( (주)세중 나모 인터랙티브 개발본부 )



Posted by 쿵캉켕