1. How to use hiatus
Version 1
05/11/2012

2. What is hiatus?
hiatus is a localization QA tool.
Like xBench, but different in
details.
See slide 4 & 5 for details of what
you can check with this tool.
You can get it from here
https://github.com/ahanba/hiatus

3. Requisites?
Ruby 1.9.2 or 1.9.3
Ruby gem
tk (When install Ruby, check on the option for tk)
nokogiri (gem install nokogiri)
rubyzip (gem install zip)
Windows XP/Vista/7 Japanese*
MS Office Excel (mandatory), Word (optional)
*By default, character code for Excel is set to Shift-
jis (Windows JA OS code). If you modify there, you can
use hiatus on other language OS.

4. Supported bilingual file format
CSV TXT
(LocStudio Dump) (Tab Separated)
DOC* TMX
DOCX* XLS*
RTF* XLSX*
(Trados RTF)
XLZ
TBX (Idiom XLZ)
TTX
*To check these, Microsoft Word/Excel is required

5. What can be checked?
Glossary Error Length
Style Check Skipped Translation
Monolingual Search Missing/Added Tag
Check
Numbers
Unsourced Term
Inconsistency (Source > Target)
(Source > Target)
Unsourced Term
Inconsistency (Target > Source)
(Target > Source)

6. Auto Conversion
When you run Glossary check, you can
check the option to enable “Auto
Conversion” function.
For example:
If you want to search “make”, following
terms are also detected by check on
this option.
[make, makes, made, making]
Currently (05/11/2012), this function
is only implemented for English.

7. Set up
Download & Instal Ruby1.9.3 from
http://rubyinstaller.org/
Check on “Install tk” option.
Download & Setup RubyGems from
http://rubygems.org/pages/download
Just run “ruby setup.rb” to setup
Run following gem commands
gem install nokogiri
gem install zip

8. Overview
This is the
components of hiatus
To run hiatus
1. Edit Config.yaml
2. Run hiatus.rb

9. Checks
Glossary Error Source-Target bilingual check
Monolingual Source or Target monolingual check
Number Check Number is consistent to source
Inconsistency Source<->Target inconsistency
Length Catch too long/short translation
Catch English term which is not in
Unsourced the source but in the translation
Tag Missing/Added tag check
Skip Catch potentially skipped translation

10. Edit Config.yaml

11. Edit Config.yaml
Path of target bilingual files (Root dir)
bilingual Files in subfolders are checked
output Output path of the report
report Output report format. Currently only “XLS”
source/target 2 char Source/Target language code
glossary Path of glossary files
monolingual Path of monolingual files
Enter True or False for each check
check section Select True which you want to run
If True, 100% match segment is skipped
ignore100 Valid for TTX & XLZ
If True, ICE match segment is skipped
ignoreICE Valid for TTX & XLZ

12. Config of Glossary file
3 columns Tab separated value
Source Term Target Term Option
UTF-8 without BOM TXT file
Options:
i Regexp, Autoconv = ON, ignore case
m Regexp, Autoconv = ON, multiline
e Regexp, Autoconv = ON, extended
Start with # Regexp = ON. If start with #, no Autoconv
blank Regexp = OFF, Autoconv = OFF. CaseSensitive
z Regexp = OFF, Autoconv = OFF. Ignore case.

13. Config of Monolingual file
4 columns Tab separated value
S or t Term Option Comment
UTF-8 without BOM TXT file
Options:
s or t s = search the source, t = search the target
i Regexp, Autoconv = ON, ignore case
m Regexp, Autoconv = ON, multiline
e Regexp, Autoconv = ON, extended
Start with # Regexp = ON. If start with #, no Autoconv
blank Regexp = OFF, Autoconv = OFF. CaseSensitive
z Regexp = OFF, Autoconv = OFF. Ignore case.
Comment Comment to display on the report

14. Sample Files

15. config.yaml

16. Glossary

17. Monolingual (Styleguide)

18. Report 1

19. Report 2

20. Report 3

21. Demo

22. http://youtu.be/
6yaiI0OS-3c