문서 플러그인 작성(더 이상 사용되지 않음)

위젯 사용자에게 도움말 파일을 제공할 수 있습니다. 이 파일은 어디에나 배치할 수 있지만 도움말 내에 통합하려는 경우 문서 플러그인을 작성해야 합니다.

1. 플러그인 컨텐츠가 포함될 폴더를 작성하고 플러그인의 이름과 일치하도록 폴더의 이름을 지정하십시오. 플러그인의 이름은 .doc로 끝나야 하며 버전 번호를 포함할 수 있습니다. 예를 들어 com.ibm.wbpm.bspace.main.doc_7.5.0입니다.
   팁: 플러그인 폴더 이름의 끝에 버전 번호를 추가하여 플러그인을 더 쉽게 업데이트할 수 있도록 하십시오. 도움말 시스템은 기본 이름이 동일한 플러그인을 발견할 때 버전 번호를 비교하며 최상위 버전을 가지고 있는 플러그인의 컨텐츠만 표시합니다.
2. plugin.xml 파일을 작성하여 플러그인을 정의하십시오. plugin 및 toc 요소의 속성을 설정하십시오. plugin 요소에서 name 속성은 도움말 시스템이 사용자에게 표시하는 텍스트입니다. toc 요소에서 file 속성은 탐색 구조를 포함하는 파일을 식별합니다.
   도움말에서 사용되는 속성 및 요소의 DTD는 다음과 같습니다.

   <!ELEMENT plugin (extension*)>
   <!ATTLIST plugin
     name               CDATA #REQUIRED
     id                 CDATA #REQUIRED
     version            CDATA #REQUIRED 
   >
   
   <!ELEMENT extension ANY> 
   <!ATTLIST extension point              CDATA #REQUIRED 
    >

3. 탐색 파일을 작성하고 일치하도록 이름을 지정하십시오. 파일의 이름은 plugin.xml 파일의 file 속성과 일치해야 합니다.
4. 탐색 파일에서 topic 요소를 사용하여 탐색 구조를 작성하십시오. 다음 예제는 프레임워크 컨텐츠 플러그인에 대한 탐색의 일부입니다.

   <?xml version="1.0" encoding="utf-8"?>
   <?NLS TYPE="org.eclipse.help.toc"?>
   <!--  Copyright IBM Corporation 2011-->
   <toc label="Business Space powered by WebSphere" topic="concepts/bspace_concepts_main.html">
      <topic label="Business Space overview" href="concepts/bspace_concepts_main.html">
         <topic label="Business spaces" href="concepts/bspace_concepts_openbspace.html"/>
         <topic label="Widgets" href="concepts/bspace_concepts_widgets.html"/>
         <topic label="Showcases" href="concepts/bspace_concepts_showcases.html"/>
      </topic>
   </toc>

5. 컨텐츠 파일을 plugin.xml 및 탐색 파일과 동일한 폴더에 복사하십시오.
6. 컨텐츠 파일을 doc.zip 파일로 압축하십시오. 압축된 파일의 이름은 doc.zip으로 지정해야 합니다. 도움말 시스템은 이름이 다른 파일에 포함된 컨텐츠를 읽을 수 없습니다.
7. 추가 언어를 지원하려면 NL 단편을 작성하십시오. NL 단편은 기본 플러그인 세트의 파일에 해당하는 번역 파일을 포함하는 플러그인 세트입니다.
   1. 단편 폴더를 작성하고 문서 플러그인과 일치하도록 이름을 바꾼 다음 이름의 끝에 .nl을 추가하십시오. 예: com.ibm.wbpm.bspace.main.doc.nl.
   2. nl 폴더를 추가한 다음 지원하는 각 언어에 대해 해당 언어의 코드가 있는 서브폴더를 작성하십시오.
   3. 각 언어 서브폴더 내에서 탐색 파일의 번역 버전을 작성하고 번역된 컨텐츠 파일을 doc.zip 파일로 압축하십시오. 번역 파일이 doc.zip에 없는 경우 기본적으로 영어 파일이 표시됩니다.
   4. 단편 플러그인의 루트에서 fragment.xml 파일을 추가하십시오. fragment.xml 파일의 DTD는 다음과 같습니다.

      <?xml encoding="US-ASCII"?> 
      <!ELEMENT fragment>
      <!ATTLIST fragment
        name                CDATA #REQUIRED
        id                  CDATA #REQUIRED
        version             CDATA #REQUIRED
        plugin-id           CDATA #REQUIRED
        plugin-version      CDATA #REQUIRED
      >

      이제 NL 단편 폴더에는 fragment.xml 파일과 nl 폴더가 있습니다. nl 폴더에는 번역된 TOC 파일과, 번역 파일이 포함된 doc.zip을 포함하는 각 지원 언어 폴더가 있습니다.
8. 기존 문서 플러그인을 업데이트하는 중이고 해당 이름에 버전이 추가되지 않은 경우에는 도움말 캐시를 지우십시오.
   1. 서버를 중지하십시오.
   2. profile_root\temp\Node_name\server_name\BusinessSpaceHelpEAR\BusinessSpaceHelp.war\eclipse\configuration 폴더에서 폴더만 삭제하십시오. 이 폴더에 있는 파일은 삭제하지 마십시오.
   3. 서버를 다시 시작하십시오.
9. 문서 플러그인만 설치하거나 업데이트하는 경우(즉, 위젯은 설치하거나 업데이트하지 않는 경우) 다음을 수행하십시오.
   1. 명령 프롬프트에서 디렉토리를 profile_root/bin 또는 cluster_root/bin 디렉토리로 변경하십시오.
   2. wsadmin.bat -conntype NONE을 입력한 후 해당 명령을 입력하십시오.
      • 위젯을 독립형 환경에 설치하는 경우:
        • Jython 명령:AdminTask.updateBusinessSpaceWidgets('{-nodeName node -serverName server -helpplugins fullpath}')
        • Jacl 명령: $AdminTask updateBusinessSpaceWidgets {-nodeName node -serverName server -helpplugins fullpath}
      • 위젯을 클러스터된 환경에 설치하는 경우:
        • Jython 명령: AdminTask.updateBusinessSpaceWidgets('{-clusterName cluster -helpplugins fullpath}')
        • Jacl 명령: $AdminTask updateBusinessSpaceWidgets {-clusterName cluster -helpplugins fullpath}
      Fullpath는 작성한 문서 플러그인의 이름 및 위치입니다.

      updateBusinessSpaceWidgets에 대한 자세한 정보는 updateBusinessSpaceWidgets 명령의 내용을 참조하십시오.

   3. Exit를 입력하십시오.
   4. 서버 또는 클러스터를 다시 시작하십시오.