使用Eclipse帮助系统为项目编制文档 - 编程入门网

作者佚名技术来源 NET编程浏览发布时间 2012-07-04

果您的项目有多人参与工作，或者有大量的文档，那么更新单个目录文件 (toc.xml) 会变得不切实际。为改变这一状况您可以向主 toc.xml 文件中的主题添加一个 link 元素（见清单 3 的示例）。

清单 3. 目录定义

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

bar-toc.xml 文件正是另一个目录，格式应该和任何其他的 toc.xml 文件完全相同。当文档被浏览时，使用这种方法和简单地直接包含另外的 topic 元素没什么不同。

生成独立的文档集

当然，如果您不介意需要发布 20 MB 额外的代码，使用 Eclipse 帮助系统当然好，但是这对小些的项目来说是不现实的。在中心服务器上安装一个 InfoCenter，让人们可以远程访问。人们可以充分利用 Eclipse 帮助系统的所有功能（比如搜索），但是那些不能连接的人还是束手无策。所以，除了使用在主机上的 InfoCenter 以外，有必要将普通的 HTML 包含在一个可下载的包中。只要您没有使用任何服务器端技术，比如 JSP，那么您可以方便地生成一个 HTML 目录来取代 Eclipse 所用的 XML 目录。这就是为什么我们要用 XSLT。

XSLT (eXtensible Stylesheet Language Transformations) 是一种将 XML 格式转化为其他格式的技术，例如 XHTML（一个更为严格的 XML 版本的 HTML）。XSLT 提供了丰富而强大的语言来完成转换，其本身就是很多书和文章的主题，所以我们在这里不再细述。清单 4 给出了一个 toc.xml 文件简单转换的例子，将条目呈现为嵌套的 HTML 列表。注意，这个特定的转换为全部文档集的内容创建了一个单独的 HTML 文件，文件量较大时这可能不实用。所以，如果您已经将您的目录拆分为多个文件，这个 XSLT 将失效。

清单 4. 生成 HTML 目录的示例 XSLT

<?xml　version="1.0"?> <xsl:stylesheet 　　 version="1.1" 　　 xmlns:xsl="http://www.w3.org/1999/XSL/Transform"> <xsl:output　method="html"　indent="no"　encoding="ISO-8859-1"　/> <xsl:template　match="toc"> 　　 <html> 　　　 <head　/> 　　　 <body> 　　　　　 <h1><xsl:value-of　select="@label"　/></h1> 　　　　　 <ul> 　　　　　　 <xsl:apply-templates　/> 　　　　　 </ul> 　　　 </body> 　　 </html> </xsl:template> <xsl:template　match="topic"> 　　 <li> 　　　 <xsl:choose> 　　　　　 <xsl:when　test="@href"> 　　　　　　 <!--　Only　add　a　hyperlink　when　there　is　something　to　link　to　-> 　　　　　　 <xsl:element　name="a"> 　　　　　　　　 <xsl:attribute　name="href"> 　　　　　　　　　 <xsl:value-of　select="@href"　/> 　　　　　　　　　 </xsl:attribute> 　　　　　　　　 <xsl:value-of　select="@label"　/> 　　　　　　 </xsl:element> 　　　　　 </xsl:when> 　　　　　 <xsl:otherwise> 　　　　　　 <xsl:value-of　select="@label

凌众科技专业提供服务器租用、服务器托管、企业邮局、虚拟主机等服务，公司网站：http://www.lingzhong.cn 为了给广大客户了解更多的技术信息，本技术文章收集来源于网络,凌众科技尊重文章作者的版权，如果有涉及你的版权有必要删除你的文章，请和我们联系。以上信息与文章正文是不可分割的一部分,如果您要转载本文章,请保留以上信息，谢谢!

分享到：更多

你可能对下面的文章感兴趣

关于使用Eclipse帮助系统为项目编制文档 - 编程入门网的所有评论

随机推荐