commit 2673366f37c2b450e4996d8ef478c4675f39017e
parent d3a2073dce563a5cf488b05ceeaea14152a799ae
Author: lumidify <nobody@lumidify.org>
Date: Fri, 27 Mar 2020 14:48:03 +0100
Add clarification to documentation
Diffstat:
2 files changed, 18 insertions(+), 0 deletions(-)
diff --git a/TODO b/TODO
@@ -1 +1,3 @@
- Some way of handling vowel marks that are sometimes written and sometimes left out in Urdu?
+ -> If a word is not found, remove the vowel marks and look for it again, then prompt user
+ for confirmation if the word is found without vowel marks?
diff --git a/transliterate.pl b/transliterate.pl
@@ -1311,6 +1311,16 @@ legitimate. When duplicates are found during normal operation of
the program, they are simply combined in exactly the same way as the
regular word choices.
+Also note that the words are still added as possible choices, which
+may be slightly confusing. If, for instance, a word "word" is stored
+in the tables "tablea", "tableb", and "tablec" with the replacements
+"a", "b", and "c", the first duplicate message will say that the
+first occurrence was in table "tablea" with the replacement "a", and
+the second duplicate message will say that the first occurrence was
+in table "tablea" with the replacement "a$b" (assuming $ is the
+value set as B<choicesep> in the config). This is just something to
+be aware of.
+
=item B<--nochoices>
Disables prompting for the right word when multiple replacement words exist.
@@ -1375,6 +1385,12 @@ a word has multiple replacement options or is not found in the database.
See L</"CONFIGURATION"> for details on what is possible.
+Note that this is B<not> some sort of advanced transliteration engine
+which understands the grammar of the language and tries to guess words
+based on that. This is only a glorified find-and-replace program
+with some extra features to make it useful for transliterating text
+using large wordlists.
+
=head1 WORD CHOICE WINDOW
The word choice window is opened any time one word has multiple replacement
