mirror of
https://github.com/LearnOpenGL-CN/LearnOpenGL-CN.git
synced 2025-08-23 04:35:28 +08:00
59 lines
1.6 KiB
Markdown
59 lines
1.6 KiB
Markdown
# 校对指南(Styleguide)
|
||
|
||
- **对照原文**
|
||
- 使用中文的标点符号: 逗号、句号、双引号
|
||
- 使用英文的标点符号: 括号
|
||
- 文本中常量/代码用``加注为代码
|
||
- 代码块不使用Tab标注，改为用```式标注
|
||
- 每一节标题使用`#` (h1)标题(到后面会有几节有很多小节的，太小的标题不明显)
|
||
- 根据原文标题大小逐渐递增标题
|
||
- 注意"#"后标题前要空格
|
||
- 专有名词在对照表里找翻译，需要用括号标注原文
|
||
- 原文单词按照标题大写规则大写首字母
|
||
- 尽量大部分都翻译掉
|
||
- 在Markdown文件中如需插入图片或者代码，请与正文空一行
|
||
|
||
例:
|
||
|
||
```markdown
|
||
[text]
|
||
|
||
[img]
|
||
|
||
[text]
|
||
```
|
||
|
||
- 翻译注释
|
||
- 原文中的斜体一律用加粗表示(中文并不存在斜体)，粗体也用粗体表示，注意不要自己添加粗体
|
||
- 每一节前面加上
|
||
|
||
```
|
||
原文 | [英文标题](原文地址)
|
||
---|---
|
||
作者 | [作者]
|
||
翻译 | [翻译]
|
||
校对 | [校对]
|
||
```
|
||
|
||
- 公式用[http://latex2png.com/](http://latex2png.com/)转换，文本中的公式Resolution为150，单独的公式为200
|
||
- 视频用Video标签添加
|
||
|
||
```html
|
||
<video src="url" controls="controls">
|
||
</video>
|
||
```
|
||
|
||
- 如果有比较长的译注:
|
||
|
||
```
|
||
xxxx(([译注x])
|
||
|
||
[译注x]: http://learnopengl-cn.readthedocs.org "text"
|
||
```
|
||
效果会像这样([译注1])
|
||
|
||
- “Additional resources”译作“附加资源”，“Exercises”译作“练习”，“Solution”译作“参考解答”
|
||
|
||
**如果有不全的继续加**
|
||
|
||
[译注1]: http://learnopengl-cn.readthedocs.org "bakabaka我是译注" |