독립형 도움말 시스템 설치

Eclipse 프레임워크를 기반으로 하지 않는 응용프로그램을 작성 중인 경우에도 Eclipse 도움말 시스템을 사용할 수 있습니다. 응용프로그램은 제거된 도움말 시스템을 제외한 모든 시스템을 포함하는 소형 Eclipse 버전인 독립형 도움말 시스템을 패키지 및 설치할 수 있습니다. 그 다음 응용프로그램은 도움말 메뉴 또는 UI 오브젝트에서 API 호출을 작성하여 도움말 브라우저를 실행할 수 있습니다. 독립형 도움말 시스템에는 정보 팝업과 활성 도움말을 제외한 통합 도움말 시스템의 모든 기능이 있습니다. 응용프로그램이 Java 기반이 아니거나 응용프로그램이 실행 중이 아닐 때 도움말이 필요한 경우에는 시스템 쉘에서 독립형 도움말을 사용하거나 쉘 스크립트 또는 데스크탑 바로 가기를 사용할 수 있으며 Java API를 호출하는 대신에 명령행 옵션을 제공할 수 있습니다.

독립형 도움말 시스템에서는 도움말 시스템의 다양한 측면을 사용자 정의하는 데 사용할 수 있는 많은 옵션의 전달이 가능합니다. 다음 옵션이 지원됩니다.

설치/패키징

이 단계는 도움말 시스템 통합자를 위한 것이며 가능한 모든 시나리오를 설명하지는 않습니다. 모든 문서는 Eclipse 플러그인으로 전달되고 일반적으로 사용자가 Eclipse 도움말 시스템에 익숙한 것으로 가정합니다.
  1. www.eclipse.org에서 Eclipse Platform Runtime Binary 드라이버를 다운로드하십시오.
  2. 드라이버를 응용프로그램 디렉토리(예:d:\myApp)에 설치(압축 풀기)하십시오. 그러면 Eclipse 플랫폼(도움말 시스템 포함)에 필요한 코드를 포함하는 Eclipse 서브디렉토리인 d:\myApp\eclipse가 작성됩니다.

Java에서 도움말 클래스를 호출하는 방법

  1. d:\myApp\eclipse\plugins\org.eclipse.help.base_3.1.0.jar이 app 클래스 경로에 있는지 확인하십시오. 도움말 시스템을 시작, 실행 및 종료하기 위해 사용하는 클래스는 org.eclipse.help.standalone.Help입니다.
  2. 도움말 시스템 지원에 전달할 옵션을 포함하는 문자열의 배열을 작성하십시오. 일반적으로, eclipsehome 옵션이 필요합니다.
    String[] options = new String[] { "-eclipsehome", "d:\\myApp\\eclipse" }; 
  3. 응용프로그램에서 옵션을 전달하여 도움말 클래스의 인스턴스를 작성하십시오. 이 오브젝트는 응용프로그램 종료 시까지 유지해야 합니다.
    Help helpSystem = new Help(options); 
  4. 도움말 시스템을 시작하려면 다음을 수행하십시오.
    helpSystem.start(); 
  5. 필요할 때 도움말을 호출하려면 다음을 수행하십시오.
    helpSystem.displayHelp(); 

    특정 기본 TOC 파일이나 주제에서 도움말을 호출할 수도 있습니다.

    helpSystem.displayHelp("/com.mycompany.mytool.doc/toc.xml");
    helpSystem.displayHelp("/com.mycompany.mytool.doc/tasks/task1.htm");
  6. 컨텍스트 도움말을 실행하려면 helpSystem.displayContext(contextId, x, y)를 호출하십시오. 여기에서 contextId는 완전한 컨텍스트 ID입니다. 화면 좌표 x와 y는 현재 사용되지 않습니다.
  7. 응용프로그램 종료 시 도움말 시스템을 종료하십시오.

    helpSystem.shutdown(); 

명령행에서 도움말을 호출하는 방법

org.eclipse.help.standalone.Help 클래스에는 명령행에서 독립형 도움말을 실행할 때 사용할 수 있는 주 메소드가 있습니다. 명령행 인수 구문은 다음과 같습니다.

-command start | shutdown | (displayHelp [href]) [-eclipsehome eclipseInstallPath] [-data instanceArea] [-host helpServerHost] [-port helpServerPort] [-dir rtl] [platform options] [-vmargs JavaVMarguments]

도움말을 표시하려면 다음을 호출하십시오.

java -classpath d:\myApp\eclipse\plugins\org.eclipse.help.base_3.1.0.jar org.eclipse.help.standalone.Help -command displayHelp

특정한 TOC 파일이나 주제를 표시하려면 다음을 사용하십시오.

java -classpath d:\myApp\eclipse\plugins\org.eclipse.help.base_3.1.0.jar org.eclipse.help.standalone.Help -command displayHelp /com.mycompany.mytool.doc/tasks/task1.htm

도움말을 표시하기 위해 위의 호출을 하면 도움말 시스템이 시작되어 도움말을 표시하고 명령이 실행된 후 사용자가 계속 도움말을 찾아볼 수 있도록 계속 실행됩니다. 도움말 시스템의 라이프 사이클을 제어하려면 displayHelp 명령뿐 아니라 시작 및 시스템 종료 명령을 사용하십시오. 예를 들어, 다음을 호출할 수 있습니다.

java -classpath d:\myApp\eclipse\plugins\org.eclipse.help.base_3.1.0.jar org.eclipse.help.standalone.Help -command start

[선택적] 최소한의 플러그인 세트 설치

독립형 도움말은 Eclipse 플랫폼 패키지 전체를 필요로 하지 않습니다. 다음 플러그인(eclipse\plugins 디렉토리에 있는)을 사용하여 독립형 도움말을 실행할 수 있습니다.

org.apache.lucene
org.eclipse.core.runtime
org.eclipse.help
org.eclipse.help.appserver
org.eclipse.help.base
org.eclipse.help.webapp
org.eclipse.osgi
org.eclipse.tomcat
org.eclipse.update.configurator

Windows 및 Linux에서 브라우저를 지원하려면, 최소 구성 맨 위에 다음 플러그인 및 단편이 필요합니다. Windows의 경우 SWT 내장 Internet Explorer, Linux의 경우, Mozilla 또는 Windows의 경우 독립형 시스템 브라우저가 필요합니다.

org.eclipse.core.expressions
org.eclipse.help.ui
org.eclipse.jface
org.eclipse.swt
org.eclipse.swt.win32 or org.eclipse.swt.gtk
org.eclipse.ui
org.eclipse.ui.workbench

일부 문서 플러그인은 대개 plugin.xml에 필수 플러그인을 지정하여 다른 플러그인에 대한 종속성을 가질 수 있습니다. 종속 플러그인은 Information Center에도 설치되어야 합니다. 또한, Eclipse의 3.0 이전 버전에 맞게 설계된 플러그인은 작동하기 위해 암시적으로 org.eclipse.core.runtime.compatibility가 플러그인에 존재해야 합니다.

도움말 시스템 사용자 정의에 관한 자세한 내용은 도움말 시스템 환경 설정을 참조하십시오.

org.eclipse.help.base preferences