This pages gives you an introduction on the concepts used in Amanuens.
Super Quick Introduction
Amanuens works like this:
- You configure a connection between Amanuens and your source code repository
- Amanuens extracts resource files from your repository and alerts translators about new strings to translate
- Translators work directly in their web browser
- Amanuens pushes translated files back into the repository.
Projects & Repositories
A project represents a group of related translations, e.g. all the translations of an application. Each project is mapped to a specific source code repository (
Subversion,
Mercurial,
Git and
Microsoft Team Foundation Server are supported).
Amanuens exchanges data with source code repositories during three phases:
- Checkout (or cloning): resource files are read from the source code repository and stored within Amanuens
- Synchronization (or sync): Amanuens checks the repository for updated content
- Commit (or pushing): Amanuens stores translated or otherwise update data into the repository (generating a new data revision).
Resource Files
Software projects usually separate text data, such as error messages, text on buttons, etc., in separate files, called
resource files. Each development platform uses a different format and Amanuens supports many (
.NET .resx,
Java .properties,
iOS .strings,
Android .xml,
GetText .po/.pot). Projects can contain several resource files and data for each language is stored in separate files (for example
strings_en.properties for English and
strings_fr.properties for French).