도움말 서버 및 파일 위치

플랫폼은 고유 문서 서버를 사용하여 플러그인의 문서에 실제 웹 페이지를 제공합니다. 사용자 정의 서버는 플랫폼이 브라우저에 종속되지 않고 HTML 컨텐츠를 처리하여 플러그인 인식 지원을 제공할 수 있도록 합니다. 플러그인 개발자로서 느낄 수 있는 주요 차이점은 파일을 구성하고 링크를 지정하는 방법에 있어 보다 많은 유연성을 갖게 된다는 점입니다.

문서 플러그인은 jar 파일을 통해 실행하거나 설치 중 플러그인 디렉토리로 언팩할 수 있습니다. 플러그인 아카이브 jar은 plugin 요소의 unpack 속성 값이 기능 Manifest에 true로 지정되면 플러그인 디렉토리로 확장되지 않습니다. 이러한 플러그인에서 문서는 다른 플러그인 파일과 함께 플러그인의 jar 형식으로 압축됩니다.

언팩되어 실행되는 플러그인에서는 문서를 zip 파일로 전달할 수 있으므로 플러그인 디렉토리에 파일이 많을 때 발생할 수 있는 문제점을 방지할 수 있습니다. 플러그인 예제에서 html이라는 서브디렉토리를 작성했습니다. 대신, HTML 파일을 doc.zip이라는 zip 파일로 배치할 수도 있었습니다. 이 zip 파일은 플러그인 디렉토리 아래의 파일 구조를 모방해야 합니다. 이 경우에는 html이라는 서브디렉토리와 html 아래의 모든 컨텐츠가 포함되어 있어야 합니다.

jar을 통해 실행되는 플러그인의 경우, doc.zip에 문서를 포함할 필요가 없으므로, 압축을 풀지 않은 플러그인 jar의 해당 doc.zip 설정은 도움말 시스템에서 지원되지 않습니다.

언팩 상태로 실행되는 플러그인에서 파일 이름을 분석할 때, 도움말 서버는 플러그인 디렉토리 자체에서 찾기 전에 doc.zip 파일에서 문서를 찾습니다. 링크로 사용될 때 href에 있는 인수는 현재 플러그인과 관련이 있는 것으로 가정합니다. 다음 링크를 고려해 보십시오.

   <topic label="Ref1" href="html/ref/ref1.html"/>

도움말 플러그인에서는 다음과 같이 이 파일을 찾습니다.

완전한 링크를 사용하여 웹에서 컨텐츠를 참조할 수 있습니다. 

   <topic label="Ref1" href="http://www.example.com/myReference.html"/>

자국어 및 변환된 문서

플랫폼 도움말 시스템에서는 변환된 파일을 찾기 위해 나머지 플랫폼에서 사용한 동일한 자국어 디렉토리 찾아보기 설계를 사용합니다. 이 디렉토리 구조에 대한 설명은 로케일 특정 파일을 참조하십시오. doc.zip 파일을 사용 중인 경우 로케일에 대해 doc.zip 파일을 생성하고 이 파일을 올바른 로케일 디렉토리에 배치해야 합니다.  (doc.zip 파일 내에 nl 로케일 디렉토리 구조를 복제해서는 안됩니다.)

로케일 특정 디렉토리 외에도, 도움말 시스템은 도움말 자원을 찾을 때 윈도윙 시스템과 운영 체제 디렉토리를 확인합니다. 찾아보기는 자원을 찾을 때까지 ws, os, nl 서브디렉토리, 플러그인의 루트 순서로 수행됩니다. 문서와 기타 자원(시스템마다 다른 이미지와 같은)은 특정 플랫폼의 경우 ws 또는 os 디렉토리에 두어야 합니다.

상호 플러그인 참조

href 인수는 다른 플러그인의 컨텐츠를 참조할 수도 있습니다. 도움말 서버에서 분석한 특수한 상호 플러그인 참조 표기법을 사용하여 수행합니다.

   <topic label="Ref1" href="../"another_plugin_id"/ref/ref1.html"/>

예를 들어, 다음 주제를 사용하여 프로그래머 안내서의 본 장으로 링크할 수 있습니다.

   <topic label="Help Chapter in Platform Doc" href="../org.eclipse.platform.doc.isv/guide/help.html"/>

참고: 다른 플러그인의 컨텐츠를 참조할 경우 플러그인의 디렉토리 이름이 아니라 plugin.xml 파일에 선언된 플러그인의 ID를 사용하십시오. 실제로 이 둘은 대개 동일하지만 디렉토리 이름이 아니라 ID를 사용하는지 확인해야 합니다.

제품 플러그인 참조

브랜딩 정보는 종종 제품 정의에 설명된 대로 제품을 정의하는 플러그인에 위치됩니다. 제품 플러그인의 도움말 자원은 플러그인 ID로 특수 ID "PRODUCT_PLUGIN"을 사용하여 목차나 주제에서 참조할 수 있습니다. 예:

   href="../PRODUCT_PLUGIN/book.css"

위의 예제는 현재 실행 중인 제품의 플러그인에 상주하는 스타일시트를 참조합니다.