-
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Fix preview branch to build and deploy Notion changes (#4)
* Update files from Notion * Update getting started page for Community checking and Drafting * update all getting-started pages * Fix preview branch after removing .md doc --------- Co-authored-by: github <>
- Loading branch information
Showing
27 changed files
with
182 additions
and
152 deletions.
There are no files selected for viewing
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1 @@ | ||
{"position":4, "label":"Community Checking"} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,34 +1,12 @@ | ||
--- | ||
title: Using Community Checking | ||
sidebar_position: 3 | ||
slug: /community-checking | ||
title: Adding Questions | ||
sidebar_position: 1 | ||
slug: /adding-questions | ||
--- | ||
|
||
import ReactPlayer from "react-player"; | ||
|
||
This guide describes how to use [Scripture Forge](https://scriptureforge.org/) for community checking. The basic steps are as follows: | ||
|
||
1. Connect a [Paratext](https://paratext.org/) project to Scripture Forge | ||
2. Create or import questions for checkers to answer | ||
3. Attach audio recording of the text (optional) | ||
4. Invite people to check your project | ||
5. Receive and interact with responses to the questions | ||
6. Sync the project so answers show up as notes in Paratext | ||
|
||
## Connect a Paratext project to Scripture Forge {#a49ffad707ee4ff69860080e6e805c3b} | ||
|
||
1. Go to [scriptureforge.org](https://scriptureforge.org/) and click **Log in**. | ||
2. On the log in page, click **Log in with Paratext**. | ||
3. Log in through Paratext and authorize Scripture Forge to access your Paratext account. | ||
4. When you’re redirected back to Scripture Forge, go to the [connect project page](https://scriptureforge.org/connect-project). If you don’t have any projects yet you’ll be sent there automatically. If you already have projects in Scripture Forge, click the project selector in the top left corner, and click **Connect project**. | ||
5. The connect project page shows a list of projects you have access to in Paratext. Select the project you want to connect from the list. | ||
6. Make sure the **Enable Community Checking** checkbox is selected. Don’t worry about the source text right now. That setting can be changed later on the project settings page. | ||
7. Click **Connect**. Within less than a minute you should be taken to the project in Scripture Forge. | ||
|
||
![](./1028160355.png) | ||
|
||
|
||
## Add Questions to the Project {#47b7c1e2e8a74a3489b167849470745e} | ||
## Add Questions to the Project {#1850d745ac9e80e09444cb3564752e31} | ||
|
||
|
||
In order to get feedback on your translation, you’ll need to add comprehension checking questions. You can import questions created by someone else, or create your own. | ||
|
@@ -46,7 +24,7 @@ Currently the only way to get feedback from community checkers is to ask checkin | |
<div class="player-wrapper"><ReactPlayer controls url="https://youtu.be/J-led5En3D8" /></div> | ||
|
||
|
||
### Creating questions individually in Scripture Forge {#0c67e74b02944b61a33b3ea2d101effd} | ||
### Creating questions individually in Scripture Forge {#1850d745ac9e8031908ef693ff578eec} | ||
|
||
|
||
To add questions to your project, click on **Overview** under the **Community Checking** section in the navigation sidebar. Then click on the **Add Question** button. A dialog will open that will allow you to create a question. | ||
|
@@ -64,7 +42,7 @@ Click **Save** and your question will be added to the list of community checking | |
![](./1916935940.png) | ||
|
||
|
||
### Importing questions from a spreadsheet {#42107c9def434bf396442d0004577710} | ||
### Importing questions from a spreadsheet {#1850d745ac9e8085960dd88b648f0c7a} | ||
|
||
|
||
Creating questions one by one can be tedious, so we’ve also made it possible to import questions from a spreadsheet. You can use a program such as Microsoft Excel, Google Sheets, or LibreOffice Calc to create or edit a list of questions. If you’re looking for a set of pre-made questions, consider the [unfoldingWord® Translation Questions](https://git.door43.org/unfoldingWord/en_tq). If you go to the linked page and click on one of the files, you can then download it, open it as a spreadsheet, and edit the list of questions. | ||
|
@@ -101,15 +79,15 @@ If you need help getting your spreadsheet into the right format to import to Scr | |
1. If you have some rows in your file that don’t have a valid reference and question, a warning will be shown letting you know that these rows will be skipped. | ||
2. Otherwise you will be shown a list of questions. | ||
|
||
### Import all questions {#3f10139da5904f1883acafad811b422c} | ||
### Import all questions {#1850d745ac9e80b59ae8cabac1b67e7f} | ||
|
||
|
||
To import all of the questions in the CSV file, follow these steps: | ||
|
||
1. Click the checkbox at the top of the list. This will select all the questions. | ||
2. Click **Import Selected Questions**. | ||
|
||
### Import a subset of questions {#f8f6b299154e4caca7aa04661a820efd} | ||
### Import a subset of questions {#1850d745ac9e8045aa5bd2ab9ce99fbc} | ||
|
||
|
||
You can also filter for a subset of the questions: | ||
|
@@ -130,7 +108,7 @@ You don’t have to remember that there are 43 verses in Mark 5 in order to filt | |
|
||
|
||
|
||
### Importing questions from Transcelerator {#1ed2e353d94847a3861ad3a69d531aac} | ||
### Importing questions from Transcelerator {#1850d745ac9e8003815fc894b8baaeb7} | ||
|
||
|
||
[Transcelerator](https://software.sil.org/transcelerator/) is a plugin for Paratext that has a bank of ready-made comprehension checking questions in several major languages. Those questions can be translated within Paratext, exported to Scripture Forge, and then after a sync, imported into Scripture Forge. | ||
|
@@ -149,13 +127,13 @@ To import questions from Transcelerator: | |
9. Select the questions you want to import. The steps for doing this are exactly the same as in the section above titled **Importing questions from a spreadsheet**. Refer to that section for instructions on filtering for the questions you want. | ||
10. Click **Import Selected Questions** and your questions will be added to the project. | ||
|
||
## Attach audio recording of the text {#fd31ef9b6d74417099996e7dadb5068e} | ||
## Attach audio recording of the text {#1850d745ac9e80e795f3d611356e74d5} | ||
|
||
|
||
Scripture Forge can play an audio recording of each passage for community checkers. To do this, you will need to upload an audio file and a timing file for each chapter. Timing files allow Scripture Forge to highlight each verse as it is being spoken. | ||
|
||
|
||
### Recording the text {#1926abf6118c46bba16353d2ef85169f} | ||
### Recording the text {#1850d745ac9e805eb4b1c0f05d6da02a} | ||
|
||
|
||
Scripture Forge supports audio in .mp3 and .wav file formats. Timing files are supported from HearThis, aeneas, Audacity, and Adobe Audition. | ||
|
@@ -167,7 +145,7 @@ One of the simplest options is to use [HearThis](http://software.sil.org/hearthi | |
The [resources](https://software.sil.org/scriptureappbuilder/resources/) for Scripture App Builder discuss more advanced approaches, such as using Glyssen for a dramatized audio recording. | ||
|
||
|
||
### Creating timing files {#066182aa22c64dc7a74ad0556619c4b9} | ||
### Creating timing files {#1850d745ac9e80c7b583c6d50193d7c9} | ||
|
||
|
||
If you already have audio recorded, there are several options for creating timing data. | ||
|
@@ -179,116 +157,11 @@ You can automatically generate timing files using aeneas by following [these ins | |
Alternatively, you can manually create timing files using Audacity by following [this guide](https://software.sil.org/downloads/r/scriptureappbuilder/Scripture-App-Builder-06-Using-Audacity-for-Audio-Text-Synchronization.pdf). Another option is Adobe Audition. Timing data from Adobe Audition is supported in decimal or FPS time formats. We don’t support the “samples” format. | ||
|
||
|
||
### Attaching audio {#a4d3ee4a4d8b4e1d9bca42b837e57f77} | ||
### Attaching audio {#1850d745ac9e80668685c9ea58252d6b} | ||
|
||
|
||
To upload audio and timing files, in the sidebar click **Questions & answers**, navigate to the chapter you want to attach audio to, and then click the **Manage Audio** icon in the top right corner. Click **Browse Files** and select the audio recording and associated timing file for that chapter, then click **Save**. | ||
|
||
|
||
![](./645317227.png) | ||
|
||
|
||
## Invite people to check your project {#678dca00aaa54fd79319ecf815049301} | ||
|
||
|
||
<div class="player-wrapper"><ReactPlayer controls url="https://youtu.be/aBPHCF56hxA" /></div> | ||
|
||
|
||
Once you have the questions on your project, it’s time to invite community checkers. | ||
|
||
|
||
In the side bar, click **Settings**, and scroll down to **Community Checking Settings**. | ||
|
||
|
||
![](./998098765.png) | ||
|
||
|
||
### User interaction settings {#84a006f1fbaa4c50a8ce8bac248c0e1d} | ||
|
||
|
||
The first setting to consider is **Allow checkers to see each other's answers**. When community checkers are presented with a question, existing answers from other community checkers are not shown so that they will not influence the answer that is given. Once a question is answered, any other answers to the question will be shown, and checkers can comment on and like each other’s answers. If you don’t want this interaction and want answers from other checkers to always be hidden, turn off **Allow checkers to see each other's answers**. | ||
|
||
|
||
### Sharing settings {#5aa7e3d8451f40cfa6b33c5dd39a3c6f} | ||
|
||
|
||
If you want community checkers to be able to invite friends to the project, make sure **Allow users to invite others to the project** is enabled. If this setting is off, only project admins will be able to add community checkers to the project. | ||
|
||
|
||
If you turn this setting on, there are two sharing modes to choose from. If you select **Anyone with a link**, you can send people a link to the project, and anyone who clicks the link can join the project. This is ideal if you want to invite a group of people (for example, you could share the link in a Facebook or WhatsApp group). Anyone with the link will be able to send the link to anyone else to join the project. Alternatively you can select **Email invitations only**, and community checkers will only be able to invite friends by sending an invitation in Scripture Forge (Scripture Forge will send an email invitation to the person). | ||
|
||
|
||
### Inviting community checkers {#2271d918980445fd8bc89587ccf33c4f} | ||
|
||
|
||
In the side bar, click **Users**, and you will be presented with sharing options. | ||
|
||
|
||
![](./1688833473.png) | ||
|
||
|
||
If you enabled link sharing in the previous step, there will be a link that you can copy to share the project. To copy the link, click the copy icon on the right side of the link. | ||
|
||
|
||
If link sharing is turned off, or if you want to send email invitations to users, type the email of the user you want to invite, select the **Community Checker** role, and choose an invitation language. Then click **Send**. An email with a link will be sent to the person, who will need to click the link and sign up to join the project. | ||
|
||
|
||
## Receive and interact with responses to the questions {#d09b7e47859e451783e6dcca8a80f40a} | ||
|
||
|
||
<div class="player-wrapper"><ReactPlayer controls url="https://youtu.be/C3bgh3yufVg" /></div> | ||
|
||
|
||
To monitor community checking responses, click on **Overview** under the **Community Checking** section in the navigation sidebar. Along with a list of questions, basic statistics about responses will be shown. | ||
|
||
|
||
![](./685721.png) | ||
|
||
|
||
To view the answers from community checkers, click on one of the books under the **Community Checking** section in the navigation sidebar. Then click on a question to see the answers that have been given. If you want an answer to be exported to Paratext, click **Mark for export** on that answer. If you don’t want to do anything further with the answer, click **Resolve**. This does not remove the answer, but it marks it as not needing any further action. | ||
|
||
|
||
![](./1417670916.png) | ||
|
||
|
||
If you want to find answers that have not been marked for export, or marked resolved, use the filter above the list of questions to find **Unreviewed answers**. | ||
|
||
|
||
![](./2739440.png) | ||
|
||
|
||
If you would prefer to have all answers exported to Paratext without individually marking them for export, go to the project settings and find the **Exporting Answers** section. The default option is to only export **Answers marked for export**, but this setting can be changed to **All answers** or **No answers**. | ||
|
||
|
||
![](./1265120461.png) | ||
|
||
|
||
## Sync the project so answers show up as notes in Paratext {#1502b9d293ff4c3aacbe91834fd02bb2} | ||
|
||
|
||
In the navigation sidebar, click **Synchronize**. On the page that opens, click **Synchronize** to send and receive changes from Paratext. Then open your project in Paratext and do a send and receive. Answers from community checkers will show up in your project as notes. Please note that if you reply to these notes in Paratext, your replies will not appear as comments on the answer in Scripture Forge. | ||
|
||
|
||
The note will show the original question, the name of the community checker who answered, and the answer itself, as shown below. | ||
|
||
|
||
![](./673009763.png) | ||
|
||
|
||
Notes generated from community checking answers will have a unique note tag, with an icon that is different from other notes in your Paratext project. You can change the icon by editing the note tag. For details, see [the Paratext help article on custom note tags](https://paratext.org/paratext-training/tutorials/custom-project-note-tags-tutorial/). You can also [filter notes by their note tag](https://paratext.org/2022/08/15/custom-note-tags/#Filter_for_Custom_Note_Tags), allowing you to show only community checking responses, or hide them from view altogether. | ||
|
||
|
||
:::note | ||
|
||
Currently audio answers show up in Paratext but the audio cannot be played. In order to play the audio from an answer it has to be opened in Scripture Forge. This may be improved in the future. | ||
|
||
::: | ||
|
||
|
||
|
||
|
||
## Feedback {#f7d132ecbb04437e9d5a81440f84b6df} | ||
|
||
|
||
If you have questions, problems, or suggestions, please reach out to the Scripture Forge team at [[email protected]](mailto:[email protected]). You can also post on the [community support site](https://community.scripture.software.sil.org/c/scripture-forge/19), which allows others to participate in the conversation. We value your feedback and frequently make changes or fix problems at the request of our users. | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,13 @@ | ||
--- | ||
title: Enable Community Checking | ||
sidebar_position: 0 | ||
slug: /enable-community-checking | ||
--- | ||
|
||
|
||
|
||
To use Scripture Forge Community checking, you need to first login to Scripture Forge using your Paratext credentials and Connect your project. Once your project is connected, navigate to Settings and scroll down to the Community Checking section. Make sure the “Enable Community Checking” checkbox is selected as shown in the below screenshot | ||
|
||
|
||
![](./2042422434.png) | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,61 @@ | ||
--- | ||
title: Managing Collected Answers | ||
sidebar_position: 3 | ||
slug: /managing-answers | ||
--- | ||
|
||
import ReactPlayer from "react-player"; | ||
|
||
## Receive and interact with responses to the questions {#1850d745ac9e800db3dacdee0053beca} | ||
|
||
|
||
<div class="player-wrapper"><ReactPlayer controls url="https://youtu.be/C3bgh3yufVg" /></div> | ||
|
||
|
||
To monitor community checking responses, click on **Overview** under the **Community Checking** section in the navigation sidebar. Along with a list of questions, basic statistics about responses will be shown. | ||
|
||
|
||
![](./685721.png) | ||
|
||
|
||
To view the answers from community checkers, click on one of the books under the **Community Checking** section in the navigation sidebar. Then click on a question to see the answers that have been given. If you want an answer to be exported to Paratext, click **Mark for export** on that answer. If you don’t want to do anything further with the answer, click **Resolve**. This does not remove the answer, but it marks it as not needing any further action. | ||
|
||
|
||
![](./1417670916.png) | ||
|
||
|
||
If you want to find answers that have not been marked for export, or marked resolved, use the filter above the list of questions to find **Unreviewed answers**. | ||
|
||
|
||
![](./2739440.png) | ||
|
||
|
||
If you would prefer to have all answers exported to Paratext without individually marking them for export, go to the project settings and find the **Exporting Answers** section. The default option is to only export **Answers marked for export**, but this setting can be changed to **All answers** or **No answers**. | ||
|
||
|
||
![](./1265120461.png) | ||
|
||
|
||
## Sync the project so answers show up as notes in Paratext {#1850d745ac9e80a8b3f0f50bcdd0be58} | ||
|
||
|
||
In the navigation sidebar, click **Synchronize**. On the page that opens, click **Synchronize** to send and receive changes from Paratext. Then open your project in Paratext and do a send and receive. Answers from community checkers will show up in your project as notes. Please note that if you reply to these notes in Paratext, your replies will not appear as comments on the answer in Scripture Forge. | ||
|
||
|
||
The note will show the original question, the name of the community checker who answered, and the answer itself, as shown below. | ||
|
||
|
||
![](./673009763.png) | ||
|
||
|
||
Notes generated from community checking answers will have a unique note tag, with an icon that is different from other notes in your Paratext project. You can change the icon by editing the note tag. For details, see [the Paratext help article on custom note tags](https://paratext.org/paratext-training/tutorials/custom-project-note-tags-tutorial/). You can also [filter notes by their note tag](https://paratext.org/2022/08/15/custom-note-tags/#Filter_for_Custom_Note_Tags), allowing you to show only community checking responses, or hide them from view altogether. | ||
|
||
|
||
:::note | ||
|
||
Currently audio answers show up in Paratext but the audio cannot be played. In order to play the audio from an answer it has to be opened in Scripture Forge. This may be improved in the future. | ||
|
||
::: | ||
|
||
|
||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,52 @@ | ||
--- | ||
title: Inviting Community Checkers | ||
sidebar_position: 2 | ||
slug: /managing-checkers | ||
--- | ||
|
||
import ReactPlayer from "react-player"; | ||
|
||
## Invite people to check your project {#1850d745ac9e80caacf5e643bb216f77} | ||
|
||
|
||
<div class="player-wrapper"><ReactPlayer controls url="https://youtu.be/aBPHCF56hxA" /></div> | ||
|
||
|
||
Once you have the questions on your project, it’s time to invite community checkers. | ||
|
||
|
||
In the side bar, click **Settings**, and scroll down to **Community Checking Settings**. | ||
|
||
|
||
![](./998098765.png) | ||
|
||
|
||
### User interaction settings {#1850d745ac9e8018b5a7ff9f3ea349e9} | ||
|
||
|
||
The first setting to consider is **Allow checkers to see each other's answers**. When community checkers are presented with a question, existing answers from other community checkers are not shown so that they will not influence the answer that is given. Once a question is answered, any other answers to the question will be shown, and checkers can comment on and like each other’s answers. If you don’t want this interaction and want answers from other checkers to always be hidden, turn off **Allow checkers to see each other's answers**. | ||
|
||
|
||
### Sharing settings {#1850d745ac9e8097ad4efcb063fc2603} | ||
|
||
|
||
If you want community checkers to be able to invite friends to the project, make sure **Allow users to invite others to the project** is enabled. If this setting is off, only project admins will be able to add community checkers to the project. | ||
|
||
|
||
If you turn this setting on, there are two sharing modes to choose from. If you select **Anyone with a link**, you can send people a link to the project, and anyone who clicks the link can join the project. This is ideal if you want to invite a group of people (for example, you could share the link in a Facebook or WhatsApp group). Anyone with the link will be able to send the link to anyone else to join the project. Alternatively you can select **Email invitations only**, and community checkers will only be able to invite friends by sending an invitation in Scripture Forge (Scripture Forge will send an email invitation to the person). | ||
|
||
|
||
### Inviting community checkers {#1850d745ac9e802d84d8e00da4fe25c2} | ||
|
||
|
||
In the side bar, click **Users**, and you will be presented with sharing options. | ||
|
||
|
||
![](./1688833473.png) | ||
|
||
|
||
If you enabled link sharing in the previous step, there will be a link that you can copy to share the project. To copy the link, click the copy icon on the right side of the link. | ||
|
||
|
||
If link sharing is turned off, or if you want to send email invitations to users, type the email of the user you want to invite, select the **Community Checker** role, and choose an invitation language. Then click **Send**. An email with a link will be sent to the person, who will need to click the link and sign up to join the project. | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1 +1 @@ | ||
{"position":7, "label":"Drafting"} | ||
{"position":3, "label":"Drafting"} |
Oops, something went wrong.