Skip to content

编写帮助文档

本节内容

本节将介绍帮助文档的编写,请善用侧边栏和搜索,按需阅读文档。

我们假定你已了解 JSON 格式。如果你对 JSON 还很陌生,可以阅读以下教程或自行在互联网搜索:

创建 JSON 格式的帮助文档

你可以直接按照以下格式书写 <helpdoc>.json

json
{
  "mod": "名字",
  "author": "作者",
  "brief": "概述",
  "comment": "备注",
  "helpdoc": {
    "词条A": "词条 A 的具体内容。",
    "词条B": "词条 B 的具体内容。",
    "词条C": "[图:data/images/sealdice.png] 词条 C 的图片与内容。"
  }
}

若你的文本需要换行,你可以使用 \n 作为换行符,而不是在编写时直接换行,这会导致格式错误。你还可以使用 \f{FormFeed} 作为分页符。

注意:标准 JSON 而不是 JSON5

海豹支持的 JSON 帮助文档是「标准 JSON」格式,诸如注释,尾逗号等语法不属于 JSON 语法,而是 JSON5 这个扩展标准的语法,出错时请严格检查。

目前暂不考虑支持 JSON5 标准。

注意:文件编码

永远使用 UTF-8 编码编写 helpdoc。

你可以在 JSON 格式的帮助文档中嵌套引用其它条目:

json
{
  "helpdoc": {
    "词条A": "词条 A 的具体内容。",
    "词条B": "{词条A}词条 B 的具体内容。",
    "词条C": "你还可以 {词条A}\n{词条B}"
  }
}

如此一来当你发送 .help 词条 B 时,骰子将回复:「词条 A 的具体内容。词条 B 的具体内容。」。

示例文档:塔罗牌(节选)

json
{
  "mod": "KIYTarot",
  "author": "浣熊旅記",
  "brief": "KIY 塔罗牌",
  "comment": "释义来源网络。",
  "helpdoc": {
    "愚者逆位": "漂泊,冒险,鲁莽,冒失,疯狂,无视物质损失,灵魂堕落,内心空虚,感情轻浮。",
    "魔术师逆位": "方向错误,被骗或失败,局面失控,二流角色,缺乏热忱和创造力,爱情难有进展。",
    "女祭司逆位": "挑剔,贪心,目光短浅,洁癖,不适宜的激情,自尊心太强,锋芒外露,单相思。",
    "女皇逆位": "冷淡,缺乏上进心,困难,享乐,环境险恶,贴近自然,自负,纠纷,感情挫折。",
    "皇帝逆位": "幼稚,挫折,武断,滥用权利,冷酷,占有欲和控制力强烈,感情勉强。"
  }
}

创建 EXCEL 格式的帮助文档

你还可以按照以下格式书写 <helpdoc>.xlsx

KeySynonymContentDescriptionCatalogueTag
词条 A词条同义词词条内容对词条的简述所属目录内容 TAG
海豹骰豹骰/海豹/sealdice一个简单易用的跑团骰子系统。
形象是海豹,可以被叫做海豹骰、豹骰,豹子骰之类。

Excel 格式的 helpdoc 分为 KeySynonymContentDescriptionCatalogueTag 六块,其中第二列、后三项为选填,一般情况下你都可以留空。

  • Synonym 列可以填写多个同义词,使用 / 分隔即可。
  • Excel 中的词条内容可以直接换行(也可以使用 \n 来换行,但不支持其它换行符与分页符),因此它常用来快速编写有大段文字的帮助文档。
  • 帮助文档所在工作表的名称会作为前缀加入词条。如将工作表命名为 测试,则对应的词条会显示为 测试:词条 A。由于海豹的 .find 指令会对词条进行模糊检索,所以你不必担心前缀对查询带来的影响。

注意:必须保留首行!

不要删去第一行的 KeySynonym 等词。请从第二行开始编写词条。

提示:EXCEL 格式的帮助文档

<helpdoc>.xlsx 原本是梨骰用于 D&D 词条查询的格式,但海豹同样可以读取它。