Skip to content

Commit

Permalink
Merge pull request #49 from bible-technology/Version-0.5.6
Browse files Browse the repository at this point in the history
Version 0.5.6
  • Loading branch information
vipinpaul authored Jan 8, 2024
2 parents 3939533 + 93efeea commit 93b4f81
Show file tree
Hide file tree
Showing 154 changed files with 4,111 additions and 114 deletions.
3 changes: 2 additions & 1 deletion .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -33,4 +33,5 @@ website-1.x-migrated

website/i18n/**/*
#!website/i18n/fr
#!website/i18n/fr/**/*
#!website/i18n/fr/**/*
.env
7 changes: 3 additions & 4 deletions docs/scribe/Basic Setup/p1-3-notifications.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,11 +3,10 @@ id: p1-3-notifications
sidebar_label: Notifications
title: Notifications
---

- Click on the **bell** icon <img src="/assets/notification.png" width="30px" alt=""/> at the top right side of the screen next to the **New Layout** icon
- Here you will find a list of **Notifications**
- Click on the **bell** icon img< src="/assets/notification.png" width="30px" alt=""/> at the top right side of the screen next to the **New Layout** icon
- Here you will find a list of **Notifications**
- Each type of notification will have a different color

To return to the main page, click on the <—— arrow on the top left side of the screen.
<img src="/0.5.5/en-notification1.png" width="1000px" alt="notification"/>
<img src="/0.5.5/en-notification2.png" width="1000px" alt="notification"/>
<img src="/0.5.5/en-notification2.png" width="1000px" alt="notification"/>
19 changes: 8 additions & 11 deletions docs/scribe/Getting-Started/p0-1-what-is-scribe-SE.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,23 +4,20 @@ sidebar_label: What is Scribe SE?
title: What is Scribe SE?
slug: '/'
---




:::tip Features Introduced in version 0.5.5

<!-- :::tip Features Introduced in version 0.5.5
[Upload Help Resources](../How-to/p9-2-offlineupload.md)
:::
::: -->

**Scribe Scripture Editor** is an easy-to-use Bible translation tool designed to empower mother tongue translators to quickly and efficiently complete various tasks related to Bible translation with minimal training.


**Scribe SE** supports different flavours such as Bible Translation, Open Bible Stories (OBS) and Oral Bible Translation (Audio). Bible translations from the source text can be drafted and edited with the help of **Scribe**. Additionally, it allows translators to import and export [Scripture Burrito](https://docs.burrito.bible/) format, it also allows importing USFM files from the local system. Users can work on multiple projects simultaneously.

Multiple reference panels are available for the translator to use when looking for information or seeking clarity in the source text. In resource panes the translator can load different resources like Bibles, translation notes, translation words list, translation words, translation questions, translation academy, Open Bible Stories, OBS translation notes, OBS translation question, OBS translation words list and Audio Bible resources as reference material.
Multiple reference panels are available for the translator to use when looking for information or seeking clarity in the source text. In resource panes the translator can load different resources like Bibles, translation notes, translation words list, translation words, translation questions, translation academy, Open Bible Stories, OBS translation notes, OBS translation question, OBS translation words list and Audio Bible resources as reference material.

:::note

*Note*:
**The Scribe Scripture Editor (Scribe SE) will hereafter be referred to as Scribe in this document.**
**The Scribe Scripture Editor (Scribe SE) will hereafter be referred to as Scribe in this document.**

:::
37 changes: 29 additions & 8 deletions docs/scribe/Getting-Started/p0-3-installation.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -6,12 +6,22 @@ title: Installation

- Go to https://github.com/bible-technology/scribe-scripture-editor/releases/
- To download click the **Scribe** program that matches your computer's Operating System (OS)
- Supported Operating System
- Windows
- Mac
- Ubuntu

### Steps to Install Scribe on Windows OS ###
#### Steps to Install on supported Operating System

import Tabs from '@theme/Tabs';
import TabItem from '@theme/TabItem';

<Tabs
defaultValue="Windows"
values={[
{label: 'Windows', value: 'Windows'},
{label: 'Mac', value: 'Mac'},
{label: 'Ubuntu', value: 'Ubuntu'},
]}>
<TabItem value="Windows">

Steps to Install Scribe on Windows OS

- Right click or Double-click the application file (scribe.exe) you've downloaded from the GitHub
- On the menu option, select **Run** or **Open**
Expand All @@ -36,7 +46,10 @@ If you receive a pop-up screen with the message, “Windows protected your PC,

Note: Some devices may prevent the installation of **Scribe** because of operating system restrictions.

### Steps to Install Scribe on Mac OS
</TabItem>
<TabItem value="Mac">

Steps to Install Scribe on Mac OS
- Double-click the application file (scribe.dmg) you've downloaded from the GitHub
<img src="/assets/download.png" width="1000px" alt=""/>
- Drag the application to the **Applications** folder
Expand All @@ -58,7 +71,10 @@ If you receive a pop-up screen with the message, **Scribe** cannot be opened bec
- Click **Modify Settings** to launch the application automatically
<img src="/assets/modify.png" width="1000px" alt=""/>

### Steps to Install Scribe on Ubuntu OS ###
</TabItem>
<TabItem value="Ubuntu">

Steps to Install Scribe on Ubuntu OS

- Locate the downloaded (scribe.deb) package. By default, the system stores downloaded files in the **Downloads** directory
<img src="/assets/dload.png" width="1000px" alt=""/>
Expand All @@ -71,4 +87,9 @@ If you receive a pop-up screen with the message, **Scribe** cannot be opened bec
- Enter the user's password when prompted and press **Enter** to authenticate
<img src="/assets/psd.png" width="1000px" alt=""/>
- Wait for the installation to complete. When finished, the software is ready to use
<img src="/assets/wait.png" width="1000px" alt=""/>
<img src="/assets/wait.png" width="1000px" alt=""/>

</TabItem>

</Tabs>

8 changes: 4 additions & 4 deletions docs/scribe/How-to/p9-1-Scripture Burrito.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,20 +28,20 @@ On the projects page create a new project.
- After a successful export, a notification will appear at the bottom left side of the screen, confirming that the project has been exported successfully

The user can refer to **Bible, OBS and Audio** resources from local computer by uploading them to Scribe.
<video controls src="/0.5.5/en_burritofile_create.mov" width="100%" type="video/mp4"/>
<video controls src="/0.5.6/en_burritofile_create.mov" width="100%" type="video/mp4"/>

###
### Steps to Upload Scripture Burrito Files(resources) from local device
- Choose the desired project from the Projects page
- An editor pane will open up
- Click on the layout icon in the upper right side of the editor pane to add the layout for reference resources
- Click on the layout icon to add the layout for reference resources
- Click on the **resource selector**, the resource page opens up
- Select the Flavour of the project (Bible, OBS and Audio)
- Each module has a **COLLECTION** tab
- Click on the **COLLECTION** tab to import resources from the local device
- Click on Select Folder
- Select the file from local drive to upload
- Click **Upload**
- The uploaded file will appear in the Bible, OBS, and Audio tabs based on the chosen flavour.
<video controls src="/0.5.3/en_burritofile_import.mov" width="100%" type="video/mp4"/>
- The uploaded file will appear in the Bible, OBS, and Audio tabs based on the chosen flavour
<video controls src="/0.5.6/en_burritofile_import.mov" width="100%" type="video/mp4"/>

18 changes: 7 additions & 11 deletions docs/scribe/How-to/p9-2-offlineupload.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,23 +3,19 @@ id: p9-2-offlineupload
sidebar_label: Upload Help Resources
title: Upload Help Resources
---

**Upload Help Resources** enables users to upload Help resources from a local device. Resources like Translation Notes, Translation Words, Translation Questions, Translation Academy, OBS Translation Notes and OBS Translation Questions.

**Steps to Upload Help Resources**
- Select the desired project from the project page

- Open the desired project from the project page
- An editor pane will open
- Click the **Layout** icon at the top right of the editor pane to add a layout for the reference resource.
- Click the **Layout ** icon at the top left of the editor pane to add a layout for the reference resource.
- Click the **Resource Selector** or **Load a Module** icon on the new layout
- A Resources pane will open, displaying a list of available resources.
- Select the **Upload Help Resource** button from the list
- Click **Compile** tab to import resources from local device
- Click on **Select Folder**
- Select file from local drive to upload
- In the **Collection** tab click on **Select Folder**
- Select a folder with valid manifest.yaml from local drive to upload
- Click on **Upload**
- The uploaded file will appear in the relevant resources under the **Downloaded Resources** section with the **Downloaded** tag.

Note: **Supported formats** are translation notes, translation words, translation questions and translation academy


- The uploaded file will appear in the relevant resource section under the **Downloaded Resources** section with the **Uploaded** tag.

Note: **Supported formats** are translation notes, translation words, translation questions and translation academy
11 changes: 5 additions & 6 deletions docs/scribe/Modes/Common Functionality/p5-1-layout.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,18 +3,17 @@ id: p5-1-layout
sidebar_label: Layout
title: Layout
---
For all three modes, **Scribe** enables the user to compare and refer to resources. **Scribe** supports up to three columns open at a time (including the editing column).

For all three modes, **Scribe** enables the user to compare and refer to resources. **Scribe** supports up to three columns open at a time (including the editing column).

### Steps to add Layout ###
### Steps to add Layout

- By clicking Layout icon to add the Layout <img src="/assets/newcolumn.png" width="50px" alt=""/>
- Each column can be further divided into two sections, and the user can simultaneously refer to four translation resources

### Steps to open/add the reference resource Layout ###
### Steps to open/add the reference resource Layout

- Choose the desired project from the Projects page
- An editor pane will open up
- Click on the layout icon in the upper right side of the editor pane to add the layout for reference resources
- Click on the layout icon in the upper left side of the editor pane to add the layout for reference resources

<video controls src="/0.5.5/en-add-columns.mov" width="100%" type="video/mov"/>
<video controls src="/0.5.5/en-add-columns.mov" width="100%" type="video/mov"/>
34 changes: 17 additions & 17 deletions docs/scribe/Modes/Common Functionality/p5-2-resources.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ Text Bible Translation
**Scribe** offers a variety of translation resources to help translators with their work. In addition to the available online resources on Scribe, the translator can upload files from local storage as a reference for his translation work.

Scribe assists translators in gaining access to the best resources in as many languages as possible and completing translation projects with speed and quality.
<video controls src="/0.5.3/import-resources.mov" width="100%" type="video/mov"/>
<video controls src="/0.5.6/en-import-resources.mov" width="100%" type="video/mov"/>


#### TYPES OF RESOURCES ####
Expand Down Expand Up @@ -40,7 +40,7 @@ You can also refer to resources from your local computer by uploading them to Sc
- Select the file from your PC that you want to upload
- Select the upload option
You'll be able to see the file if you click the Bible tab.
<video controls src="/0.5.3/import-resources-bible.mov" width="100%" type="video/mov"/>
<video controls src="/0.5.6/en-import-resources-bible.mov" width="100%" type="video/mov"/>

### To download the other reference Resources
Following resources can be used both **online** and **offline**: **Translation Notes, Translation Words, Translation Questions, Translation Academy and OBS resources**
Expand All @@ -58,14 +58,14 @@ Following resources can be used both **online** and **offline**: **Translation N
- Click the **Trash bin** icon to remove unused resources <img src="/0.5.3/trashbin.png" width="30px" alt="trashbin"/>

Note: Bible Translation Words list and OBS Translation Words List can be used **Online only**(Refer Translotion Word List).
<video controls src="/0.5.3/download-resources-cmn.mov" width="100%" type="video/mov"/>
<video controls src="/0.5.6/en-download-resources-cmn.mov" width="100%" type="video/mov"/>



### TRANSLATION NOTES ###

Scribe currently supports Translation Notes in different languages.
<video controls src="/0.5.3/import-resources-trans-notes.mov" width="100%" type="video/mov"/>
<video controls src="/0.5.6/en-import-resources-trans-notes.mov" width="100%" type="video/mov"/>

### TRANSLATION WORDS LIST ###
This section offers a list of key biblical terms.
Expand All @@ -75,7 +75,7 @@ This section offers a list of key biblical terms.
- This action will open the Resource page
- From there, select the Translation Word List for the language you need
- The chosen resource will then appear in the reference column
<video controls src="/0.5.3/import-resources-transwordlist.mov" width="100%" type="video/mov"/>
<video controls src="/0.5.6/en-import-resources-transwordlist.mov" width="100%" type="video/mov"/>

### TRANSLATION WORDS ###

Expand All @@ -87,17 +87,17 @@ The list of translation words is divided into three categories:

**Other** – This is a list of additional Bible terms. The definition, Bible references, and word data are all included in the list.

<video controls src="/0.5.3/import-resources-transwords.mov" width="100%" type="video/mov"/>
<video controls src="/0.5.6/en-import-resources-transwords.mov" width="100%" type="video/mov"/>

### TRANSLATION QUESTION ###

This resource category contains questions that are designed to help translators in analyzing and understanding specific Bible books.
<img src="/0.5.3/Translationques.PNG" width="1000px" alt="file menu"/>
<img src="/0.5.6/en-Translationques.PNG" width="1000px" alt="file menu"/>

### TRANSLATION ACADEMY ###

Translation Academy is a resource for Bible translation information and instruction for translators.
<img src="/0.5.3/transacademy.PNG" width="1000px" alt="file menu"/>
<img src="/0.5.6/en-transacademy.PNG" width="1000px" alt="file menu"/>

<!-- ##
To import a resource, follow the steps below.
Expand All @@ -121,7 +121,7 @@ There are three tabs once you click on the Open Bible Stories
The downloaded Bible story will appear at the top of the list. This allows you to keep track of the resources that have been downloaded.
You can also choose a Bible story by entering information such as Language and type into the window provided in the Resource section.
By clicking on the OBS tab, you will be able to access the downloaded Bible story for reference.
<video controls src="/0.5.3/obsresourcedownload.mov" width="100%" type="video/mov"/>
<video controls src="/0.5.6/en-obsresourcedownload.mov" width="100%" type="video/mov"/>

**<i>To upload resources from local,</i>** **COLLECTION**

Expand All @@ -132,26 +132,26 @@ You can also refer to resources from your local computer by uploading them to **
- Select the file from your PC that you want to upload
- Select the upload option
You'll be able to see the file if you click the OBS tab.
<video controls src="/0.5.3/obsresoucollection.mov" width="100%" type="video/mov"/>
<video controls src="/0.5.6/en-obsresoucollection.mov" width="100%" type="video/mov"/>

### OBS TRANSLATION NOTES ###

OBS translation notes provide interpretive information for stories to assist translators with their translation work.

<img src="/0.5.3/obstransnotes.PNG" width="1000px" alt="file menu"/>
<img src="/0.5.3/obstransnotes1.PNG" width="1000px" alt="file menu"/>
<img src="/0.5.6/en-obstransnotes.PNG" width="1000px" alt="file menu"/>
<img src="/0.5.6/en-obstransnotes1.PNG" width="1000px" alt="file menu"/>

### OBS TRANSLATION QUESTIONS ###

These questions allow translators to determine whether the intended meaning is clearly communicated to the audience.
<img src="/0.5.3/obstransques.PNG" width="1000px" alt="file menu"/>
<img src="/0.5.3/obstransques1.PNG" width="1000px" alt="file menu"/>
<img src="/0.5.6/en-obstransques.PNG" width="1000px" alt="file menu"/>
<img src="/0.5.6/obstransques1.PNG" width="1000px" alt="file menu"/>

### OBS TRANSLATION WORDS LIST ###

This section offers a list of key biblical terms.
<img src="/0.5.3/obstranswl.PNG" width="1000px" alt="file menu"/>
<img src="/0.5.3/obstranswl1.PNG" width="1000px" alt="file menu"/>
<img src="/0.5.3/en-obstranswl.PNG" width="1000px" alt="file menu"/>
<img src="/0.5.3/en-obstranswl1.PNG" width="1000px" alt="file menu"/>


### AUDIO
Expand All @@ -168,7 +168,7 @@ This section offers a list of key biblical terms.

You'll be able to see the file if you click the **Audio** tab.

<video controls src="/0.5.3/en_audioresource_import.mov" width="100%" type="video/mov"/>
<video controls src="/0.5.6/en_audioresource_import.mov" width="100%" type="video/mov"/>

### UPLOAD HELP RESOURCES

Expand Down
5 changes: 2 additions & 3 deletions docs/scribe/Modes/Common Functionality/p5-3-font size.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,11 +3,10 @@ id: p5-3-font size
sidebar_label: Font Size
title: Font Size
---

Steps to change the Font Size of your project

- Find the **text** icon <img src="/assets/font-size.png" width="50px" alt=""/> on the top right corner of the **Translation column**
- Find the **text** icon <img src="/assets/font-size.png" width="50px" alt=""/> on the top left corner of the **Translation column**
- Select the small letter A to make the font size smaller
- Select the big letter A to make the font size larger

<video controls src="/0.5.5/en_fontsize.mov" width="100%" type="video/mov"/>
<video controls src="/0.5.5/en_fontsize.mov" width="100%" type="video/mov"/>
23 changes: 20 additions & 3 deletions docusaurus.config.js
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
// @ts-check
// Note: type annotations allow type checking and IDEs autocompletion

require('dotenv').config();
const lightCodeTheme = require('prism-react-renderer/themes/github');
const darkCodeTheme = require('prism-react-renderer/themes/dracula');

Expand Down Expand Up @@ -51,13 +51,13 @@ const config = {
lastVersion: 'current',
versions: {
current: {
label: '0.5.5',
label: '0.5.6',
badge: false
},
},


onlyIncludeVersions: ['current', '0.5.4', '0.5.3']
onlyIncludeVersions: ['current', '0.5.5', '0.5.4']



Expand Down Expand Up @@ -89,11 +89,28 @@ const config = {
themeConfig:
/** @type {import('@docusaurus/preset-classic').ThemeConfig} */
{

algolia: {
// The application ID provided by Algolia
appId: 'BKMMWW9E98',

// Public API key: it is safe to commit it
apiKey: '2ed30216081fba4be4b13d2005b8fc1a',

indexName: 'scribedocs',

// Optional: see doc section below
contextualSearch: true,
},



colorMode: {
defaultMode: 'light',
disableSwitch: false,
respectPrefersColorScheme: true,
},

navbar: {
title: 'Scribe',
logo: {
Expand Down
2 changes: 1 addition & 1 deletion i18n/fr/docusaurus-plugin-content-docs/current.json
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

"version.label": {

"message": "0.5.5",
"message": "0.5.6",

"description": "The label for version current"

Expand Down
Loading

0 comments on commit 93b4f81

Please sign in to comment.