Toolkit: Translating the Rational Unified Process
This page describes what you have to do in order to translate
the Rational Unified Process (RUP) to other languages than English.
Topics
The following steps must be performed in order to translate the HTML
pages.
- Install the RUP on a computer with the non-English
operating system. We recommend that you do the translation on the
operating system on which the translated RUP will be installed.
- Set the default character set for all HTML pages in the RUP. This has to
be done programmatically, by either using a global search-and-replace tool,
or with by writing a script.
- Translate all text in HTML pages.
- Translate the title of all HTML pages.
- Translate all bookmarks. You also need to update all hyperlinks that
reference these bookmarks. Notice that bookmarks with the prefix 'XE_' are
index entries. This is explained below, in section Generate
an index.
- Translate the text in all the diagrams and pictures.
- Translate the text on the navigational buttons.
Perform the following steps to translate the treebrowser. See Toolkit:
Treebrowser Applet and Toolkit:
Modifying the Treebrowser for information about the 'tree.dat' and its dependent
subfiles.
- Visit the five menu files located in the 'Applet' directory: tree.dat, rpw_artifact_subtree.dat,
rpw_role_subtree.dat, rpw_discipline_subtree.dat, rpw_tool_subtree.dat.
- Translate each of the files mentioned above. If you are using Rational Process
Workbench; (RPW) for creating a RUP customization, refer to the RPW documentation
for further details on translation issues.
- The treebrowser applet is declared in the file 'applet/orytree.htm'. Change
the values of the following parameters in the treebrowser applet declaration
(at least):
- 'characterset'
- 'treefont'
IMPORTANT: In the 'tree.dat' and its subordinate menu files there is one character
that is used as delimiter (or separator), this is a '*'. This character is configurable
by changing the value of the parameter 'delimiter' in the 'applet/orytree.htm'
file.
- Open the tree.dat or any of the four submenu files to see what character
is used as delimiter (or separator).
- Change the declaration of the treebrowser applet in the file
'applet/orytree.htm'. Change the value of the parameter 'delimeter' to the
character that is used as delimiter (or separator).
Example
The following is an example of the file 'applet/orytree.htm'.
The example shows how you can change the declaration of the treebrowser applet.
The new (or changed) lines are marked with red.
<script
language="JavaScript">
<!---
document.writeln("<applet
name=\"Tree\" codebase=\"./\"
code=\"ruptools.TreeBrowse.class\" width=\"100%\"
archive=\"treebrowse.zip\" height=\"97%\">\n");
document.writeln("<param
name=\"loadpage\" value=\"../spscreen.htm\">\n");
printFinishPage();
document.writeln("<param
name=\"fgcolor\" value=\"51,102,153\">\n");
document.writeln("<param
name=\"delimeters\" value=\"¤\">\n");
document.writeln("<param
name=\"characterset\" value=\"SJIS\">\n");
document.writeln("<param
name=\"selbgcolor\" value=\"51,102,153\">\n");
document.writeln("<param
name=\"selfgcolor\" value=\"white\">\n");
document.writeln("<param
name=\"visitcolor\" value=\"51,51,51\">\n");
document.writeln("<param
name=\"mouseovercolor\" value=\"0,0,102\">\n");
document.writeln("<param
name=\"mouseovershadow\" value=\"false\">\n");
document.writeln("<param
name=\"loadinglabel\" value=\"Loading contents
tree...\">\n");
document.writeln("<param
name=\"target\" value=\"ory_doc\">\n");
document.writeln("<param
name=\"maxvisiblenodes\" value=\"100\">\n");
document.writeln("<param
name=\"scrollbartoleft\" value=\"false\">\n");
document.writeln("<param
name=\"border\" value=\"true\">\n");
document.writeln("<param
name=\"treefont\" value=\"Arial,plain,12\">\n");
document.writeln("<param
name=\"bgcolor\" value=\"#FFFFFF\">\n");
document.writeln("</applet>\n");
//---> </Script>
The search applet is declared in the file 'applet/search.htm'. Some of the
parameters specify the text in the search applet window. Translate the value of
these parameters. See The
Search applet for details about the search applet.
You should generate a new index, for the new language. See the page KeyWordIndex
for more information.
- Translate existing bookmarks and add new bookmarks in the HTML pages. In
order to generate an index, you must translate all bookmarks with a leading
'XE_. One effect of translating these bookmarks is that you need to update
all hyperlinks that reference these bookmarks.
- Translate the file 'devkit/rupuse/keywords.txt'. This file contains the
cross-references in the index.
- Translate the title of the index in the file 'keywordpreamble.txt'.
- Translate the text in the file 'keywordpostamble.txt'. This file describes
the end of the generated index.
- Generate a new index. See Toolkit:
Preparing for Publication, section "Generating an
Index", for detailed instructions.
The following steps describe how to generate new Site Map pages.
- Update the pages that specify the layout of the Site Map pages. See page SiteMap,
section "Layout of the Site Map", for details on how to
specify the layout of the Site Map pages. The layout of the Site Map pages are
specified in the following files in the folder 'devkit/rupuse/sitemap':
- artifactdef.txt
- overviewdef.txt
- sitemapdef.txt
- templatedef.txt
- toolmentorsdef.txt
- workerdef.txt
- workflowdef.txt
- Translate the relevant parts of the following two files:
- sitepostamble.txt
- sitepreamble.txt
- Generate a new index. See Toolkit:
Preparing for Publication, section "Generating a Site Map".
Generate a new search database. See Toolkit:
Preparing for Publication, section "Generating a Search
Database" for detailed instructions.
The tools for generating a search database, generating the index, and
generating the sitemap, all produce progress messages and error messages in
English.
All these messages can be translated to any language. The message can be specified
in a text file which is used by the tools. See Translating
the RUP Tools, for details on how to create this file.
Copyright
© 1987 - 2001 Rational Software Corporation
|