docs_usage.md

文档使用教程

本章节讲述如何正确查看Inkar Suki的文档，本章节的示例命令与实际功能无关。

命令前缀

在Inkar Suki文档中，+开头的命令均可以省略掉这个+，例如原始命令或者别名为+cmd，发送cmd与其等效。

命令别名

如果看到一个表格，像这样：

命令	格式	别名	描述	权限	图片
+lblock	+lblock	+本群黑名单、+列出黑名单	查询所有避雷人员。	-	示例/图例

+lblock是原始命令，一般来说用户不需要使用该命令，而是使用别名，表格中的别名中显示的是+本群黑名单、+列出黑名单，那么您发送+本群黑名单或者+列出黑名单，效果等同于+lblock。

此处+lblock不需要任何参数，关于有参数的命令，请见下一小节。

命令参数

同样是一个表格，像这样：

命令	格式	别名	描述	权限
+bmi	+bmi <身高(M)> <体重(kg)>	+BMI、+身体质量指数	计算BMI指数。	-

想必已经知道+BMI与+身体质量指数均可以等同于+bmi这个命令，至于参数的填法，我们开始讲解。

必选参数

如果看到<aaa>这种用尖括号（即<>）包裹的参数，则表示该参数为必填参数，但如果是服务器参数，绑定群聊之后即变为可选参数，关于可选参数，请参见下一段落。

假设某命令的格式为：+cmd <aaa>，您应该发送的是：+cmd 参数1，而不是：+cmd <参数1>！

可选参数

如果看到[aaa]这种用方括号（即[]）包裹的参数，则表示该参数为可选参数，此处的参数可填可不填，请根据自身需求决定，使用章节中有详细说明可选参数的接受值。

如同必选函数，你不应该发送：+cmd [xxx]，而是+cmd xxx或者+cmd（即直接省略该参数，因为是可选参数）。

斜杠

如果使用的是/，那么该斜杠在此处仅仅作为一个字符！

例如+webhook <author/repository>，您应该给出+webhook codethink-cn/Inkar-Suki，而不是+webhook codethink-cn或者+webhook Inkar-Suki！

如果使用的是|，那么该竖线表示参数二选一。

例如+arcbind <usercode|username>，您应该给出+arcbind 114514，或者+arcbind TianSuoHaoEr，而不是+arcbind 114514|TianSuoHaoEr！

!> 注意，只有参数中的斜杠适用于此规则，其他位置的斜杠均表示二选一！

命令图片

示例指如何调用机器人的命令，而图例指机器人的回复样例。

简单地说，示例是一个完整的对话，而图例仅仅是机器人的回复。

命令权限

某些命令为了防止滥用，我们对其添加了权限限制，关于更多信息，清查看setop命令。

群管表示该功能可以由群主或者群管理员进行调用。

如果权限是阿拉伯数字，如1~10，该权限系统为机器人内置权限。

如果权限为-，则说明该命令不需要任何权限即可调用。

好了，基本的文档教学就到这里啦，可以尝试阅读Inkar Suki的使用说明了！