Skip to content

Commit

Permalink
Merge pull request #43 from bible-technology/0.5.3-Second-Part
Browse files Browse the repository at this point in the history
Version 0.5.3
  • Loading branch information
vipinpaul authored Oct 30, 2023
2 parents 9c512d6 + 84b49c8 commit 10ac3fa
Show file tree
Hide file tree
Showing 184 changed files with 4,333 additions and 359 deletions.
4 changes: 2 additions & 2 deletions docs/scribe/Getting-Started/p0-1-what-is-scribe-SE.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,12 +8,12 @@ slug: '/'



:::tip Features Introduced in version 0.5.2
<!-- :::tip Features Introduced in version 0.5.2
[Shortcut keys for Audio recording](../Modes/Oral%20Bible%20Translation/p7-1-audio%20toolbar.mdx)
:::
::: -->

**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.

Expand Down
11 changes: 4 additions & 7 deletions docs/scribe/Getting-Started/p0-2-system requirement.md
Original file line number Diff line number Diff line change
@@ -1,23 +1,20 @@
---
id: p0-2-system requirement
sidebar_label: System Requirements
sidebar_label: System Requirements
title: System Requirements
---

**Supported System**

### Supported System
**Scribe** is supported by the following operating systems

- Windows 10 and above
- Ubuntu 18.04 and above
- Mac OS 10.15 and above

**System Requirements**

### System Requirements
- Minimum 2 GB free disk space
- Internet connectivity (Required for syncing and downloading references)
- Keep the application updated with the latest version of **Scribe** ([download Scribe](https://github.com/bible-technology/scribe-scripture-editor/releases))
- Write to us at [email protected] to contact our technical team if you experience any difficulties during installation
- You can raise an issue to report bugs and suggestions on the GitHub page ([create issue](https://github.com/bible-technology/scribe-scripture-editor/issues))
<!-- - To ensure your system supports the target language, download the needed **font** on your device. -->
- Use full screen for effective use of the application
- Use full screen for effective use of the application
15 changes: 10 additions & 5 deletions docs/scribe/Getting-Started/p0-3-installation.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -11,11 +11,14 @@ title: Installation
- Mac
- Ubuntu

**Steps to Install Scribe on Windows OS**
### 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**

**Windows OS restrictions:** If you receive a pop-up screen with the message, “Windows protected your PC,” perform the following actions.
#### Windows OS restrictions

If you receive a pop-up screen with the message, “Windows protected your PC,” perform the following actions.

- Click on the **More Info** button
<img src="/assets/windows_p.png" width="1000px" alt=""/>
Expand All @@ -33,14 +36,16 @@ title: Installation

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

**Steps to Install Scribe on Mac OS**
### 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
<img src="/assets/drag.png" width="1000px" alt=""/>
- Open the application from the **Application Launcher**

**Mac OS restrictions:** If you receive a pop-up screen with the message, **Scribe** cannot be opened because the developer cannot be verified,” perform the following actions.
#### Mac OS restrictions

If you receive a pop-up screen with the message, **Scribe** cannot be opened because the developer cannot be verified,” perform the following actions.
- A pop-up message will appear on the screen saying, **“macOS cannot verify the developer of “Scribe-Scripture-Editor”. Are you sure you want to open it?”**
<img src="/assets/first.png" width="1000px" alt=""/>
- Click **Open** on the pop-up window
Expand All @@ -53,7 +58,7 @@ Note: Some devices may prevent the installation of **Scribe** because of operati
- Click **Modify Settings** to launch the application automatically
<img src="/assets/modify.png" width="1000px" alt=""/>

**Steps to Install Scribe on Ubuntu OS**
### 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 Down
8 changes: 4 additions & 4 deletions docs/scribe/Getting-Started/p0-4-create a new account.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,21 +6,21 @@ title: Create a New Account

In order to start translating with the help of **Scribe** application, the user must have an account.

**Steps to create an account**
### Steps to create an account ###

- Open the **Scribe** application installed on the computer
- Choose **CREATE NEW ACCOUNT** button
- In the pop-up window that appears, enter the user name and click **CREATE**
- The user's account will be created, and the user can start using the **Scribe** application

**For existing users**
### For existing users ###

- If you already have an account, sign in by selecting your username from the View More menu
- This opens the **PROJECTS Page** for the users to work in **Scribe**

<video controls src="/assets/signing-in.mov" width="100%" type="video/mov"/>

<h2>Sign in function </h2>
### Sign in function ###

**Scribe** enables multiple users on the same computer to use the same application while maintaining separate project data.
It can be difficult to locate the project and user name when multiple users are using the same computer
Expand All @@ -33,7 +33,7 @@ To assist with this, there is a **View More** option on the **Sign In** page. Th
- You can Archive the Inactive users by clicking the delete button next to the user name
- The chosen user name will be **Archived**

**To restore the Archived user name**
### To restore the Archived user name ###
- Click on **View More**
- Select the **Archive** tab
- A list of Archived user names appears
Expand Down
44 changes: 44 additions & 0 deletions docs/scribe/How-to/p9-1-Scripture Burrito.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,44 @@
---
id: p9-1-scripture burrito
sidebar_label: Scripture Burrito
title: Scripture Burrito
---
### Steps to create Scripture Burrito files
On the projects page create a new project.
#### Steps to create a new project
- Click on the **New Project** Icon on the left side of the page
- Select the Flavour of the project from the drop-down menu
- On the new project page, enter specific project details
- Project Name
- Project Description
- Abbreviation (It will be auto generated on entering the project name. The user has the option to editthe autogenerated abbreviation)
- Target Language
- **Import** the necessary books in USFM format by clicking IMPORT BOOKS icon
- After entering the required details, click on Create Project
- Once a project is created, it will appear as a new item on the **PROJECTS** page
- After the project is created, go to the project’s page and select the project created
- Click the downward pointing arrow to see a dropdown menu with the project description
- Click on the three dots menu with options
- Edit
- Export
- Archive
- Select **Export** to export the project to a local device
- A dialog box will be displayed, enter the desired file path
- Click Export
- 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.
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 **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.

Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ title: New Project
---
On the **New Project** page, the user can create different project modes like Text Bible Translation, Oral Bible Translation (Audio) and Open Bible Stories (OBS).

Steps to create **New Project**
### Steps to create New Project ###
- Click on the **New Project** Icon <img src="/autographaAssetsV2/how-to/new-project.png" width="30px" alt=""/> on the left side of the page
- On this page, you can enter specific project details
- Project Name
Expand All @@ -29,11 +29,11 @@ Once a project is created, it will appear as a new item on the **PROJECTS** page

<video controls src="/assets/creating-project.mov" width="100%" type="video/mov"/>

<h2> To add a new language </h2>
### To add a new language ###

If the desired language isn't listed in the target language drop-down menu, the user can still create the project in that language.

**Steps to add a new language**
#### Steps to add a new language

- Click on the plus sign <img src="/assets/plusicc.png" width="20px" alt=""/>
- A dialogue box with the option to add the new language appears
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,19 +5,19 @@ title: Advanced Settings
---
The **Advanced Settings** allow the user to edit more specific project details, for example, scope, versification scheme, and license.

- **Scope**
### Scope ###

- This feature allows the user to choose what book of the Bible they want to work on
- The user can choose all books from the Old testament, the New testament, or all books of the Bible, or they can customize the number of books they wish to work on

- **Versification Scheme**
### Versification Scheme ###

- Each language may have a different versification scheme based on various translation decisions
- **Scribe** supports popular versification schemes used in the Bible
- You can choose between All books, Old Testament, and New Testament in the advanced settings


- **License**
### License ###

- This feature allows users to select a domain
- **Scribe** encourages users to select a public domain so that Bible translations may be accessible to the general public
Expand Down
6 changes: 3 additions & 3 deletions docs/scribe/Manage Project/Projects/p3-1-projects.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -4,19 +4,19 @@ sidebar_label: Projects
title: Projects
---

**Project Listing**
### Project Listing ###

Once you’ve signed in, you will see the project listing screen. This is where all the projects you create will be displayed.
<img src="/assets/project-listing01.PNG" width="1000px" alt="project listing"/>

**Star and Unstar**
### Star and Unstar ###
- Click on the **star** next to the project name
- This will pin the project to the top of the list
<video controls src="/assets/staring-project.mov" width="100%" type="video/mov"/>



**Searching and Sorting**
### Searching and Sorting ###

**Searching**

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,7 @@ title: Edit Project Details

<video controls src="/assets/editing-project.mov" width="100%" type="video/mov"/>

By following the previous list of instructions, you will be directed to the **Edit Project** page of the app.

Another interesting feature on the **Edit Project** screen is the **Advanced Settings.**
####
By following the previous list of instructions, you will be directed to the **Edit Project** page of the app.
Another interesting feature on the **Edit Project** screen is the **Advanced Settings.**
5 changes: 3 additions & 2 deletions docs/scribe/Manage Project/Projects/p3-3-import project.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ title: Import Project

**Scribe** provides users with the functionality to import [Scripture Burrito](https://docs.burrito.bible/) validated projects directly from the local devices.

**Steps to Import a Project**
### Steps to Import a Project ###

- On the project page, click on the **Import** <img src="/assets/import01.png" width="80px" alt=""/> button located at the top right side
- Select a folder from local device using the dialogue box that displays
Expand All @@ -19,7 +19,8 @@ title: Import Project

Note: **Scribe** allows to **Import** and **Export** USFM (Unified Standard Format Markers) files and MD files. It also supports TSV resources in OBS Translation Notes

**Importing the project allows the users to merge it while offline**
**Importing the project allows the users to merge it while offline**.

Visit this page for more information on [Offline Merge](./p3-4-offlinemerge.md)

<video controls src="/assets/importbfile.mov" width="100%" type="video/mov"/>
4 changes: 2 additions & 2 deletions docs/scribe/Manage Project/Projects/p3-4-offlinemerge.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ Offline merge refers to the process of merging changes from one translator to an
This feature can be used with multiple translators. When multiple users are working on the same project conflicts may occur while merging.
This page allows users to review conflicting changes, decide how to resolve them, and then merge them as needed.

**Steps to offline merge**
### Steps to offline merge

- Click **Import** <img src="/assets/import01.png" width="80px" alt=""/> in the top right corner of the projects page
- Choose the desired folder for import and click on **Select Folder/Open**
Expand All @@ -29,7 +29,7 @@ This page allows users to review conflicting changes, decide how to resolve them
- Suppose the user decides to Abort the **Resolve Conflict** action. Click the close **(x)** symbol in the top right corner. It will bring an **Abort Conflict Resolution** to pop up
<video controls src="/0.5.2/replaceandmerge.mov" width="100%" type="video/mov"/>

<h3>Steps to Resolve Conflicts</h3>
### Steps to Resolve Conflicts

**The Resolve Conflict page appears when a user selects the Merge option**
- A list of files with conflicts appears in the left section of the pane
Expand Down
4 changes: 2 additions & 2 deletions docs/scribe/Manage Project/Projects/p3-5-archive project.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ title: Archive Project

**Scribe** discourages deletion to prevent any inadvertent data loss. As an alternative, it allows users to Archive projects which would not show up in the main listing of projects anymore. Archived projects maybe restored at any point. Though discouraged, power users may delete archived projects completely from the disk location outside the application. Backups of the archived projects are maintained by **scribe**.

**Steps to archive the project**
### Steps to archive the project
- Select a project from the list to **Archive**
- Click the downward pointing arrow to see a dropdown menu with the project description
- Click on the three dots menu with options
Expand All @@ -15,7 +15,7 @@ title: Archive Project
- Archive
- Select the **Archive** to save the project for future reference

**Steps to restore the Archived project**
### Steps to restore the Archived project

- Click the Archived button in the top right corner
- The archived files list appears
Expand Down
2 changes: 1 addition & 1 deletion docs/scribe/Manage Project/Projects/p3-6-export project.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,4 +18,4 @@ title: Export 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


<video controls src="/assets/exportfile.mov" width="100%" type="video/mov"/>
<video controls src="/0.5.3/exportfile.mov" width="100%" type="video/mov"/>
Loading

0 comments on commit 10ac3fa

Please sign in to comment.