From adc26956884e909e1443a7332731b85fef74cd7f Mon Sep 17 00:00:00 2001
From: Paul Licameli <paul.licameli@audacityteam.org>
Date: Fri, 8 Sep 2017 14:48:06 -0400
Subject: [PATCH] i18n-hints about the name "Nyquist" ...

... Although "Nyquist" is a proper name, still, translators should have
discretion to transliterate it into another alphabet, and also make it
consistent with longer translated strings containing it.

Not so for debug messages mentioning actual keywords of Nyquist programming.
---
 src/effects/nyquist/Nyquist.cpp | 9 +++++++++
 src/effects/nyquist/Nyquist.h   | 2 +-
 2 files changed, 10 insertions(+), 1 deletion(-)

diff --git a/src/effects/nyquist/Nyquist.cpp b/src/effects/nyquist/Nyquist.cpp
index dab6a7d8e..6124e769c 100644
--- a/src/effects/nyquist/Nyquist.cpp
+++ b/src/effects/nyquist/Nyquist.cpp
@@ -149,6 +149,10 @@ NyquistEffect::NyquistEffect(const wxString &fName)
 
    // Interactive Nyquist
    if (fName == NYQUIST_PROMPT_ID) {
+      /* i18n-hint: "Nyquist" is an embedded interpreted programming language in
+       Audacity, named in honor of the Swedish-American Harry Nyquist (or Nyqvist).
+       In the translations of this and other strings, you may transliterate the
+       name into another alphabet.  */
       mName = XO("Nyquist Prompt");
       mType = EffectTypeProcess;
       mOK = true;
@@ -159,6 +163,7 @@ NyquistEffect::NyquistEffect(const wxString &fName)
 
    if (fName == NYQUIST_WORKER_ID) {
       // Effect spawned from Nyquist Prompt
+/* i18n-hint: It is acceptable to translate this the same as for "Nyquist Prompt" */
       mName = XO("Nyquist Worker");
       return;
    }
@@ -1389,6 +1394,8 @@ wxString NyquistEffect::NyquistToWxString(const char *nyqString)
     if (nyqString != NULL && nyqString[0] && str.IsEmpty()) {
         // invalid UTF-8 string, convert as Latin-1
         str = _("[Warning: Nyquist returned invalid UTF-8 string, converted here as Latin-1]");
+       // TODO: internationalization of strings from Nyquist effects, at least
+       // from those shipped with Audacity
         str += LAT1CTOWX(nyqString);
     }
     return str;
@@ -1835,6 +1842,8 @@ bool NyquistEffect::ParseProgram(wxInputStream & stream)
    }
    if (!mFoundType && mIsPrompt)
    {
+      /* i1n-hint: SAL and LISP are names for variant syntaxes for the
+       Nyquist programming language.  Leave them, and 'return', untranslated. */
       wxMessageBox(_("Your code looks like SAL syntax, but there is no \'return\' statement.\n\
 For SAL, use a return statement such as:\n\treturn *track* * 0.1\n\
 or for LISP, begin with an open parenthesis such as:\n\t(mult *track* 0.1)\n ."),
diff --git a/src/effects/nyquist/Nyquist.h b/src/effects/nyquist/Nyquist.h
index 07eed2d87..5123de117 100644
--- a/src/effects/nyquist/Nyquist.h
+++ b/src/effects/nyquist/Nyquist.h
@@ -193,7 +193,7 @@ private:
    bool              mOK;
    wxString          mInputCmd; // history: exactly what the user typed
    wxString          mCmd;      // the command to be processed
-   wxString          mName;   ///< Name of the Effect
+   wxString          mName;   ///< Name of the Effect (untranslated)
    wxString          mAction;
    wxString          mInfo;
    wxString          mAuthor;