Skip to content
This repository has been archived by the owner on Oct 12, 2021. It is now read-only.
/ brocrobes Public archive

Brocrobes Google Chrome (and compatible) browser extension for transcrobing web pages

License

Notifications You must be signed in to change notification settings

transcrobes/brocrobes

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

5 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Archived

This functionality is now available in the main repo here

Brocrobes

Brocrobes is the Chrome-compatible web extension for interacting with the content enrichment system of Transcrobes (https://transcrob.es). It allows you to take (virtually) any webpage and enrich it with personalised, hypertext-based comprehension aids. It requires an existing account on a Transcrobes server.

All Transcrobes software, including brocrobes, is open source and is initially being developed as part of Anton Melser's PhD research platform.

Documentation

See https://transcrob.es for more information about the component parts and the ongoing research project it is a part of.

Status

Brocrobes is currently alpha software, and is being actively developed as part of an academic research project.

Installation

Installation can either be done from the Chrome Web Store by searching for brocrobes, or by putting Chrome in developer mode, cloning/downloading this repository and then pointing to the src directory. See the Chrome website for further instructions on installing extensions in developer mode.

Configuration

There are currently no public Transcrobes servers so you will need your own server installation for this extension to be of any use. See https://transcrob.es on how to install a Transcrobes server.

If you are actively learning Chinese, have native-like English, and you are willing to participate in Anton Melser's PhD research, then please contact him at anton@transcrob.es about getting an account. Participating in the research will give you free access until at least 2023, and you will always be able to install and manage your own platform.

You will also need a user to be created on the server, a username and password for accessing the server, along with the server's publicly accessible URL.

You should then go to the extension properties page and fill in these values. Until you fill in correct values there, clicking the "Transcrobe me!" button/menu entry will fail. Error messages only appear in the developer console.

Development

Please check the issues (and create if needed) for things to work on.

Developer Certificate of Origin

Please sign all your commits by using git -s. In the context of this project this means that you are signing the document available at https://developercertificate.org/. This basically certifies that you have the right to make the contributions you are making, given this project's licence. You retain copyright over all your contributions - this sign-off does NOT give others any special rights over your copyrighted material in addition to the project's licence.

Contributing

See the website for more information. Please also take a look at our code of conduct (or CODE_OF_CONDUCT.md in this repo).

About

Brocrobes Google Chrome (and compatible) browser extension for transcrobing web pages

Resources

License

Code of conduct

Stars

Watchers

Forks

Packages

No packages published