插件:TemplateData
阅读
2022-02-17更新
最新编辑:顾小满real
阅读:
更新日期:2022-02-17
最新编辑:顾小满real
说明
插件:TemplateData的主要功能是为模板中的参数添加多种注释和说明,并且这些注释和说明会保存成json数据表,便于可视化编辑器或其他api调用
补充说明
- 该插件对于使用SMW的模板特别友好
- 该插件主要使用场景为可视化编辑器插入模板过程中的体验
- 改插件仅仅是为模板增加补充额外信息,并不会直接对模板进行修改,即使使用了该插件的功能“添加参数”,也是仅仅在引用相关信息的时候增加一个参数,该参数并不会直接作用于模板(如果模板内没有参数)
操作
进入任一模板:页面,点击编辑源代码即可发现在编辑工具栏上方的管理模板数据功能按钮。点击该按钮,即可唤起模板文档编辑器
模板描述
如果填写了模板描述,在插入模板动作时,可以在诸多默认搜索结果里看到该模板的描述,用于区别其他模板
模板默认字符串
默认选择未指定,当然也可以选择自己喜欢的模式来匹配
- 行内:{{_|_=_}}
- 块:{{_ |_=_ }}
已有模板改造
老模板可以在唤起模板文档编辑器的时候看到页面最下方的参数快捷建立方式,点击之后会提取模板中带有参数名的参数导入,可以看到模板中的参数都整理导入,点击对应的参数名可以看到单个参数的相关数值设置
- 参数名:一般会默认参数名,也可以另行更改,此处建议自动
- 别名(逗号分隔):用于其他API调用的时候的别名
- 标签(zh-cn):如果不填写,则显示参数名,如果填写则显示填写的标签
- 描述(zh-cn):该参数名的实际作用,在可视化编辑器中会作为该字段的提示信息显示
- 示例(zh-cn):用于填写一个示例值,多半用于占位数字。例如:0003
- 类型:可以选择多种字段属性,用于api调用时区分。比如填写值中如果需要0来做判断,那么最好选择类型为“单行文本”
- 默认值(zh-cn):该参数即使不填写也会默认填写的值
- 自动值:
- 弃用:该参数可以不填写
- 必填:一定要填写的参数,如果不填写则在可视化编辑器中插入该模板内容无法完成提交
- 推荐:引用该模板就默认会显示出来的字段