1
0
mirror of https://github.com/LearnOpenGL-CN/LearnOpenGL-CN.git synced 2025-10-19 00:20:10 +08:00

Update sytle guide

This commit is contained in:
Meow J
2016-07-04 02:49:16 +08:00
parent ec944fb3f6
commit 17fe8a5dda
4 changed files with 102 additions and 46 deletions

View File

@@ -1,30 +1,11 @@
# 校对指南(Styleguide)
# 样式指南
- **对照原文**
- 使用中文的标点符号: 逗号、句号、双引号
- 使用英文的标点符号: 括号
- 文本中常量/代码用``加注为代码
- 代码块不使用Tab标注改为用```式标注
- 每一节标题使用`#` (h1)标题(到后面会有几节有很多小节的,太小的标题不明显)
- 根据原文标题大小逐渐递增标题
- 注意"#"后标题前要空格
- 专有名词在对照表里找翻译,需要用括号标注原文
- 原文单词按照标题大写规则大写首字母
- 尽量大部分都翻译掉
- 在Markdown文件中如需插入图片或者代码请与正文空一行
这里是LearnOpenGL中文化工程的样式指南在编写新的翻译或者校对之前请先阅读此文档以确定你的翻译符合要求。
例:
## 基础
```markdown
[text]
[img]
[text]
```
- 翻译注释
- 原文中的斜体一律用加粗表示(中文并不存在斜体),粗体也用粗体表示,注意不要自己添加粗体
- **对照原文,以原文为准**
- 必要时可以使用HTML代码
- 每一节前面加上
```
@@ -35,6 +16,59 @@
校对 | [校对]
```
- 在Markdown文件中如需插入图片或者代码请与正文空一行以方便阅读及解析例如
```markdown
[text]
[img]
[text]
```
## 标点符号
- 一般情况下请使用中文的标点符号
- 当标注翻译的原文时,括号请使用英文的括号(英文与周围空太多会有点难看),但其它情况下请用中文的括号,如
```
OpenGL规范严格规定了每个函数该如何执行以及它们的输出值。至于内部具体每个函数是如何实现(Implement)的将由OpenGL库的开发者自行决定这里开发者是指编写OpenGL库的人。因为OpenGL规范并没有规定实现的细节具体的OpenGL库允许使用不同的实现只要其功能和结果与规范相匹配亦即作为用户不会感受到功能上的差异
```
- 原文中的斜体一律用加粗表示(中文并不存在斜体),粗体也用粗体表示,注意不要自己违反原文添加粗体
## 代码
- 文本中常量/代码用``加注为代码
- 代码块不使用Tab标注请用```式标注
- 代码的语言请用以下方式标注出来:
```c++
[code]
```
- 请记得翻译注释
## 标题
- 每一节标题使用`#`h1标题(到后面会有几节有很多小节的,太小的标题不明显)
- 根据原文标题大小逐渐递增标题
- 注意`#`后与标题前要加一个空格
## 专有名词
- 专有名词需要在第一次出现的之后用括号标注原文
- 原文单词按照标题大写规则大写首字母
- 翻译
- 首先,请与本工程中大部分的翻译保持一致
- 如果工程中找不到已有的翻译,请参考本文档最下面的词汇表寻找翻译
- 如果还是找不到,可以自己创造一个翻译,或者直接写英文
- “Additional resources”译作“附加资源”“Exercises”译作“练习”“Solution”译作“参考解答”
## 特殊元素
- 公式用[http://latex2png.com/](http://latex2png.com/)转换文本中的公式Resolution为150单独的公式为200
- 视频用Video标签添加
@@ -43,25 +77,43 @@
</video>
```
- 如果有比较长的译注:
- 短的译注直接用中文括号插入文中标明译注即可,例如:
```
xxxx(([译注x])
[译注x]: http://learnopengl-cn.readthedocs.org "text"
文本(译注:[text]
```
效果会像这样([译注1])
- “Additional resources”译作“附加资源”“Exercises”译作“练习”“Solution”译作“参考解答”
- 必要时可以使用HTML代码
- 如果有比较长的译注,请将以下标记插入文本的段落之后:
**如果有不全的继续加**
```
!!! note "译注"
##专业词汇对照表
[text]
```
1. [《游戏引擎架构》中英词汇索引表](http://www.cnblogs.com/miloyip/p/GameEngineArchitectureIndex.html)
- 原文中的红色方框请用`!!! attention`标注,绿色方框请用`!!! important`标注注意文本前有个Tab格式如下
2. 摘抄自《OpenGL超级宝典第五版》
红色方框:
```
!!! attention
[text]
```
绿色方框:
```
!!! important
[text]
```
## 专业词汇对照表
1. [微软术语搜索](https://www.microsoft.com/Language/zh-cn/Search.aspx)
2. [《游戏引擎架构》中英词汇索引表](http://www.cnblogs.com/miloyip/p/GameEngineArchitectureIndex.html)
3. 摘抄自《OpenGL超级宝典第五版》
英文词 | 对应翻译
---|---
@@ -122,4 +174,4 @@ Viewport|视口
Wireframe|线框
pipeline | 渲染管线
[译注1]: http://learnopengl-cn.readthedocs.org "bakabaka我是译注"
[译注1]: http://learnopengl-cn.readthedocs.org "这里是很长很长很长很长很长很长很长很长很长很长很长很长很长很长很长很长很长很长很长很长很长很长很长很长很长很长很长很长很长很长很长很长很长很长很长很长很长很长很长很长很长很长很长很长很长很长很长很长很长很长很长很长很长很长很长很长很长很长很长很长很长很长很长很长很长很长很长很长很长很长很长很长很长很长很长很长很长很长很长很长很长很长很长很长很长很长很长很长很长很长很长很长很长很长很长很长很长很长很长很长很长很长很长很长很长很长很长很长很长很长很长很长很长很长很长很长很长很长很长很长很长很长很长很长很长很长很长很长很长很长很长很长很长很长很长很长很长很长很长很长很长很长很长很长很长很长很长很长很长很长很长很长很长很长很长很长很长很长很长很长很长很长很长很长很长很长很长很长很长很长很长很长很长很长很长很长很长很长很长很长很长很长很长很长很长很长很长很长很长很长很长很长很长很长很长很长很长很长很长很长的译注"