도움말 파일을 제공하는 플러그인에서는 일반적으로 다음과 같은 작업을 수행합니다.
선택적으로 첫 번째 검색 시도의 성능을 위해 index
요소를 사용하여 검색 색인을 사전 빌드하고 등록할 수 있습니다.
플러그인당 하나의 색인만 등록할 수 있습니다. 복수 index
요소는 정의되지 않은 동작을 가져옵니다.
<!ELEMENT extension (toc* , index?)>
<!ATTLIST extension
point CDATA #REQUIRED
id CDATA #IMPLIED
name CDATA #IMPLIED>
<!ELEMENT toc EMPTY>
<!ATTLIST toc
file CDATA #REQUIRED
primary (true | false) "false"
extradir CDATA #IMPLIED>
목차 파일의 구성 마크업:
<!ELEMENT toc (topic | anchor | link)* >
<!ATTLIST toc link_to CDATA #IMPLIED >
<!ATTLIST toc label CDATA #REQUIRED >
<!ATTLIST toc topic CDATA #IMPLIED >
<!ELEMENT topic (topic | anchor | link )*
>
<!ATTLIST topic label CDATA #REQUIRED >
<!ATTLIST topic href CDATA #IMPLIED >
<!ELEMENT anchor EMPTY >
<!ATTLIST anchor id ID #REQUIRED >
<!ELEMENT link EMPTY >
<!ATTLIST link toc CDATA #REQUIRED >
일반적으로 온라인 도움말을 제공해야 하는 플러그인은 자체 TOC 파일을 정의합니다. 결국 도움말 시스템은 일부 조치로 실행하도록 구성되며 이를 위해 TOC 파일의 경로를 사용할 수 있습니다.
주제 요소
모든 도움말 항목 요소는 목차 컨테이너 요소의 일부로 제공됩니다. 모든 주제가 계층 구조를 갖거나 일반 목록으로 나열할 수 있습니다.
주제 요소는 목차 구조의 중요 항목입니다. 주제 요소에 대한 일반적인 용도 두 가지는 다음과 같습니다.
1. 대개 HTML 파일인 문서 파일에 링크 제공
2. 같은 Manifest 또는 다른 Manifest에서 다른 toc에 대한 컨테이너 역할
1. 링크로서의 주제
문서 파일 링크는 주제를 가장 간단히 사용한 예입니다.
<topic label="Some concept file" href="concepts/some_file.html" />
href 속성은 Manifest 파일이 속하는 플러그인에 관련된 것입니다. 다른 플러그인에서 파일에 액세스해야 할 경우 다음 구문을 사용할 수 있습니다.
<topic label="topic in another plug-in" href="../other.plugin.id/concepts/some_other_file.html" />
2. 컨테이너로서의 주제
주제의 가장 일반적인 두 번째 용도는 다른 목차의 컨테이너로 사용하는 것입니다.
컨테이너 주제는 항상 특정 파일도 참조할 수 있습니다.
<topic label="Integrated Development Environment" href="concepts/ciover.htm"
>
<topic label="Starting the IDE" href="concepts/blah.htm"
/>
...
</topic>
링크 요소
링크 요소를 사용하여 다른 목차 파일에 정의된 목차에 연결할 수 있습니다. 목차 속성에 지정된 목차 파일의 모든 주제는 링크 요소 대신 직접 정의된 것처럼 목차에 나타납니다. api.xml 파일에서 목차를 포함하려면 다음을 작성하십시오.
<topic label="References" >
...
<link toc="api.xml" />
...
</topic>
앵커 요소
앵커 요소는 다른 목차 파일을 이 탐색에 링크하고 링크 요소를 사용하거나 여기서 다른 목차 파일을 참조하지 않고 확장할 수 있는 지점을 정의합니다. "ZZZ" 문서 뒤에 더 많은 주제를 가진 목차를 삽입하려면 다음과 같이 앵커를 정의하십시오.
...
<topic label="zzz" href="zzz.html" />
<anchor id="moreapi" />
...
목차 요소
목차 요소는 이 파일에 정의된 주제 및 기타 요소를 그룹화하는 목차입니다. 레이블은 목차가 사용자에게 표시될 때 사용자에게 목차를 식별해 줍니다. 선택적 주제 속성은 목차를 설명하는 주제 파일의 경로입니다. 선택적 link_to 속성은 탐색 계층 구조에서 이 파일의 목차를 상위의 목차 파일에 링크하도록 허용합니다. link_to 속성의 값은 다른 목차 파일의 앵커를 지정해야 합니다. myapi.xml 파일의 목차를 다른 플러그인에서 지정된 api.xml 파일에 링크하려면 다음 구문을 사용하십시오.
<toc link_to="../anotherPlugin/api.xml#moreapi" label="My Tool
API"/>
...
<toc />
# 문자는 앵커 ID에서 목차 파일 이름을 분리합니다.
<!ELEMENT index EMPTY>
<!ATTLIST index
path CDATA #REQUIRED>
(3.1 이후) 이 플러그인이 제공하는 문서에서 작성되는 사전 빌드된 검색 색인의 선언을 허용하는 선택적 요소입니다.
index/
, nl/ja/JP/index/
, nl/en/US/index/
등).(plugin.xml 파일의 경우)
<extension point=
"org.eclipse.help.toc"
>
<toc file=
"maindocs.html"
primary=
"true"
/>
<toc file=
"task.xml"
/>
<toc file=
"sample.xml"
extradir=
"samples"
/>
<index path=
"index/"
/>
</extension>
(maindocs.xml 파일의 경우)
<toc label="Help System Example">
<topic label="Introduction" href="intro.html"/>
<topic label="Tasks">
<topic label="Creating a Project" href="tasks/task1.html">
<topic label="Creating a Web Project" href="tasks/task11.html"/>
<topic label="Creating a Java Project" href="tasks/task12.html"/>
</topic>
<link toc="task.xml" />
<topic label="Testing a Project" href="tasks/taskn.html"/>
</topic>
<topic label="Samples">
<topic label="Creating Java Project" href="samples/sample1.html">
<topic label="Launch a Wizard" href="samples/sample11.html"/>
<topic label="Set Options" href="samples/sample12.html"/>
<topic label="Finish Creating Project" href="samples/sample13.html"/>
</topic>
<anchor id="samples" />
</topic>
</toc>
(tasks.xml 파일의 경우)
<toc label="Building a Project">
<topic label="Building a Project" href="build/building.html">
<topic label="Building a Web Project" href="build/web.html"/>
<topic label="Building a Java Project" href="build/java.html"/>
</topic>
</toc>
(samples.xml 파일의 경우)
<toc link_to="maindocs.xml#samples" label="Using The Compile Tool">
<topic label="The Compile Tool Sample" href="compilesample/example.html">
<topic label="Step 1" href="compilesample/step1.html"/>
<topic label="Step 2" href="compilesample/step2.html"/>
<topic label="Step 3" href="compilesample/step3.html"/>
<topic label="Step 4" href="compilesample/step4.html"/>
</topic>
</toc>
"samples"로 시작하는 경로를 사용하는 다른 문서가 있을 경우 탐색 트리에는 표시되지 않지만 검색을 사용하여 이 문서에 액세스할 수 있습니다. 이는 plugin.xml 파일의 <toc file="sample.xml" extradir="samples" /> 요소에 "extradir" 속성이 있기 때문입니다. 예를 들어, "Creating Java Project"를 검색할 경우 경로가 samples/sample2.html인 "Other Ways of Creating Java Project" 문서를 리턴할 수 있습니다.
국제화 TOC XML 파일을 변환할 수 있고 그 결과 사본(변환된 레이블이 있음)은 nl/<language>/<country> 또는 nl/<language> 디렉토리에 있어야 합니다. <language> 및 <country>는 로케일 코드에서 사용된 두 문자의 언어 및 국가 코드를 나타냅니다. 예를 들어, 대만어 변환은 nl/zh/TW 디렉토리에 저장되어야 합니다. nl/<language>/<country> 디렉토리가 nl/<language> 보다 우선순위가 높습니다. nl/<language>/<country>에 파일이 없는 경우에만 nl/<language>에 있는 파일이 사용됩니다. 플러그인의 루트 디렉토리는 맨 마지막에 검색됩니다.
doc.zip에 포함된 문서는 변환된 버전의 문서와 함께 doc.zip 파일을
작성하고 doc.zip을
nl/<language>/<country> 또는 nl/<language>
디렉토리에 저장하여 지역화할 수 있습니다. 도움말 시스템은 이 디렉토리에서
파일을 찾은 후 플러그인 디렉토리를 기본 디렉토리로 지정합니다.
Copyright (c) 2000, 2005 IBM Corporation and others.
All rights reserved. 본 프로그램 및 본 프로그램에 동봉되는 자료는 본 배포물에 동봉되는 Eclipse Public License v1.0의 조항에 따라 사용해야 하며
웹 사이트(http://www.eclipse.org/legal/epl-v10.html)에서도 관련 사항을 참조할 수 있습니다.