bible-technology / scribe-scripture-editor

A Bible translation editor for everyone.

Scribe Scripture Editor (Scribe SE)

A Bible translation editor for everyone.
Report Issue · Feature Request

Table of Contents

• About the Project
  • Built With
• Getting Started
  • Prerequisites
  • Installation
• Roadmap
• Contributing
• License
• Contact
• Acknowledgements

About The Project

Scribe Scripture Editor is a free and open-licensed desktop application that is designed to support the Bible translator with drafting and checking scripture in both text and audio formats as well as provides support for translating Open Bible Stories in different modes. The features include multi-project support, revision control (cloud sync), audio recording and seamless basic USFM editing. It has a modular architecture and is poised to grow and support the evolving needs on the ground.

Built With

• ReactJS
• Electron
• Tailwind CSS

Getting Started

It is relatively easy to setup the application locally for development.

Prerequisites

This is an example of how to list things you need to use the software and how to install them.

• Node.js ^16.15.1
• YARN ^1.22.19

Installation

1. Fork and clone this repository
2. Install dependencies with yarn install
3. Start the application with yarn start
4. Checkout the web version with yarn dev Runs the app in the development mode.
   Open http://localhost:3000 to view it in the browser.

Roadmap

See the projects page for a list of proposed features and known issues we are working on.

Contributing

If you'd like to contribute, please fork the repository and commit changes in your fork. Pull requests are warmly welcome.

We really value our contributors whether they helped fix a bug, built a feature, tested out the app or contributed in some other way.

The process for submitting pull requests.

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/NewFeature)
3. Create logs as you start making changes

Logger level:
Production => warn
Development => debug

Usage: logger.[level]("<filename>, <message>")

4. Add nessesary propTypes for all the properties passed to react component (https://github.com/facebook/prop-types)
5. After adding features make sure you write test for that using:

• Jest
• React Testing Library

6. Run yarn lint:fix for code to adapt our linting rules
7. Run yarn build for build checks
8. Commit your Changes (git commit -m 'Add some NewFeatures')
9. Push to the Branch (git push origin feature/NewFeature)
10. Open a Pull Request and make sure all checks have passed

License

This project is licensed under the MIT License. See LICENSE for more details.

Contact

Let us know if you face any bugs/problems by opening an issue on GitHub. We'll do our best to be prompt in our response.

Acknowledgements

• Supported by the Open Components Ecosystem.
• Developed and maintained by Bridgeconn

scribe-scripture-editor's Issues

Rebrand

• Change name to: Scripture Scribe
• Change color scheme
• Change icon
• Update package.json: "name": "scripture-scribe", "description": "A friendly assistant for Bible Translators" and "author": "Bible Technology". Update repository URLs. We could remove the email key.

Audio Chapter Exported size is big

#31

Language Drop down

Refactoring the code and implementing a new language box with search.

Script Direction : https://burrito.bible/schema/language.schema.json

friendsofagape/autographa#799 (Issue From Ag )

While export as Chapter-wise the audio pitch changes (it may occur due to sample rate conversion)

• Exporting chapter-wise the audio pitch changes and the recorded voice sounds different than the original voice.
• #95

Web version

Background

As the app matures, there is an ask for a web version. And since the tech stack chosen and the design of the app took this feature into account from the get-go, it would be good to implement and make available.

Enhancement

The plan is to have the:

• OBS mode
• Bible text editor mode

available via the browser. The Oral Bible editor mode is planned to be subsequent to the release of the modes listed above.

Create landing page website

Need a new public landing page website for Scribe.

Non-functional buttons on the editor pane in the Bible Translation pane

• The lock button is not working
• Recreation steps

1. In Bible translation editor pane, the lock button is not clickable

• The bookmark is not working
• Recreation steps

1. In Bible translation editor pane, the bookmark button is not clickable

• The Blocks section button is not functional
• Recreation steps

1. Split into blocks and collapse blocks button is clickable
2. While the collapse button is active the title and chapter title disappear and the hash # sign appears along with the

The undo option(Crtl+Z command) does not undo word by word but rather clears the entire entry in one go

Step-by-step undo would enhance the workflow. Consider both while typing and deleting.

Scribe SE does not save data that is copy pasted from any other application

When text is copied from any other software like Translation Studio and any web pages it is not getting saved, though it shows saved.
Steps:

1. Copy text from any web pages or Translation Studio and paste it in Scribe SE
2. It shows, saved
3. When the editor window is restarted all the pasted text got disappeared.

Note: In Windows with Paratext, it is working properly.

Update licensing info in the app

Update the app license info according to this file: https://github.com/bible-technology/scribe-scripture-editor/blob/development/LICENSE

Switching from npm to Yarn

Conflict Resolver for Online Sync

• Incorporate Conflict Resolver with Online Sync

Change the installation app logo

Change the installation logo from Autographa to Scribe

Progress bar in the import dialog box

While importing large files (audio flavor) unable to identify whether it is working or not. Providing a progress bar or loading bar would be helpful to know the status.

Download the images locally for the OBS to run in offline

• Download the images (while installing the app or check while creating an OBS project whether the images are available locally).

Add OBS tW and twl in the resources

Add and connect the obs editor with tw and twl.

OBS: Auto scroll is not working (working only on the marked pane)

Recreation steps:

1. Open the OBS resource pane
2. First layout's auto-scroll will work until the next layout opens
3. when the fourth resource pane opens, only the last resource pane works
   Note: in the screenshot red marked pane alone works whereas the other pane's auto-scroll does not work
   

Projects with same name causing script direction issue

• Scribe will not allow the user to create a duplicate project, but here in this case importing another project with the same name is possible.

To re-create this issue.
First, create a project with the same name you are trying to import with LTR script direction and import a RTL project with same name

Update Scripture Burrito to 1.0 stable

Background

Currently the app supports a release candidate. However, the stable version of the SB standard has been released since: https://github.com/bible-technology/scripture-burrito/releases/tag/v1.0.0

Update

Update the compatibility of the app to work with and export to the stable version of Scripture Burrito.

Bibles are not current

The TNs, TWs, etc seem to point to the latest unfoldingWord resources, but the Bibles available are outdated, not being updated versions.
These are the Bibles that should be available:
https://git.door43.org/unfoldingWord/en_ult/releases
https://git.door43.org/unfoldingWord/en_ust/releases

Auto Close Project Flavour Selection Drop down

• auto close the project flavour selection drop down after select one in New project page

Add French App translation

Audio Flavor: Font size does not increase or decrease

The source text's font size does not increase or decrease in the Audio flavor.

Import resource columns are labeled wrong

I saw that the Type column has orgs, and the Organization column has the date. And there is no Type. Soon there will be RC, TS, TC and SB metadata types in the DCS Catalog!

Project does not export when the project is named without the underscore ( _ ) symbol in Ubuntu and with underscore in Windows and Mac OS

• This behavior occurs in the Audio and OBS flavor
• The project name after the underscore ( _ ) does not appear in the editor window

Observations and issues from release 0.3.0

All the functions were working well before the release (0.3.0), now we were able to identify multiple issues. The list of the issues are mention below. This issues were recreated with Ubuntu.

• Unable to create Bible (Text) Translation project
• App is breaking when the OBS project is been tried to open multiple times with Twl reference resource.
• OBS project is not exporting in some systems with underscore ( _ ), and some systems without underscore

RTL is loading LTR layout in Bible Translation flavor

RTL is loading LTR layout in Bible Translation

• Recreation steps

1. Your Profile
2. Select the App language as Farsi and save
3. Go to the project page and create a Bible Translation
4. Select Target Language as Persian (Farsi)
5. Click the created project
6. It loads the LTR layout in the editor pane

Known issues with Text Translation in 0.5.0

• Backspace is not working at the first time and after saving
• Without making any changes (loading or reloading the project) if we use the undo or redo, the app breaks
• RTL is typing in LTR, verse number also shown/changing in LTR while typing
• #205
• #263
• #204
• The font selector in the File menu is disappearing while clicking on the font selector
• While changing the font the in the text editor it is affecting the font of the loaded OBS in the resource pane
• Font selector is not working on the OBS
• #262
• Insert popup is not closing automatically
• Footer and cross reference can be added with read-only mode (edit disable)
• Layout panes are not consistent in height

issue

Update documentation website

The documentation website needs updating and should be linked from the main website.

Navigation Bar showing in default resource pane after unlock

• default resource panes shows the 1TI Book navigation bar
  

Conflict Resolver for Online Sync

• new conflict editor incorporate with Online Sync

RTL is loading LTR layout in OBS flavor

RTL is loading LTR layout in OBS editor pane

• Recreation steps

1. Your Profile
2. Select the App language as Farsi and save
3. Go to the project page and create a Bible Translation
4. Select Target Language as Persian (Farsi)
5. Click the created project
6. It loads the LTR layout in the editor pane

Offline Merge UI change

• update UI for offline merge

RTL is loading LTR layout in OBS flavor

RTL is loading LTR layout in OBS flavor

• Recreation steps

1. Your Profile
2. Select the App language as Farsi and save
3. Go to the project page and create an OBS project
4. Select Target Language as Persian (Farsi)
5. Click the created project
6. It loads the LTR layout in the editor pane

Is it possible to keep the menus highlighted based on the flavor in the resource selection pane?

The image representation is given below:
While OBS flavor is selected, in the resource selection window the OBS menu should be highlighted. Do the same for the other flavors too.

Cross-app support for Sync.

• While importing a project from Autographa to Scribe or vise-versa, we should read versification data from the settings file.

Offline Merge for OBS Projects

• add support for OBS projects to merge locally
• add a provision to resolve conflict in merge

Network Status

• Network status for app

Change Label Name

• change label name translation to Bible Translation in create projects drop down

Add Nepali app translation

Offline Merge - Collaborative Editing

Ability for multiple editors working on a single project at the same time using different computers to merge their work to the same single project for checking and revising each other's work. Browse mock ups and expected user flow video

UseCase: Editors in rural African regions working on a single OBS story want to collaboratively edit, check each other's work and complete a single OBS story while remaining offline.

Sync phase-2, multi-user collaboration

Multi-user collaboration in door43 projects.

Zero draft

Adding a Zero draft (in the target language) feature in Scribe would speed up the translation work - it is a suggestion from a user

Playwriight test cases

Error on export audio

• Promise is breaking while export audio ( project have large set of data or long audios ), so export is not happening.

Copy and pasting the data verse by verse is okay until you reach verse 9 or 10 and then the screen freezes

Steps in Windows and Ubuntu

1. Copy and paste any data to Scribe SE editor
2. Till verse four, pasting is smooth
3. From verse five onwards taking a lot of time to load the passed text
4. Later, in verse 9 or 10 the takes so much time to load, or many times the screen freezes
5. When it freezes, Need to force restart the application to work on Scribe SE again

Delay in page load

• Opening a project and coming back to Project page - It takes time in loading the projects on the project listing page
• Resource language pop having empty spaces because of non filter languages have no name
• ( i ) button in the resource language drop down to show type at least 3 letter of the language name

Stable release of 0.4.0

Stable release of 0.4.0 from 0.4.0-beta.1

Offline Merge for Text Translation Projects

• offline merge feature for Text translation project