Skip to content

Commit

Permalink
Add Chinese (zh) User Guide
Browse files Browse the repository at this point in the history
  • Loading branch information
imnasnainaec committed Nov 2, 2023
1 parent 21787af commit 4d3dd6b
Show file tree
Hide file tree
Showing 9 changed files with 520 additions and 6 deletions.
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@
[github-actions]: https://github.com/sillsdev/TheCombine/actions
[localization-sd-badge]:
https://img.shields.io/badge/Semantic%20Domains-Ar%20En%20Es%20Fr%20Hi%20Ml%20My%20Pt%20Ru%20Sw%20Zh-blue
[localization-ug-badge]: https://img.shields.io/badge/User%20Guide-En%20Es-blue
[localization-ug-badge]: https://img.shields.io/badge/User%20Guide-En%20Es%20Zh-blue
[localization-crowdin-combine]: https://crowdin.com/project/the-combine
[localization-crowdin-flex]: https://crowdin.com/project/fieldworks
[github-version-badge]: https://img.shields.io/github/package-json/v/sillsdev/TheCombine
Expand Down
43 changes: 43 additions & 0 deletions docs/user_guide/docs/account.zh.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,43 @@
# 账号

如何注册、登录并编辑用户账号

![登陆](../images/login.png){.center}

## 注册

要创建新账户,请点击登录页面上的 [注册](../../sign-up) 按钮。

!!! 笔记

电子邮件地址用于重新设置用户密码,因此,每个电子邮件地址只能有一个账号。

## 登录

[登录](../../login) 到 The Combine 请键入注册时提供的用户名和密码,

如果用户想换密码,点击“忘记密码?”链接即可 按照指示去操作,系统会将一套密码重新设置流程发送到与用户账号有关的电子邮件地
址上。

!!! 重要警告

用户名和电子邮件地址不需要区分大小写。 密码必须要区分大小写。

## 设置

登陆后,沿着 The Combine 的顶部有一个蓝色应用框(App Bar)。 点击应用框右端的头像图标,以打开用户菜单 选“用户设置”就可更
改账号或简况设置

![用户菜单](../images/userMenu.png){.center}

用户可添加或更新

- • 头像图标;
- • 姓名;
- • 电话号码;
- • 电子邮件地址;
- • 用户界面语言;

!!! 笔记

注册时用到的用户名具有永久性,且无法更改。
32 changes: 32 additions & 0 deletions docs/user_guide/docs/admin.zh.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
# 管理/网站设置

网站管理员在用户菜单中还有一个选项:“网站设置”。

![用户菜单 - 管理](../images/userMenuAdmin.png){.center}

## 项目管理

管理员可以输出、归档及存储任何项目。 项目一旦归档,所有用户都将无法再访问,甚至对项目创建者也不例外;但任何管理员都可以
重新恢复该项目。 目前还没有一种方法可以永久删除一个项目。

## 用户管理

管理员可以删除任何非管理员用户账户。 需添加或移除管理员用户,请与网站所有者联系。

## 横幅

管理员可通过配置横幅,定义自己的 The Combine 实例。

### 通知横幅

当用户访问 The Combine 时,通知横幅将一条醒目的横幅摊开在页面顶部。 这些横幅旨在向用户显示那些跟 The Combine 实例有关的
重要、简短的信息。 信息可能包括定时升级、计划的停机时间,或即将发生的服务器更改。

![通知横幅](../images/announcementBanner.png){.center}

### 登录横幅

登陆横幅将一条信息置于登陆页面底部。 该横幅旨在告诉用户需要了解 The Combine 的实例特定信息,例如有关支持、版本升级、数据
库备份策略的联系人是谁。

![登录横幅](../images/loginBanner.png){width=400 .center}
62 changes: 62 additions & 0 deletions docs/user_guide/docs/dataEntry.zh.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,62 @@
# 词条输入

## 语义域树

浏览或查询感兴趣的领域。

!!! 提示

为快速查询某个域名,The Combine 会在用户键入一连串连续数字时自动插入“.”符号。 例如,“1234‘就会自动变为“1.2.3.4”。 如果键入任何非数字的字符,此现象则不会发生。

## 新词条

### 土语

出现在土语语言中的词,它通常按照语音拼写或根据当地的正字写出。

### 注释

一个词条可有多种词义或注释,在开始创建词条时,只能添加一个。

### 笔记

每个词条可以有一个笔记。 对一个词·条的词义、注释、语义域等的任何注释,都可以加进该词条的笔记中

### 录音

用户可为每一词条添加多重录音(如男声或女声)。 跟笔记部分一样,音频录音与词条相关联,而非其词义。

要录制音频时,有一个红色的圆键。 每一条录好的音频,都有一个绿色三角键

**用鼠标** 点击并按住红色圆圈开始录制。 点击绿色三角键播放音频,或按住 移位键并单击以删除其录音。

**用触屏** 点击并按住红色圆圈开始录制。 轻触绿色三角键播放其音频,或者下压并按住,以拉出菜单栏(带播放或删除选项)。

## 含重复土语形式的新词条 {#new-entry-with-duplicate-vernacular-form}

如果用户提交的新词条与土语现有的词条有相同的形式和注释,该词条将被更新,不会创建一个新词条。 举例说明:如果用户在域值
2.1.3.1(手臂) 提交了[土语: dedo; 注释: 手指] 后,又在域值2.1.3.3(手指,脚趾) 提交,结果 “dedo”这词条、含注释为“手指” 单
个词义及有两个域值。

The Combine 有一个可选功能,便于输入项目中已经存在的词条,但 这词条在新语义域中再次被收集。 该功能可以在
[项目设置 > 自动完成](project.md#autocomplete)打开和关闭。 当该功能打开后,用户在数据输入中键入土语时,就会出现一条下拉
菜单,而菜单里列出项目中现存完全相同或类似的土语词条。 如果用户看到正在键入的单词出现在该项目中,可以点击 列出的词条,而
不必键入该单词的其余部分。 当功能关闭后,词条必须完整地输入;不会推荐任何现有的词条。

![含重复土语形式的新词条](../images/data-entry-dup-vern.png){.center}

无论您键入的词条是与项目中的现有词条一样,还是选择 The Combine 提供的建议,都会弹出一个提供选项的方框。 (如果自动完成设
置处于关闭状态,或者输入的土语词条在项目中不存在,则此方框不会弹出)。 在弹出的方框中,用户可以看到所有类似的词条,然后可
以选择更新其中一个词条或创建一个新词条。

![新词条重复土语的词条](../images/data-entry-dup-vern-select-entry.png){.center}

如果用户选择创建新词条,弹出的方框就会消失,这时就可以键入新词条的注释。

!!! 笔记

尽管用户选择创建新词条,如果键入的注释与土语中另一条完全相同的词条一样,新词条就不会被创建,而是该词条会被更新。

如果用户选择更新已有的其中一个词条,屏幕就会显示另一个方框 此时用户可选择更新词条的词义,或者将新的词义添加到该词条。

![新词条重复土语的词义。](../images/data-entry-dup-vern-select-sense.png){.center}
173 changes: 173 additions & 0 deletions docs/user_guide/docs/goals.zh.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,173 @@
# 数据清理/目标

## 检阅词条 {#review-entries}

检查词条表显示出一个项目内所有的词条。

### 排序和筛选列

这些列包括:编辑,土语,词义,注释,领域,发音,笔记,标记,和删除。

![审查词条列标题](../images/reviewEntriesColumns.png)

主要是文字内容(土语,注释,领域,笔记,或标记) 的列的顶部,用户可根据字母顺序分类,或者采用文本搜素的方式进行筛选

在词义和发音列的顶部,用户可根据词条的词义数量或录音数量进行分类或筛选。

由于快速字词收集(Rapid Word Collection)自身带有的特性,The Combine 中的 [词条输入](dataEntry.md) 不支持添加定义或词性
的功能。 但是,如果该项目已输入的数据中已有定义或词类,审查词条表中会自动添加额外的列来表达该信息。

### 编辑词条行

用户可以使用“发音”列中的图标来录制、播放或删除词条的录音。 用户可以使用删除列中的图标删除整个词条。

要编辑词条的语形、词义(含注释和领域)、笔记、标记时,只需点击编辑列的图标。

## 合并重复项 {#merge-duplicates}

该工具会自动查找可能重复的词条(每组最多 5 个词条,每次最多 12 组)。 首先,该工具会找出有相同形式的土语。 接着,它会找出
类似土语形式或有相同注释(或定义) 的土语。

![合并两个重复的词条](../images/mergeTwo.png)

每个词条都显示在一列中,并且该词条的每种词义都以卡片的形式展现,这样可方便用户点击并拖动。 用户可对每一个词义采取三种基
本的处理方式:移除、将其与另一个词义合并,或者删除。

### 迁移词义

当用户点击并按住词义卡时,它会变成绿色。 用户可将词义卡拖放至同一列中的不同位置,以重新排列该词条的各项词义。 或者,也可
将此卡拖放至不同列,以将该词义移至另一词条。

![Merge Duplicates moving a sense](../images/mergeMove.png)

如果用户想将含有多种词义的词条拆分为多个词条,可将其中一张词义卡拖至右侧空的附加列中。

### 合并词义

如果将一张词义卡拖至另一张词义卡上,另一张词义卡也会变成绿色。

![Merge Duplicates merging a sense](../images/mergeMerge.png)

将一张词义卡拖放到另一张词义卡上(当它们同时显为绿色时),它们的词义就合并。 这会导致在右侧出现一个蓝色侧边栏,显示出哪些
词义被合并。

![合并重复的词条和合并其词义](../images/mergeSidebar.png)

!!! 重要警告

当多种词义被合并时,所有语义域得以保留,但“只有侧边栏顶部的词义”保留其注释(和定义)。

用户可将词义卡拖放至侧栏,或者从侧栏拖放至词义卡,来决定哪个词义被合并。 或者在侧栏内,用户可将不同的词义移至顶部(以保留
其注释)。

![Merge Duplicates moving a sidebar sense](../images/mergeSidebarMove.png)

点击右角括号(>) 可关闭或打开蓝色侧边栏。

### 删除词义

要完全删除一个词义,请将其卡片拖至左下角垃圾桶的图标内。 当词义卡变为红色时,松开鼠标。

![合并重复,删除一个词义](../images/mergeDelete.png)

如果用户删除列中仅剩的一条词义,则整个列将消失,并且在保存& 时,整个词条将被删除。

![合并重复的词条,删除词义内容](../images/mergeDeleted.png)

### 标记词条

每列的右上角(位于土语形式右侧) 都有一个旗标图标。

![合并重复,标记该词条](../images/mergeFlag.png){.center}

用户可点击旗标来标记该词条,以用于将来检查或编辑。 (用户可以在[检阅词条](#review-entries)中对标记的词条进行排序)。 当用
户标记词条时,可选择添加文本。

![Merge Duplicates adding or editing a flag](../images/mergeEditFlag.png){.center}

无论是否有任何文本被键入,用户会知晓该词条已被标记,因旗标图标会变为红色。 如果用户添加了文本,可将鼠标悬停在旗标图标上
方来查看文本。

![Merge Duplicates a flagged entry](../images/mergeFlagged.png){.center}

点击红色旗标图标来编辑文本,或者移除标记。

### 完成一组

在底部的位置有两个键,可用于完成目前这一组潜在重复词条有关的工作,并继续下一组的工作:“保存& 继续”和“推迟”。

#### 保存 & 继续

![合并重复保存并继续按钮](../images/mergeSaveAndContinue.png)

蓝色的“保存与继续”键有两个功能。 第一,它将所有更改都保存下来(例如,所有已被移除、合并或被删除的词义),并更新数据库中的
词。 第二,它将任何未合并的词保存为非重复词。

!!! 提示

可能的重复是真的重复吗? 用户只需点击 保存& 继续, 即可告诉 The Combine 不再显示该组的资料。

!!! 笔记

如果有意不合并词组中有一个被修改(例如,在检阅条目),则该组词会再次显示为可能重复词。

#### 推迟

![合并重复推迟按钮](../images/mergeDefer.png)

灰色”推迟”键会重置潜在重复词组所做的任何修改 可通过 "审查被推迟的重复词组 "重新访问被推迟的词组。 。

### 与输入的数据合并

#### 定义和词性

尽管定义与词性无法在词条输入时添加,但它们可以出现在输入的词条中。 出现在“合并重复项”词义卡上的内容:

- 分析语言内的任何定义都将被显示在该语言的注释下方。
- 左上角的彩色六边形表示词性 颜色对应其一般类别(例如名词或动词)。 用户将鼠标悬停在六边形上可查看该词的具体语法类别(例
如,专有名词或及物动词)。

![将重复词义与定义和语性合并](../images/mergeSenseDefinitionsPartOfSpeech.png){.center}

#### 受保护的词条与词义

如果导入的词条或词义项包含 The Combine 不支持的资料(例如词源或词义反转),它将被保护以防止删除。 受保护的词义卡会有一个黄
色背景。它无法被删除,也无法(被合并)放入另一张词义卡。 如果整个词条受保护,其列将具有黄色标题(位于土语和旗标位置)。 当受
保护的词条只有一个词义时,该词义卡就无法被移动。

## 创建字符库存

创建字符工具仅供项目管理员使用。

_创建字符库存_" 提供了该项目词条土语形式出现的每个符编码标准字符的概览。 这会使用户识别出该语言中经常用到的字符,并将它
们“接受”为该语言字符库存的一部分。 字符库属于项目土语的LDML文档一部分,在项目 [导出](project.md#export) 时会包含该文件。
接受字符后,就能用统一的字符编码标准、在民族语及其他语言资源中表达,

*创建字符库存*的另一个用途,即为识别和替换那些在键入土语字形时被误用的字符。

土语词条中的每个统一编码标准的的字符都有一个图块。 每个图块显示字符、其编码 Unicode "U+" 值,以及它在词条土语形中出现的
次数并其指定名称(默认:有待决定)。

![字符库字符图标](../images/characterInventoryTiles.png)

### 管理单个字符

点击一个字符图块可打开该字符的面板。

!!! 提示

用户可能需要滚动才能看到面板。 如果用户电脑可视窗户足够宽,窗的右边会有空白边距;而面板将位于其顶部。 如果电脑可视窗户狭窄,图块就会一直填充到窗户右侧;该面板将位于底部,即所有图块的下方。

![字符库字符面板](../images/characterInventoryPanel.png){.center}

面板中间最多会显示该字符总共出现的5个土语形示例,并突出显示每次出现时的字符。

面板顶部有三个键,用于指定该字符是否应含在土语的字符库中。它们是:“接受”、“待定”、“拒绝”。 按其中任何一个键都会更新位于
字符图块底部的指定。 (这些对字符库所做的修改只有在点击“保存”键后才会被保存到项目。“保存”键在页面底部)

面板底部是“查找和替换”工具。 如果该字符在*每次*时都应替换成其他字符,只需在“替换为”框中键入替换字符或字符串,然后点击“应
用”键即可。

!!! 重要警告

“查找和替换 ”操作更改的是词条,而不是字符库。 **它无法被撤销!**
17 changes: 17 additions & 0 deletions docs/user_guide/docs/index.zh.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
# 概览

The Combine 是一个支持
[快速字词收集](https://www.sil.org/dictionaries-lexicography/rapid-word-collection-methodology)(RWC) 工作坊和后工作坊数
据清理的工具。

## 开始

关于如何创建与管理账户,请参看我们 [账户](account.md) 页面。

关于如何创建与管理项目,请参看我们 [项目](project.md) 页面。

## 收集与组织数据

关于如何收集数据,请参阅我们的 [词条输入](dataEntry.md) 页面。

关于编辑和整理所收集数据的工具,请参阅我们的 [数据清理](goals.md) 页面。
Loading

0 comments on commit 4d3dd6b

Please sign in to comment.