Skip to content

Commit

Permalink
[User Guide] Add custom semantic domains info (#3218)
Browse files Browse the repository at this point in the history
  • Loading branch information
imnasnainaec authored Jul 2, 2024
1 parent 157753b commit 89906ef
Show file tree
Hide file tree
Showing 24 changed files with 119 additions and 40 deletions.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/user_guide/assets/images/projectSettings1Basic.es.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/user_guide/assets/images/projectSettings1Basic.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/user_guide/assets/images/projectSettings1Basic.zh.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/user_guide/assets/images/projectSettings2Langs.es.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/user_guide/assets/images/projectSettings2Langs.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/user_guide/assets/images/projectSettings2Langs.zh.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/user_guide/assets/images/projectSettings3Users.es.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/user_guide/assets/images/projectSettings3Users.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/user_guide/assets/images/projectSettings3Users.zh.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/user_guide/assets/images/projectSettings4Port.es.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/user_guide/assets/images/projectSettings4Port.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/user_guide/assets/images/projectSettings4Port.zh.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/user_guide/assets/images/projectSettings5Sched.es.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/user_guide/assets/images/projectSettings5Sched.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/user_guide/assets/images/projectSettings5Sched.zh.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
54 changes: 40 additions & 14 deletions docs/user_guide/docs/project.es.md
Original file line number Diff line number Diff line change
Expand Up @@ -42,9 +42,11 @@ y/o el nombre del proyecto en el centro de la barra de aplicaciones, en la parte
en el icono de engranaje o en el nombre del proyecto, aparece Proyecto Ajustes para gestionar el proyecto. Los
siguientes ajustes están disponibles para los usuarios del proyecto con permisos suficientes.

![Configuración](../images/projectSettings123456.png)

### Configuración básica

![Configuración básico](../images/projectSettings1Basic.es.png){width=750 .center}
![Configuración básico](../images/projectSettings1Basic.es.png)

#### Nombre del proyecto

Expand All @@ -70,7 +72,7 @@ que el proyecto se elimine por completo de los servidores.

### Idiomas del proyecto {#project-languages}

![Idiomas](../images/projectSettings2Langs.es.png){width=750 .center}
![Idiomas](../images/projectSettings2Langs.es.png)

![Idiomas del proyecto - Tzotzil](../images/projectLanguagesTzotzil.es.png){.center}

Expand All @@ -89,7 +91,7 @@ dominios semánticos en [Entrada de datos](./dataEntry.md).

### Usuarios del proyecto

![Usuarios](../images/projectSettings3Users.es.png){width=750 .center}
![Usuarios](../images/projectSettings3Users.es.png)

#### Usuarios actuales

Expand Down Expand Up @@ -146,7 +148,7 @@ used for the file names).

### Importar/Exportar

![Importar/Exportar](../images/projectSettings4Port.es.png){width=750 .center}
![Importar/Exportar](../images/projectSettings4Port.es.png)

#### Importar {#import}

Expand Down Expand Up @@ -177,16 +179,44 @@ When a project is exported from TheCombine and imported into FieldWorks, if a pr
the speaker name will be added as a pronunciation label. The consent files can be found in the zipped export, but will
not be imported into FieldWorks.

### Calendario de talleres {#workshop-schedule}
### Calendario {#schedule}

![Calendario de talleres](../images/projectSettings5Sched.es.png){width=750 .center}
![Calendario](../images/projectSettings5Sched.es.png)

Sólo está disponible para editar para el Propietario del proyecto, lo que permite fijar un calendario para un taller de
recopilación rápida de palabras. Haga clic en el primer botón para seleccionar un intervalo de fechas para el taller.
Pulse el botón central para añadir o eliminar fechas concretas. Pulse el último botón para borrar la programación.

![Calendario de talleres](../images/projectSchedule.es.png){.center}

### Dominios semánticos {#semantic-domains}

![Dominios semánticos](../images/projectSettings6Doms.es.png)

In this settings tab, you can change the semantic domain language and manage custom semantic domains.

El _idioma de los_ dominios semánticos controla el idioma en el que se muestran los títulos y descripciones de los
dominios semánticos en [Entrada de datos](./dataEntry.md).

The _custom semantic domains_ supported at this time are the [established domains](https://semdom.org/) with `.0` added
to the end of the id. For example, domain _4.2.6.2: Sports_ has two standard subdomains, _4.2.6.2.1: Football, Soccer_
and _4.2.6.2.2: Basketball_. If another sport is dominant among the people group gathering their language, it can be
added as domain _4.2.6.2.0_.

For each custom domain, you can add a name, description, and questions to help with word collection in that domain.

!!! note "Nota"

Custom semantic domains are included in the project export and can be imported into FieldWorks. However, the
questions are not included.

Custom semantic domains will appear in the domain tree for the project, but will not be visible to other projects.

!!! note "Nota"

Custom semantic domains are language-specific. If you add a custom domain in one language then change the semantic
domains language, that domain will not be visible unless you change back to its language.

## Estadísticas del proyecto

Si usted es el Propietario del proyecto, habrá otro icono junto al icono del engranaje en la App Bar, en la parte
Expand All @@ -208,14 +238,10 @@ Una tabla con el número de palabras de cada dominio semántico.

### Palabras por día

Gráficos lineales que muestran las palabras recogidas durante los días especificados en el
[Calendario de talleres](#workshop-schedule).
Gráficos lineales que muestran las palabras recogidas durante los días especificados en el [Calendario](#schedule) de
talleres.

### Progresos del taller

Gráficos lineales que muestran las palabras acumuladas a lo largo de los días del
[Calendario de talleres](#workshop-schedule), así como las previsiones para el resto del taller.

## Semantic Domains

Details about custom semantic domains are coming soon.
Gráficos lineales que muestran las palabras acumuladas a lo largo de los días del [Calendario](#schedule) de talleres,
así como las previsiones para el resto del taller.
52 changes: 39 additions & 13 deletions docs/user_guide/docs/project.md
Original file line number Diff line number Diff line change
Expand Up @@ -41,9 +41,11 @@ When a project has been created or selected, it becomes the active project—you
name in the middle of the App Bar at the top of The Combine. Clicking on the gear icon or project name brings up Project
Settings for managing the project. The following settings are available for project users with sufficient permissions.

![Settings](images/projectSettings123456.png)

### Basic Settings

![BasicSettings](images/projectSettings1Basic.png){width=750 .center}
![BasicSettings](images/projectSettings1Basic.png)

#### Project Name

Expand All @@ -68,7 +70,7 @@ from the servers.

### Project Languages {#project-languages}

![Languages](images/projectSettings2Langs.png){width=750 .center}
![Languages](images/projectSettings2Langs.png)

![Project Languages - Tzotzil](images/projectLanguagesTzotzil.png){.center}

Expand All @@ -87,7 +89,7 @@ The _semantic domains language_ controls the language in which semantic domain t

### Project Users

![Users](images/projectSettings3Users.png){width=750 .center}
![Users](images/projectSettings3Users.png)

#### Current Users

Expand Down Expand Up @@ -144,7 +146,7 @@ used for the file names).

### Import/Export

![Import/Export](images/projectSettings4Port.png){width=750 .center}
![Import/Export](images/projectSettings4Port.png)

#### Import {#import}

Expand Down Expand Up @@ -175,16 +177,44 @@ When a project is exported from TheCombine and imported into FieldWorks, if a pr
the speaker name will be added as a pronunciation label. The consent files can be found in the zipped export, but will
not be imported into FieldWorks.

### Workshop Schedule {#workshop-schedule}
### Schedule {#schedule}

![Workshop Schedule](images/projectSettings5Sched.png){width=750 .center}
![Schedule](images/projectSettings5Sched.png)

This is only available for editing by the project Owner, allowing a schedule to be set for a Rapid Word Collection
workshop. Click the first button to select a date range for the workshop. Click the middle button to add or remove
specific dates. Click the last button to clear the schedule.

![Workshop Schedule](images/projectSchedule.png){.center}

### Semantic Domains {#semantic-domains}

![Semantic Domains](images/projectSettings6Doms.png)

In this settings tab, you can change the semantic domain language and manage custom semantic domains.

The _semantic domains language_ controls the language in which semantic domain titles and descriptions are displayed in
[Data Entry](./dataEntry.md).

The _custom semantic domains_ supported at this time are the [established domains](https://semdom.org/) with `.0` added
to the end of the id. For example, domain _4.2.6.2: Sports_ has two standard subdomains, _4.2.6.2.1: Football, Soccer_
and _4.2.6.2.2: Basketball_. If another sport is dominant among the people group gathering their language, it can be
added as domain _4.2.6.2.0_.

For each custom domain, you can add a name, description, and questions to help with word collection in that domain.

!!! note "Note"

Custom semantic domains are included in the project export and can be imported into FieldWorks. However, the
questions are not included.

Custom semantic domains will appear in the domain tree for the project, but will not be visible to other projects.

!!! note "Note"

Custom semantic domains are language-specific. If you add a custom domain in one language then change the semantic
domains language, that domain will not be visible unless you change back to its language.

## Project Statistics

If you are the project Owner, there will be another icon alongside the gear icon in App Bar at the top of The Combine.
Expand All @@ -206,13 +236,9 @@ A table listing number of words in each semantic domain.

### Words per Day

Line graphs showing words collected during the days specified in the [Workshop Schedule](#workshop-schedule).
Line graphs showing words collected during the days specified in the workshop [Schedule](#schedule).

### Workshop Progress

Line graphs showing cumulative words collected across the days of the [Workshop Schedule](#workshop-schedule), as well
as projections for remainder of the workshop.

## Semantic Domains

Details about custom semantic domains are coming soon.
Line graphs showing cumulative words collected across the days of the workshop [Schedule](#schedule), as well as
projections for remainder of the workshop.
49 changes: 37 additions & 12 deletions docs/user_guide/docs/project.zh.md
Original file line number Diff line number Diff line change
Expand Up @@ -36,9 +36,11 @@
一旦创建或选择了一个项目,它就变成活动项目。用户可在 The Combine 顶部应用框的中间位置看到一个齿轮图标或该项目名。 点击齿
轮图标或项目名,拉出“项目设置”以管理该项目。 具有足够权限的项目用户可以使用以下设置。

![设置](../images/projectSettings123456.png)

### 基本设置

![基本设置](../images/projectSettings1Basic.zh.png){width=750 .center}
![基本设置](../images/projectSettings1Basic.zh.png)

#### 项目名称

Expand All @@ -58,7 +60,7 @@

### 项目语言 {#project-languages}

![语言](../images/projectSettings2Langs.zh.png){width=750 .center}
![语言](../images/projectSettings2Langs.zh.png)

![项目语言 - Tzotzil](../images/projectLanguagesTzotzil.zh.png){.center}

Expand All @@ -74,7 +76,7 @@

### 项目用户

![用户](../images/projectSettings3Users.zh.png){width=750 .center}
![用户](../images/projectSettings3Users.zh.png)

#### 当前用户

Expand Down Expand Up @@ -129,7 +131,7 @@ used for the file names).

### 导入/导出

![导入/导出](../images/projectSettings4Port.zh.png){width=750 .center}
![导入/导出](../images/projectSettings4Port.zh.png)

#### 导入 {#import}

Expand Down Expand Up @@ -160,15 +162,42 @@ When a project is exported from TheCombine and imported into FieldWorks, if a pr
the speaker name will be added as a pronunciation label. The consent files can be found in the zipped export, but will
not be imported into FieldWorks.

### 工作坊日程 {#workshop-schedule}
### 日程 {#schedule}

![工作坊日程](../images/projectSettings5Sched.zh.png){width=750 .center}
![日程](../images/projectSettings5Sched.zh.png)

只有项目所有人可以使用该功能,以便为快速文字工作坊设定时间。 点击第一个键可选择工作坊日期范围。 点击中间键可添加或移除具
体日期。 点击最后的键可清除日程表。

![工作坊日程](../images/projectSchedule.zh.png){.center}

### 语义域 {#semantic-domains}

![语义域](../images/projectSettings6Doms.zh.png)

In this settings tab, you can change the semantic domain language and manage custom semantic domains.

*语义领域语言*决定[词条输入](./dataEntry.md)中表达语义领域标题和描述的语言。

The _custom semantic domains_ supported at this time are the [established domains](https://semdom.org/) with `.0` added
to the end of the id. For example, domain _4.2.6.2: Sports_ has two standard subdomains, _4.2.6.2.1: Football, Soccer_
and _4.2.6.2.2: Basketball_. If another sport is dominant among the people group gathering their language, it can be
added as domain _4.2.6.2.0_.

For each custom domain, you can add a name, description, and questions to help with word collection in that domain.

!!! note "笔记"

Custom semantic domains are included in the project export and can be imported into FieldWorks. However, the
questions are not included.

Custom semantic domains will appear in the domain tree for the project, but will not be visible to other projects.

!!! note "笔记"

Custom semantic domains are language-specific. If you add a custom domain in one language then change the semantic
domains language, that domain will not be visible unless you change back to its language.

## 项目统计数据

如果用户是项目所有者,在 The Combine 顶部应用栏齿轮图标的旁边会有另一个图标。 这将打开项目中关于字词的统计数据。
Expand All @@ -188,12 +217,8 @@ not be imported into FieldWorks.

### 每天字数

线形图显示在 [工作坊时间表](#workshop-schedule)中指定的日子里收集到的词语。
线形图显示在工作坊[日程](#schedule)中指定的日子里收集到的词语。

### 工作坊进度

线型图显示了 [工作坊日程](#workshop-schedule)多天所累积的词以及对余下时间的预测。

## Semantic Domains

Details about custom semantic domains are coming soon.
线型图显示了工作坊[日程](#schedule)多天所累积的词以及对余下时间的预测。
3 changes: 2 additions & 1 deletion public/locales/es/translation.json
Original file line number Diff line number Diff line change
Expand Up @@ -137,10 +137,11 @@
"project": "Proyecto:",
"tab": {
"basic": "Configuración básica",
"domains": "Dominios semánticos",
"export": "Exportar",
"importExport": "Importar/Exportar",
"languages": "Idiomas",
"schedule": "Programar",
"schedule": "Calendario",
"users": "Usuarios"
},
"language": {
Expand Down
1 change: 1 addition & 0 deletions public/locales/zh/translation.json
Original file line number Diff line number Diff line change
Expand Up @@ -126,6 +126,7 @@
"project": "项目:",
"tab": {
"basic": "基本设置",
"domains": "语义域",
"export": "导出",
"importExport": "导入/导出",
"languages": "语言",
Expand Down

0 comments on commit 89906ef

Please sign in to comment.