Giter Club home page Giter Club logo

filter-translation-words-rcl's Introduction

Contributors Forks Stargazers Issues MIT License


Table of Contents ↧

About The Project

Filter translation words shot

Purpose

  • Filter repeated words in TWL card

Problem

  • Chapters and verses often contain words that have already been encountered before. And it's not really convenient when they are repeated in translation-helps-rcl's TWL card.

Scope

  • The library allows you to filter words that have already appeared in a verse, chapter or book
  • Words can either be removed from the list or left, but marked with a different color.

Background

  • Translators who check the correctness of the translation really wanted to have this feature

(back to top)

Built With

(back to top)

Getting Started

Installation

Add the library to your React app

  • yarn
yarn add @texttree/filter-translation-words-rcl
  • npm
npm install @texttree/filter-translation-words-rcl

(back to top)

Usage/Integration

This library works in conjunction with the useСontent and useCardState hooks from the library translation-helps-rcl.

Full demo

To begin with, you need to get 2 arrays using a useContent - tsvs (a list of all encountered word references for this book) and items (a list of references for this verse).

 const config = {
    verse: '1',
    chapter: '1',
    projectId: 'tit,
    ref: 'master',
    languageId: 'en',
    resourceId: 'twl',
    owner: 'unfoldingWord',
    server: 'https://git.door43.org',
  };
   const { tsvs, items, markdown } = useContent({
    ...config,
  });

You can use useMarkRepeatedWords

const { markedWords } = useMarkRepeatedWords({ items, tsvs });

For more examples, please refer to the Styleguidist link

(back to top)

Roadmap

IN PROGRESS

See the open issues for a full list of proposed features (and known issues).

(back to top)

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated. Guidelines for external contributions.

You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

If you would like to fork the repo and create a pull request.

  1. Fork the Project
  2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
  3. Commit your Changes (git commit -m 'Add some AmazingFeature')
  4. Push to the Branch (git push origin feature/AmazingFeature)
  5. Open a Pull Request

(back to top)

License

Distributed under the MIT License. See LICENSE for more information.

(back to top)

Contact

Project Link: https://github.com/texttree/filter-translation-words-rcl

(back to top)

filter-translation-words-rcl's People

Contributors

foxprogs avatar valyukhov avatar

Watchers

 avatar  avatar

filter-translation-words-rcl's Issues

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.