Jenkins插件开发之help采坑

插件中需要包含帮助文档，文档的名称为help-FIELD.html或者help-FIELD.jelly，路径同config.jelly,这时在控件的右边会显示一个问号:

，点击图标就会将帮助文件在配置页面中内联的渲染出来

jelly中有多种方式进行help配置

方式一：

config.jelly文件中对要设置的控件配置 filed 字段，与此同时在resources/.../plug-in/config.jelly同级目录下添加

help-nameLen.html文件就可以实现。

jelly：

  <f:entry field="nameLen" title="Name Len">
            <f:textarea/>
  </f:entry>

help-nameLen.html：

<div>
    <h3 >Naming Len</h3>
    <p>
    Set the naming len ...
</p>

</div>

方式二：

config.jelly文件可以不需要filed字段，采用key=value形式。 help="PATH"。

这里的PATH尝试了无数次， 在调试过程中点击

都表示 ERROR: Failed to load help file: Not Found

 实际应该怎么写？请多多体会：

 
原理：
采用  j:out 测试一下第一种方式的路径

<j:out value="${descriptor.getHelpFile('nameLen')}"/>

结果： /descriptor/io.jenkins.plugins.xxxxxx.yyy/help/nameLen  

so正确的写法：

<f:entry title="Name Len" help="/descriptor/io.jenkins.plugins.xxxxxx.yyy/help/nameLen">
    <f:textarea/>
</f:entry>

方式三：

注意help字段中的路径,红色部分需要根据实际项目替换掉，固定格式:

help="/plugin/[PLUGIN-NAME]/help/help-nameRules.html"

jelly：

<f:entry  field="xxx" title="yyy" help="/plugin/[PLUGIN-NAME]/help/help-xxx.html">

<textarea>x</textarea>
</f:entry>

help文件的位置：

help-xxx.html

$ tree -L 4
.
|-- main
|   |-- java
|   |   `-- hudson
|   |       `-- plugins
|   |-- resources
|   |   |-- hudson
|   |   |   `-- plugins
|   |   `-- index.jelly
|   `-- webapp
|       |-- help-folder.html
|       |-- help-icon.html
|       |-- help-icon_ja.html
|       |-- help-project.html
|       |-- help-project_ja.html
|       |-- help-url.html
|       |-- help-xxx.html
|       `-- help-url_ja.html