插件帮助



插件帮助的通用范例

帮助插件按照以下的格式描述。

插件名称

分类

显示以何种方式调用插件。有的插件存在多种调用方式。

  • 命令 - 表示可以用命令形式调用。因为在内部调用,省略说明时需用括号括起来。
  • 块型插件 - 表示可以当做区块型插件调用。
  • 内联型插件 - 表示可以当做内联型插件调用。
  • 伪块型插件 - 表示已经在原版PukiWiki实现的功能。为方便起见,记述方式与区块型插件相同,并加入到插件手册中。
重要程度

显示该插件的使用频率和实用性指数。不怎么重要的为★☆☆☆☆,重要的插件为★★★★★。

格式

指定插件参数的方法。为了表示参数的指定方法,使用下述的记述格式。

  • [] - 表示如需要可以省略的地方。
  • | - 表示在|分隔的多个参数当中,只可以指定1个。
  • {} - 表示中括号内的参数指定顺序可以任意。
概述

该插件的功能概述。

参数

参数的详细说明。

插件内设定

插件的源代码中可定义的常量一览。可以进行参数无法改变的详细自定义。

备注

该插件的相关参考信息。