路径格式
所有文件采用扁平化的组织形式,不对类型、专业等作任何区分,统一存放在 docs/
下。docs/
被配置为 VitePress 的根目录,并不出现在 URL 中。因此,飞跃手册经验分享的帖子路径格式为:docs/<id>.md
,对应的 URL 路径为 /<id>
。
文件名格式
其中,<id>
的格式为 <surname><first-name-abbr><year>
:
<surname>
为姓氏的全拼写,如「李」姓对应li
。使用复姓的,全拼写所有汉字,如「慕容」对应murong
。<first-name-abbr>
为名的首字母缩写,如单名「明」的,对应m
;双名「小明」的,对应xm
;双名以上的,以此类推。<year>
为年级的后两位。如入学年份为 2019 年的,对应19
。
例如,李小明于 2019 年入学,其分享对应的文件名为 lixm19.md
。
格式来源
这个格式主要启发自南科大邮箱的别名格式,但只取年份的后两位以缩短链接长度。
若是匿名分享,则采用 anon<year>
格式。
同名同年级情况
若出现同名同年级的情况,或一人有多个投稿的,按上述规则,则文件名也相同,因此需要作出如下区分:
- 先进行第一次投稿的作者,可使用标准文件名
- 主文件名之外,其他的帖子,不管是同一作者还是不同作者,应按时间顺序排列,在后方添加字母后缀,如
lixm19a
、lixm19b
等。 - 同一作者有多个帖子的,不论投稿时间先后,其研究生项目申请经验分享应始终拥有主文件名(如该作者先于其他同名同年级作者投稿)
- 同年级的匿名作者,先投稿的可使用默认文件名,其他投稿统一按照时间顺序排列添加字母后缀。
例如,下表中,李小明(甲)和李晓民(乙)同为 19 级本科生,且按时间顺序(从上到下)进行了表格中列举的投稿,则其文件名应如表所示。
作者 | 投稿内容 | 文件名 | 解释 |
---|---|---|---|
甲 | 暑研项目 | lixm19a | 此投稿早于同一作者的申请经验分享,但不能使用主文件名 |
乙 | 博士申请 | lixm19b | 李小明的第一次投稿更早,且后续也投稿了申请经验,因此这里不能使用主文件名 |
甲 | 硕士申请 | lixm19 | 李小明的第一次投稿更早,因此使用主文件名 |
乙 | 英语学习 | lixm19c | 按时间顺序添加字母后缀 |
在这个例子中,即使甲后续并没有投稿申请经验,其第一个投稿依然能使用主文件名,这样避免了访问 URL 时跳转到完全不相关的帖子。
资产路径
若一帖子引用了图片、自定义组件、CSS 等资产,则作出如下目录调整:
txt
| <id>/
|-- index.md
|-- img1.png
|-- img2.png
|-- MyComponent.vue
|-- style.css
|-- ...
即,不使用单个文件 <id>.md
,而是使用一个目录 <id>/
,在其下存放相关的资产,而帖子本身为 index.md
。
已弃用的路径格式
已弃用
这一节中描述的路径格式已在 v3
中被弃用。
样例:
/grad-application/computer-science-and-engineering/[US]-15-yanxiangyi
/grad-application/finance/financial-engineering/[SG]-16-liyilin
/oversea-program/semester-program/uc_yangzonghao
路径名
路径格式为:<type>[/<subtype>]/<department>[/<major>]
,其中
<type>
为帖子类别,如grad-application
、oversea-program
等。<subtype>
为可选的细分类别,如英语学习
下细分TOEFL
、GRE
等。<department>
为院系名称,如computer-science-and-engineering
、microelectronics
等。<major>
为可选的专业名称,当一个院系下有多个专业时使用,如biology
下的bioinformatics
、bioscience
等。
已弃用
这个格式已被弃用:
- URL 过长
- 创建、查找帖子困难
- 专业、院系的命名和层级不确定
- 许多专业没有或只有少数几个帖子
文件名
文件名格式为:[<region>]-<year>-<name>
,其中
<region>
为地区代码,如US
、CN
、HK
等<year>
为年级的后两位数字,如 2019 年入学对应19
<name>
为姓名的全拼写,如「李小明」对应lixiaoming
。
已弃用
这个格式已被弃用,一来因其过长,二来不应在 URL 中使用 []
等特殊字符。