总结一下了一下现在看到的几个问题 举例子说一下 并附上正确规范,因为只是markdown 编辑器的一种,不同编辑器对于markdown语言是别的能力是不同的,所以为了翻译的文档可以在每一个编辑器上都可以正确显示,很多细节需要注意一下.
1. 井号后边没有空格
在上,#号后边不添加空格是不影响显示的,但是在之后会用到的编辑器上,会如下效果.
可以看出来 是没有加粗效果的,所以需要#后添加一个空格.
2. 翻译后的中文 和 英文之间没有空行.
在上,中英文中间没有空行也不会影响显示,但是在之后使用的编辑器上,不空行会造成两个段落合并的结果. 效果如下,所以在英文中添加中文的时候,请在段落之间,添加一个空行.
3. 标题和加粗分不清楚.
加粗和斜体,指的是在一个段落中,有加粗和斜体效果的文字,而在一个段落的开始,或者是明显是一个段落内容的总结,请是用#来进行加粗.
比较明显的就是在文档中,文档的开始,会有连续的几个段落,是对罗克韦尔的介绍,段头加粗的单词,是整个段落内容的概述,和一段的开始,请使用#
效果如下.
Contact Rockwell
联系罗克韦尔
See contact information provided in your maintenance contract.
请参阅维护合同中提供的联系信息。
Copyright Notice
版权记录
@2017 Rockwell Automation Technologies, Inc. All rights reserved.
This document and a ny accompanying Rockwell Software products are copyrighted by Rockwell Automation Technologies, Inc. Any reproduction and/or distribution without prior written consent from Rockwell Automation Technologies, Inc. is strictly prohibited. Please refer to the license agreement for details.
@2017罗克韦尔自动化技术有限公司。保留所有权利。
本文档及其随附的罗克韦尔软件产品的版权归罗克韦尔自动化技术有限公司所有。未经罗克韦尔自动化技术有限公司事先书面许可，严禁复制和/或分发。有关详细信息，请参阅许可协议。
4. 引用和代码的区别
引用一般都是存在于 tip 或者 important中的,内容多为文字
tip
hellow world
而代码块的使用是针对于明显代码和注释都用的情况下的.
// get hello world
int a=0
b=a+1
system.out.printlin(b)
5. 引用的书写方式
引用存在的情况是很多的,因为一段引用在>后添加一段话 都是可以加入到引用的,但是因为一段文字的格式问题,可能会出现分段的问题,所以尽量在每一句话前都加上>并且在书写引用的时候请尽量按照以下格式书写
tip
提示
this is a tip about markdown
这是一段关于markdown的提示
6. 表格
在表格中,经常会出现,一个单元格中有好几行的内容,比如第一个单元格中的a b c三个字母是分行的
需要用到的就是br标识符
| hello | world | eg. |
|---|---|---|
| a b c |
这是一个表格 | 请使用br标识符 |
如果表格有标题的话,请在写完标题后,空一行再写表格哦.
7.无序列表的翻译
无序列表 翻译后的中文 请也加上- 并且加上一行空格.
二级无序列表的使用 是在二级列表前加上两个空格
-
一级无序
- 二级无序
-
一级无序
- 二级无序
8. 页眉页脚
如果全部复制过来的文字中,有页眉页脚,请把页眉页脚给删掉.
9. 有序列表的翻译
在翻译有序列表的时候,翻译后的中文,可以序号去掉.
- number1
数字1
- number2
数字2
- number3
数字3
10. 目录的翻译
Chapter 1 Introduction .....................................................1
Intended Audience .....................................................................1
Naming Recommendations ....................................................................2
Typographical Conventions ....................................................................2
Chapter 2 Configuration and Extensions........................... 3
Configuration Keys Specific to the Upload Image Phase .......................3
Configuration Keys Specific to the Upload PDF Phase...........................3
Chapter 3 Reference Documents ........................................ 5
Chapter 4 Revision History................................................... 7
Index ....................................................................................... 9
11. 翻译格式
翻译的时候请尽量将翻译和中文,标题和标题对应,段落和段落对应,方便阅读.