模板使用指南:修订间差异
来自Robuddy
更多语言
更多操作
ContentBot2(留言 | 贡献) 修复:用nowiki/pre替代syntaxhighlight,防止模板示例被展开 |
ContentBot2(留言 | 贡献) 重写:修复标签问题,补充详细用法说明和适用场景 |
||
| 第1行: | 第1行: | ||
本页面介绍 Robuddy Wiki 中常用的编辑模板,方便用户快速套用。 | 本页面介绍 Robuddy Wiki 中常用的编辑模板,方便用户快速套用。所有模板均可在编辑器中直接输入使用。 | ||
== 模板总览 == | == 模板总览 == | ||
| 第6行: | 第6行: | ||
! 模板 !! 用途 !! 颜色 | ! 模板 !! 用途 !! 颜色 | ||
|- | |- | ||
| <nowiki>{{Infobox}}</nowiki> || 零件/项目信息卡片 || 蓝色 | | <nowiki>{{Infobox}}</nowiki> || 零件/项目信息卡片 || 蓝色标题栏 | ||
|- | |- | ||
| <nowiki>{{Warning|文字}}</nowiki> || | | <nowiki>{{Warning|文字}}</nowiki> || 注意事项提示 || 橙色左边框 | ||
|- | |- | ||
| <nowiki | | <nowiki={{Note|文字}}></nowiki> || 补充说明/小技巧 || 蓝色左边框 | ||
|- | |- | ||
| <nowiki | | <nowiki={{Danger|文字}}></nowiki> || 危险警告 || 红色左边框 | ||
|- | |- | ||
| <nowiki>{{Documentation}}</nowiki> || 模板文档页脚 || 灰色 | | <nowiki>{{Documentation}}</nowiki> || 模板文档页脚 || 灰色 | ||
| 第19行: | 第19行: | ||
== Infobox(信息框) == | == Infobox(信息框) == | ||
用于在页面右侧显示零件或项目的基本信息卡片。 | 信息框用于在页面右侧显示零件或项目的基本信息卡片,浮动在正文旁边,不影响正文排版。 | ||
=== 参数列表 === | === 参数列表 === | ||
{| class="wikitable" | {| class="wikitable" | ||
! 参数 !! 是否必填 !! 说明 !! 示例 | ! 参数 !! 是否必填 !! 说明 !! 示例值 | ||
|- | |- | ||
| <code>标题</code> || 否 || 默认取页面名称 || | | <code>标题</code> || 否 || 信息框标题,默认取页面名称 || 电机 | ||
|- | |- | ||
| <code>image</code> || 否 || 图片,用 File: | | <code>image</code> || 否 || 展示图片,使用 <code>[[File:文件名|宽度]]</code> 格式 || [[File:电机.png|250px]] | ||
|- | |- | ||
| <code>类别</code> || 否 || 所属系统分类 || | | <code>类别</code> || 否 || 所属系统分类 || 动力系统 | ||
|- | |- | ||
| <code>英文名</code> || 否 || 英文名称 || | | <code>英文名</code> || 否 || 英文名称,以小字显示 || Brushless Motor | ||
|- | |- | ||
| <code>功能</code> || 否 || 核心功能描述 || | | <code>功能</code> || 否 || 核心功能描述 || 将电能转换为机械能 | ||
|- | |- | ||
| <code>类型</code> || 否 || 型号 | | <code>类型</code> || 否 || 型号或种类 || 外转子无刷直流电机 | ||
|- | |- | ||
| <code>标称电压</code> || 否 || 额定工作电压 || | | <code>标称电压</code> || 否 || 额定工作电压 || 3.7V/单片电芯 | ||
|- | |- | ||
| <code>质量</code> || 否 || 典型质量 || | | <code>质量</code> || 否 || 典型质量 || 28g | ||
|- | |- | ||
| <code>密度</code> || 否 || 材料密度 || | | <code>密度</code> || 否 || 材料密度 || 2.7 g/cm³ | ||
|} | |} | ||
=== 使用 | === 使用方法 === | ||
在页面最开头(引言之前)插入以下代码,将参数值替换为实际内容即可: | |||
<pre> | <pre> | ||
| 第55行: | 第57行: | ||
|功能=将电能转换为机械能 | |功能=将电能转换为机械能 | ||
|类型=外转子无刷直流电机 | |类型=外转子无刷直流电机 | ||
|标称电压= | |||
|质量=28g | |质量=28g | ||
|密度= | |||
}} | }} | ||
</pre> | </pre> | ||
{{Note| | {{Note|不填写的参数会显示为空行。如果某参数没有信息,可以留空或直接删除该行。}} | ||
=== 实际效果 === | |||
以「电池」页面为例,信息框会渲染为右侧浮动的蓝色标题卡片,包含图片和属性表格。 | |||
=== 注意事项 === | |||
* 信息框应放在页面最开头,在所有正文内容之前 | |||
* <code>image</code> 参数需要先将图片上传到 Wiki(通过左侧「上传文件」) | |||
* 图片格式建议使用 PNG 或 JPG,宽度建议 250px | |||
* 每个页面只使用一个信息框 | |||
== Warning(注意提示) == | == Warning(注意提示) == | ||
用于提示读者操作中的注意事项 | 用于提示读者操作中的注意事项、常见错误或需要特别留意的事项。 | ||
=== 使用方法 === | === 使用方法 === | ||
| 第74行: | 第89行: | ||
{{Warning|不要把正负极接反!}} | {{Warning|不要把正负极接反!}} | ||
=== 适用场景 === | |||
* 操作前的安全提醒 | |||
* 常见错误的警告 | |||
* 需要读者特别注意的事项 | |||
* 可能导致设备损坏的操作提示 | |||
=== 多行内容 === | |||
如果提示内容较长,可以直接换行: | |||
<pre> | |||
{{Warning|1. 充电时必须有人在场 | |||
2. 不要带锂电池进电梯 | |||
3. 锂电池应单独保存于防爆箱}} | |||
</pre> | |||
== Note(提示信息) == | == Note(提示信息) == | ||
用于补充说明、小技巧或有 | 用于补充说明、小技巧或有帮助但非关键的信息。 | ||
=== 使用方法 === | === 使用方法 === | ||
| 第88行: | 第120行: | ||
{{Note|齿槽转矩是永磁电机的固有特性。}} | {{Note|齿槽转矩是永磁电机的固有特性。}} | ||
=== 适用场景 === | |||
* 补充说明或背景知识 | |||
* 实用小技巧 | |||
* 拓展阅读信息 | |||
* 对正文内容的额外解释 | |||
== Danger(危险警告) == | == Danger(危险警告) == | ||
用于标注可能导致设备损坏 | 用于标注可能导致设备损坏、人身伤害或安全风险的操作。这是最高级别的警告。 | ||
=== 使用方法 === | === 使用方法 === | ||
| 第102行: | 第141行: | ||
{{Danger|锂电池起火只能等它自己烧完,灭火器难以阻止复燃!}} | {{Danger|锂电池起火只能等它自己烧完,灭火器难以阻止复燃!}} | ||
=== 适用场景 === | |||
* 可能导致人身安全风险的操作 | |||
* 可能导致设备永久损坏的操作 | |||
* 严禁违反的安全规定 | |||
* 与火灾、触电等相关的危险事项 | |||
== Documentation(模板文档) == | == Documentation(模板文档) == | ||
用于在模板页面底部自动生成文档说明框 | 用于在模板页面底部自动生成文档说明框。 | ||
=== 使用方法 === | |||
=== | |||
在模板源码的最末尾加入: | |||
<pre> | <pre> | ||
{{ | <nowiki>{{Documentation}}</nowiki> | ||
</pre> | |||
}} | |||
系统会自动查找 <code>Template:模板名/doc</code> 子页面作为文档内容。 | |||
== 模板组合使用 == | |||
一个页面可以同时使用多个模板。以下是一个完整的零件页面示例: | |||
<pre> | <pre> | ||
{{Infobox | {{Infobox | ||
|标题= | |标题=电池 | ||
|类别= | |image=[[File:锂电池.png|250px]] | ||
|英文名= | |类别=供电系统 | ||
| | |英文名=LiPo Battery | ||
|质量= | |标称电压=3.7V/单片电芯 | ||
|质量=约200g | |||
}} | }} | ||
电池是各类电子设备和机器人项目的能量来源。 | |||
<blockquote>本词条内容整理自[[File: | <blockquote>本词条内容整理自[[File:思飞 电子设备基础-苗澍.pdf|思飞 电子设备基础-苗澍.pdf]]。</blockquote> | ||
== 使用到该零件的项目 == | == 使用到该零件的项目 == | ||
<!-- 请在此处添加项目链接 --> | <!-- 请在此处添加项目链接 --> | ||
== 一、基本原理 == | == 一、基本原理 == | ||
... | ... | ||
== 二、 | == 二、注意事项 == | ||
. | |||
{{Warning|充电时必须有人在场!}} | |||
{{Note|建议单片电芯电压降到3.6V时停止放电。}} | |||
{{Danger|过放的电池会鼓包,不可继续充电!}} | |||
[[Category:零件]] | [[Category:零件]] | ||
[[Category: | [[Category:供电系统]] | ||
</pre> | </pre> | ||
2026年7月16日 (四) 18:42的版本
本页面介绍 Robuddy Wiki 中常用的编辑模板,方便用户快速套用。所有模板均可在编辑器中直接输入使用。
模板总览
| 模板 | 用途 | 颜色 |
|---|---|---|
| {{Infobox}} | 零件/项目信息卡片 | 蓝色标题栏 |
| {{Warning|文字}} | 注意事项提示 | 橙色左边框 |
| <nowiki= 💡 提示: 文字 ></nowiki> |
补充说明/小技巧 | 蓝色左边框 |
| <nowiki= 🚨 危险: 文字 ></nowiki> |
危险警告 | 红色左边框 |
| {{Documentation}} | 模板文档页脚 | 灰色 |
Infobox(信息框)
信息框用于在页面右侧显示零件或项目的基本信息卡片,浮动在正文旁边,不影响正文排版。
参数列表
| 参数 | 是否必填 | 说明 | 示例值 |
|---|---|---|---|
标题 |
否 | 信息框标题,默认取页面名称 | 电机 |
image |
否 | 展示图片,使用 宽度 格式 |
File:电机.png |
类别 |
否 | 所属系统分类 | 动力系统 |
英文名 |
否 | 英文名称,以小字显示 | Brushless Motor |
功能 |
否 | 核心功能描述 | 将电能转换为机械能 |
类型 |
否 | 型号或种类 | 外转子无刷直流电机 |
标称电压 |
否 | 额定工作电压 | 3.7V/单片电芯 |
质量 |
否 | 典型质量 | 28g |
密度 |
否 | 材料密度 | 2.7 g/cm³ |
使用方法
在页面最开头(引言之前)插入以下代码,将参数值替换为实际内容即可:
{{Infobox
|标题=电机
|image=[[File:电机.png|250px]]
|类别=动力系统
|英文名=Brushless Motor
|功能=将电能转换为机械能
|类型=外转子无刷直流电机
|标称电压=
|质量=28g
|密度=
}}
💡 提示: 不填写的参数会显示为空行。如果某参数没有信息,可以留空或直接删除该行。
实际效果
以「电池」页面为例,信息框会渲染为右侧浮动的蓝色标题卡片,包含图片和属性表格。
注意事项
- 信息框应放在页面最开头,在所有正文内容之前
image参数需要先将图片上传到 Wiki(通过左侧「上传文件」)- 图片格式建议使用 PNG 或 JPG,宽度建议 250px
- 每个页面只使用一个信息框
Warning(注意提示)
用于提示读者操作中的注意事项、常见错误或需要特别留意的事项。
使用方法
{{Warning|不要把正负极接反!}}
渲染效果
⚠️ 注意: 不要把正负极接反!
适用场景
- 操作前的安全提醒
- 常见错误的警告
- 需要读者特别注意的事项
- 可能导致设备损坏的操作提示
多行内容
如果提示内容较长,可以直接换行:
{{Warning|1. 充电时必须有人在场
2. 不要带锂电池进电梯
3. 锂电池应单独保存于防爆箱}}
Note(提示信息)
用于补充说明、小技巧或有帮助但非关键的信息。
使用方法
{{Note|齿槽转矩是永磁电机的固有特性。}}
渲染效果
💡 提示: 齿槽转矩是永磁电机的固有特性。
适用场景
- 补充说明或背景知识
- 实用小技巧
- 拓展阅读信息
- 对正文内容的额外解释
Danger(危险警告)
用于标注可能导致设备损坏、人身伤害或安全风险的操作。这是最高级别的警告。
使用方法
{{Danger|锂电池起火只能等它自己烧完,灭火器难以阻止复燃!}}
渲染效果
🚨 危险: 锂电池起火只能等它自己烧完,灭火器难以阻止复燃!
适用场景
- 可能导致人身安全风险的操作
- 可能导致设备永久损坏的操作
- 严禁违反的安全规定
- 与火灾、触电等相关的危险事项
Documentation(模板文档)
用于在模板页面底部自动生成文档说明框。
使用方法
在模板源码的最末尾加入:
{{Documentation}}
系统会自动查找 Template:模板名/doc 子页面作为文档内容。
模板组合使用
一个页面可以同时使用多个模板。以下是一个完整的零件页面示例:
{{Infobox
|标题=电池
|image=[[File:锂电池.png|250px]]
|类别=供电系统
|英文名=LiPo Battery
|标称电压=3.7V/单片电芯
|质量=约200g
}}
电池是各类电子设备和机器人项目的能量来源。
<blockquote>本词条内容整理自[[File:思飞 电子设备基础-苗澍.pdf|思飞 电子设备基础-苗澍.pdf]]。</blockquote>
== 使用到该零件的项目 ==
<!-- 请在此处添加项目链接 -->
== 一、基本原理 ==
...
== 二、注意事项 ==
{{Warning|充电时必须有人在场!}}
{{Note|建议单片电芯电压降到3.6V时停止放电。}}
{{Danger|过放的电池会鼓包,不可继续充电!}}
[[Category:零件]]
[[Category:供电系统]]
模板源码
如需查看或修改模板源码,请访问以下页面: