Skip to content

Commit

Permalink
[User Guide] Add Spanish (es) (#2716)
Browse files Browse the repository at this point in the history
  • Loading branch information
imnasnainaec authored Oct 20, 2023
1 parent ea887b5 commit 9b9126b
Show file tree
Hide file tree
Showing 59 changed files with 808 additions and 85 deletions.
1 change: 1 addition & 0 deletions .vscode/settings.json
Original file line number Diff line number Diff line change
Expand Up @@ -33,6 +33,7 @@
"files.insertFinalNewline": true,
"cSpell.ignorePaths": [
"*.dic.js",
"docs/user_guide/docs/*.*.md",
"node_modules",
"package-lock.json",
"public/locales/",
Expand Down
1 change: 1 addition & 0 deletions dev-requirements.in
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,7 @@ isort
# Documentation.
mkdocs-material
mkdocs-htmlproofer-plugin
mkdocs-static-i18n

# Templating/Docker.
Jinja2
Expand Down
27 changes: 13 additions & 14 deletions dev-requirements.txt
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
#
# This file is autogenerated by pip-compile with Python 3.10
# This file is autogenerated by pip-compile with Python 3.11
# by the following command:
#
# pip-compile dev-requirements.in
Expand Down Expand Up @@ -35,6 +35,8 @@ click==8.1.7
colorama==0.4.6
# via
# -r dev-requirements.in
# click
# mkdocs
# mkdocs-material
# tox
cryptography==41.0.4
Expand Down Expand Up @@ -69,7 +71,7 @@ flake8-eradicate==1.5.0
# via -r dev-requirements.in
ghp-import==2.1.0
# via mkdocs
google-auth==2.23.2
google-auth==2.23.3
# via kubernetes
humanfriendly==10.0
# via -r dev-requirements.in
Expand Down Expand Up @@ -105,13 +107,16 @@ mkdocs==1.5.3
# via
# mkdocs-htmlproofer-plugin
# mkdocs-material
# mkdocs-static-i18n
mkdocs-htmlproofer-plugin==1.0.0
# via -r dev-requirements.in
mkdocs-material==9.4.4
mkdocs-material==9.4.5
# via -r dev-requirements.in
mkdocs-material-extensions==1.2
# via mkdocs-material
mypy==1.5.1
mkdocs-static-i18n==1.1.0
# via -r dev-requirements.in
mypy==1.6.0
# via -r dev-requirements.in
mypy-extensions==1.0.0
# via
Expand Down Expand Up @@ -166,7 +171,9 @@ pyopenssl==23.2.0
pyproject-api==1.6.1
# via tox
pyreadline3==3.4.1
# via -r dev-requirements.in
# via
# -r dev-requirements.in
# humanfriendly
python-dateutil==2.8.2
# via
# ghp-import
Expand Down Expand Up @@ -198,12 +205,6 @@ six==1.16.0
# python-dateutil
soupsieve==2.5
# via beautifulsoup4
tomli==2.0.1
# via
# black
# mypy
# pyproject-api
# tox
tox==4.11.3
# via -r dev-requirements.in
types-pyopenssl==23.2.0.2
Expand All @@ -215,9 +216,7 @@ types-pyyaml==6.0.12.12
types-requests==2.31.0.8
# via -r dev-requirements.in
typing-extensions==4.8.0
# via
# black
# mypy
# via mypy
urllib3==2.0.6
# via
# kubernetes
Expand Down
File renamed without changes.
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes.
45 changes: 45 additions & 0 deletions docs/user_guide/docs/account.es.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,45 @@
# Cuenta

Cómo registrarse, iniciar sesión y editar su cuenta.

![Inicio de sesión](../images/login.png){.center}

## Registrarse

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

!!! note "Nota"

La dirección de correo electrónico se utiliza para restablecer su contraseña, por lo que sólo se permite una cuenta por dirección de correo electrónico.

## Iniciar Sesión

[Iniciar Sesión](../../login) a The Combine con el nombre de usuario y la contraseña facilitados en el momento de la
inscripción.

Si desea cambiar su contraseña, haga clic en el enlace "¿Olvidó su contraseña?". Siga las instrucciones y un
restablecimiento de contraseña será enviada a la dirección de correo electrónico asociada a su cuenta.

!!! warning "Importante"

El nombre de usuario y la dirección de correo electrónico **no** distinguen entre mayúsculas y minúsculas. La contraseña **es** sensible a mayúsculas y minúsculas.

## Configuración

Tras iniciar sesión, aparecerá una barra de aplicaciones azul en la parte superior de The Combine. Pulse el icono del
avatar en el extremo derecho de la App Barra para abrir el Menú de Usuario. Seleccione "Configuración de usuario" para
cambiar los ajustes de cuenta/perfil.

![Menú de usuario](../images/userMenu.png){.center}

Puede añadir o actualizar su:

- imagen de avatar;
- nombre;
- número de teléfono;
- dirección de correo electrónico;
- lenguaje de interfaz de usuario.

!!! note "Nota"

El nombre de usuario elegido en el momento de la inscripción es permanente y no puede cambiarse.
Original file line number Diff line number Diff line change
Expand Up @@ -2,13 +2,13 @@

How to sign up, log in, and edit your account.

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

## Sign Up

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

!!! note
!!! note "Note"

The email address is used to reset your password, so there is only one account allowed per email address.

Expand All @@ -19,7 +19,7 @@ To create a new account, click the [SIGN UP](../sign-up) button on the Login pag
If you want to change your password, click the "Forgot password?" link. Follow the instructions and a password-reset
will be sent to the email address associated with your account.

!!! important
!!! warning "Important"

The username and email address are **not** case-sensitive. The password **is** case-sensitive.

Expand All @@ -28,7 +28,7 @@ will be sent to the email address associated with your account.
After login, there is a blue App Bar along the top of The Combine. Click on the avatar icon at the right end of the App
Bar to open the User Menu. Select "User Settings" to change account/profile settings.

![User Menu](images/userMenu.png){ .center }
![User Menu](images/userMenu.png){.center}

You can add or update your:

Expand All @@ -38,6 +38,6 @@ You can add or update your:
- email address;
- user-interface language.

!!! note
!!! note "Note"

The username chosen at registration is permanent and cannot be changed.
38 changes: 38 additions & 0 deletions docs/user_guide/docs/admin.es.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,38 @@
# Administración / Configuración del sitio

Los administradores del sitio disponen de una opción más en el menú de usuario: "Configuración del sitio".

![Menú de usuario - Administrador](../images/userMenuAdmin.png){.center}

## Administración de proyectos

Los administradores pueden exportar o archivar/restaurar cualquier proyecto. Archivar un proyecto lo hace invisible e
inaccesible para todos los usuarios, incluso el creador del proyecto, pero cualquier administrador puede restaurar el
proyecto. Actualmente no hay forma de eliminar permanentemente un proyecto.

## Administración de usuarios

Los administradores pueden eliminar cualquier cuenta de usuario que no sea de administrador. Para añadir o eliminar
usuarios administradores, póngase en contacto con el propietario del sitio.

## Banners

Los administradores pueden personalizar su instancia de The Combine mediante banners de configuración.

### Banner de anuncios

El banner de anuncio coloca un banner brillante en la parte superior de la página cuando los usuarios visitan The
Combine. Estos banners están destinados a mostrar a los usuarios mensajes importantes y de corta duración relacionados
con la instancia de The Combine. Los usos podrían incluir actualizaciones programadas, tiempos de inactividad
planificados o próximos cambios en el servidor.

![Banner de anuncios](../images/announcementBanner.png){.center}

### Banner de inicio de sesión

El banner de inicio de sesión coloca un mensaje en la parte inferior de la página de inicio de sesión. Este banner está
pensado para incluir información sobre una instancia de The Combine que los usuarios puedan necesitar conocer, como con
quién ponerse en contacto en relación con el soporte, actualizaciones de versión o políticas de copia de seguridad de la
base de datos.

![Banner de inicio de sesión](../images/loginBanner.png){width=400 .center}
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

Site administrators have one more option in the User Menu: "Site Settings".

![User Menu - Admin](images/userMenuAdmin.png){ .center }
![User Menu - Admin](images/userMenuAdmin.png){.center}

## Project Management

Expand All @@ -24,12 +24,12 @@ The announcement banner places a bright banner across the top of the page when u
are intended for displaying important, short-term messages to users related to the instance of The Combine. Uses could
include scheduled upgrades, planned down time, or upcoming server changes.

![Announcement Banner](images/announcementBanner.png){ .center }
![Announcement Banner](images/announcementBanner.png){.center}

### Login Banner

The login banner places a message at the bottom of the login page. This banner is intended for including specific
information about an instance of The Combine that users may need to know, such as who to contact regarding support,
version upgrades, or database backup policies.

![Login Banner](images/loginBanner.png){ width=400 .center }
![Login Banner](images/loginBanner.png){width=400 .center}
77 changes: 77 additions & 0 deletions docs/user_guide/docs/dataEntry.es.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,77 @@
# Entrada de datos

## Árbol de dominios semánticos

Navegue o busque el dominio de su interés.

!!! tip "Consejo"

Para agilizar la búsqueda de un dominio, The Combine insertará automáticamente `.` entre los dígitos consecutivos a medida que usted
escriba. Por ejemplo, `1234` se convertirá automáticamente en `1.2.3.4`. Este comportamiento no se produce si se introduce algún carácter no numérico
se introducen caracteres no numéricos.

## Nueva entrada

### Vernáculo

Palabra tal y como se encuentra en la lengua vernácula, normalmente deletreada fonéticamente o con la ortografía local.

### Glosa

Aunque una entrada puede tener varios acepciones/brillos, sólo se puede añadir uno cuando se crea la entrada por primera
vez.

### Nota

Puede tener una nota en cada entrada. Se puede añadir cualquier anotación para los acepciones de una entrada, glosas,
dominios semánticos, etc a la nota de la entrada.

### Grabación

Puede añadir varias grabaciones a una entrada (por ejemplo, una voz masculina y otra femenina). Como en el caso de la
nota, el audio se asocian a la entrada y no a acepciones individuales.

Para grabar audio, hay un botón circular rojo. Para cada audio grabado, hay un botón triangular verde.

**Con el ratón:** Pulse y mantenga pulsado el círculo rojo para grabar. Haga clic en un triángulo verde para reproducir
su audio, o pulse Mayúsculas y haga clic para borrar su grabación.

**En una pantalla táctil:** Mantenga pulsado el círculo rojo para grabar. Pulse un triángulo verde para reproducir su
audio, o manténgalo pulsado para abrir un menú (con opciones para reproducir o eliminar).

## Nueva entrada con forma vernácula duplicada {#new-entry-with-duplicate-vernacular-form}

Si presenta una nueva entrada con idéntica forma vernácula y glosa a una entrada existente, se actualizará dicha entrada
en lugar de crearse una nueva entrada. Por ejemplo, si presenta [Vernáculo: finger; Glosa: dedo] en el dominio 2.1.3.1
(Brazo) y de nuevo en el dominio 2.1.3.3 (Dedo, dedo del pie), el resultado será una única entrada para "finger" con un
única acepción que tiene glosa "dedo" y dos dominios.

The Combine dispone de una función opcional de facilitar la introducción de palabras que ya existen en el proyecto pero
que se recogen de nuevo en nuevo dominio semántico. Esta función puede activarse o desactivarse en
[Configuración del proyecto > Autocompletar](project.md#autocomplete). Cuando el ajuste está activado, al escribir la
forma vernácula en Entrada de datos, aparece un menú desplegable con formas vernáculas idénticas/similares que ya
existen como entradas en el proyecto. Si ve que la palabra que escribe ya está en el proyecto, puede pulsar en la
palabra en la lista de sugerencias, en lugar de tener que escribir el resto de la palabra. Cuando la configuración está
desactivada, la palabra vernácula debe escribirse en su totalidad; no se sugerirá ninguna coincidencia potencial
existente.

![Entrada de datos duplicados de formularios vernáculos](../images/data-entry-dup-vern.png){.center}

Ya sea que escriba una forma que coincide con una entrada existente en el proyecto o seleccione una de las sugerencias
que ofrece The Combine, aparecerá un cuadro con opciones. (Este cuadro no aparecerá si la configuración de Autocompletar
está desactivada o si escribe una forma vernáculo que aún no existe en el proyecto.) En el cuadro emergente, se le
mostrarán todas las entradas existentes con esa forma vernácula y puede elegir si actualizar una de esas entradas o
crear una nueva entrada.

![Entrada de datos entradas vernáculas duplicadas](../images/data-entry-dup-vern-select-entry.png){.center}

Si elige crear una nueva entrada, se cerrará el cuadro emergente y entonces podrá escribir la glosa de su nueva entrada.

!!! note "Nota"

Aunque haya seleccionado crear una nueva entrada, si la glosa que escribe es idéntica a una glosa de otra entrada con la misma forma vernácula, no se creará una nueva entrada, sino que se actualizará esa entrada.

Si por el contrario elige actualizar una de las entradas existentes, aparecerá un segundo cuadro. Aquí puede elegir
actualizar una acepción existente en la entrada seleccionada o añadir una nueva acepción a esa entrada.

![Entrada de datos duplicadas acepciones vernáculas](../images/data-entry-dup-vern-select-sense.png){.center}
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@

Browse or search for the domain of interest.

!!! tip
!!! tip "Tip"

To make searching for a domain quicker, The Combine will automatically insert `.` between consecutive digits as you
type. For example, `1234` will automatically become `1.2.3.4`. This behavior does not happen if any non-numeric
Expand All @@ -27,8 +27,8 @@ to the entry's note.

### Recording

You can add multiple recordings to an entry (e.g., a male voice and a female voice). As with the [Note](#note), audio
recordings are associated with the entry and not individual senses.
You can add multiple recordings to an entry (e.g., a male voice and a female voice). As with the note, audio recordings
are associated with the entry and not individual senses.

To record audio, there is a red circle button. For each recorded audio, there is a green triangle button.

Expand All @@ -38,7 +38,7 @@ delete its recording.
**On a touch screen:** Press-and-hold the red circle to record. Tap a green triangle to play its audio, or
press-and-hold to bring up a menu (with options to play or delete).

## New Entry with Duplicate Vernacular Form
## New Entry with Duplicate Vernacular Form {#new-entry-with-duplicate-vernacular-form}

If you submit a new entry with identical vernacular form and gloss to an existing entry, that entry will be updated
instead of a new entry created. For example, if you submit [Vernacular: dedo; Gloss: finger] in domain 2.1.3.1 (Arm) and
Expand All @@ -53,22 +53,22 @@ project. If you see that the word you are typing is already in the project, you
suggestions, instead of having to typing the remainder of the word. When the setting is off, the vernacular word must be
typed in its entirety; no existing potential matches will be suggested.

![Data Entry duplicate vernacular forms](images/data-entry-dup-vern.png){ .center }
![Data Entry duplicate vernacular forms](images/data-entry-dup-vern.png){.center}

Whether you type a form that matches an existing entry in the project or select one of the suggestions offered by The
Combine, a box will pop up with options. (This box will not pop up if the Autocomplete setting is off or if you type a
vernacular form that does not yet exist in the project.) In the pop-up box, you will be shown all existing entries with
that vernacular form and can to choose whether to update one of those entries or create a new entry.

![Data Entry duplicate vernacular entries](images/data-entry-dup-vern-select-entry.png){ .center }
![Data Entry duplicate vernacular entries](images/data-entry-dup-vern-select-entry.png){.center}

If you choose to create a new entry, the pop-up box will close, and you can then type the gloss for your new entry.

!!! note
!!! note "Note"

Even if you selected to create a new entry, if the gloss you type is identical to a gloss of another entry with the same vernacular form, a new entry will not be created, but rather that entry will be updated.

If you instead choose to update one of the existing entries, a second box will appear. Here you can choose to update an
existing sense on the selected entry or to add a new sense to that entry.

![Data Entry duplicate vernacular senses](images/data-entry-dup-vern-select-sense.png){ .center }
![Data Entry duplicate vernacular senses](images/data-entry-dup-vern-select-sense.png){.center}
Loading

0 comments on commit 9b9126b

Please sign in to comment.