Skip to content
体验新版
项目
组织
正在加载...
登录
切换导航
打开侧边栏
OpenHarmony
Docs
提交
d0426137
D
Docs
项目概览
OpenHarmony
/
Docs
1 年多 前同步成功
通知
159
Star
292
Fork
28
代码
文件
提交
分支
Tags
贡献者
分支图
Diff
Issue
0
列表
看板
标记
里程碑
合并请求
0
Wiki
0
Wiki
分析
仓库
DevOps
项目成员
Pages
D
Docs
项目概览
项目概览
详情
发布
仓库
仓库
文件
提交
分支
标签
贡献者
分支图
比较
Issue
0
Issue
0
列表
看板
标记
里程碑
合并请求
0
合并请求
0
Pages
分析
分析
仓库分析
DevOps
Wiki
0
Wiki
成员
成员
收起侧边栏
关闭侧边栏
动态
分支图
创建新Issue
提交
Issue看板
未验证
提交
d0426137
编写于
8月 11, 2022
作者:
L
LiAn
提交者:
Gitee
8月 11, 2022
浏览文件
操作
浏览文件
下载
电子邮件补丁
差异文件
update zh-cn/contribute/style-guide/style-guide-content-elements.md.
Signed-off-by:
N
LiAn
<
lian15@huawei.com
>
上级
de5356ca
变更
1
隐藏空白更改
内联
并排
Showing
1 changed file
with
13 addition
and
0 deletion
+13
-0
zh-cn/contribute/style-guide/style-guide-content-elements.md
zh-cn/contribute/style-guide/style-guide-content-elements.md
+13
-0
未找到文件。
zh-cn/contribute/style-guide/style-guide-content-elements.md
浏览文件 @
d0426137
...
...
@@ -32,6 +32,10 @@
【规则】表格至少为两行两列。
【规则】表格行数(Rows)应≤9行,列数(Columns)应≤4列,推荐2~3列。大于4列的表格需要拆分或将列内容合并,以减少列数;也可采用项目列表等形式改写。每个单元格中,内容所占行数不宜超过5行。
【规则】Markdown中,如果表格预览效果不佳,请采用减少列数、减少单元格内容中单个英文字符串长度、或将表格改写为项目列表等方式调整,以免影响可读性。
【规则】相同类型的表标题、表头,风格保持一致,采用名词或名词词组的形式。
同样对参数进行说明的表,不应出现“参数说明”、“参数解释”、“参数含义”、“参数意义”等不同的表头内容,需要全文保持统一。
...
...
@@ -48,6 +52,8 @@
【规则】表格内容默认使用左对齐。
【建议】如果表格的列数太多而行数较少,建议把表格的列转换成行。
## 图片
...
...
@@ -167,6 +173,13 @@
【规则】中文文档中,缩略语全称中对应的字母大写。
【规则】“
[
OpenHarmony术语表
](
https://gitee.com/openharmony/docs/blob/master/zh-cn/glossary.md
)
”中,术语名以“英文全称 (缩略语);中文全称”的形式写作;术语解释直接陈述术语内涵,不需要重复术语名。
|
**正例**
|
**反例**
|
| ------------------------------------------------------------ | ------------------------------------------------------------ |
| - Hardware Driver Foundation (HDF);硬件驱动框架
<br>
用于提供统一外设访问能力和驱动开发、管理框架。 | - HDF
<br>
Hardware Driver Foundation,硬件驱动框架,用于提供统一外设访问能力和驱动开发、管理框架。 |
| - ArkUI;方舟开发框架
<br>
一套极简、高性能、跨设备应用设计研发的UI开发框架,支撑开发者高效地构建跨设备应用UI界面。 | - ArkUI
<br>
是一套极简、高性能、跨设备应用设计研发的UI开发框架,支撑开发者高效地构建跨设备应用UI界面。 |
【建议】一篇文档中某缩略语首次出现的位置(标题和表头除外),提供英文全称,可选提供中文全称。
【建议】开发板名称、设备名称等不作为术语或缩略语,不在术语表中体现。建议在文档中单独以表格或其他形式介绍。
...
...
编辑
预览
Markdown
is supported
0%
请重试
或
添加新附件
.
添加附件
取消
You are about to add
0
people
to the discussion. Proceed with caution.
先完成此消息的编辑!
取消
想要评论请
注册
或
登录