Skip to main content
Software Localisation Course 5

2. Components

7. Documentation

Before translation memory systems became popular in the translation and localisation industry, documentation was translated by overwriting the source text (mostly in English) in a document created with a word processor (e.g. Microsoft Word) or in a desktop publishing (DTP) application (e.g. FrameMaker or PageMaker). Today, translation memory systems are generally used for localising software documentation. When using TM systems, translators no longer have to work within the application used for creating the original documents. Instead, TM systems support many common document formats (e.g. FrameMakerWordSGML, etc.) which can be directly edited in the system's editors. 

 

The strategy followed by several TM systems for those formats which are not supported and cannot be directly edited in the TM systems is to export the source text together with layout information from the original application, import the resulting files into the TM system, translate, export from the TM the translated files and re-import them into the original application. To illustrate this, let us take as example the TM system SDL TRADOS 7 and the DTP application InDesign in its current version (CS2). To translate an InDesign document, the original document files (with the extension *.indd) have to be exported from the application InDesign in a specific interchange format (*.inx), which can then be opened and translated directly in TRADOS TagEditor. After translation, the translated file will be saved back from TRADOS TagEditor in the *.inx format, which can later on be imported into the original application InDesign.

 

Exporting localisable text

The idea of exporting the source text from the original application is to preserve all formatting information from the original format. This information will in turn be coded in tags and "protected" by the TM system, so that it cannot be modified during translation. After translation and re-importing into the original application, possible problems regarding layout can be fixed and minor changes can be made.

(Adapted from Esselink, 2000:290)

 

Future trends

Finally, regarding the development of software products, two trends can be distinguished: on one hand, there is a growing diversity of approaches, formats, environments and processes; on the other hand, XML is becoming more and more the lingua franca for developing software and documentation. This implies the traditional distinction made between software localisation and documentation localisation will not be so clear in the future (Schildhauer, 2000).

 

Software documentation usually consists of manuals with more or less the same structure. In the beginning there is a table of contents followed by an introduction about the application's features or instructions on how to use the guide. Then, different topics are dealt with in the chapters finally there is an index where keywords are listed (Wahle, 2000a).

These manuals come in printable electronic format (e.g. PDFMS WordFrameMakerXML, etc.). As a rule, printed paper documentation is no longer provided with software applications. In fact, the only printed documentation that comes with software applications today is the Installation or Getting Started guide (adapted from Esselink, 2000).

Depending on the format used for the documentation, files consist of text divided into chapters, appendices and different types of automatically-generated components - such as lists of graphics, internal cross-referencestable of contents, index, etc. Localising documentation such as manuals involves:

  • Translation: there are two strategies: a) the translation can be done by overwriting the source text in the same application in which the file was originally created. This implies that character and paragraph formatting as well as place holders and graphics are preserved, but also that translators must have the corresponding application in the right language and edition (the same edition used for creating the original manual should be used to edit it); or b) the source text can be edited in a translation memory system, which is the most commonly-used strategy.
  • Graphic localisation: Graphics and images (such as screenshots) must also be localised when they contain text. Graphics are usually translated during the translation of text using graphic editors. In the case of screenshots, these must be done again based upon the previously-localised version of the software application. It is important that the terminology used in the text corresponds to that used in the graphic or screenshot.
  • Sentence and layout editing (DTP): After translation is ready, pages have to be rearranged so that they appear as in the original documents. This process is necessary, because most of the time the length of the translated text changes. Line and page breaks, the position of graphics as well as formatting have to be checked. Part of the DTP process is also the automatic generation of the new table of contents, index and table or image lists in the target language.

(Adapted from Wahle, 2000a).

Most software instructions are included in the online documentation. Reference or administrative guides are also very often published in online format (Esselink, 2000).

From the point of view of content and form, online documentation is very similar to printed documentation. Online documentation is always in electronic format and can contain coded information. The translation workflow for online documentation is also very similar to that of printed documentation; In fact, very often translated manuals are used to create the online documentation (Wahle, 2000a).

Web Pages

Today, in times of globalisation, it is very important for enterprises, institutions or products to be present on the Internet. This presence in form of a website should also be adapted to local target markets. A multilingual website is often not initially planned and localisation therefore comes later on in the schedule.

Websites vs. web pages

website is an Internet presence, which consists of web pages. A web page represents the contents that are displayed by the browser’s window. Web pages are composed of several elements which can contain translatable text or must be adapted to the target market, such as text blocks, graphics, sound or video recordings, buttons, animations, hyperlinks and navigation elements. These elements are interrelated with each other forming a complex text.

 

 

Websites can be static or dynamic depending on the type of text presented in them. Static websites consist of static text contained in HTML files. Dynamic websites contain text which is generated from databases and updated regularly.

 

When preparing a localisation project for a website it is essential to analyse:

  • Language and design: One of the best strategies for website language usage and design for a website is to know the purposes of the translation and to localise directly in the target country with local translators and specialists.
  • File formats containing translatable text: when preparing a localisation project it is essential to know which types of file formats are involved in the project and which contain translatable text or culture-specific content to be adapted. Some examples of possible file formats of a website are:
    • HTML files with static or dynamic contents
    • Style sheets containing formatting information
    • XML files for dynamically generated content (from databases)
    • ASP (Active Server Pages) or JSP (Java Server Pages) with additional code for generating dynamic pages
    • Graphics with text
    • Sound and video files
    • Animated graphics with text
    • Scripts in PHP (Hypertext-Preprocessor), Perl or JavaScript for user queries
  • Different strategies for file formats and content: First of all, it must be clearly stated which content needs to be translated or adapated, and which is irelevant for the target market.