From a555c65ae35908a8206c33deeea539abad3d2d0b Mon Sep 17 00:00:00 2001
From: Cameron White <cameronwhite91@gmail.com>
Date: Fri, 22 Dec 2023 23:51:05 -0500
Subject: [PATCH] Some initial work on improving add-in localization

The goal is to allow add-ins to be translated on Weblate alongside the main Pinta project, and then also ship these translations with the add-in. Using resource files rather than gettext works better, since the 'mautil pack' command for building the addin will automatically pull in the satellite assemblies for the resources. The string table localizer is an adhoc format that isn't understood by any other tools like Weblate

- Added missing translation strings for the effect properties.
- Switch to a string resource localizer for the reasons mentioned above.
- For now, the add-in header properties (description, etc) are left as-is in the XML file. It doesn't seem like there is a way to get these to be translated by the addin's localizer, so the solution is probably to generate a new .addin-xml automatially from the .resx files.
---
 NightVisionAddin/.addin.xml                 |  25 +---
 NightVisionAddin/NightVisionEffect.cs       |   3 +-
 NightVisionAddin/Resources/Language.es.resx | 136 +++++++++++++++++++
 NightVisionAddin/Resources/Language.resx    | 140 ++++++++++++++++++++
 4 files changed, 284 insertions(+), 20 deletions(-)
 create mode 100644 NightVisionAddin/Resources/Language.es.resx
 create mode 100644 NightVisionAddin/Resources/Language.resx

diff --git a/NightVisionAddin/.addin.xml b/NightVisionAddin/.addin.xml
index b3705d5..9b72ae3 100644
--- a/NightVisionAddin/.addin.xml
+++ b/NightVisionAddin/.addin.xml
@@ -3,7 +3,7 @@
 	<!-- This is the information shown in the add-in manager, with translations -->
 	<Header>
 		<Name>Night Vision Effect</Name>
-		<Description>A simple add-in that will recolour your image so that it looks like a night vision picture.</Description>
+		<Description>A simple add-in that will recolor your image so that it looks like a night vision picture.</Description>
 		<Author>Pinta Project</Author>
 		<Url>https://github.com/PintaProject/NightVisionEffect</Url>
 		<Name locale="ca">Efecte de visió nocturna</Name>
@@ -13,25 +13,12 @@
 		<Description locale="es">Este complemento coloreará la imagen para que parezca vista a través de un dispositivo de visión nocturna.</Description>
 		<Description locale="nb">En enkel effekt som vil endre fargene på bildet ditt slik at det ser ut som det er tatt med nattkikkert.</Description>
 	</Header>
-	<!-- This is technical info for Pinta to identify the add-in. -->
+
+	<!-- Indicate the required Pinta version for the add-in. -->
 	<Dependencies>
 		<Addin id="Pinta" version="2.2" />
 	</Dependencies>
-	<!-- These are strings used in the add-in and their translations.
-	Note that some of the strings might be in Pinta from before, especially effect submenu names,
-	and should be translated the same way, so that we don't end up with redundant submenus.-->
-	<Localizer type="StringTable">
-		<Locale id="ca">
-			<Msg id="Night Vision" str="Visió nocturna" />
-			<Msg id="Stylize" str="Estilitza" />
-		</Locale>
-		<Locale id="es">
-			<Msg id="Night Vision" str="Visión nocturna" />
-			<Msg id="Stylize" str="Estilizar" />
-		</Locale>
-		<Locale id="nb">
-			<Msg id="Night Vision" str="Nattkikkert" />
-			<Msg id="Stylize" str="Stilisér" />
-		</Locale>
-	</Localizer>
+
+	<!-- Use string resources (from satellite assemblies) to localize strings used in the add-in -->
+	<Localizer type="StringResource" />
 </Addin>
diff --git a/NightVisionAddin/NightVisionEffect.cs b/NightVisionAddin/NightVisionEffect.cs
index 5be977b..06398d4 100644
--- a/NightVisionAddin/NightVisionEffect.cs
+++ b/NightVisionAddin/NightVisionEffect.cs
@@ -83,9 +83,10 @@ protected override ColorBgra Render (in ColorBgra pixel)
 
 		public class NightVisionData : EffectData
 		{
-			[MinimumValue (0), MaximumValue (1)]
+			[Caption ("Brightness"), MinimumValue (0), MaximumValue (1)]
 			public double Brightness = 0.6;
 
+			[Caption ("Noise")]
 			public bool Noise = false;
 		}
 	}
diff --git a/NightVisionAddin/Resources/Language.es.resx b/NightVisionAddin/Resources/Language.es.resx
new file mode 100644
index 0000000..4e2e6bc
--- /dev/null
+++ b/NightVisionAddin/Resources/Language.es.resx
@@ -0,0 +1,136 @@
+<?xml version="1.0" encoding="utf-8"?>
+<root>
+  <!--
+    Microsoft ResX Schema
+
+    Version 2.0
+
+    The primary goals of this format is to allow a simple XML format
+    that is mostly human readable. The generation and parsing of the
+    various data types are done through the TypeConverter classes
+    associated with the data types.
+
+    Example:
+
+    ... ado.net/XML headers & schema ...
+    <resheader name="resmimetype">text/microsoft-resx</resheader>
+    <resheader name="version">2.0</resheader>
+    <resheader name="reader">System.Resources.ResXResourceReader, System.Windows.Forms, ...</resheader>
+    <resheader name="writer">System.Resources.ResXResourceWriter, System.Windows.Forms, ...</resheader>
+    <data name="Name1"><value>this is my long string</value><comment>this is a comment</comment></data>
+    <data name="Color1" type="System.Drawing.Color, System.Drawing">Blue</data>
+    <data name="Bitmap1" mimetype="application/x-microsoft.net.object.binary.base64">
+        <value>[base64 mime encoded serialized .NET Framework object]</value>
+    </data>
+    <data name="Icon1" type="System.Drawing.Icon, System.Drawing" mimetype="application/x-microsoft.net.object.bytearray.base64">
+        <value>[base64 mime encoded string representing a byte array form of the .NET Framework object]</value>
+        <comment>This is a comment</comment>
+    </data>
+
+    There are any number of "resheader" rows that contain simple
+    name/value pairs.
+
+    Each data row contains a name, and value. The row also contains a
+    type or mimetype. Type corresponds to a .NET class that support
+    text/value conversion through the TypeConverter architecture.
+    Classes that don't support this are serialized and stored with the
+    mimetype set.
+
+    The mimetype is used for serialized objects, and tells the
+    ResXResourceReader how to depersist the object. This is currently not
+    extensible. For a given mimetype the value must be set accordingly:
+
+    Note - application/x-microsoft.net.object.binary.base64 is the format
+    that the ResXResourceWriter will generate, however the reader can
+    read any of the formats listed below.
+
+    mimetype: application/x-microsoft.net.object.binary.base64
+    value   : The object must be serialized with
+            : System.Runtime.Serialization.Formatters.Binary.BinaryFormatter
+            : and then encoded with base64 encoding.
+
+    mimetype: application/x-microsoft.net.object.soap.base64
+    value   : The object must be serialized with
+            : System.Runtime.Serialization.Formatters.Soap.SoapFormatter
+            : and then encoded with base64 encoding.
+
+    mimetype: application/x-microsoft.net.object.bytearray.base64
+    value   : The object must be serialized into a byte array
+            : using a System.ComponentModel.TypeConverter
+            : and then encoded with base64 encoding.
+    -->
+  <xsd:schema id="root" xmlns="" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:msdata="urn:schemas-microsoft-com:xml-msdata">
+    <xsd:import namespace="http://www.w3.org/XML/1998/namespace"/>
+    <xsd:element name="root" msdata:IsDataSet="true">
+      <xsd:complexType>
+        <xsd:choice maxOccurs="unbounded">
+          <xsd:element name="metadata">
+            <xsd:complexType>
+              <xsd:sequence>
+                <xsd:element name="value" type="xsd:string" minOccurs="0"/>
+              </xsd:sequence>
+              <xsd:attribute name="name" use="required" type="xsd:string"/>
+              <xsd:attribute name="type" type="xsd:string"/>
+              <xsd:attribute name="mimetype" type="xsd:string"/>
+              <xsd:attribute ref="xml:space"/>
+            </xsd:complexType>
+          </xsd:element>
+          <xsd:element name="assembly">
+            <xsd:complexType>
+              <xsd:attribute name="alias" type="xsd:string"/>
+              <xsd:attribute name="name" type="xsd:string"/>
+            </xsd:complexType>
+          </xsd:element>
+          <xsd:element name="data">
+            <xsd:complexType>
+              <xsd:sequence>
+                <xsd:element name="value" type="xsd:string" minOccurs="0" msdata:Ordinal="1"/>
+                <xsd:element name="comment" type="xsd:string" minOccurs="0" msdata:Ordinal="2"/>
+              </xsd:sequence>
+              <xsd:attribute name="name" type="xsd:string" use="required" msdata:Ordinal="1"/>
+              <xsd:attribute name="type" type="xsd:string" msdata:Ordinal="3"/>
+              <xsd:attribute name="mimetype" type="xsd:string" msdata:Ordinal="4"/>
+              <xsd:attribute ref="xml:space"/>
+            </xsd:complexType>
+          </xsd:element>
+          <xsd:element name="resheader">
+            <xsd:complexType>
+              <xsd:sequence>
+                <xsd:element name="value" type="xsd:string" minOccurs="0" msdata:Ordinal="1"/>
+              </xsd:sequence>
+              <xsd:attribute name="name" type="xsd:string" use="required"/>
+            </xsd:complexType>
+          </xsd:element>
+        </xsd:choice>
+      </xsd:complexType>
+    </xsd:element>
+  </xsd:schema>
+  <resheader name="resmimetype">
+    <value>text/microsoft-resx</value>
+  </resheader>
+  <resheader name="version">
+    <value>2.0</value>
+  </resheader>
+  <resheader name="reader">
+    <value>System.Resources.ResXResourceReader, System.Windows.Forms, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089</value>
+  </resheader>
+  <resheader name="writer">
+    <value>System.Resources.ResXResourceWriter, System.Windows.Forms, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089</value>
+  </resheader>
+  <data name="Stylize" xml:space="preserve">
+    <value>Estilizado</value>
+    <comment/>
+  </data>
+  <data name="Night Vision" xml:space="preserve">
+    <value>Visión nocturna</value>
+    <comment/>
+  </data>
+  <data name="Brightness" xml:space="preserve">
+    <value>Brillo</value>
+    <comment/>
+  </data>
+  <data name="Night Vision Effect" xml:space="preserve">
+    <value>Efecto de visión nocturna</value>
+    <comment/>
+  </data>
+</root>
\ No newline at end of file
diff --git a/NightVisionAddin/Resources/Language.resx b/NightVisionAddin/Resources/Language.resx
new file mode 100644
index 0000000..af2e3db
--- /dev/null
+++ b/NightVisionAddin/Resources/Language.resx
@@ -0,0 +1,140 @@
+<?xml version="1.0" encoding="utf-8"?>
+<root>
+  <!--
+    Microsoft ResX Schema
+
+    Version 2.0
+
+    The primary goals of this format is to allow a simple XML format
+    that is mostly human readable. The generation and parsing of the
+    various data types are done through the TypeConverter classes
+    associated with the data types.
+
+    Example:
+
+    ... ado.net/XML headers & schema ...
+    <resheader name="resmimetype">text/microsoft-resx</resheader>
+    <resheader name="version">2.0</resheader>
+    <resheader name="reader">System.Resources.ResXResourceReader, System.Windows.Forms, ...</resheader>
+    <resheader name="writer">System.Resources.ResXResourceWriter, System.Windows.Forms, ...</resheader>
+    <data name="Name1"><value>this is my long string</value><comment>this is a comment</comment></data>
+    <data name="Color1" type="System.Drawing.Color, System.Drawing">Blue</data>
+    <data name="Bitmap1" mimetype="application/x-microsoft.net.object.binary.base64">
+        <value>[base64 mime encoded serialized .NET Framework object]</value>
+    </data>
+    <data name="Icon1" type="System.Drawing.Icon, System.Drawing" mimetype="application/x-microsoft.net.object.bytearray.base64">
+        <value>[base64 mime encoded string representing a byte array form of the .NET Framework object]</value>
+        <comment>This is a comment</comment>
+    </data>
+
+    There are any number of "resheader" rows that contain simple
+    name/value pairs.
+
+    Each data row contains a name, and value. The row also contains a
+    type or mimetype. Type corresponds to a .NET class that support
+    text/value conversion through the TypeConverter architecture.
+    Classes that don't support this are serialized and stored with the
+    mimetype set.
+
+    The mimetype is used for serialized objects, and tells the
+    ResXResourceReader how to depersist the object. This is currently not
+    extensible. For a given mimetype the value must be set accordingly:
+
+    Note - application/x-microsoft.net.object.binary.base64 is the format
+    that the ResXResourceWriter will generate, however the reader can
+    read any of the formats listed below.
+
+    mimetype: application/x-microsoft.net.object.binary.base64
+    value   : The object must be serialized with
+            : System.Runtime.Serialization.Formatters.Binary.BinaryFormatter
+            : and then encoded with base64 encoding.
+
+    mimetype: application/x-microsoft.net.object.soap.base64
+    value   : The object must be serialized with
+            : System.Runtime.Serialization.Formatters.Soap.SoapFormatter
+            : and then encoded with base64 encoding.
+
+    mimetype: application/x-microsoft.net.object.bytearray.base64
+    value   : The object must be serialized into a byte array
+            : using a System.ComponentModel.TypeConverter
+            : and then encoded with base64 encoding.
+    -->
+  <xsd:schema id="root" xmlns="" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:msdata="urn:schemas-microsoft-com:xml-msdata">
+    <xsd:import namespace="http://www.w3.org/XML/1998/namespace"/>
+    <xsd:element name="root" msdata:IsDataSet="true">
+      <xsd:complexType>
+        <xsd:choice maxOccurs="unbounded">
+          <xsd:element name="metadata">
+            <xsd:complexType>
+              <xsd:sequence>
+                <xsd:element name="value" type="xsd:string" minOccurs="0"/>
+              </xsd:sequence>
+              <xsd:attribute name="name" use="required" type="xsd:string"/>
+              <xsd:attribute name="type" type="xsd:string"/>
+              <xsd:attribute name="mimetype" type="xsd:string"/>
+              <xsd:attribute ref="xml:space"/>
+            </xsd:complexType>
+          </xsd:element>
+          <xsd:element name="assembly">
+            <xsd:complexType>
+              <xsd:attribute name="alias" type="xsd:string"/>
+              <xsd:attribute name="name" type="xsd:string"/>
+            </xsd:complexType>
+          </xsd:element>
+          <xsd:element name="data">
+            <xsd:complexType>
+              <xsd:sequence>
+                <xsd:element name="value" type="xsd:string" minOccurs="0" msdata:Ordinal="1"/>
+                <xsd:element name="comment" type="xsd:string" minOccurs="0" msdata:Ordinal="2"/>
+              </xsd:sequence>
+              <xsd:attribute name="name" type="xsd:string" use="required" msdata:Ordinal="1"/>
+              <xsd:attribute name="type" type="xsd:string" msdata:Ordinal="3"/>
+              <xsd:attribute name="mimetype" type="xsd:string" msdata:Ordinal="4"/>
+              <xsd:attribute ref="xml:space"/>
+            </xsd:complexType>
+          </xsd:element>
+          <xsd:element name="resheader">
+            <xsd:complexType>
+              <xsd:sequence>
+                <xsd:element name="value" type="xsd:string" minOccurs="0" msdata:Ordinal="1"/>
+              </xsd:sequence>
+              <xsd:attribute name="name" type="xsd:string" use="required"/>
+            </xsd:complexType>
+          </xsd:element>
+        </xsd:choice>
+      </xsd:complexType>
+    </xsd:element>
+  </xsd:schema>
+  <resheader name="resmimetype">
+    <value>text/microsoft-resx</value>
+  </resheader>
+  <resheader name="version">
+    <value>2.0</value>
+  </resheader>
+  <resheader name="reader">
+    <value>System.Resources.ResXResourceReader, System.Windows.Forms, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089</value>
+  </resheader>
+  <resheader name="writer">
+    <value>System.Resources.ResXResourceWriter, System.Windows.Forms, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089</value>
+  </resheader>
+  <data name="Stylize" xml:space="preserve">
+    <value>Stylize</value>
+    <comment/>
+  </data>
+  <data name="Night Vision" xml:space="preserve">
+    <value>Night Vision</value>
+    <comment/>
+  </data>
+  <data name="Brightness" xml:space="preserve">
+    <value>Brightness</value>
+    <comment/>
+  </data>
+  <data name="Noise" xml:space="preserve">
+    <value>Noise</value>
+    <comment/>
+  </data>
+  <data name="Night Vision Effect" xml:space="preserve">
+    <value>Night Vision Effect</value>
+    <comment/>
+  </data>
+</root>
\ No newline at end of file