Skip to content

Commit

Permalink
[User Guide] Update to match the current version (#3216)
Browse files Browse the repository at this point in the history
  • Loading branch information
imnasnainaec authored Jul 1, 2024
1 parent 565a7f7 commit 683ebac
Show file tree
Hide file tree
Showing 9 changed files with 47 additions and 39 deletions.
2 changes: 1 addition & 1 deletion docs/user_guide/docs/account.es.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ Cómo registrarse, iniciar sesión y editar su cuenta.

## Registrarse

Para crear una nueva cuenta, pulse el botón [REGISTRARSE](../../sign-up) en la página de inicio de sesión.
Para crear una nueva cuenta, pulse el botón [REGISTRARSE](../../signup) en la página de inicio de sesión.

!!! note "Nota"

Expand Down
2 changes: 1 addition & 1 deletion docs/user_guide/docs/account.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ How to sign up, log in, and edit your account.

## Sign Up

To create a new account, click the [SIGN UP](../sign-up) button on the Login page.
To create a new account, click the [SIGN UP](../signup) button on the Login page.

!!! note "Note"

Expand Down
2 changes: 1 addition & 1 deletion docs/user_guide/docs/account.zh.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@

## 注册

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

!!! note "笔记"

Expand Down
15 changes: 9 additions & 6 deletions docs/user_guide/docs/goals.es.md
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,8 @@ include subdomains, add a final period to your filter. For example, "8111." incl

### Edición de filas de entrada

Puede grabar, reproducir o borrar las grabaciones de audio de una entrada con los iconos de la columna Pronunciaciones.
Puede grabar, reproducir o borrar las grabaciones de audio de una entrada con los iconos de la columna Pronunciaciones
(![Review Entries pronunciations column header](images/reviewEntriesColumnPronunciations.png){width=28}).

To edit any other part of an entry, click the
![Review Entries row edit icon](../images/reviewEntriesRowEdit.png){width=20} edit icon in the initial column.
Expand Down Expand Up @@ -80,10 +81,6 @@ que aparezca una barra lateral azul aparezca a la derecha, mostrando cuales acep

![Fusionar duplicados acepciones fusionadas](../images/mergeSidebar.es.png)

!!! warning "Importante"

Cuando se fusionan varias acepciones, se conservan todos los dominios semánticos, pero **sólo la acepción superior de la barra lateral** conserva sus glosas (y definiciones).

Puede arrastrar y soltar tarjetas de acepción hacia o desde la barra lateral para cambiar las acepciones que se están
fusionando. O dentro de la barra lateral, puede desplazar una acepción diferente a la parte superior (para conservar sus
glosas).
Expand Down Expand Up @@ -170,6 +167,12 @@ la siguiente manera:

![Fusionar duplicados acepción con definiciones y parte de la oración](../images/mergeSenseDefinitionsPartOfSpeech.png){.center}

!!! note "Nota"

A sense can only have one part of speech. If two senses are merged that have different parts of speech in the same
general category, the parts of speech will be combined, separated by a semicolon (;). However, if they have different
general categories, only the first one is preserved.

#### Entradas y acepciones protegidas

Si una entrada o acepción importada contiene datos no admitidos en The Combine (por ejemplo, etimologías o inversiones
Expand Down Expand Up @@ -224,4 +227,4 @@ APLICAR.

!!! warning "Importante"

La operación de buscar y reemplazar realiza cambios en las entradas, no en el inventario de personajes. No **se puede deshacer**
La operación de buscar y reemplazar realiza cambios en las entradas, no en el inventario de personajes.
15 changes: 9 additions & 6 deletions docs/user_guide/docs/goals.md
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,8 @@ include subdomains, add a final period to your filter. For example, "8111." incl

### Editing Entry Rows

You can record, play, or delete an entry's audio recordings by using the icons in the Pronunciations column.
You can record, play, or delete an entry's audio recordings by using the icons in the Pronunciations
(![Review Entries pronunciations column header](images/reviewEntriesColumnPronunciations.png){width=28}) column.

To edit any other part of an entry, click the ![Review Entries row edit icon](images/reviewEntriesRowEdit.png){width=20}
edit icon in the initial column.
Expand Down Expand Up @@ -79,10 +80,6 @@ to appear on the right, showing which senses are being merged.

![Merge Duplicates senses merged](images/mergeSidebar.png)

!!! warning "Important"

When multiple senses are merged, all semantic domains are preserved, but **only the top sense in the sidebar** has its glosses (and definitions) preserved.

You can drag-and-drop sense cards to or from the sidebar to change which senses are being merged. Or within the sidebar,
you can move a different sense to the top (to preserve its glosses).

Expand Down Expand Up @@ -165,6 +162,12 @@ information will appear in the Merge Duplicate sense cards as follows:

![Merge Duplicates sense with definitions and part of speech](images/mergeSenseDefinitionsPartOfSpeech.png){.center}

!!! note "Note"

A sense can only have one part of speech. If two senses are merged that have different parts of speech in the same
general category, the parts of speech will be combined, separated by a semicolon (;). However, if they have different
general categories, only the first one is preserved.

#### Protected Entries and Senses

If an imported entry or sense contains data not supported in The Combine (e.g., etymologies or sense reversals), it is
Expand Down Expand Up @@ -217,4 +220,4 @@ something else, type the replacement character or string in the "Replace with" b

!!! warning "Important"

The find-and-replace operation makes changes to entries, not to the character inventory. It **cannot be undone!**
The find-and-replace operation makes changes to entries, not to the character inventory.
16 changes: 10 additions & 6 deletions docs/user_guide/docs/goals.zh.md
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,9 @@ include subdomains, add a final period to your filter. For example, "8111." incl

### 编辑词条行

用户可以使用“发音”列中的图标来录制、播放或删除词条的录音。
用户可以使用“发音
”(![Review Entries pronunciations column header](images/reviewEntriesColumnPronunciations.png){width=28})列中的图标来
录制、播放或删除词条的录音。

To edit any other part of an entry, click the
![Review Entries row edit icon](../images/reviewEntriesRowEdit.png){width=20} edit icon in the initial column.
Expand Down Expand Up @@ -76,10 +78,6 @@ You can delete an entire entry by clicking the

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

!!! warning "重要警告"

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

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

Expand Down Expand Up @@ -156,6 +154,12 @@ You can delete an entire entry by clicking the

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

!!! note "笔记"

A sense can only have one part of speech. If two senses are merged that have different parts of speech in the same
general category, the parts of speech will be combined, separated by a semicolon (;). However, if they have different
general categories, only the first one is preserved.

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

如果导入的词条或词义项包含 The Combine 不支持的资料(例如词源或词义反转),它将被保护以防止删除。 受保护的词义卡会有一个黄
Expand Down Expand Up @@ -197,4 +201,4 @@ _创建字符库存_" 提供了该项目词条土语形式出现的每个符编

!!! warning "重要警告"

“查找和替换 ”操作更改的是词条,而不是字符库。 **它无法被撤销!**
“查找和替换 ”操作更改的是词条,而不是字符库。
13 changes: 6 additions & 7 deletions docs/user_guide/docs/project.es.md
Original file line number Diff line number Diff line change
Expand Up @@ -161,8 +161,7 @@ used for the file names).
#### Exportar {#export}

Tras pulsar el botón Exportar, puede navegar por otras partes del sitio web mientras se preparan los datos para la
descargar. Aparecerá un icono de descarga en la barra de aplicaciones cuando la exportación esté lista para su descarga.
El nombre de archivo por defecto es el nombre del proyecto con una marca de tiempo añadida.
descargar. When the data is gathered, the download will begin automatically. El nombre de archivo es el id del proyecto.

!!! warning "Importante"

Expand All @@ -175,16 +174,16 @@ El nombre de archivo por defecto es el nombre del proyecto con una marca de tiem
#### Exportar locutores de las pronunciaciones

When a project is exported from TheCombine and imported into FieldWorks, if a pronunciation has an associated speaker,
the speaker name and id will be added as a pronunciation label. Consent files will be exported with speaker id used for
the file name. The consent files can be found in the zipped export, but will not be imported into FieldWorks.
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 de talleres](../images/projectSettings5Sched.es.png){width=750 .center}

Sólo está disponible 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.
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}

Expand Down
13 changes: 6 additions & 7 deletions docs/user_guide/docs/project.md
Original file line number Diff line number Diff line change
Expand Up @@ -159,8 +159,7 @@ used for the file names).
#### Export {#export}

After clicking the Export button, you can navigate to other parts of the website while the data is being prepared for
download. A download icon will appear in the App Bar when the export is ready for download. The default filename is the
project name with a timestamp affixed.
download. When the data is gathered, the download will begin automatically. The filename is the project id.

!!! warning "Important"

Expand All @@ -173,16 +172,16 @@ project name with a timestamp affixed.
#### Export pronunciation speakers

When a project is exported from TheCombine and imported into FieldWorks, if a pronunciation has an associated speaker,
the speaker name and id will be added as a pronunciation label. Consent files will be exported with speaker id used for
the file name. The consent files can be found in the zipped export, but will not be imported into FieldWorks.
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}

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

This is only available to 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.
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}

Expand Down
8 changes: 4 additions & 4 deletions docs/user_guide/docs/project.zh.md
Original file line number Diff line number Diff line change
Expand Up @@ -143,8 +143,8 @@ used for the file names).

#### 导出 {#export}

单击 "导出 "按钮后,在数据准备下载时,用户可以到网站的其他部分浏览。 当导出内容可供下载时,应用程序栏中会出现一个下载图
标。 默认文件名是项目名称加上下载时间。
单击 "导出 "按钮后,在数据准备下载时,用户可以到网站的其他部分浏览。 When the data is gathered, the download will begin
automatically. The filename is the project id.

!!! warning "重要警告"

Expand All @@ -157,8 +157,8 @@ used for the file names).
#### Export pronunciation speakers

When a project is exported from TheCombine and imported into FieldWorks, if a pronunciation has an associated speaker,
the speaker name and id will be added as a pronunciation label. Consent files will be exported with speaker id used for
the file name. The consent files can be found in the zipped export, but will not be imported into FieldWorks.
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}

Expand Down

0 comments on commit 683ebac

Please sign in to comment.