2011-05-02 50 views
3

我目前工作的一家公司在多个项目中有多个taglibs。我们使用maven和哈德森。我负责发现一些可用于为我们的taglibs自动生成文档的东西。我找到了TLDDoc,但我一直无法找到任何解释如何设置的东西。请注意,我不是Java开发人员,我是一个UI开发人员,可以在JSP和其他技术中工作。任何帮助,将不胜感激。如何设置TLDDoc来为JSP TagLib创建文档?

回答

1

我有一些类似的要求。我所做的就是在maven文件中使用Ant脚本,它会在我需要的项目下找到所有TLD定义文件,然后遍历每个文件并执行一些操作。

我需要2个输出。 HTML和DITA(技术文档格式,DOCBOOK的继任者)。

  1. 对于每个TLD,都会调用TLDDoc并调用一个相同的输出目录。
  2. 额外的脚本执行了将TLD xml转换为DITA的XSLT样式表。从DITA我使用“DITA Open Toolkit”输出为PDF和另一种类型的HTML。

有了maven,你需要学习一点ANT脚本,并知道如何调用java类(TLDDOC)或XSLT引擎。

这真的很酷,很灵活。

+0

忘了提。 TLDDoc可以作为maven插件找到。请参阅http://mvnrepository.com/artifact/taglibrarydoc/tlddoc – 2013-02-08 16:18:14

0

如果你想执行TLDDoc作为maven插件,你可以这样做,例如,像这样:

 <plugin> 
      <groupId>org.codehaus.mojo</groupId> 
      <artifactId>exec-maven-plugin</artifactId> 
      <executions> 
       <execution> 
        <id>generateTldDoc</id> 
        <phase>prepare-package</phase> 
        <goals> 
         <goal>java</goal> 
        </goals> 
        <configuration> 
         <includePluginDependencies>true</includePluginDependencies> 
         <includeProjectDependencies>false</includeProjectDependencies> 
         <mainClass>com.sun.tlddoc.TLDDoc</mainClass> 
         <arguments>     
          <argument>-doctitle</argument> 
          <argument>Whatever Taglib</argument> 
          <argument>-windowtitle</argument> 
          <argument>Whatever Taglib</argument> 
          <argument>-d</argument> 
          <argument>${project.build.directory}/tlddoc</argument> 
          <argument>src/main/resources/META-INF/something.tld</argument> 
          <argument>src/main/resources/META-INF/somethingelse.tld</argument> 
         </arguments> 
        </configuration> 
       </execution> 
      </executions> 
      <dependencies> 
       <dependency> 
        <groupId>taglibrarydoc</groupId> 
        <artifactId>tlddoc</artifactId> 
        <version>1.3</version> 
       </dependency> 
      </dependencies> 
     </plugin>