Skip to content

Commit

Permalink
Merge branch 'Videos-for-0.5.5' of https://github.com/bible-technolog…
Browse files Browse the repository at this point in the history
…y/scribe-docs into Videos-for-0.5.5
  • Loading branch information
jobjohnsonc committed Jan 5, 2024
2 parents 1dd3406 + edd89d9 commit 63859fe
Show file tree
Hide file tree
Showing 120 changed files with 4,068 additions and 71 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"/>
15 changes: 6 additions & 9 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


[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>

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"/>
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: process.env.APP_ID,

// Public API key: it is safe to commit it
apiKey: process.env.API_KEY,

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
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,22 @@ title: Télécharger des ressources d'aide
**Télécharger des ressources d'aide** permet aux utilisateurs de télécharger des ressources d'aide à partir de l'appareil local. Ressources telles que les notes de traduction, les mots de traduction, les questions de traduction et l'Académie de traduction, les notes de traduction OBS et la question de traduction OBS.

**Étapes pour télécharger des ressources d'aide**

Étapes pour télécharger des ressources d'aide**

- Ouvrez le projet souhaité depuis la page du projet
- Un volet éditeur s'ouvrira
- Cliquez sur l'icône **Mise en page ** en haut à gauche du volet de l'éditeur pour ajouter une mise en page pour la ressource de référence.
- Cliquez sur l'icône **Sélecteur de ressources** ou **Charger un module** sur la nouvelle mise en page.
- Un volet Ressources s'ouvrira, affichant une liste des ressources disponibles.
- Sélectionnez le bouton **Télécharger la ressource d'aide** dans la liste.
- Dans l'onglet **Collection** cliquez sur **Sélectionner un dossier**
- Sélectionnez un dossier avec manifest.yaml valide sur le lecteur local à télécharger
- Cliquez sur **Télécharger**
- Le fichier téléchargé apparaîtra dans la section des ressources correspondante sous la section **Ressources téléchargées** avec la balise **Téléchargé**.

Remarque : **Les formats pris en charge** sont les notes de traduction, les mots de traduction, les questions de traduction et l'académie de traduction.

- Choisissez le projet souhaité dans la page Projets
- Un volet d'édition s'ouvrira
- Cliquez sur l'icône **mise en page** dans le coin supérieur droit du volet de l'éditeur pour ajouter la mise en page des ressources de référence.
Expand All @@ -17,6 +33,5 @@ title: Télécharger des ressources d'aide
- Sélectionnez le fichier sur le disque local à télécharger
- Cliquez sur **Télécharger**
- Le fichier téléchargé apparaîtra dans la section **Ressources téléchargées** avec la balise **téléchargé** dans les ressources concernées.

Remarque : **Les formats pris en charge** sont les notes de traduction, les mots de traduction, les questions de traduction et l'Académie de traduction.

Remarque : **Les formats pris en charge** sont les notes de traduction, les mots de traduction, les questions de traduction et l'Académie de traduction.
Original file line number Diff line number Diff line change
Expand Up @@ -3,10 +3,9 @@ id: p5-3-font size
sidebar_label: Taille de police
title: Taille de police
---

#### Étapes pour modifier la taille de la police de votre projet

- Recherchez **l'icône **de texte dans le coin supérieur droit de la **colonne Traduction.**
- Recherchez l'icône de texte dans le coin supérieur gauche de la colonne Traduction
- Sélectionnez la petite lettre A pour réduire la taille de la police
- Sélectionnez la grande lettre A pour agrandir la taille de la police

Expand Down
101 changes: 101 additions & 0 deletions i18n/fr/docusaurus-plugin-content-docs/version-0.5.5.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,101 @@
{

"version.label": {

"message": "0.5.5",

"description": "The label for version current"

},

"sidebar.Sribe.category.Getting-Started": {

"message": "Commencer",

"description": "The label for category Getting-Started in sidebar Sribe"

},

"sidebar.Sribe.category.Basic Setup": {

"message": "Configuration de base",

"description": "The label for category Basic Setup in sidebar Sribe"

},

"sidebar.Sribe.category.Manage Project": {

"message": "Gérer le projet",

"description": "The label for category Manage Project in sidebar Sribe"

},

"sidebar.Sribe.category.Create a Project": {

"message": "Créer un projet",

"description": "The label for category Create a Project in sidebar Sribe"

},

"sidebar.Sribe.category.Projects": {

"message": "Projets",

"description": "The label for category Projects in sidebar Sribe"

},

"sidebar.Sribe.category.Modes": {

"message": "Modes",

"description": "The label for category Modes in sidebar Sribe"

},

"sidebar.Sribe.category.Common Functionality": {

"message": "Fonctionnalité commune",

"description": "The label for category Common Functionality in sidebar Sribe"

},

"sidebar.Sribe.category.Text Bible Translation (BT)": {

"message": "Traduction de texte de la Bible (BT)",

"description": "The label for category Text Bible Translation (BT) in sidebar Sribe"

},

"sidebar.Sribe.category.Oral Bible Translation (OBT)": {

"message": "Traduction orale de la Bible (OBT)",

"description": "The label for category Oral Bible Translation (OBT) in sidebar Sribe"

},

"sidebar.Sribe.category.Open Bible Stories (OBS)": {

"message": "Histoires de la Bible ouverte (OBS)",

"description": "The label for category Open Bible Stories (OBS) in sidebar Sribe"

},

"sidebar.Sribe.doc.Technical Support": {

"message": "Soutien technique",

"description": "The label for the doc item Technical Support in sidebar Sribe, linking to the doc scribe/p11-1-technical support"

}

}


Loading

0 comments on commit 63859fe

Please sign in to comment.