<commit_before>﻿# (Scroll down for Release Notes)

# Getting Started
To use HearThis to record audio Scriptures, you will need the following:

1. A default recording and playback device capable of high-quality audio. Set up a headset microphone and (probably) an external A/D USB converter. Reportedly some laptops can do an OK recording job right out of the microphone jack, so if you can't locate an external convert, please do some experimenting anyways. But do not try to use the built-in microphone.
2. One of the following:
  - [Paratext](https://paratext.org/) 8 installed on the machine, with the project you want to record, or
  - a Digital Bible Library [Text Release Bundle](https://app.thedigitalbiblelibrary.org/static/docs/entryref/text/index.html) with some translated Scripture, or
  - a [Glyssen](http://software.sil.org/glyssen/) script exported from Glyssen
3. One or more speakers of the language to record the Scriptures. Once a project is selected and a few (optional) settings are selected to meet the needs of the project, HearThis is intended to be usable by people with minimal computer skills and relatively little training. Users should be taught to navigate to the text that is to be recorded, record each script item, check the recordings, and re-record as necessary. After they get the basics, please teach them to use the keyboard, not the mouse (which is inefficient for such a repetitive task). Please take note of their reading fluency; a large proportion of the intended audience will struggle to read naturally, and that's why the interface is designed to make it easy to listen and re-record, as many times as necessary.
4. If you have a question, suggestion, or encouragement for us or our backers, please visit our [web forum](https://community.scripture.software.sil.org/c/hearthis). If you have a bug report, you can get that into our "to do" list directly by emailing [<EMAIL>](mailto://<EMAIL>).

# What to Back Up
HearThis stores a separate WAV file for each script line, indefinitely.
When you "Export", it gathers these up, joins them into chapters, and then
converts them to the format you choose.   The individual WAV files are
stored in the Program Data folder, under the SIL\HearThis directory.  For
example, on Windows 7, Genesis chapter 1 of the Good News UK would be stored
here: <a href="file:///C:/ProgramData/SIL/HearThis/GNTUK/Genesis/1">
C:\ProgramData\SIL\HearThis\GNTUK\Genesis\1</a>. This location needs to be
backed up (a future version of MyWorkSafe will do that automatically). If for
some reason you need to get at these files, for example to delete them or run
some audio cleanup process over them, feel free to do so.

#Notes on Exporting

To export to mp3 format, you'll need to download something extra. If you install "<a
	href="http://audacity.sourceforge.net/help/faq?s=install&amp;item=lame-mp3">LAME
for Audacity</a>", then HearThis will use it to create MP3s. This format is also needed for export to Saber devices.

#Notes on MegaVoice

MegaVoice uses small "tag" recordings to help the user navigate by audio.
This version of HearThis does not yet generate those files.  MegaVoice also
requires a particular bit/rate for its wav files (16bit, 44.1k, mono). HearThis does convert
the recorded files to that format, if necessary.

-----------------------------

# Release Notes

## 3 January 2018
- Fixed bug to add support for transliterated text (in \tl field). This change was incorporated into product for both Paratext 7 and Paratext 8.

## HearThis 2.0
- Dramatic Reading support. You can now do dramatized recordings. Use [Glyssen](http://software.sil.org/glyssen/) to prepare a script based on your Paratext project, then export a "Glyssen Script". Double-click on that file to open it with HearThis. Each "actor" can then select their name, see the acting roles they have been given, and select one. HearThis will then walk them through recording the script for that role.
- You can now save and merge-in “HearThis Packs”, so that multiple computers can be used to do the recordings, then brought back together.
- You can now select a high contrast color scheme in Settings:Interface. This is useful for presenting with projectors.
- We've cleaned up the normal color scheme a bit and given it a higher contrast than before.
- There has always been an icon that shows you what device HearThis is listening to. We've added new icons to make that clearer, including a "warning"-looking one if HearThis detects that you are using a laptop's built-in microphone.
- If you click the device icon, HearThis will now open the Windows Control Panel that lets you change to a different default recording device.
- To use with Paratext, you must have Paratext 8


## February 2017
Fixed bug that cause HearThis to crash when not connected to the Internet.

## January 2017
Added support for recording passages of poetry in which you want to separate text at paragraph markers, instead of just punctuation. See Settings:Punctuation. This change was incorporated into both 1.4 (for Paratext 7) and 1.5 (for Paratext 8).

## 1.5 November 2016
Added support for Paratext 8 projects. HearThis 1.4.x should be used for Paratext 7 projects.

## 1.4 September 2016
Increased time we wait for external audio merger/converters to finish, from 1 minute to 10 minutes.

## 1.3 May 2016
* Right to left languages now align to the right in the main window. HearThis gets this setting from Paratext.

## 1.2 February 2016

* New "Record Line in Parts" dialog allows readers who are having trouble with a line to split a long line into two separate recordings.<commit_msg>Added release note<commit_after>﻿# (Scroll down for Release Notes)

# Getting Started
To use HearThis to record audio Scriptures, you will need the following:

1. A default recording and playback device capable of high-quality audio. Set up a headset microphone and (probably) an external A/D USB converter. Reportedly some laptops can do an OK recording job right out of the microphone jack, so if you can't locate an external convert, please do some experimenting anyways. But do not try to use the built-in microphone.
2. One of the following:
  - [Paratext](https://paratext.org/) 8 installed on the machine, with the project you want to record, or
  - a Digital Bible Library [Text Release Bundle](https://app.thedigitalbiblelibrary.org/static/docs/entryref/text/index.html) with some translated Scripture, or
  - a [Glyssen](http://software.sil.org/glyssen/) script exported from Glyssen
3. One or more speakers of the language to record the Scriptures. Once a project is selected and a few (optional) settings are selected to meet the needs of the project, HearThis is intended to be usable by people with minimal computer skills and relatively little training. Users should be taught to navigate to the text that is to be recorded, record each script item, check the recordings, and re-record as necessary. After they get the basics, please teach them to use the keyboard, not the mouse (which is inefficient for such a repetitive task). Please take note of their reading fluency; a large proportion of the intended audience will struggle to read naturally, and that's why the interface is designed to make it easy to listen and re-record, as many times as necessary.
4. If you have a question, suggestion, or encouragement for us or our backers, please visit our [web forum](https://community.scripture.software.sil.org/c/hearthis). If you have a bug report, you can get that into our "to do" list directly by emailing [<EMAIL>](mailto://<EMAIL>).

# What to Back Up
HearThis stores a separate WAV file for each script line, indefinitely.
When you "Export", it gathers these up, joins them into chapters, and then
converts them to the format you choose.   The individual WAV files are
stored in the Program Data folder, under the SIL\HearThis directory.  For
example, on Windows 7, Genesis chapter 1 of the Good News UK would be stored
here: <a href="file:///C:/ProgramData/SIL/HearThis/GNTUK/Genesis/1">
C:\ProgramData\SIL\HearThis\GNTUK\Genesis\1</a>. This location needs to be
backed up (a future version of MyWorkSafe will do that automatically). If for
some reason you need to get at these files, for example to delete them or run
some audio cleanup process over them, feel free to do so.

#Notes on Exporting

To export to mp3 format, you'll need to download something extra. If you install "<a
	href="http://audacity.sourceforge.net/help/faq?s=install&amp;item=lame-mp3">LAME
for Audacity</a>", then HearThis will use it to create MP3s. This format is also needed for export to Saber devices.

#Notes on MegaVoice

MegaVoice uses small "tag" recordings to help the user navigate by audio.
This version of HearThis does not yet generate those files.  MegaVoice also
requires a particular bit/rate for its wav files (16bit, 44.1k, mono). HearThis does convert
the recorded files to that format, if necessary.

-----------------------------

# Release Notes

## 27 February 2018
- Update to work with latest version of Paratext 8 project data.

## 3 January 2018
- Fixed bug to add support for transliterated text (in \tl field). This change was incorporated into product for both Paratext 7 and Paratext 8.

## HearThis 2.0
- Dramatic Reading support. You can now do dramatized recordings. Use [Glyssen](http://software.sil.org/glyssen/) to prepare a script based on your Paratext project, then export a "Glyssen Script". Double-click on that file to open it with HearThis. Each "actor" can then select their name, see the acting roles they have been given, and select one. HearThis will then walk them through recording the script for that role.
- You can now save and merge-in “HearThis Packs”, so that multiple computers can be used to do the recordings, then brought back together.
- You can now select a high contrast color scheme in Settings:Interface. This is useful for presenting with projectors.
- We've cleaned up the normal color scheme a bit and given it a higher contrast than before.
- There has always been an icon that shows you what device HearThis is listening to. We've added new icons to make that clearer, including a "warning"-looking one if HearThis detects that you are using a laptop's built-in microphone.
- If you click the device icon, HearThis will now open the Windows Control Panel that lets you change to a different default recording device.
- To use with Paratext, you must have Paratext 8


## February 2017
Fixed bug that cause HearThis to crash when not connected to the Internet.

## January 2017
Added support for recording passages of poetry in which you want to separate text at paragraph markers, instead of just punctuation. See Settings:Punctuation. This change was incorporated into both 1.4 (for Paratext 7) and 1.5 (for Paratext 8).

## 1.5 November 2016
Added support for Paratext 8 projects. HearThis 1.4.x should be used for Paratext 7 projects.

## 1.4 September 2016
Increased time we wait for external audio merger/converters to finish, from 1 minute to 10 minutes.

## 1.3 May 2016
* Right to left languages now align to the right in the main window. HearThis gets this setting from Paratext.

## 1.2 February 2016

* New "Record Line in Parts" dialog allows readers who are having trouble with a line to split a long line into two separate recordings.
{'fraction_non_alphanumeric': 0.06219716324552903, 'fraction_numerical': 0.013302792705488503, 'mean_word_length': 4.169398907103825, 'pattern_counts': {'":': 0, '<': 15, '<?xml version=': 0, '>': 15, 'https://': 6, 'lorem ipsum': 0, 'www.': 0, 'xml': 0}, 'pii_count': 0, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 6, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '1747508', 'n_tokens_mistral': 3143, 'n_tokens_neox': 2869, 'n_words': 1729}