How do CATs process Markdown files?
Introduction
Markdown markup language is often used to create technical documentation. It can be code documentation or instructions for use, for instance API documentation.
Sometimes, this documentation needs to be translated into other languages. To make translation smoother, Computer Aided Translation (CAT) software is usually used. Such programs, among many other features, protect non-editable text elements from accidental changes and make translation faster with glossaries or databases of previously translated texts.
There are many different CAT programs available. However, they process Markdown files differently as this markup language can be difficult for them to interpret.
This study presents how three CAT programs — Phrase, Trados Studio 2022, and Wordfast Pro — process Markdown files with inbuilt settings.
Aim
Successful translation of a Markdown file is like a coin: there are two sides that are inseparable opposites.
On the one side, there is a technical writer who creates the Markdown file.
On the other side, there is a translator who translates the Markdown file.
Both the technical writer and the translator must be aware of the pitfalls and obstacles Markdown files pose in translation with CAT programs.
A technical writer needs to have general knowledge about what a CAT program can do, can do to a certain extent, and cannot do. They can also make translation of Markdown files easier by writing their texts in a specific manner. Lastly, they can meet the translator halfway by preparing a brief with dos and don’ts.
A translator needs to have general knowledge about Markdown. The translator should be aware what should be translated, what should not be edited, and how to translate phrases in certain contexts. Lastly, the translator can meet the technical writer halfway by knowing what characters are used in Markdown and what the general syntax of Markdown is.
This study is like the rim of a coin; it joins both sides so they can create together a unified whole.
How to use this study
This study is of value for both technical writers and translators. Whether you are the former or the latter, you can treat it as a point of reference on Markdown for translators and on CAT programs for technical writers.
You can also learn what Markdown settings are included in Phrase, Trados Studio 2022, and Wordfast Pro. The settings are applied separately and in conjunction to open a Markdown test file. This file covers basic and extended Markdown syntax and also embedded HTML tags. The aim is to test how the CAT programs process Markdown syntax and which settings are best suited for the translation of `` files. The programs are then compared with each other.
The study includes sections with recommendations. If you are a technical writer, they can help you with preparing a Markdown file which is easier for translating with a CAT. If you are a translator, they can help you with proper opening and translating a Markdown file in a CAT program.
You can read this study as a whole or just the sections that are of interest to you. If you know your Markdown file will be processed in a given CAT program, go straight to relevant sections.
Table of contents
- Introduction
- Overview
- The test file
- Phrase
- Trados
- Wordfast
- Comparison
- General recommendations
- Conclusion
- Glossary
- About
Next section: Overview