Giter Club home page Giter Club logo

tc-create-app's Introduction

Netlify Status Custom badge Coveralls github

Purpose:

tC Create is a web-based application (https://create.translationcore.com) that enables users to translate and edit unfoldingWord’s Gateway Language resources. This tool will greatly expedite the production of the resources needed to further unfoldingWord’s Gateway Language Strategy.

Usage:

tC Create allows users to translate from unfoldingWord’s English Translation Notes, Translation Words, Translation Questions, Translation Academy and Open Bible Stories. Once the resources are translated and checked in tC Create, they can be used in unfoldingWord’s translationCore tool to check Bible translations.

|624x184 Features:

  • Supports unfoldingWord’s markdown (.md) and tab-separated values (.tsv) files
  • Parallel view of the text allows for comparison to the original file
  • Text can be edited in smaller portions or in larger blocks
  • Directly reads and writes to the Door43 Content Service
  • Branched workflow protects the master files from unauthorized changes

Learn More:

translationCore Create: How to video

tC Create is built using React Component Libraries. These libraries (listed here) can be used for other applications and we hope that others will contribute libraries to this effort.

Developer Notes

Running Local Cypress Tests

First Time Setup

  • make sure cypress is fully installed:
yarn
yarn run cypress install
  • create test config file cypress.env.json in root folder with the following contents (substitute your username in password):
{
  "TEST_USERNAME": "<user>",
  "TEST_PASSWORD": "<password>"
}
  • you will need to be part of unfoldingWord organization for the test to complete

Running tests

  • in first terminal, start the app by (in Windows, run this in git Bash as it needs bash):
yarn start
  • then in second terminal, to run cypress interactively do:
yarn run cypress open
  • or to run headless: in second terminal, run cypress by:
`yarn cypress:run`

Details on how the auto-increment build number works

tc-create-app's People

Contributors

abelpz avatar actions-user avatar ancienttexts-net avatar birchamp avatar dependabot-preview[bot] avatar dependabot[bot] avatar elsylambert avatar jag3773 avatar jincypjose avatar joel-c-johnson avatar klappy avatar larsgson avatar lijujacob08 avatar mandolyte avatar mannycolon avatar photonomad0 avatar superdav42 avatar thenerd247 avatar

Watchers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

tc-create-app's Issues

App crashes when scroll down from Intro section

  • Open a tN resources(.tsv file)
  • Scroll down from the introduction section
  • as soon as it reaches the next Block the App crashes.
    Blank screen.zip

This is happening for OT books only. NT books are loading fine.
Seems like when the Parallel scripture section comes up the App crashes

Displaying more rows disrupts display of reference texts

I tried editing Titus in my fork of tN. I completed the first section of 25 rows and then changed to 100 row display successfully (as I remember). However when I moved to the next 100 rows, the scripture pane stopped updating and remained blank.

4 second max.

Back button on login page is not functioning

I entered Language and Resources and was at Login page, wanted to go back to change the Resources option but the Back button would not let me go a step back neither does clicking on Resources on the header.

Only edit/translate file types supported

Right now all file types are able to be opened. It would be nice to be able to prevent non-supported file types from being messed up by editing them in the Markdown editor.

Potential solutions:

  1. Only open MD files.
  2. Open MD files as is, but open the others in a plain text editor without MD parsing.

Permalinks

What do you think about addressing this during a feature like what is in the Consume App? Every navigation action yields unique query params that are copy/pasteable to navigate directly to what you are currently viewing. For example https://glts.door43.org/?rc://unfoldingword/en/tw/tit&language=fr which would take you to translate en_tw into fr_tw as you're own logged in user and write to your repo.

Stepper Auto Advance

As a user, I expect the stepper to auto-advance to the next step after I have made a choice since there is only 1 interaction on each screen.

For example, after I click login I expect to see the language page (the hot pink/red LOGOUT button makes it look like something went wrong.

Same unexpected results on Language and Resource steps... e.g. after I select my option I expect to be taken to the next step automatically. Incidentally, this is what happens on the file selection, I am automatically taken to the next step of editing the file.

Version GLtS v0.9.0-alpha.17

Underline html tags in MD files

Most implementations do not support double underscores instead of implementing .
Ensure it doesn't add line breaks like it currently is.

SPIKE: Support source resource versioning

The major limiting functionality that prevents production use is locking the Source and Target resources to the same version.

Intended Steps:

  • Write a new manifest.yaml file to the translation repository that specifies the version of the source resource.
  • Use the version of the source resource from the translation repository found in the manifest.yaml to load that version of the source resource.
  • Gitea React Toolkit needs to add the ability to load data from a Release/Tag in addition to the "master or ex: v10" branch of a repository.
  • Specify the Release/Tag version when loading files from the Gitea React Toolkit.
  • What would the UI experience for the user? Possible Dropdown selection (dynamic approach)? or change the manifest (static approach)?

Spike: [12] Auto Save Feature

What triggers do we want to fire autosave?
Do we think this is safe if inadvertent actions are taken.

Also, do we save on blur like the changed status happens currently on the save icon.

  • How does data retrieval work?
  • Recover data from user branch?

Font size too small for Hebrew pasted text

Currently the Hebrew text is too small to work with.

It is currently pasted into the UTN resource, OrigQuote field, when an Old Testament book is being edited/translated.

tsv file gets corrupted at d43 when the incorrect file content is displayed in tN

Related to #17
Steps to replicate the issue:

  1. Open 1 peter.tsv , edit , save.

  2. Select hab.tsv(Habakkuk), NOte that the page still shows 1 Peter content, but the file name in header is hab.tsv.

  3. Click on the link icon to see the content on D43. Note that hab. tsv displays content from 1 peter.
    image

  4. You may logout and login back or may just open the resources page and open Hab. tsv file. Note that the content is 1 peter and actual content of Habakkuk is lost.

Confirm certain actions when save is pending

When there is a pending save aka dirty file, confirm actions that would result in lost edits.

Changing files, closing repo, logging out, back button, refresh, closing window.

File Selection without permissions

There are certain use cases when coming back to the app after some time where permissions don't appear to be working. The app acts like everything is fine since it can fetch files. We need to ensure that permissions are proper on the file so that edits aren't made and lost.

This can be confirmed by watching the log, failing to save files, but also changing to a new file that hasn't been created yet will fail to load the target file.

Refreshing the window does not appear to help until a logout and another login is performed.

Single Editor Pane for MD Document

Add a mode for editing the entire document as a single block that doesn't break the document up into smaller blocks by paragraph.

This could be handled by adding a toggle in the menu for Paragraph Blocks just like we have for Heading Sections.

Scripture Viewer Not updating when Switching books while Editing UTN

Tested in the Test Build at https://develop--glts.netlify.com./. on alpha-21

The App does not crash while loading Parallel Scriptures on OT books anymore, But when we switch the book from Menu, the Intro changes to the new book but the Scripture part does not get refreshed to the new one but shows the previous book instead.
image

This behaviour is seen in NT book too. Change of Books displays scripture of the previous book selected.

Moved from issue #33 second comment.

Reset Chapter Bug on Blur

On blur while editing the Original Quote, jumped back to chapter 1, if the filter is on
(happened during demo)

Edits Lost Using Menu Options

When changing font sizes, new props are sent to the edit/translate component which re-renders them. The edits since the last save are lost.

Block Saved/Dirty Status Indication

As a user I want a clear indication of when I have unsaved edits in a content block.

I can see the save icon in the upper right toggle based on dirty status, but this is very subtle and not noticeable when editing since you aren't looking up there. Ideally, we could have a subtle change to the text entry box that has been edited, something that indicates it has not be saved. Perhaps a light background shading or a small icon indicator in the right of the box? Something that I would notice as I am editing to indicate that I've got unsaved changes.

Version GLtS v0.9.0-alpha.17

Right hand side content is not loading in tA

Select tA from the Resources>File>Checking>acceptable. Left hand side content loads up , not the right hand side.
image

Click on the
image link, it takes you to the door43 catalog and the file there is has the Content that should be loaded in the right hand side.

If you are not seeing this issue, follow the below steps:

  1. if the page loads up correctly, displaying the content on both the sides, Go to Menu click on the files License.md or readme.md.
  2. Open up the Checking> Acceptable file. Note that the right side content is either blank or displaying a invalid content.

Icon Tooltips Needed

As a user I'd like to hover over the icons in the scripture pane and get a short description of what it does (similar to the icons at the top of the app).

Version GLtS v0.9.0-alpha.17

  • tC is doing localization already
  • look into using a context provider.

Incorrect line breaks in raw mode

Duplicate of #48

upLooking at TA/translate/figs-metaphor/01.md

In preview mode, breaks are OK now. However, in raw mode they still seems to occur in text that has underlining. See the Bible quotes in the section Examples from the Bible

Listen to this word,
you cows of Bashan
, (Amos 4:1 ULT)

Highlighting Relationship Unclear

As a user, I want to know where the highlighting in the Scripture pane comes from so that I can know when it needs modified.

As a user I want the highlighting to come from the target's OrigQuote field so that I can see my changes.

I can't figure out if the highlights come from the OrigQuote field in the source or target when editing a TSV file. Changing the target seems to remove all highlighting.

Deployment Process for Develop and Master

We should have at least 2 stages of deployment, one matching the develop branch and one matching the master branch, following git flow.

Ideally, we could have feature branch deployments as well. This needs to happen automatically so that devs and qa can test at discrete URL endpoints.

Side menu bar shows up blank when using the filter

Noticed this issue when testing #38.
After the up/down button is clicked when the filter is on, the app lands on first page> Click on the side menu option(the hamburger icon), it shows up a blank menu as a result of slow loading
image
Similarly, when we move to the next pages from the footer Next button to go to the later chapters (approx 1000th page), it brings up a blank Menu as it loads up very slow.
image

Branch Workflow

Need clear definition of how fork/branch effects the main branch

Logout and login back gives Username does not exist message

  1. Click on the user icon on the header.
    image
  2. It brings up the below shown screen. Note that the user name is Camel-cased. Actual username is -elsylambert.
    image
  3. Clicking on the logout button, logs me out. and Username and Pwd boxes are enabled with the values in. Those values are incorrect, so if I click on the Login button again, it gives User does not exist or username is invalid message,
    image

Right hand side content for editing not getting refreshed after the file is changed from the Menu

Right hand side content for editing not getting refreshed after the file is changed from the Menu
image

  • Opened Bibles>Names>Haggai file and edited and saved
  • Go to Menu>Select another file>(Bible>other>12TribesofIsrael)
    -Left hand side loads up as 12TribesofIsrael, but right hand side stays the same as Haggai.

The link to Door 43 from the right hand side(user) goes to 12tribesofisrael.md but the content it shows is of Haggai.md
image

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.