도움말 시스템을 InfoCenter로 설치

서버에 InfoCenter 및 문서 플러그인을 설치하여 사용자가 인터넷 또는 인트라넷으로 도움말 시스템에 액세스하도록 허용할 수 있습니다. 클라이언트는 URL을 호출하여 도움말을 보고 도움말 시스템이 해당 웹 브라우저에 표시됩니다. InfoCenter 도움말 시스템은 클라이언트 응용프로그램과 웹 응용프로그램 모두에 사용될 수 있으며 원격으로 이들 응용프로그램의 도움말에 액세스할 수 있습니다. 정보 팝업 및 활성 도움말을 제외한 도움말 시스템의 모든 기능이 지원됩니다.

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

설치/패키징

이 단계는 도움말 시스템 통합자를 위한 것이며 가능한 모든 시나리오를 설명하지는 않습니다. 모든 문서는 Eclipse 플러그인으로 전달되고 일반적으로 사용자가 Eclipse 도움말 시스템에 익숙한 것으로 가정합니다.

  1. www.eclipse.org에서 Eclipse Platform Runtime Binary 드라이버를 다운로드하십시오.
  2. 드라이버를 d:\myApp 디렉토리에 설치(압축 풀기)하십시오. 그러면 Eclipse 플랫폼(도움말 시스템 포함)에 필요한 코드를 포함하는 Eclipse 서브디렉토리인 d:\myApp\eclipse가 작성됩니다.

명령행에서 InfoCenter를 시작 또는 중지하는 방법

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

-command start | shutdown | [-eclipsehome eclipseInstallPath] [-data instanceArea] [-host helpServerHost] [-locales localeList] [-port helpServerPort] [-dir rtl] [-noexec] [platform options] [-vmargs JavaVMarguments]

포트 8081에서 InfoCenter를 시작하려면 다음 명령을 실행하여 시작 명령을 발행하십시오.

java -classpath d:\myApp\eclipse\plugins\org.eclipse.help.base_3.1.0.jar org.eclipse.help.standalone.Infocenter -command start -eclipsehome d:\myApp\eclipse -port 8081

InfoCenter를 종료하려면 다음 명령을 실행하여 시스템 종료 명령을 발행하십시오.

java -classpath d:\myApp\eclipse\plugins\org.eclipse.help.base_3.1.0.jar org.eclipse.help.standalone.Infocenter -command shutdown -eclipsehome d:\myApp\eclipse

InfoCenter 사용

웹 서버를 시작하십시오. InfoCenter를 시작할 때 지정된 포트에서 실행 중인 경로 "help" 웹 응용프로그램에 웹 브라우저를 지정하십시오. InfoCenter가 설치된 시스템에서 이 경로는 http://localhost:8081/help/입니다.

Java에서 InfoCenter를 시작 또는 중지하는 방법

다른 응용프로그램에 InfoCenter를 포함시킬 경우에는 시스템 명령 대신에 Java API를 사용하여 InfoCenter를 시작하고 중지하는 것이 간편할 수 있습니다. 이런 경우에는 다음 단계를 수행하십시오.

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

    helpSystem.shutdown(); 

웹에서 InfoCenter 사용

Eclipse에는 완전한 InfoCenter가 들어 있으므로 다른 서버 소프트웨어가 실행될 필요가 없습니다. 하지만 인터넷 같이 안전하지 않은 환경에서는 클라이언트에서 직접 InfoCenter에 액세스하지 않고 HTTP 서버나 Application Server를 통해 InfoCenter를 사용하도록 하는 것이 좋습니다. 대부분의 서버에는 특정한 요청을 다른 웹 자원에 위임하는 데 사용할 수 있는 모듈이나 Servlet이 있습니다. 예를 들어, Apache HTTP 서버의 프록시 모듈을 구성하여 http://mycompany.com/myproduct/infocenter에 대한 요청의 경로를 InfoCenter를 실행하는 http://internalserver:8081/help로 재지정할 수 있습니다. 이렇게 하려면 mycompany 웹 사이트를 실행 중인 Apache 서버의 conf/httpd.conf 파일에 다음 행을 추가하십시오.

LoadModule proxy_module modules/ApacheModuleProxy.dll
ProxyPass /myproduct/infocenter http://internalserver:8081/help
ProxyPassReverse /myproduct/infocenter http://internalserver:8081/help

Apache HTTP Server의 일부 버전에는 구성 파일에 사용 가능한 AddDefaultCharset 지시문이 들어 있을 수 있습니다. 해당 지시문을 제거하십시오.

AddDefaultCharset Off

또는 앞의 지시문으로 바꾸어 브라우저에서 올바른 문자 세트를 사용하는 문서를 표시하도록 하십시오.

InfoCenter의 복수 인스턴스 실행

InfoCenter의 복수 인스턴스는 한 번의 설치를 통해 시스템에서 실행될 수 있습니다. 시작된 각 인스턴스에서는 소유 포트를 사용하고 작업공간과 함께 제공되어야 하므로 -port-data 옵션이 지정되어야 합니다. 이러한 인스턴스에서는 -configuration 옵션을 사용하여 올바른 플랫폼 구성을 제공하여 여러 플러그인 세트에서 문서를 제공할 수 있습니다.

-configuration을 사용하지 않고 로케일 세트가 겹쳐 있는 복수 InfoCenter 인스턴스에서 구성 디렉토리를 공유하는 경우 다른 인스턴스를 시작하기 전에 모든 검색 색인이 하나의 InfoCenter 인스턴스에서 작성되었는지 확인해야 합니다. 이러한 색인은 구성 디렉토리에 저장되지만 쓰기 액세스는 Infocenter 프로세스에서 동기화되지 않습니다.

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

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

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

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

Information Center 플러그인은 명령행에서 실행 중인 Information Center 갱신 주제를 사용하여 Information Center를 다시 시작하지 않고 갱신할 수 있습니다. 이 기능을 사용하려면 플러그인의 최소 세트가 org.eclipse.update.core 플러그인을 포함해야 합니다.

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