lkml.org 
[lkml]   [2021]   [Dec]   [8]   [last100]   RSS Feed
Views: [wrap][no wrap]   [headers]  [forward] 
 
Messages in this thread
/
From
Date
SubjectRe: [PATCH] doc/zh_CN: add Chinese document coding style reminder
<alexs@kernel.org> 于2021年12月8日周三 19:41写道:
>
> From: Alex Shi <alexs@kernel.org>
>
> The coding style requirement for Chinese document is easy to be overlooked.
> Add the request as a remdiner.
>
> Signed-off-by: Alex Shi <alexs@kernel.org>
> Cc: Yanteng Si <siyanteng01@gmail.com>
> Cc: Tang Yizhou <tangyizhou@huawei.com>
> Cc: Jonathan Corbet <corbet@lwn.net>
> Cc: linux-doc@vger.kernel.org
> Cc: linux-kernel@vger.kernel.org
> ---
> Documentation/translations/zh_CN/index.rst | 4 ++++
> 1 file changed, 4 insertions(+)
>
> diff --git a/Documentation/translations/zh_CN/index.rst b/Documentation/translations/zh_CN/index.rst
> index a34e58733ac8..8c2786ed0279 100644
> --- a/Documentation/translations/zh_CN/index.rst
> +++ b/Documentation/translations/zh_CN/index.rst
> @@ -23,6 +23,10 @@
> 另外,随时欢迎您对内核文档进行改进;如果您想提供帮助,请加入vger.kernel.org
> 上的linux-doc邮件列表。
>
> +顺便说下,中文文档也需要遵守内核编码风格,风格中中文和英文的主要不同就是中文
> +的字符标点占用两个英文字符宽度, 所以,当英文要求不要超过每行100个字符时,
> +中文就不要超过50个字符。另外,也要注意'-','=' 等符号与相关标题的对齐。
How about:
另外,'-','=' 等符号需要与相关标题对齐, 为了照顾没有图形界面和习惯用vi查阅文档
的开发者,中文文档的文本块、段落等也应像英文文档那样整整齐齐。

在将补丁提交到社区之前,一定要进行必要的checkpatch.pl检查和编译测试,网页版
文档在部分浏览器中暂时可能会出现多余的空格,目前已知firefox正常,据了解,浏
览器规范草案中已有该问题的解决方案,将来有希望解决。

.. 小技巧: 翻译时跟随英文文本块换行无需关心中文每行是否超字数,也不用担心漏掉空
行和缩进以及漏翻译,因为我们只需原地进行中英文字符串替换就可以了。

Thanks,
Yanteng
> +
> 许可证文档
> ----------
>
> --
> 2.27.0
>
\
 
 \ /
  Last update: 2021-12-09 02:35    [W:0.088 / U:0.180 seconds]
©2003-2020 Jasper Spaans|hosted at Digital Ocean and TransIP|Read the blog|Advertise on this site