关于写作标准,请参见:文章风格规范/写作
注意:这篇文章根据 RFC 2119 来描述需求级别。
下面列出了 wiki 良好支持的本地化语言:
File Name | 中文写法 | 本地写法 |
---|---|---|
en.md |
英语 | English |
ar.md |
阿拉伯语 | اَلْعَرَبِيَّةُ |
be.md |
白俄罗斯语 | Беларуская мова |
bg.md |
保加利亚语 | Български |
ca.md |
加泰罗尼亚语 | Català |
cs.md |
捷克语 | Česky |
da.md |
丹麦语 | Dansk |
de.md |
德语 | Deutsch |
el.md |
希腊语 | Ελληνικά |
es.md |
西班牙语 | Español |
fi.md |
芬兰语 | Suomi |
fil.md |
菲律宾语 | Wikang Filipino |
fr.md |
法语 | Français |
he.md |
希伯来语 | עִבְרִית |
hu.md |
匈牙利语 | Magyar |
id.md |
印尼语 | Bahasa Indonesia |
it.md |
意大利语 | Italiano |
ja.md |
日语 | 日本語 |
ko.md |
韩语 | 한국어 |
lt.md |
立陶宛语 | Lietuvių kalba |
nl.md |
荷兰语 | Nederlands |
no.md |
挪威语 | Norsk |
pl.md |
波兰语 | Polski |
pt.md |
葡萄牙语 | Português |
pt-br.md |
葡萄牙语(巴西) | Português (Brasil) |
ro.md |
罗马尼亚语 | Română |
ru.md |
俄语 | Русский |
sk.md |
斯洛伐克语 | Slovenčina |
sl.md |
斯洛文尼亚语 | Slovenščina |
sr.md |
塞尔维亚语 | Српски |
sv.md |
瑞典语 | Svenska |
th.md |
泰语 | ไทย |
tr.md |
土耳其语 | Türkçe |
uk.md |
乌克兰语 | Українська мова |
vi.md |
越南语 | Tiếng Việt |
zh.md |
简体中文 | 简体中文 |
zh-tw.md |
繁体中文(台湾) | 繁體中文(台灣) |
注意:网站会给读者提供其选择的语言版本的文章。如果没有对应的语言文章,则提供英文文章。
前言(元数据)应置于文章顶部,使用 YAML 语言编写,并提供文章的其他有关信息。必须在前言上下两行用三个连字符(---
)包围,并且在前言之后,必须留一空行。
注意:尽量不要翻译含有此标签的英文文章。而且,如果翻译文章需要清理,那么应该在翻译文章中添加此标签。
可以将 needs_cleanup
标签添加到需要重写或排版帮助的文章中。你也可以因此在 GitHub 上提出问题 (issue)。这个标签必须按以下格式添加:
needs_cleanup: true
当在文章中添加这个标签时,还应该添加有关只有按照某些方法处理文章,才能移除标签的注释。
注意:尽量不要翻译含有此标签的英文文章。如果英文原文章含有这个标签,那么翻译文章也必须含有这个标签。
如果英文文章内容已经是误导性或者内容已经不重要时,则可算作过时文章,此时,应该添加 outdated
标签,必须按以下格式添加:
outdated: true
当在文章中添加这个标签时,还应该添加有关只有按照某些方法处理文章,才能移除标签的注释。
当英文原文章更新时,过时的翻译文章必须添加 outdated_translation
标签。如果英文原文章只做出了轻微的改写、语法调整等,则除外。
outdated_translation: true
当给翻译文章添加过时翻译标签时,也应该添加指向英文原文章更新时,第一条提交的 outdated_since
标签。
outdated_since: 29eac89cd535f8b071ca000af8fe4f0be22bdc9b
标签能让网站的搜索引擎更有效地查询文章。标签应该使用与文章相同的语言。并包含英文原文章中所有标签。如果可用,则应使用小写字母。
比如,一篇叫做"谱面讨论"的文章应该包含以下标签:
tags:
- beatmap discussions
- modding V2
- MV2
- 谱面讨论
- 摸图 V2
注意:wiki 维护员将在合并拉取请求之前,根据情况判断并使用这个标签。
有时,翻译文章会在未经过其他熟练使用该语言的人审查的情况下,直接添加进 wiki 中。此时文章需要添加 no_native_review
标签。它能提示将来的翻译员可能需要再次检查这篇文章。
no_native_review: true
另外,no_native_review_since
标签可用于指示第一次未审核编辑的提交位置,以及此后谁编辑了翻译:
no_native_review_since: 5539d9e8c943605a7be186dc3f5ab10569275b05 Doryan
英文文章标题应该使用单数、句首大写。有关更多信息,请参阅维基百科的命名惯例文章。
文章标题应匹配其所在的文件夹名(如有必要,使用空格替代文件夹名里的下划线 (_
))。如果需要修改文件夹名,则也需要相应地修改文章标题名。反之亦然。
比赛(锦标赛或竞赛)的文章标题不需要遵循以上标准。而是:文件夹名必须使用比赛的英文名首字母缩写、简称或其他缩略词,并且应将比赛的全名作为文章标题名。
参见:文章命名
文件夹名必须为英文,且首字母大写。
文件夹名只能使用以下字符:
_
)-
)!
)文章的文件名参考本地化语言小节的文件名
一列。翻译文章的文件位置应放在英文原文章文件所处的文件夹中。
如果文件夹只是为了收录其他文章,则应添加索引文章。索引文章需要列出它所处的文件夹中的文章,以及其他信息,比如所链接文章的引言或描述。
消歧义文章应放在 /wiki/Disambiguation
文件夹下。当添加或更新消歧义文章时,也应该更新消歧义索引文章。参阅 Disambiguation/Mod 作为示例。
必须添加重定向行,才能将容易混淆的词语重定向至消歧义文章。
添加了消歧义文章链接的文章,必须添加对于更多义项 顶注。
除了注释之外,不允许使用 HTML 标签。如果文章内使用了 HTML 标签,则必须重构。
HTML 注释应该用于标记待做事项或添加其他注释内容。一般来说,注释应写在独立的一行中,但也可以写在段落之间。如果写在段落之间,那么注释开头不能含有空格。
反面例子:
HTML 注释 <!-- 待做 HTML 注释解析 --> 应该用于标记待做事项或添加其他注释内容。
正面例子:
HTML 注释<!-- 待做 HTML 注释解析 --> 应该用于标记待做事项或添加其他注释内容。
请注意:在 Github 中上传以 CRLF
(回车换行)作为行尾的 Markdown 文件,将导致这些文件强制使用 CRLF
。为防止这种情况,请在上传前将文件的行尾序列设置为 LF
(换行)。
Markdown 文件必须使用 LF
行尾序列。
根据需求使用转义语法。文章标题会解析为纯文本,因此不可转义。
每段落之后必须有一个空行。
只能使用反斜杠 (\
) 作为换行符。
谨慎使用换行符。
不要与提示相混淆。
顶注是位于整篇文章或部分章节顶部的简短注释。它能用来帮助读者导航到相关文章或提供相关的主题。
顶注必须使用斜体,并紧靠在标题之后。如果使用多个顶注,则必须紧密相连成一个段落,并用换行符分隔。
主文章顶注会引导读者阅读某个主题的主文章。当使用此顶注时,顶注所处的部分必须是所链接页面的摘要。顶注应该只包含一个链接。格式如下:
*主文章:{article}*
*主文章:{article} 和 {article}*
参见顶注告知了读者特定文章或章节中的其他兴趣点。格式如下:
*参见:{article}*
*参见:{article} 和 {article}*
关于...请参见顶注与参见顶注类似,但相比之下更加简明扼要。如有必要,可使用多个链接。格式如下:
*关于 {description},请参见:{article}*
*关于 {description},请参见:{article} 和 {article}*
不要与...相混淆顶注用于区分容易引发歧义和误解的文章标题或章节。如有必要,可使用多个链接。格式如下:
*不要与 {article} 相混淆。*
*不要与 {article} 或 {article} 相混淆。*
对于更多义项顶注与不要与...相混淆顶注类似,但会直接链接到消歧义文章。这类顶注只能链接到消歧义文章。格式如下:
*对于更多义项,参见:{disambiguation article}。*
不要与顶注相混淆。
提示应放在适当的章节开头中,并使用斜体。如有必要,可使用粗体标注,但应谨慎使用粗体。提示应是一条完整的句子。因此,与大多数顶注不同,提示需要使用句号 (.
) 或感叹号 (!
) 结尾。通知内包含的所有内容必须用斜体表示。格式如下:
*备注: {note}.*
*注意: {notice}.*
*小心: {caution}.*
*警告: {warning}.*
备注 (Note)
用于描述事实或琐碎的细节。注意 (Notice)
用于提醒读者或标注需要读者注意的事情。小心 (Caution)
用于警告读者避免节外生枝。警告 (Warning)
用于警告读者如果违反内容,则可能会被处罚。如有必要,可以将顶注和提示混用。若这样做,则必须紧密连接,并使用反斜杠换行。
*警告: {warning}.*\
*另见: {article}*
大多数情况下,将没有直接关系的顶注或提示分开并嵌入一段文字中,可能比混在一起用更合适。
必须使用双星号 (**
) 加粗。
若文章的开头段落中含有文章标题,可以使用粗体。
必须使用单星号 (*
) 加斜。
若首字母缩写第一次出现在文章中,可以使用斜体。
斜体也可以用于强调或方便读者阅读。
应该使用斜体标注作品或电子游戏的名称。osu!——这个游戏除外。
例如,出现 {艺术家} - {曲名}
格式的歌曲时,因为这整个部分都是引用作品,则应该使用斜体表示:
当启动游戏客户端时,可以听到 *cYsmix - triangles* 或其他两首主题歌。
通常不需要将艺术家的名字标为斜体。也就是说,如果是在自由形式的参考中,因为艺术家的名字通常不属于曲名的一部分,所以只需要将曲名改为斜体:
由于一位顶级玩家在某张谱面上留下了一个著名的分数,xi 制作的 *Blue Zenith* 在 osu! 社区内臭名昭著。
由于链接文本已经显示为不同的颜色,所以其已经有强调作用,不需要再次强调:
[Camellia - OOPARTS](https://cametek.bandcamp.com/track/parts) 是一首官方专门为 osu! 创作的歌曲例子,也称为 *osu! original*。它是专门为 osu! 世界杯 2020 决胜谱面创作的。
然而,如果引用的作品并不是链接的一部分,则可以在其中强调:
[Voltaeyx 制作的谱面:*TheFatRat - Mayday (feat. Laura Brehm)*](https://osu.ppy.sh/beatmapsets/756794) 由于含有非常独特的排列,在 2018 年获得了相当大的人气。
以上类型的结构应谨慎使用,并且不能在诸如表格或列表之类会出现大量链接的地方使用。
所有标题首字母必须大写。
标题必须使用 ATX (hash) 样式,并且前后必须含有一个空行(除非标题已经位于第一行,此时,只需要在标题后留一个空行)。
不可使用 5 级之后的标题,并且不得设置文字样式或格式。
参见:文章命名
注意:标题会解析为纯文本,不能转义。
所有文章的第一个标题必须使用 1 级标题,也就是文章标题。其后的所有标题必须为章节标题。第一个标题不得包含格式、链接、图像。
除了使用前言,文章标题必须位于第一行。如果这样,标题应和它之间空出一行。
只能使用 2 到 5 级标题作为章节标题。文章标题之后的章节标题必须使用 2 级标题。与文章标题不同,章节标题可以添加小图标。
其后的章节标题不可跳级使用(比如,不要在使用 2 级标题后直接使用 4 级标题)并且不能包含格式、链接。
注意:在网页上,4、5 级标题不会出现在目录中。
如果想要通过链接直接跳转到章节,也可以自定义章节的标识符。如果用于跳转到章节的标识符太长或含有其他难缠的标点符号或图像,应该使用自定义标识符:
## 我的冷静期结束了。如何申诉? {id=appeal}
## osu! 游玩的各种例子 {id=osu!-gameplay}
这个功能也可以用于标记文章中无标题的特定部分,但应该谨慎使用:
> 就是这样!你正在成为 osu! 节奏冠军的路上!
{id=tutorial-quote}
不应使用超过 4 级列表,并且列表内不能有空行。
如果使用嵌套列表,则项目符号和数字必须与其父列表的项目内容对齐(相比父列表留空 3 格)。
以下是反面例子(请注意项目符号之前的空格数量):
1. 放风筝
- 下雨就别放了。
以下是正面例子:
1. 放风筝
- 下雨就别放了。
无序列表前必须使用连字符号 (-
)。其后必须添加一个空格(如下所示)。
- osu!
- 打击圈
- 连击数字
- 缩圈
- 滑条
- 打击圈
- 滑条体
- 滑条点
- 转盘
- osu!taiko
有序列表的编号必须逐渐递增来表示层级。
1. 下载 osu! 安装程序。
2. 运行安装程序。
1. 如果要更改安装位置,请点击进度条下方的文本。
2. 安装程序将提示你输入新的安装位置,选择安装文件夹。
3. 当安装程序完成后,osu! 将启动。
4. 登录。
应谨慎使用混合列表。
1. 在论坛下载皮肤。
2. 将皮肤加载进 osu!。
- 如果文件格式是 `.zip`,解压文件并将其移动至 `Skins/`(可在你的 osu! 目录下找到)。
- 如果文件格式是 `.osk`,在桌面上直接双击打开它,或是直接拖入游戏客户端内打开。
3. 如果未打开 osu!,打开它,并在设置中选择皮肤。
- 如果你双击打开或是拖入游戏打开了 `.osk` 文件,这步可能已经自动完成。
可以使用重音符 (`
) 标记代码。如果要在代码中加上此符号,请在它周围使用两个标记包括。如果标记位于开始或结束处,请在前后添加空格(如下所示)。
`` ` ``
`` `Space` ``
注意:如果仅介绍字母,而不是所对应的键盘按键,则应使用引号。
表示键盘按键时,单字符按键使用大写字母,多字符按键首字母大写。使用加号 (+
) (不需要用重音符包裹)表示组合键(如下所示)。
pippi 的拼写是小写的 "p",就像 peppy 一样。
按 `Ctrl` + `O` 来打开对话框。
当表示空格时,使用 `Space`
。
从菜单或按钮复制文本时,应该按照显示内容的字母大小写来复制(如下所示)。
如果你的 osu!supporter 生效,则 `osu!direct` 按钮会出现在主菜单的右边。
复制文件夹或目录的名称时,应该按照显示内容的字母大小写来复制,并且尽可能在路径里使用小写。不能使用绝对路径(即路径不能包含驱动器号(盘符)或根目录)(如下所示)。
除非安装时指定了其他文件夹,osu! 会默认安装在 `AppData/Local` 文件夹。
复制关键字或命令时,应按照其显示内容或通常键入方式的字母大小写来复制。并且尽量使用小写(如下所示)。
截至目前,皮肤配置文件 (`skin.ini`) 中的 `Name` 和 `Author` 命令不起任何作用。
复制文件夹名时,应按照其显示内容的字母大小写来复制。并且尽量使用小写(如下所示)。
想要玩 osu!,双击 `osu!.exe` 图标。
注意:文件格式(不要与文件扩展名相混淆)必须使用大写字母拼写,且不包含之前的英文句号 (.
)。
文件扩展名之前必须添加英文句号 (.
),并且需要使用小写(如下所示)。
JPG(或者 JPEG)文件格式的扩展名是`.jpg`(或者 `.jpeg`)。
复制聊天频道的名称时,请使用井号键 (#
) + 小写频道名的格式(如下所示)。
你可以在 `#lobby` 频道宣传你的多人游戏房间。
注意:预格式化文本的语法高亮功能暂未实装至网站。
预格式化文本(也称为代码块)必须使用 3 个重音符号包括起来。并且需要设置代码语言来正常使用语法高亮功能。
参见:脚注
可以使用两种链接:行内链接和参考链接。行内链接有两种样式。
以下是两种行内链接的样式例子:
[Game modifier](/wiki/Gameplay/Game_modifier)
<https://osu.ppy.sh/home>
以下是参考链接的样式例子:
[Game modifier][game mods link]
[game mods link]: /wiki/Game_modifier
如果只引用一次链接,则必须使用行内样式。并且尽量避免使用行内样式中的尖括号样式。参考链接的引用必须放在文章的底部。
注意:内部链接指位于 https://osu.ppy.sh/
域名之内的链接。
所有指向 wiki 文章的链接都应以 /wiki/
开头,后跟目标文章的路径。可以使用相对链接。例子如下所示:
[FAQ](/wiki/FAQ)
[pippi](/wiki/Mascots#pippi)
[Beatmaps](../)
[Pattern](./Pattern)
不允许在 wiki 链接中使用重定向,结尾也不能含有正斜杠号 (/
)。
以下是反面例子:
[文章风格规范](/wiki/ASC)
[开发者](/wiki/Developers/)
[开发者](/wiki/Developers/#游戏客户端开发)
以下是正面例子:
[文章风格规范](/wiki/Article_styling_criteria)
[开发者](/wiki/People/Developers)
[开发者](/wiki/People/Developers#游戏客户端开发)
指向子文章的 wiki 链接需要在链接文本中添加父文章所处的文件夹名称。参见以下示例:
*参见:[谱面编辑器/设计](/wiki/Client/Beatmap_editor/Design)*
注意:在网页里,4 和 5 级标题不含有 id 属性。也就是说无法添加对应的链接。
指向文章章节的 wiki 链接需要使用章节符号 (§
)。参见以下示例:
*对于测量时间轴规定,参见:[谱面上架标准 (RC) § 时间轴](/wiki/Ranking_criteria#timing)*
链接到其他 osu! 网页时,应原样复制浏览器地址栏内网址的所有部分,必须保留 https://osu.ppy.sh
。
当玩家名第一次在文章中出现,可以添加玩家主页链接。其他出现的位置添加链接可选。但对于所有玩家名的处理方式,上下文必须一致。如果很难确认玩家的 id,可以不用添加对应的链接。
链接到玩家主页时,链接中必须填写玩家的 id。使用新网页(https://osu.ppy.sh/users/{username}
)获得玩家的 id。
链接文本应填写玩家现在的名字。
链接到某一个难度时,使用以下的格式:
{艺术家} - {标题} ({谱师}) [{难度名}]
必须链接到单一的难度。难度的 URL 必须使用以下的格式:
https://osu.ppy.sh/beatmapsets/{谱面ID (SID)}#{模式}/{难度ID (BID)}
链接文本里的难度名可以留空,但需要在上下文内保持相同的做法。
链接到某一张谱面时,使用以下的格式:
{艺术家} - {标题} ({谱师})
谱面的 URL 必须使用以下的格式:
https://osu.ppy.sh/beatmapsets/{谱面ID (SID)}
注意:外部链接指位于 https://osu.ppy.sh/
域名之外的链接。
除非目标网站不支持,否则链接必须为 https
协议。外部链接必须绿色无毒,且链接到一个值得信赖的来源。链接到其他外部页面时,应原样复制浏览器地址栏中的 URL。
在视觉上,外部链接和 osu! 网站链接没有区别。因此,应在标题文本中写入网站的名称。参见以下示例:
*想了解更多关于音乐理论的信息,参见:[音乐理论](https://en.wikipedia.org/wiki/Music_theory)。*
可以使用两种图像链接:行内图像和参考图像。例子:
行内样式:
![金牌](/wiki/shared/crown-gold.png "第一名")
参考样式:
![金牌][GCrown]
[GCrown]: /wiki/shared/crown-gold.png "第一名"
图像应使用行内链接样式。参考链接定义必须放在文章的底部。
页面上的所有图像块(同一行上没有其他图像)会被纳入一个画廊中,可以使用屏幕两侧的箭头图标、键盘快捷键或屏幕滑动来导航。
图像链接内,第一对方括号内的文本(备选文本)应该从字面上描述图像。当图像加载失败,或是使用屏幕阅读器时,可以用到它。如果它与标题文本相同,或是图像仅用于装饰,那么可以不用填写备选文本。
图像链接内,引号中的文本(标题文本)应提供图像的其他信息或指明其含义。当光标悬停在图片上时,它将作为提示信息显示,也可以作为图片的标题显示。它不支持任何 Markdown 格式。
如果图像占用了独有的一段,则它将居中成块显示。否则,它将会被行内其他文本包裹显示。
如果图像块含有标题文本,则标题文本会显示在图像的下方。同时,为了避免标题无法正常显示,请不要在图像所处的行添加 HTML 注释或其他任何文本。
图像块通常会与信息框一起使用,来限制图像显示尺寸并将它移至文字内容的另一侧:
::: Infobox
![](img/mod-response.png "一个回摸例子")
:::
网站上的图像可最久缓存 60 天。缓存的图像会匹配对应的链接 URL。
更新图像时,可以更改图像名称,也可以在 URL 中附加查询字符串。此时,所有链接到此更新图像的翻译也应更新、
图像应使用质量 8(80 或 80%,取决于图像制作软件)的 JPG 格式。如果图像包括透明像素,或是含有必须保证可读的文本,则应使用 PNG 格式。如果图像是动画,则可以使用 GIF 格式(谨慎使用。因为它可能超过文件大小限制,或是需要长时间加载)。
图像文件大小必须小于 1 MB。否则图像会加载失败。下采样并用 80% 质量渲染成 JPG 文件几乎不会超过这个限制。
所有图像应该尽可能地优化。使用 jpeg-archive 来压缩 JPEG 图像。为了确保一致性,请在 jpeg-archive 中使用此命令:
jpeg-recompress -am smallfry <input> <output>
另外,ezgif.com也能用于转换和优化图像。
注意:文件扩展名必须使用小写字母,否则会加载失败!
当分隔单词时,使用连字符 (-
)。当给图像命名时,名称应有意义,或是简短扼要。
文章内的图像应存放在文章所处文件夹下的 img
文件夹内。如果图像被多篇文章使用,应存放至 /wiki/shared
文件夹。
网站上的最大图像宽度即文章正文的宽度。图像宽度不应超过 800 像素。
在使用英文注释图像时,使用 Torus Regular 字体。注释内含中文、韩文、日文时,使用微软雅黑字体。
因为翻译者(或其他编者)很难编辑含有注释的图像,所以请尽量避免使用。
翻译含有注释的图像时,翻译图像应放在原始版本(英语版本)图像的同一目录下。且名称应为原始版本图像的名称,后跟连字符,再加上语言文字区域名称(大写字母)。参见以下示例:
hardrock-mod-vs-easy-mod.jpg
对应英文hardrock-mod-vs-easy-mod-DE.jpg
对应德文hardrock-mod-vs-easy-mod-ZH-TW.jpg
对应繁体中文除非想要截图的特性或功能不存在稳定版中,所有游戏中截图应于稳定版 (stable) 中获取。且应使用游戏内截图功能(F12
)。
备注:如果你不想只是为了撰写 wiki 而修改游戏客户端设置,你可以将你的 osu!.<计算机用户名>.cfg
配置文件移出 osu! 文件夹,之后再移回来。
当在游戏客户端内截图时,必须设置为以下参数(以下未列出的设置,使用默认参数)。
English
启用
1280x720
禁用
禁用
禁用
从不
启用
Default
(第一个选项)翻译者请注意:如果你正在翻译的文章中含有截图,截图里游戏语言可以设置为你想要翻译过去的语言。
图像不能是链接文本的一部分。
旗帜标识使用两个大写字母代码来对应某个国家或地区。在行内添加旗帜标识时,请使用以下格式:
::{ flag=XX }::
XX
是 ISO 3166-1 alpha-2 定义的国家或地区用于表示旗帜的两字母代号。
网站内的表格只支持在第一行显示标题。
不能使用美化表格(也就是说,不要在单元格中填充额外的空格来让表格的宽度匹配)。表格内容的左右两侧必须有竖条 (|
),表格内容的两侧还应填充一个空格。使用两个空格,左右添加竖线来表示空单元格。
分隔符行(表格标题下面的行)的每列只能用三个字符描述(左右需要填充一个空格),即以下三种样式之一:
:--
(左对齐):-:
(中心对齐)--:
(右对齐)以下是一个表格例子。
| "古雅"红队 | 比分 | "雕塑"蓝队 | 平均谱面星数 |
| :-- | :-: | --: | :-- |
| **peppy** | 5 - 2 | pippi | 9.3 星 |
| Aiko | 1 - 6 | **Alisa** | 4.2 星 |
| Ryūta | 3 - 4 | **Yuzu** | 5.1 星 |
| **Taikonator** | 7 - 0 | Tama | 13.37 星 |
| Maria | 未比赛 | Mocha | |
信息框是固定宽度的块,与文章右侧对齐。可以用它来存放解释附近文本的相关图像,或者链接到同一类的其他文章的一整块链接。
以下例子,会渲染至屏幕的右侧(如果是竖屏屏幕,则位于上侧)。
Sudden Death 模组图标
::: Infobox
![](/wiki/shared/mods/SD.png "Sudden Death 模组图标")
:::
在以下情况中,应谨慎使用信息框:
信息框中只允许使用 4 和 5 级标题。这些标题不会出现在目录中,而且不能使用 4 级以下的标题。因此,如果这条限制触发了 CI 检查错误,可能需要手动忽略。
脚注是位于页面末尾的简短注释。为了避免影响文章的可读性,可用脚注来存放引用来源、提供背景信息。脚注可以含有文本格式或者链接。
在 osu! wiki 中,脚注是使用了特殊语法([^标识符]
)实现的。脚注可以使用任何文本作为标识符,它们会自动按照出现的先后顺序,显示为数字。翻译文章时,不能修改脚注的标识符。
脚注引用直接位于其指示的单词、短语或句子后面,中间不能含有空格。这些引用必须位于标点符号之后(括号和破折号除外。因为括号用于囊括里面的内容)。
脚注必须放在文章末尾的段落中,并且使用 2 级标题标注。根据脚注内容的不同,2 级标题可写为:参考
、备注
、备注和参考
。
以下是正面例子:
osu! wiki 是一项为了替代老旧的 FAQ 系统的项目。[^wiki-faq]它的名字来自于节奏游戏 osu![^osu] 以及最大的开放在线百科全书——维基百科。从一开始,它就吸引了众多的熟练的翻译者[^wiki-tl]和编者。
## 参考
[^wiki-faq]: https://osu.ppy.sh/community/forums/topics/68525
[^wiki-tl]: https://osu.ppy.sh/community/forums/posts/1177500
[^osu]: https://osu.ppy.sh/community/forums/posts/1178153
引文,或参考,通常用于标识信息来源。请尽量通过脚注引用的方式添加参考资料,而不是在行内直接引用。
在合适的情况下,参考文献应标出作者、日期、服务或平台、标题。根据参考材料的不同,确切的格式也会不同。但尽量使用简明的格式来标出。
例子:
osu!api 的初代版本于 2013 年 7 月 2 日上线。[^api-first-usage]它获得了玩家们的好评。[^api-praise]几年后发行的新版本 API,含有很多新功能。[^api-v2-2020]端点版本控制在 web API 中很常见。[^web-api]
## 参考
[^api-first-usage]: [peppy 提出的论坛讨论串 "osu!api open beta" (2013-07-02)](https://osu.ppy.sh/community/forums/posts/2403913)
[^api-praise]: [在 "osu!api open beta" 里提出的论坛帖 (2013-11-02) ](https://osu.ppy.sh/community/forums/posts/2662247)
[^api-v2-2020]: [@ppy 发送的推特 (2020-03-20)](https://twitter.com/ppy/status/1263083636363948032)
[^web-api]: [维基百科上的 "Web API"](https://zh.wikipedia.org/wiki/Web_API)
为了保持文章可读,或者这些内容不如文章本身重要,脚注可以用于存放无法放入段落内的解释或系列注释。这类脚注可以使用自由文本格式。
例子:
锦标赛不得由经验不足、缺乏理解或毫无见识的工作人员组成的团队组织和运营。[^staff]
## 备注
[^staff]: 一位*缺少经验*的工作人员,可以粗略定义为:osu! 的游玩时长总共小于 1 小时。
引用块只能用于引用某人说过的话或做过的事。除此之外,不能用引用块给文本添加样式。
> plz enjoy game
—rrtyui
主题中断(或称为水平规则、分隔线)应谨慎使用。以下情况(包括但不限于)可以使用主题中断:
主题中断前后必须有一行空行,且只能使用三个连字符。如下所示:
---