為什麼使用 XHTML?
說明系統可讓您利用特殊標示來過濾、併入和指定執行錨點,以註解您的 XHTML 標記,從而提供了產生動態說明內容的功能。 當使用 HTML 時,無法使用這些特性。
如何提出 XHTML
XHTML 說明文件的提方式與 HTML 大體上相同,不過,為了支援動態內容和搜尋,也些重要差異。 這些必要的修正列示如下:
您必須將 XHTML 搜尋參與程式連結到您的文件外掛程式。
Eclipse 說明實作利用 Lucene 來建立文件索引,以加快搜尋速度。 為了建立文件索引,Lucene 必須能夠讀取格式。 Eclipse 提供了用來建立 XHTML 文件索引的搜尋參與程式,因此,您只需要告訴說明系統將它用在您的文件上即可。 請將下列延伸規格加到您的外掛程式 Manifest 中:
<extension point="org.eclipse.help.base.luceneSearchParticipants"> <binding participantId="org.eclipse.help.base.xhtml"/> </extension>
如果使用動態內容,您必須將 XHTML 動態內容生產器連結到您的文件外掛程式。
如果您要利用 XML 註解來產生動態內容,您必須告訴說明系統它應該要處理您的文件。 方式是將 XHTML 動態內容生產器連結您的外掛程式。
<extension point="org.eclipse.help.contentProducer"> <binding producerId="org.eclipse.help.dynamic"/> </extension>
如果您要在 XHTML 中使用併入,path
屬性的格式如下:(說明在下文中)
<plugin_id>/<path_to_xhtml_file>/<filename_xhtml>/<element_id>
它的各個欄位如下:
org.eclipse.help
)/my_folder/my_sub_folder/
)my_file.xhtml
)id
屬性加到這個元素中(如 my.element.id
)
比方說,如果您要在 my.product.plugin
外掛程式中,併入 /copyrights/copyright.xhtml
檔中 ID 為 my_copyright
的段落(<p>
元素),您會指定如下:
my.product.plugin/copyrights/copyright.xhtml/my_copyright