Translating Symbolic Descriptions

To translate the symbolic descriptions, you use some hidden commands in Purple Pen.

Once you have installed your new version of Purple Pen, run it and open the sample event.

Windows Vista / Windows 7 only: You must be running Purple Pen as an Administrator in order to translate the symbolic description. To do this on Windows Vista:

Accessing the translation menu

To begin translation, hold down the Ctrl and Shift keys simultaneously, and open the Help menu. A special sub-menu called "Translate Description Texts" is available only if Ctrl and Shift are both held down.

screenshot 1

 

Adding a new language

Select the "Add Description Language..." menu item. A dialog window appears to get information about the language that you wish to translate to.

screenshot 2

In the new language drop-down, select the language that you wish to translate to.

In the "Native language name" text area, type the name of the language, in that language. This will be automatically filled in for you; correct it if you like or leave it alone.

The rest of the dialog needs to be filled out with information that helps Purple Pen create grammatically correct descriptions. In order to get good quality descriptions, you must fill these out correctly for your language. They works as follows:

Use plural nouns for between/junction/crossing

This setting is used when the between, junction, or crossing symbols are used, and the same symbol is used for both objects. For example:

screenshot 3

In many languages, it may produce a better description to use a plural form of the symbol in column D. For example, in English, this description would be "between boulders". If you check this box, then you can and should define a plural form of each symbol that can appear in column D. If you leave this unchecked, then only singular forms of symbols can be entered.

Use plural adjectives for plural nouns

This setting is only significant when the between, junction, or crossing symbol are used, plural nouns (above) are used, and a descriptive symbol (shallow, rocky, ruined, ...) is present in column E. For example:

screenshot 4

In English, this would be "between rocky hills". In English, the word "rocky" does not change form whether it is modifying "hill" or "hills". However, in some languages (French, for example), the form of the adjective may change depending on whether it modifies a plural or singular word (une colline rocheuse vs. des collines rocheuses). If this is the case for the language you are translating to, check the box.

If you check this box, then you can and should define a plural form of each symbol that can appear in column E.

Adjectives change based on gender of noun being modified

In some languages other than English, each noun belongs to a particular gender, and adjectives change their form depending on the gender of the noun. If this is the case in the language you are translating, check this box. If you check this, for each symbol that can appear in column D, you should set the gender of that word. For adjectives and descriptive phrases that can appear in columns C, E, F, and G, you can enter different forms for each gender, if necessary.

If you check this box, you must fill in a list of genders (separated by commas) in the text box below.

Nouns change case based on modifiers

In some lanuages, the forms of nouns (used in column D primarily) can change form based on some kinds of modifiers in other columns. For example:

In English, this would "North side of small gully". The text "small gully" does not change because of the modifier "North side". In Polish, however, this should be "Północna strona suchego rowu". The noun of the feature in column D (normally "suchy row") changes to the genitive case due to the modifier in column G. This is the reverse of the change that occur for noun genders (above); in this case the adjective and modifiers change the form of the noun, instead of the noun changing the form of the adjectives.

If your language requires this, check this box and fill in a list of noun cases (separated by commas) in the text box below. You only need to include cases that will actually be required by your translation. The first case must be the default case, which is used if there are no modifying symbols in other columns.

Example

So, for example, for French, the dialog would be filled out as follows:

screenshot 5

Once you press OK, your new language is added. It is initialized with the English text for each symbol.

Entering translated text for symbols

Again, hold down the Ctrl and Shift keys simultaneously, and open the Help menu. Select "Add Translated Texts..." from the "Translate Description Texts" sub-menu.

screenshot 6

The left hand side shows all of the symbols that need translation. On the right hand side shows the current entered translations. At first, each symbol is initialized with the English version of the text for that symbol. There are two different translation for each symbol -- the symbol text and the symbol name. Often they are the same (except the symbol name is capitalized, but sometimes they are different. The Name of the symbol shows up at the bottom of the popup symbol chooser when choosing a symbol. The text is used when constructing the textual description for the control. In some cases, the name is a longer or more descriptive for that the text. For example, the name of the symbol in English is "North-east edge", but the text is "NE edge".

To change the name of the symbol, just type in the text box under "Symbol name:". To change the description text for the symbol, click the button "Change text...". When you click this button, you get an additional window that allows you to enter the text for the symbol, possibly included plural or gender forms. For example:

screenshot 7

In this window, enter the text in the last column of the grid. If applicable, be sure to set the gender or case of the word in the dropdown at the bottom of the window.

See the Appendix for information with detailed information about different symbol types and how they are combined to make the full textual description.

Checking your translations

After entering translations, it is a good idea to return the main program and test out different descriptions to look at the text forms, to make sure that your translations combine in a reasonable grammatical way. When any control is selected, the text version is show in the selected object pane, right below the description sheet. You may need to enlarge the pane to see it.

Submitting your translations

Once you are happy with the translations, email the file "C:\Program Files\Purple Pen\symbols.xml" to peter@golde.org. I will incorporate the translation in the next release of Purple Pen, and make sure that no one else does the same translation.

Asking for help

If you have any questions, please feel free to email peter@golde.org with any questions.


Appendix: Symbol types

While the symbols that appear in column D (Control feature) are fairly straightforward, other symbols are somewhat more complex. Many symbols use replaceable text, which is replaced with actual text when the description is being created. Replacable text appears as either the text "{0}" or "{1}". The usage of replaceable text differs depending on the type of symbol.

When constructing the description, Purple Pen always uses the text from symbols in the following order:

Column D (control feature)
Column E (appearance)
crossing or junction in column F
between in column G
size in column F
Column C (which of any similar feature)
Column G (location of control)
Column H (other information)

Column E symbols (Appearance)

The text for these symbols uses the replaceable text "{0}". When the description is being constructed, {0} is replaced with the text for the column D symbol that is being described. This allows the text to either precede or follow the symbol being described, as needed by the language. For example, in English the text for rocky is "rocky {0}", so a rocky hill is described as "rocky hill". If the text were changed to "{0} that is covered with rocks", then a rocky hill would be described as "hill that is covered with rocks".

Column C and G symbols, except crossing (which of any similar feature, location of control)

The text for these symbols uses the replaceable text "{0}". When the description is being constructed {0} is replaced with the text for the feature. If both a column C and column G symbol is present, the column C symbol is processed first. For example, the text for "Nothern" (column C) is "N {0}", and text for "Eastern edge" is "E edge of {0}". Thus the text for:

screenshot 8

is processed in the following order:

column D = "clearing" --> "clearing"
column C = "N {0}" --> "N clearing"
column G = "E edge of {0}" --> "E edge of N clearing"

resulting in a complete description of "E edge of N clearing".

Crossing, Junction, and Between

These three symbols are handled in special ways, because they involve combining two different other symbols. Each of these symbols is actually two different symbols internally, with different texts.

The first form of this symbol is used when two different control features are used in columns D and E. These three symbols are called "Crossing", "Junction", and "Between". For these symbols, the replacable text "{0}" is replaced with the first control feature, and the replaceable text "{1}" is replaced with the second control feature. The text for these symbols should contain both {0} and {1}.

The second form of this symbol is used when the same control feature is used in column D and E, or when column E is blank or an appearance symbol. These three symbols are called "Crossing (objects of same kind)", "Junction  (objects of same kind)", and "Between  (objects of same kind)". They do not have pictures next to the in the list. For these symbols, the replacable text "{0}" is replaced with the singular form of the control feature, and "{1}" is replaced with the plural form of the control feature. The text should contain exactly one of {0} and {1}.

Examples in English:

screenshot 9

Control 33:
column D = singular "boulder" / plural "boulders"
column E = singular "boulder" / plural "boulders"
column G (objects of same kind) = "between {1}" --> "between boulders"

Control 34:
column D = singular "boulder"
column E = singular "knoll"
column G = "between {0} and {1}" --> "between boulder and knoll"

Control 35:
column D = "path"
column E = "stream"
column F = "{0} and {1} crossing" --> "path and stream crossing"

Control 36:
column D = singular "knoll" / plural "knolls"
column E = "rocky {0}" --> singular "rocky knoll" / plural "rocky knolls"
column G = "between {1}" --> "between rocky knolls"

Control 37:
column D = singular "path" / plural "paths"
column E = "singular "path" / plural "paths"
column F (objects of same kind) = singular "{0} crossing" / plural "{0} crossings" --> singular "path crossing" / plural "path crossings"
column G (objects of same kind) = "between {1}" -> "between path crossings"

Size of feature in Column F

There are several different "symbols" that affect how size numbers in column F are translated into text. The following describes the purpose of each of these symbols:

"Height of feature":  used when column F is a simple number, such as "5", which describes how high the main feature is (e.g., a boulder). The special text {0} is replaced with the height in meters.

"Depth of feature": used when column F is a simple number, such as "5", which describes how deep the main feature is (e.g., a pit). The special text {0} is replaced with the depth in meters.

"Size of feature": used when column F has two numbers separated by an "x", such as "5x8", which describes the size of the feature (e.g., a clearing). The special text {0} is replaced with the first length, and the special text {1} is replaced by the second length.

"Height of feature on slope": used when column F is two numbers separated by a slash, such as "1/3", which describes the height of a feature on a slope. The special text {0} is replaced with the first height, and the special text {1} is replaced by the second height.

"Depth of feature on slope": used when column F is two numbers separated by a slash, such as "1/3", used with a feature that is deep rather than high. The special text {0} is replaced with the first height, and the special text {1} is replaced by the second height.

"Size of two features": used when column F describes the sizes of two different main features, one above the other (entered in Purple Pen using a "|"). The special text {0} is replaced with the first size, and {1} with the second size. In this case, the {0} and {1} texts are those formed by one of the other size symbol textgs.

Special directives with distances (finish, flagged routes)

There are symbols for the various special directive that span all eight boxed (the pictures look kind of squished in the translation window!) The directives for finishes, marked routes, and finishes have special text {0} which is replaced with the appropriate distance, plus a space. Thus the {0} should be right in front of the next word, without any space. For example, the finish symbol without tapes in English is "navigate {0}to finish", with no space between "{0}" and "to".

Other special symbols

A few other special "symbols" (which do not have actual graphics symbols) are used for a few pieces of text that appear in descriptions, as follows:

"Course length" --> describes the course statistics, when the course has no climb. {0} is replaced with the length

"Course length and climb" --> describes the course statistics, when the course has climb. {0} is replaced with the length, {1} with the climb.

"Number of Controls" --> used in the all controls description sheet to show the number of controls. {0} is replaced with the number of controls.

"Number of Points" --> used in score course description sheet to show the total number of points. {0} is replaced with the number of points.

"And" --> used when two features are placed in column D and E, but without the crossing, between, or junction symbols being used. This is non-standard, but occasionally used. {0} is replaced with the first feature, {1} with the second feature.