[User Guide] Update Account, Data Cleanup, Data Entry, Project pages (#…

…2285)
sillsdev · Jun 26, 2023 · 9d9f128 · 9d9f128
1 parent 6c07f86
commit 9d9f128
Show file tree

Hide file tree

Showing 15 changed files with 104 additions and 17 deletions.
diff --git a/deploy/scripts/check_certs.py b/deploy/scripts/check_certs.py
@@ -65,7 +65,7 @@ def get_expiration(secret: str, kubectl_opts: List[str]) -> Optional[str]:
 
 
 def main() -> None:
-    """Setup access to the the target specified on the command line."""
+    """Setup access to the target specified on the command line."""
     args = parse_args()
 
     if args.namespace is not None:

diff --git a/docs/user_guide/docs/account.md b/docs/user_guide/docs/account.md
@@ -35,7 +35,8 @@ You can add or update your:
 - avatar image;
 - name;
 - phone number;
-- email address.
+- email address;
+- user-interface language.
 
 !!! note
 

diff --git a/docs/user_guide/docs/dataEntry.md b/docs/user_guide/docs/dataEntry.md
@@ -37,3 +37,34 @@ 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
+
+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
+again in domain 2.1.3.3 (Finger, Toe), the result will be a single entry for "dedo" with a single sense that has gloss
+"finger" and two domains.
+
+The Combine has an optional feature to assist with data entry involving duplicate vernacular forms. It can be turned on
+or off in [Project Settings > Autocomplete](project.md#autocomplete). When the setting is on, as you type the vernacular
+form in Data Entry, a drop-down menu appears with identical/similar vernacular forms that already exist in other entries
+in the project. If you ignore the menu options and type a new vernacular form, you can simply continue on to the gloss
+and submit a new entry.
+
+![Data Entry duplicate vernacular forms](images/data-entry-dup-vern.png){ .center }
+
+When the autocomplete setting is on and you type or select a vernacular form that already exists in another entry, a box
+will pop up with options. You will be shown all entries with that vernacular form and get to choose whether to update
+one of those entries or create a new entry. If you choose to create a new entry, the pop-up box with go away and you can
+type the gloss for your new entry.
+
+![Data Entry duplicate vernacular entries](images/data-entry-dup-vern-select-entry.png){ .center }
+
+!!! 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 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 }
diff --git a/docs/user_guide/docs/goals.md b/docs/user_guide/docs/goals.md
@@ -6,7 +6,7 @@ The Review Entries table shows all entries in a project.
 
 ### Sorting and Filtering Columns
 
-The columns are: Actions, Vernacular, Senses, Glosses, Domains, Pronunciations, Note, Flag, and Delete.
+The columns are: Edit, Vernacular, Senses, Glosses, Domains, Pronunciations, Note, Flag, and Delete.
 
 ![Review Entries column headers](images/reviewEntriesColumns.png)
 
@@ -16,14 +16,16 @@ alphabetically or filter with a text search.
 At the top of the Senses and Pronunciations columns, you can sort or filter by the number of senses or recordings that
 entries have.
 
-There is also a Definitions column that can be turned on or off in [Project Settings](project.md#definitions).
+Due to the nature of Rapid Word Collection, [Data Entry](dataEntry.md) in The Combine does not support adding
+definitions or parts of speech. However, if you have imported a project in which senses have definitions or part of
+speech, additional columns with that information will automatically be added to the Review Entries table.
 
 ### Editing Entry Rows
 
 You can record, play, or delete an entry's audio recordings with the icons in the Pronunciations column. You can delete
 an entire entry with the icon in the Delete column.
 
-To edit an entry's vernacular form, senses (including glosses and domains), note, or flag, click the icon in the Actions
+To edit an entry's vernacular form, senses (including glosses and domains), note, or flag, click the icon in the Edit
 column.
 
 ## Merge Duplicates
@@ -126,6 +128,27 @@ deleted senses), updating the words in the database. Second, it saves any unmerg
 The grey "Skip" button resets any changes made to the set of potential duplicates. The same set will be suggested again
 the next time Merge Duplicates is opened.
 
+### Merging with Imported Data
+
+#### Definitions and Part of Speech
+
+Although definitions and part of speech cannot be added during Data Entry, they can be present on imported entries. This
+information will appear in the Merge Duplicate sense cards as follows:
+
+- Any definition in an analysis language is shown below the gloss in that language.
+- Any part of speech is indicated by a colored hexagon in the upper-left corner. The color corresponds to its general
+  category (e.g., noun or verb). Hover your cursor over the hexagon to see the specific grammatical category (e.g.,
+  proper noun or transitive verb).
+
+![Merge Duplicates sense with definitions and part of speech](images/mergeSenseDefinitionsPartOfSpeech.png){ .center }
+
+#### Protected Entries and Senses
+
+If an entry or sense was imported with other data not supported in The Combine, it is protected to prevent its deletion.
+The sense card of a protected sense will have a yellow background—it cannot be deleted or dropped into another sense
+card. The column of a protected entry will have a yellow header (where the vernacular and flag are located). When a
+protected entry has only one sense, that sense card cannot be moved.
+
 ## Create Character Inventory
 
 Character Inventory tools are only available to project admins.

diff --git a/docs/user_guide/docs/images/data-entry-dup-vern-select-entry.png b/docs/user_guide/docs/images/data-entry-dup-vern-select-entry.png
diff --git a/docs/user_guide/docs/images/data-entry-dup-vern-select-sense.png b/docs/user_guide/docs/images/data-entry-dup-vern-select-sense.png
diff --git a/docs/user_guide/docs/images/data-entry-dup-vern.png b/docs/user_guide/docs/images/data-entry-dup-vern.png
diff --git a/docs/user_guide/docs/images/login.png b/docs/user_guide/docs/images/login.png
diff --git a/docs/user_guide/docs/images/mergeSenseDefinitionsPartOfSpeech.png b/docs/user_guide/docs/images/mergeSenseDefinitionsPartOfSpeech.png
diff --git a/docs/user_guide/docs/images/projectLanguagesTzotzil.png b/docs/user_guide/docs/images/projectLanguagesTzotzil.png
diff --git a/docs/user_guide/docs/images/projectSchedule.png b/docs/user_guide/docs/images/projectSchedule.png
diff --git a/docs/user_guide/docs/images/projectStatsButton.png b/docs/user_guide/docs/images/projectStatsButton.png
diff --git a/docs/user_guide/docs/images/reviewEntriesColumns.png b/docs/user_guide/docs/images/reviewEntriesColumns.png
diff --git a/docs/user_guide/docs/images/userMenu.png b/docs/user_guide/docs/images/userMenu.png
diff --git a/docs/user_guide/docs/project.md b/docs/user_guide/docs/project.md
@@ -35,6 +35,8 @@ A distinguishing and descriptive name is recommended. The project name is part o
 
 ### Project Languages
 
+![Project Languages - Tzotzil](images/projectLanguagesTzotzil.png){ .center }
+
 The _vernacular language_ specified at project creation is fixed.
 
 There may be multiple _analysis languages_ associated with the project, but only the top one in the list is associated
@@ -52,7 +54,7 @@ The _semantic domains language_ controls the language in which semantic domain t
 
 !!! note
 
-    Currently, the maximum size of Lift files supported for import is 250MB.
+    Currently, the maximum size of LIFT files supported for import is 100MB.
 
 !!! note
 
@@ -68,18 +70,12 @@ affixed.
 
 ### Autocomplete
 
-The default setting is On: When a user is entering the [vernacular form](dataEntry.md#vernacular) of a new entry in Data
-Entry, this setting gives suggestions of similar existing entries, allowing the user to select an existing entry and add
-a new sense to that entry, rather than creating a (mostly) duplicate to something previously entered.
-
-(This does not effect the [gloss](dataEntry.md#gloss) spelling suggestions, which are based on a dictionary independent
-of existing project data.)
-
-### Definitions
+The default setting is On: When a user is entering the vernacular form of a new entry in Data Entry, this setting gives
+suggestions of similar existing entries, allowing the user to select an existing entry and add a new sense to that
+entry, rather than creating a (mostly) duplicate to something previously entered. See
+[Data Entry](dataEntry.md#new-entry-with-duplicate-vernacular-form) for more details.
 
-Due to the nature of Rapid Word Collection, [Data Entry](dataEntry.md) in The Combine supports glosses instead of
-definitions. However, if you have imported a project in which senses also have definitions, this setting can enable
-definition support in [Data Cleanup](goals.md).
+(This does not effect gloss spelling suggestions, which are based on a dictionary independent of existing project data.)
 
 ### Project Users
 
@@ -103,8 +99,44 @@ Either search existing users (shows all users with the search term in their name
 new users by email address (they will be automatically added to the project when they make an account via the
 invitation).
 
+### Workshop Schedule
+
+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.
+
+![Workshop Schedule](images/projectSchedule.png){ .center }
+
 ### Archive Project
 
 This is only available to the project Owner. Archiving a project makes it inaccessible to all users. This can only be
 undone by a site administrator. Please contact a site administrator if you wish for the project to be entirely deleted
 from the servers.
+
+## 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.
+This opens statistics about words in the project.
+
+![Project Statistics Button](images/projectStatsButton.png){ .center }
+
+In the context of these statistics, _word_ refers to a sense-domain pair: e.g., an entry with 3 senses, each with 2
+semantic domains, will be counted as 6 words.
+
+### Words per User
+
+A table listing number of words and distinct semantic domains for each project user. Imported words have no associated
+user and will be counted in an "unknownUser" row.
+
+### Words per Domain
+
+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).
+
+### 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.