Skip to content
HelpTransl8 helps translators check the original documentation repository by comparing each file and listing the files that have been modified
Branch: devel
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
spec
src
.editorconfig
.gitignore
.guardian.yml
.travis.yml
LICENSE
README-fr.adoc
README.adoc
shard.yml

README.adoc

HelpTransl8

HelpTransl8 is a tool for document translators.

Origin of development and its response

The main problem when documentation is translated is maintenance. The original documentation (often in english) evolves. So how do we locate between the version we translated and the latest version?

HelpTransl8 is an answer to this question: each file of the original documentation is kept in a hidden file with the same name. Thus, when updating HelpTransl8 compares the new file with the old one. If the new file is different then it replaces the hidden file and informs the user in a TODO list. If the file does not exist, it is created with its original version!

Installation

macOS

brew brew tap papilip/brew
brew install helptransl8

From source (check dependencies :)

git clone https://github.com/papilip/helptransl8.git && cd helptransl8
crystal build src/helptransl8.cr --release

Quickstart

helptransl8 --init=https://url_original_repository
helptransl8 --check
cat TODO_helptransl8.yml

Usage

  • helptransl8 -c | --check Check each file with the original repository.

  • helptransl8 -h | --help Show help with all commands.

  • helptransl8 -i | --init=url_du_depot_original Generates the helptransl8.yml file with original repository url.

  • helptransl8 -p | --print Print URL from original repository.

  • helptransl8 -v | --version Shows the program version.

Development

  • CRYSTAL_ENV=devel|development|test ./helptransl8 Using the program by initializing the environment.

  • Tests are missing!

Pull Requests welcome !

Contributors

  • Philippe Nénert (@papilip) - Creator, maintainer

You can’t perform that action at this time.