首頁
編程語言
C語言|JAVA編程
Python編程
網頁編程
ASP編程|PHP編程
JSP編程
數據庫
MYSQL數據庫|SqlServer數據庫
Oracle數據庫|DB2數據庫
您现在的位置: 程式碼之家 >> 編程語言 >  >> Java 程式設計 >> Java 相關知識

使用 Eclipse 幫助系統為專案編制文檔:從插件開發到獨立發布全攻略

     編輯:Java 相關知識

Eclipse 幫助系統底層啟動內嵌 Apache Tomcat,開啟瀏覽器視窗,左側可摺疊索引(Apache Lucene 搜尋引擎),右側 HTML 文檔。支援 JSP 動態內容(但建議避免,後文說明)。

文檔插件的「Hello World」

文檔分「書」,每書一 Eclipse 插件,工作量極小。需 plugin.xml 描述插件:


<plugin name="Sample Documentation Plug-in" id="com.ibm.sample.doc"
  version="1.0.0" provider-name="IBM">
  <extension point="org.eclipse.help.toc">
    <toc file="toc.xml" primary="true" />
  </extension>
</plugin>

toc.xml 定義目錄結構,對應左側導航窗格:


<toc label="Sample Documentation">
  <topic label="My Section" href="mySection.html">
    <topic label="Foo" href="foo.html"/>
    <topic label="Bar" href="bar.html"/>
  </topic>
</toc>

打包與部署

目錄結構需符合:plugins/com.ibm.sample.doc_1.0.0/ 下放 plugin.xml、toc.xml、HTML 檔案。為壓縮體積,可將 HTML 存入 doc.zip。測試:將目錄拖入 Eclipse plugins 目錄,重啟選 Help > Help Contents 即見。

InfoCenter:無 IDE 環境下的文檔伺服器

啟動後台 Tomcat 進程(InfoCenter),瀏覽器連接即可瀏覽,指令見 Eclipse 文檔。可精簡 Eclipse 系統僅保留幫助功能。

處理龐大目錄:模組化 toc.xml

多人協作/大量文檔時,單一 toc.xml 不實用。在主題加 link 元素引入子目錄:


<topic label="Bar" href="bar.html">
  <link toc="bar-toc.xml" />
</topic>

bar-toc.xml 格式同主目錄,瀏覽時無縫整合。

生成獨立文檔集:XSLT 轉換

Eclipse 幫助系統含 20MB 運行時,小專案不切實際。部署 InfoCenter 供遠程訪問,但離線用戶需獨立 HTML 包。前提:未使用 JSP 等伺服器端技術。用 XSLT 將 XML 目錄轉為 HTML:


<xsl:stylesheet version="1.1" xmlns:xsl="https://www.w3.org/1999/XSL/Transform">
  <xsl:output method="html" indent="no" encoding="ISO-8859-1"/>
  <xsl:template match="toc"> ... 輸出巢狀 <ul> 列表 ...
  <xsl:template match="topic"> ... 處理超連結與巢狀主題 ...
</xsl:stylesheet>

用 Apache Xalan 處理 toc.xml 生成 index.html,含完整導航結構。若目錄已拆分多檔,需調整 XSLT 處理 link 元素。

結語

Eclipse 幫助系統輕鬆產出專業、可搜尋文檔。無需獨立發布時,僅兩個 XML 檔即可享用;需獨立包時,XSLT 轉換 HTML 目錄即可。立即開始為專案編寫文檔!

  1. 上一篇文章:
  2. 下一篇文章:
Copyright © 程式碼之家 All Rights Reserved