Difference between revisions of "ReNamer:Rules:Translit"

From den4b Wiki
Jump to: navigation, search
(Created page with '== Translit Rule == [[Image:]]This rule transliterates Non-English characters from different languages into their English/Latin representation. For example, the German character ...')
 
(Using a built-in transliteration map: Rephrased the alternation of maps)
 
(25 intermediate revisions by 3 users not shown)
Line 1: Line 1:
== Translit Rule ==
+
{{Go|up=ReNamer:Rules|prev=ReNamer:Rules:CleanUp|next=ReNamer:Rules:RegEx}}
[[Image:]]This rule transliterates Non-English characters from different languages into their English/Latin representation. For example, the German character '''ü''' can be transliterated to '''ue''' (the name '''Müller '''can be also written as''' Mueller''').
 
  
So, we create a pair of equivalent characters, like this: '''ü= ue'''
+
[[Image:TranslitRule.png|center]]
  
(Note that the right side of this equation has ''two'' characters. Any number of characters may be placed on both sides of the equation.)
+
This rule transliterates one alphabet into another. Its main goal is to transliterate Non-English characters from different languages into their English/Latin representation. For example, the German character '''ü''' can be transliterated to '''ue''' (the name '''Müller '''can be also written as '''Mueller''').
  
We need several such “''equivalent character pairs''” to convert one language into another. An entire set is called a “''transliteration map”''. ReNamer has several built-in maps. Each map is named after a language (the second language in all maps is English).  
+
This rule uses ''transliteration maps'' (explained below).  
  
Each map can be used in ''both'' directions (e.g. French-to-English or English-to-French.)
+
== Transliteration maps ==
  
Note that this rule is really a character-level “find-and-replace” rule
+
To transliterate, we create a pair of equivalent characters, like this: '''ü=ue'''
  
When you start up the '''Translit''' Rule, its window does not show any maps. You are free to do any of the following:
+
(Note that the right side of this equation has ''two'' characters. Any number of characters may be placed on both sides of the equation.)
  
# Use any of the built-in maps (and use it in ''forward'' or ''reverse'' direction)
+
We need several such ''equivalent character pairs'' to convert one language into another. The entire set is called a ''transliteration map''. (This is really some kind of a find-and-replace rule.)
# Create your own map and use it.
 
# Edit a built-in map first, and then use it.
 
  
Let us see how to do this.
+
ReNamer has several such built-in maps. Each map is named after a language (the second language in all maps is English).  
  
=== Using a built-in transliteration map ===
+
Each map can be used in ''both'' directions (e.g. French-to-English or English-to-French.)
To select any of the built-in maps, press the [[Image:]] button. A list of available transliteration maps pops up:
 
  
[[Image:]]Click on the desired transliteration map. As an example, let us click on the French (to English) transliteration map.
+
When you start up the '''Translit''' Rule, its window does not show any maps. You are free to do any of the following:
  
The '''Rules''' window changes immediately to show the French characters and their English equivalent.
+
#Use any of the built-in maps (and use it in ''forward'' or ''reverse'' direction)
 +
#Create your own map and use it.
 +
#Edit a built-in map first, and then use it.
  
[[Image:]]You can edit any of the entry in this list, add new entries, or delete any of the entries.  
+
Let us see how to do this.  
  
Note that such editing does not alter the saved version of the map. (The map is edited just for a one-time use. So, if you select the same Translit map again, ReNamer will load the ''original'' version, not the ''edited'' version.) Later we will see how to edit and save a map.
+
== Automatic case conversion ==
  
Next, select the rule's parameters as shown below::
+
Translit rule does automatic case conversion with an algorithm adopted specifically for transliteration. Translit rule discard the case on the input, i.e. "A=B" is same as "a=b". Case is decided upon case of the input fragment. Multiple character fragments are treated as part of words, with their case decided based on the case of letters around them.
  
 +
The logic for the case conversion is as follows (ReNamer Beta from 23 Aug 2009):
 +
<pre>
 +
set OUTPUT-PART to lower case
 +
if first letter in INPUT-PART is upper case then
 +
  if length of OUTPUT-PART bigger than 1 then
 +
    if next letter in original name is upper case then
 +
      convert whole OUTPUT-PART to upper case
 +
    else
 +
      convert only first letter in OUTPUT-PART to upper case
 +
  else
 +
    convert whole OUTPUT-PART to upper case
 +
</pre>
  
{| class="prettytable"
+
== Using a built-in transliteration map ==
| <center>'''Parameter'''</center>
 
| <center>'''Details'''</center>
 
  
 +
To select any of the built-in maps, press the [[Image:TranslitMapsButton.png]] button. A list of available transliteration maps pops up:
 +
<center>[[Image:TranslitMenu.png]]</center>
 +
Click on the desired transliteration map. As an example, let us click on the French (to English) transliteration map.
 +
 +
The '''Rules''' window changes immediately to show the French characters and their English equivalents.
 +
<center>[[Image:TranslitRuleExample.png]]</center>
 +
You can edit any of the entry in this list, add new entries, or delete any of the entries.
 +
 +
Note that such editing does not alter the saved version of the map. The map is edited just for a one-time use. If you select the same Translit map again, ReNamer will load the ''original'' version, not the ''edited'' version. You will see how to [[#Saving_a_transliteration_map|alter a transliteration map]] in a section below.
 +
 +
Next, select the rule's parameters as shown below:
 +
 +
{| class="wikitable"
 
|-
 
|-
| forward
+
! Parameter
 +
! Details
 +
|-
 +
| forward  
 
| This is transliteration from-left-to-right direction, as defined in the map.
 
| This is transliteration from-left-to-right direction, as defined in the map.
 
 
|-
 
|-
| Backward
+
| backward
 
| This is transliteration from-right-to-left direction, as defined in the map.
 
| This is transliteration from-right-to-left direction, as defined in the map.
 
 
|-
 
|-
| Skip extension
+
| skip extension  
| If this check box is unselected, the extension will be included in the rule.
+
| If this check box is selected, the extension will be ignored by the rule.
 
 
 
|}
 
|}
Finally, press the [[Image:]] button to add the rule to the stack.
 
  
=== Making your own transliteration map ===
+
Finally, press the [[Image:AddRuleButton.png]] button to add the rule to the stack.
Click in the '''Translit Alphabet '''window, and start entering the equivalent characters (one transliteration per line).  
 
  
For example,
+
== Making your own transliteration map ==
  
'''ü=ue'''
+
Click in the '''Translit Alphabet''' window, and start entering your custom alphabet.
  
'''ö=oe'''
+
Transliteration alphabet consists of two equivalence parts (or a couple), which are entered one per line and two parts separated with "=" (equal sign). Alphabet should not contain spaces and should have case discarded ([[ReNamer:Rules:Translit#Automatic_case_conversion|case is adjusted automatically]]). Also, make sure to put couples which contain greater number of characters at the top, so they will get processed first and will not get processed partially by shorter representations. Below is a simple example:
  
'''ß<nowiki>=ss</nowiki>'''
+
{| align="center"
 +
|
 +
<pre>
 +
щ=sh
 +
ю=yu
 +
я=ya
 +
ь='
 +
э=e
 +
</pre>
 +
|}
  
After entering all such transliterations, press the [[Image:]] button to add the rule to the rule-stack.  
+
After entering all such transliterations, press the [[Image:AddRuleButton.png]] button to add the rule to the rule-stack.  
  
 
Note that this rule is not saved yet (it was just composed for a one-time use). The following topic shows how to save a map.
 
Note that this rule is not saved yet (it was just composed for a one-time use). The following topic shows how to save a map.
  
=== Saving a transliteration map ===
+
== Saving a transliteration map ==
To save a newly composed Transliteration rule, press the [[Image:]] button. A menu pops up. Select the last option ('''Save Translit...'''). A window pops up, as shown below:  
+
 
 +
To save a newly composed Transliteration rule,  
 +
 
 +
#Press the [[Image:TranslitMapsButton.png]] button.  
 +
#:A menu pops up.  
 +
#:<center>[[Image:TranslitMenu.png]]</center>
 +
#Select the last option ('''Save Translit...''').  
 +
#:A window pops up, as shown below:  
 +
#:<center>[[Image:SaveTranslitMapDialog.png]]</center>
 +
#Enter a new name for the map and press '''OK'''. The new map is saved.
 +
 
 +
The process of saving an edited Transliteration map is similar. The only difference is that the '''Save Translit '''window (see above) shows the current map's name. You can press '''OK''' to save the changes you've just made, or enter a new name to create a new translit map for the edited version of the current map.
  
[[Image:]]Enter a new name for the map and press '''OK'''. The new map is saved.
+
The new map's name is added to the map list.  
  
The process to save an edited Transliteration map is similar. The only difference is that the '''Save Translit '''window (see above) shows the current map's name. You can press '''OK''' to save the changes you just made, or enter a new name to create a edited version of the current map.
+
From now on, the new map will also be available as "standard".
  
From now on, the new map's name will be added to the map list.
+
[[Category:ReNamer]]

Latest revision as of 22:56, 6 January 2021

TranslitRule.png

This rule transliterates one alphabet into another. Its main goal is to transliterate Non-English characters from different languages into their English/Latin representation. For example, the German character ü can be transliterated to ue (the name Müller can be also written as Mueller).

This rule uses transliteration maps (explained below).

Transliteration maps

To transliterate, we create a pair of equivalent characters, like this: ü=ue

(Note that the right side of this equation has two characters. Any number of characters may be placed on both sides of the equation.)

We need several such equivalent character pairs to convert one language into another. The entire set is called a transliteration map. (This is really some kind of a find-and-replace rule.)

ReNamer has several such built-in maps. Each map is named after a language (the second language in all maps is English).

Each map can be used in both directions (e.g. French-to-English or English-to-French.)

When you start up the Translit Rule, its window does not show any maps. You are free to do any of the following:

  1. Use any of the built-in maps (and use it in forward or reverse direction)
  2. Create your own map and use it.
  3. Edit a built-in map first, and then use it.

Let us see how to do this.

Automatic case conversion

Translit rule does automatic case conversion with an algorithm adopted specifically for transliteration. Translit rule discard the case on the input, i.e. "A=B" is same as "a=b". Case is decided upon case of the input fragment. Multiple character fragments are treated as part of words, with their case decided based on the case of letters around them.

The logic for the case conversion is as follows (ReNamer Beta from 23 Aug 2009):

set OUTPUT-PART to lower case
if first letter in INPUT-PART is upper case then
  if length of OUTPUT-PART bigger than 1 then
    if next letter in original name is upper case then
      convert whole OUTPUT-PART to upper case
    else
      convert only first letter in OUTPUT-PART to upper case
  else
    convert whole OUTPUT-PART to upper case

Using a built-in transliteration map

To select any of the built-in maps, press the TranslitMapsButton.png button. A list of available transliteration maps pops up:

TranslitMenu.png

Click on the desired transliteration map. As an example, let us click on the French (to English) transliteration map.

The Rules window changes immediately to show the French characters and their English equivalents.

TranslitRuleExample.png

You can edit any of the entry in this list, add new entries, or delete any of the entries.

Note that such editing does not alter the saved version of the map. The map is edited just for a one-time use. If you select the same Translit map again, ReNamer will load the original version, not the edited version. You will see how to alter a transliteration map in a section below.

Next, select the rule's parameters as shown below:

Parameter Details
forward This is transliteration from-left-to-right direction, as defined in the map.
backward This is transliteration from-right-to-left direction, as defined in the map.
skip extension If this check box is selected, the extension will be ignored by the rule.

Finally, press the AddRuleButton.png button to add the rule to the stack.

Making your own transliteration map

Click in the Translit Alphabet window, and start entering your custom alphabet.

Transliteration alphabet consists of two equivalence parts (or a couple), which are entered one per line and two parts separated with "=" (equal sign). Alphabet should not contain spaces and should have case discarded (case is adjusted automatically). Also, make sure to put couples which contain greater number of characters at the top, so they will get processed first and will not get processed partially by shorter representations. Below is a simple example:

щ=sh
ю=yu
я=ya
ь='
э=e

After entering all such transliterations, press the AddRuleButton.png button to add the rule to the rule-stack.

Note that this rule is not saved yet (it was just composed for a one-time use). The following topic shows how to save a map.

Saving a transliteration map

To save a newly composed Transliteration rule,

  1. Press the TranslitMapsButton.png button.
    A menu pops up.
    TranslitMenu.png
  2. Select the last option (Save Translit...).
    A window pops up, as shown below:
    SaveTranslitMapDialog.png
  3. Enter a new name for the map and press OK. The new map is saved.

The process of saving an edited Transliteration map is similar. The only difference is that the Save Translit window (see above) shows the current map's name. You can press OK to save the changes you've just made, or enter a new name to create a new translit map for the edited version of the current map.

The new map's name is added to the map list.

From now on, the new map will also be available as "standard".