Guide
Technical Writing Syntax Guide
最后更新于 2026-07-22
Technical details:Wiki 实际操作指南
这份指南教你在编辑框里实际输入什么。不会编程也可以按示例复制、替换文字后使用。
1. 进入编辑页面
打开要修改的页面,点击右上角“编辑本页”。修改前先看一眼页面底部的“最后更改”,避免覆盖别人刚写的内容。
写完后先点“预览”,确认样式、链接和表格正常,再点“保存”。如果只是临时试写,点“取消”即可,不会保存。
2. 新建页面与分类
Wiki 用冒号 : 表示分类,不需要先创建真实文件夹。
例如要在“交通出行”下新建“校车”页面,直接访问或创建:
transport:shuttle_bus其中:
transport是已有分类。shuttle_bus是新页面名;推荐只用小写字母、数字和下划线。- 显示给读者看的中文标题写在页面正文第一行,不必写进页面名。
常用分类示例:
freshman:registration
campus:canteen
study:course_selection
life:laundry
transport:metro新建一个分类
假设要新增“校内办事”分类:
- 新建页面
services:start,把它当作分类首页。 - 再新建子页面,例如
services:campus_card、services:certificate。 - 在侧边栏或分类导航页面补上通往
services:start的链接。
不要一次建立很多空页面。先建立确实有内容的分类首页和第一批页面即可。
3. 标题与段落
标题两边的等号数量必须一致,最常用的是下面三种:
====== 页面主标题 ======
===== 一级小节 =====
==== 二级小节 ====标题必须从一行开头的等号开始;前面不能有空格或隐藏字符。标题下一行空一行,再写正文。
普通段落直接输入文字。想换成新段落,空一行即可。
4. 列表与步骤
无序列表在每行前加两个空格、星号和空格:
* 携带录取通知书
* 准备身份证件
* 提前查看报到地点有先后顺序的步骤把星号换成减号:
- 进入系统
- 填写信息
- 提交并保存截图5. 创建链接
站内链接写法:
[[transport:metro|查看地铁出行说明]]前半部分是目标页面,竖线后是给读者看的文字。若不写竖线,页面名会直接显示。
外部链接写法:
[[https://example.edu.cn/|学校官网]]链接新增后,请在预览或保存后点一次,确认没有跳到错误页面。
6. 常用文字样式
**重要提醒**
//补充说明//第一行会加粗,第二行会显示为斜体。不要整段加粗;只突出关键日期、材料或提醒即可。
7. 表格
表格适合放“项目—说明”或多个时间阶段的对照信息。
^ 项目 ^ 说明 ^
| 适用校区 | 龙河校区 |
| 最后核实日期 | 2026-07-22 |- 用
^开头的是表头。 - 用
|开头的是普通内容。 - 每一行的分隔符数量要一致,否则表格会错位。
手机上较宽的表格可以左右滑动查看;列太多时,优先拆成两张简单表格。
8. 上传与插入图片
- 在编辑页点击工具栏的图片按钮,打开媒体管理器。
- 进入合适分类后上传图片。
- 上传完成后点图片名称,系统会把图片语法插入编辑框。
常见写法如下:
{{wiki:example.jpg?400|报到地点示意图}}400 表示图片显示宽度,最后一段是图片说明。上传前不要忘记检查是否有个人信息、聊天记录或未获授权的人像。
9. 草稿、预览与历史版本
- 尚未核实的内容先写在
internal:drafts:页面名,不要直接发到正式栏目。 - 保存前使用“预览”检查。
- 写错了可打开“过去修订”,找到正确版本后恢复;不必手动把整页重打一遍。
10. 保存前最后检查
- 标题是否正常显示,而不是一串等号?
- 新链接能否打开?
- 表格有没有错列?
- 日期、费用、地点是否写清楚并已核实?
- 是否误发了个人信息?
都没有问题后再保存。