Skip to content

Latest commit

 

History

History
97 lines (60 loc) · 3.5 KB

README.md

File metadata and controls

97 lines (60 loc) · 3.5 KB
Raw

Chatbot translation tools

Getting started

Install latest Long-Term Support (LTS) release of Node.js.

Install project dependencies.

npm install

Running the scripts

The overall process is visualised in a flowchart.

has_any_words_check

Identify and fix possible errors in 'has_any_words' arguments.

node index has_any_words_check <rapidpro-json-file> <output-dir>

overall_integrity_check

Look for errors in arguments and in the link between QR and Arguments.

node index overall_integrity_check <rapidpro-json-file> <output-dir>

extract

Extract English-language strings from RapidPro flows, for translation.

node index extract <rapidpro-json-file> <output-dir>

localize

Merge translated strings back into original flow as a localization.

node index localize <input-rapidpro-flow-file> <translated-strings-file> <language-code> <output-name> <output-dir>

fix_arg_qr_translation

Look for errors in the link between QR and Arguments that have been introduced during translation and apply an auto-fix.

node index fix_arg_qr_translation <rapidpro-json-file> <output-dir> <file-output-name> <log-output-name>

move_quick_replies

Move quick replies to message text.

node index move_quick_replies <input-rapidpro-flow-file> <select_phrases> <output_name> <output-dir> <add_selectors> <qr_limit> <special_words>
  • add_selectors is either "yes" or "no", depending on whether you want to add the numerical quick replies back in. Example input: "yes".
  • qr_limit is an integer. A limit on the number of quick replies you want to add back in. If we are above the limit the add_selectors behaviour will be ignored and the quick replies will not be added back in.
  • special_words is a path to JSON file which has a list of words which will be reinstated as full quick replies as opposed to numbers. The words should be organised by language, an example of the file can be found in test/Input/special_words.json. This file can be reviewed for info but should not be modified as it is part of the test script.

reformat_quick_replies

Reformat quick replies.

node index reformat_quick_replies <input-rapidpro-flow-file> <select_phrases> <output_name> <output-dir> <count_threshold> <length_threshold> <qr_limit> <special_words>
  • count_threshold and length_threshold are integers. If the count of quick_replies is greater than count_threshold or the longest quick reply is greater than length_threshold, then the quick replies will be replaced with numerical prompts.
  • qr_limit is an integer. A limit on the number of quick replies you may want to add back in after they have been replaced with numerical prompts. If count_threshold and qr_limit are exceeded, the node message will be replaced with numerical prompts but those prompts will not be added as quick replies.
  • special_words is a path to a JSON file which has a list of words which will be reinstated as full quick replies as opposed to numbers. The words should be organised by language, an example of the file can be found in test/Input/special_words.json. This file can be reviewed for info but should not be modified as it is part of the test script.

convert_qr_to_html

Convert Quick Replies to HTML in message text.

node index convert_qr_to_html <input-rapidpro-flow-file> <output_name> <output-dir>

Running tests

npm test