Merge pull request #3784 from Tangerine-Community/release/v3.32.1

Release/v3.32.1

Author: esurface

.gitignore

@@ -63,3 +63,4 @@ scripts/apk-build.sh
 .angular
 .secrets
 ._.DS_Store
+/.lh

CHANGELOG.md

@@ -1,5 +1,53 @@
 # What's new
 
+## v3.32.1
+
+__General Updates__
+
+- [#3776](https://github.com/Tangerine-Community/Tangerine/issues/3776) Add platform config variable T_USER_SHORT_CODE_LENGTH to set the length of the user short code
+
+Enables configuration of the length of the user profile short code, which are used in Tangerine Sync Protocol 1 to import existing responses into a device. The default length in 6 characters. Tangerine users with custom userProfileIds should consider increasing the value to avoid duplicate ids. To change the value, set `T_USER_SHORT_CODE_LENGTH` in the `config.sh` file to set the length of the user short code, then run `docker exec -it tangerine push-all-groups-views`.
+
+- Add shared csv template parameter to generate csv data sets script and API
+
+The `/api/create/csvDataSets/` API and script called [generate-csv-data-sets](./server/src/scripts/generate-csv-data-sets/bin.js) are useful to generate CSV Data Sets (Spreadsheets) across all forms in all groups. This change adds a second parameter called `sharedCsvTemplateId` which is the CouchDB Id of a Spreadsheet Template stored in the groups database named `group-<id>-csv-templates`. When the parameter is provided to the script or API, the CSV Template will be applied to control the headers on the CSV datasets produced by the process. Only CSVs will be produced for groups that have the `sharedCsvTemplateId` template in the `group-<id>-csv-templates` database.
+
+- Format Form Titles in Tangerine Web UI to show the form title or form id with translations
+  - Fixes [#3735](https://github.com/Tangerine-Community/Tangerine/issues/3735)
+  - Closes [#3751](https://github.com/Tangerine-Community/Tangerine/issues/3751)
+
+Form Titles will now appear in more places in the Tangerine Web UI for improved readability. If the form title doesn't contain `t-lang` tag, return the text. Otherwise, it will use the English translation if it exists or the first translation if there's no English version of the title. Use the same heuristic in the pipe when creating and naming csv files.
+
+- Tangy Audio Recording and Audio Playback Inputs
+
+Two new inputs are available for recording and playing back audio.
+
+```html
+<tangy-audio-recording name="test-audio" label="Record Audio"></tangy-audio-recording>
+<tangy-audio-playback name="test-playback" label="Audio Playback" src="assets/sounds/fewtimes_Eng.mp3"></tangy-audio-playback>
+```
+
+- Add Modern Standard Arabic (MSA) to the list of supported languages
+
+Users can set the language of the tablet to Modern Standard Arabic (MSA) by selecting the 'Arabic' in the client and add `t-lang ar` tags to text labels in forms
+
+- [3811](https://github.com/Tangerine-Community/Tangerine/pull/3811) Documentation Overhaul
+
+__Libraries and Dependencies__
+- [translation-web-component](https://github.com/Tangerine-Community/translation-web-component): Update `t-select` with a `currentLanguageDirection` property to enable RTL support.
+- tangy-form: Updates and fixes for Audio Recording and Playback inputs
+- tangy-form-editor: Updates and fixes for Audio Recording and Playback widgets
+
+__Server upgrade instructions__
+
+See the [Server Upgrade Instructions](https://docs.tangerinecentral.org/system-administrator/upgrade-instructions).
+
+*Special Instructions for this release:* 
+
+Once the Tangerine and CouchDB are running, run the upgrade script for v3.32.1:
+
+`docker exec -it tangerine /tangerine/server/src/upgrade/v3.32.1.js`
+
 ## v3.32.0
 
 Tangerine v3.32.0 contains a major update to the deployment and fuctionality of Online Surveys including the introduction of authentication and case association. 

client/package.json

@@ -75,8 +75,7 @@
     "rxjs-compat": "^6.5.5",
     "sanitize-filename-ts": "^1.0.2",
     "spark-md5": "^3.0.2",
-    "tangy-form": "^4.46.1",
-    "translation-web-component": "1.1.1",
+    "tangy-form": "^4.48.2",
     "tslib": "^1.10.0",
     "underscore": "^1.9.1",
     "uuid-browser": "^3.1.0",

client/src/polyfills.ts

@@ -49,6 +49,8 @@ import 'tangy-form/input/tangy-toggle.js';
 import 'tangy-form/input/tangy-radio-blocks.js';
 import 'tangy-form/input/tangy-video-capture.js';
 import 'tangy-form/input/tangy-prompt-box.js';
+import 'tangy-form/input/tangy-audio-recording.js';
+import 'tangy-form/input/tangy-audio-playback.js';
 // import 'tangy-form/input/tangy-scan-image.js';
 
 

config.defaults.sh

@@ -86,6 +86,9 @@ T_REGISTRATION_REQUIRES_SERVER_USER="false"
 # This setting only works with new groups being created.
 T_CENTRALLY_MANAGED_USER_PROFILE="false"
 
+# User Short Code Length: The length of the short code that is used to import data to a device from the user id. Default is 6.
+T_USER_SHORT_CODE_LENGTH=6
+
 # Sync Protocol 1 Only: Don't do a GET before a PUT when uploading.
 T_UPLOAD_WITHOUT_UPDATING_REV="true"
 

develop.sh

@@ -184,6 +184,7 @@ OPTIONS="--link $T_COUCHDB_CONTAINER_NAME:couchdb \
   --env \"T_LEGACY=$T_LEGACY\" \
   --env \"T_REGISTRATION_REQUIRES_SERVER_USER=$T_REGISTRATION_REQUIRES_SERVER_USER\" \
   --env \"T_CENTRALLY_MANAGED_USER_PROFILE=$T_CENTRALLY_MANAGED_USER_PROFILE\" \
+  --env \"T_USER_SHORT_CODE_LENGTH=$T_USER_SHORT_CODE_LENGTH\" \
   --env \"T_CATEGORIES=$T_CATEGORIES\" \
   --env \"T_ORIENTATION=$T_ORIENTATION\" \
   --env \"T_REPORTING_MARK_OPTIONAL_NO_ANSWER_WITH=$T_REPORTING_MARK_OPTIONAL_NO_ANSWER_WITH\" \

docs/.pages

@@ -1,13 +1,16 @@
-arrange:
-    - index.md
-    - about.md
-    - guides.md
-    - getting-started.md
-    - whats-new.md
-    - navigation.md 
-    - CONTRIBUTING.md
-    - editor
-    - data-collector
-    - data-manager 
-    - developer
-    - system-administrator
+nav:
+   - index.md
+   - Get Started:  
+      - Form Editor: editor
+      - Data Collector: data-collector
+      - System Administrator: system-administrator
+
+
+   - Get Involved:
+      - developer
+   - Product Suite: ./product-suite 
+   - Learn: https://moodle.tangerinecentral.org/course/index.php?categoryid=14
+   - Setup your Platform: system-administrator/installation
+   - Sign up: https://www.tangerinecentral.org/pricing
+
+   - about.md

docs/CONTRIBUTING.md

@@ -42,8 +42,3 @@ Now you have everything installed, get started viewing content by running the fo
 mkdocs serve
 ```
 
-## Contribution Guide
-
-TODO: Replace this video with an updated version to reflect the new process
-
-<iframe width="560" height="315" src="https://www.youtube.com/embed/EyQz44EvdZI" frameborder="0" allow="accelerometer; autoplay; encrypted-media; gyroscope; picture-in-picture" allowfullscreen></iframe>

docs/about.md

@@ -1,13 +1,16 @@
 # About Tangerine
 
-Tangerine is electronic data collection software designed for use on Android mobile devices. Its primary use is to enable offline data capture in low-resource areas. 
+Tangerine is an electronic data collection platform designed for use on Android mobile devices. Its primary use is to enable offline data capture in low-resource areas. It is used in education, health, agriculture, and other areas.
 
-Tangerine was first developed to capture student responses in in oral early grade reading and mathematics skills assessments, specifically Early Grade Reading Assessment (EGRA) and Early Grade Mathematics Assessment (EGMA). As well as capture interview responses from students, teachers and principals on home and school context information. Tangerine's capabilities have been expanded for data capture and management for rural health intervention projects. 
+Tangerine was first developed to capture student responses in in oral early grade reading and mathematics skills assessments, specifically Early Grade Reading Assessment (EGRA) and Early Grade Mathematics Assessment (EGMA). As well as capture interview responses from students, teachers and principals on home and school context information. Tangerine's capabilities have been expanded for data capture and management for rural health intervention projects.
 
-Using Tangerine improves data quality and the efficiency of data collection and analysis by simplifying the preparation and implementation of field work, reducing measurement and data entry errors, and eliminating manual data entry from paper forms. 
+Using Tangerine improves data quality and the efficiency of data collection and analysis by simplifying the preparation and implementation of field work, reducing measurement and data entry errors, and eliminating manual data entry from paper forms.
 
-Tangerine was developed in 2011 by RTI International with its own internal research funds, and made available to the public through a GNU General Public License. RTI redesigned Tangerine and developed a new codebase using latest technologies in 2018 with funding support from Google.org. As an open source software platform Tangerine's source code is available for anyone who wishes to install and use Tangerine on their own web server. Tangerine's source code and related documentation is available on Github, a commonly used repository for open source software.  To learn more and have a look under the hood, check out Tangerine's Code Repositories on Github.
+Tangerine was developed in 2011 by RTI International with its own internal research funds and made available to the public through a GNU General Public License. RTI redesigned Tangerine and developed a new codebase using latest technologies in 2018 with funding support from Google.org. As an open-source software platform Tangerine's source code is available for anyone who wishes to install and use Tangerine on their own web server. Tangerine's source code and related documentation is available on Github, a commonly used repository for open-source software. To learn more and have a look under the hood, check out Tangerine's Code Repositories on Github.
+
+
+## Get in touch
+
+[Get in Touch](https://www.tangerinecentral.org/contact)
 
-## How it works
-![How it works](how-it-works.png)
 

docs/data-collector/.pages

@@ -1,5 +1,9 @@
 title: "Data Collector"
-arrange:
+nav:
 
-    - data-collector-overview.md
-    - README.md
+    - README.md
+    - Tangerine app Installation: install-app.md
+    - registration.md
+    - data-collector.md
+    - data-sync.md
+    - App Update: update-app.md