/ doc / DocFrag / ARCQuery.Translations / Description

Description

Edit keys at this level only

= Offers a very simple system for keeping track of translation between different ("western") languages.0x000D0x000A0x000D0x000A(this class has, as of Jan 2022, not been tested for other languages than those using an alphabet similar to the Latin alphabet with left to right direction.)0x000D0x000A0x000D0x000AVarious approaches to storing translations are:0x000D0x000A0x000D0x000AApproach 1: Storing translations in the classic -PropertyStream-:0x000D0x000ARecommended prefix is -t-, translations can then be added like this:0x000D0x000A  t/de_DE/_Car = Wagen0x000D0x000A  t/fr_FR/_Car = Auto0x000D0x000A  t/nb_NO/_Car = Bil0x000D0x000ASee -TryGetPS- (but note that it offers a slightly different format).0x000D0x000A0x000D0x000AApproach 2: Storing translation strings directly within C# source code.0x000D0x000AFor instance a class called "Translations_de_DE.cs" could have an adder method "a" working like this:0x000D0x000A  a("Car","Wagen")0x003B0x000D0x000A  a("Bicycle","Fahrrad")0x003B0x000D0x000A(the adder method is then supposed to populate this class).0x000D0x000ASee -TryGetA-0x000D0x000A0x000D0x000AApproach 3: Storing translations as -MacroType-.-Translation-.0x000D0x000A(requires use of -ARCEvent-)0x000D0x000AThis approach makes it possible to choose translation on-the-fly at time of development.0x000D0x000ASee -TryGetMacro-0x000D0x000A0x000D0x000AFor all three approaches, this class can be put into the global data storage,with prefix -t-, making translations available to API clients through ordinary queries.0x000D0x000A0x000D0x000AIn all cases, this class will add untranslated keys (assumed that they start with an underscore ('_'), with -TranslationSingleP-.-Text- set to key (minus the underscore) and -IsMissing- set to TRUE.0x000D0x000A0x000D0x000AThis is accomplished through override of method -TryGetP-.0x000D0x000A0x000D0x000AThese "IsMissing" translations can then be queried, and added either to the property stream or C# source code as suggested above.0x000D0x000A0x000D0x000AThat is, translation keys should always start with an underscore ('_').0x000D0x000AThis makes it possible to use -ARCQuery- against this class, because keys not starting with an underscore can then be attempted parsed as a query like 'All', 'SELECT *' or similar.0x000D0x000A0x000D0x000ANote that if you are using -ARCEvent- with exhaustive unit testing, that is, with all possible translation keys being excercised, then this class can be queried afterwards for any missing translations.0x000D0x000A0x000D0x000AKeeping everything in-memory / in C# code has the advantage of not polluting any database with random translation keys that come and go if code is frequently changed. This is because new keys are ephemeral (the exist only within application lifetime).0x000D0x000AYou then implementing new translation keys only when you know that you have a stabile software configuration, that is, only when you know that the keys that you have are actually permanent.0x000D0x000A0x000D0x000AAlso, you can at any time (assumed exhaustive unit testing) query this class for currently in use translation keys, with their translation, and paste that direct into the C# code (replacing the existing code), thereby removing unused keys from the C# code.0x000D0x000A0x000D0x000ANote how inherits -PConcurrent- in order to work in a multi-threaded context.0x000D0x000A0x000D0x000ANote regarding choice of which AgoRapide library to put this class into:0x000D0x000AAt time of development, no clear natural home was found for this class.0x000D0x000AIt was first put into -ARCDoc-, then -ARCQuery- because it used -QueryExpression-.-TryParse-.0x000D0x000AIt no longer uses QueryExpression.TryParse, but since it does use the concept of -EntityMethodKey-, moving back again to ARCDoc looks unnatural (but is quite possible).0x000D0x000ANote that this class also refers to ARCEvent in the comments.0x000D0x000A0x000D0x000ASee also -TranslationsP-.0x000D0x000A

Edit keys at all sub levels.
NOTE: Edits are always additive. Use 'Invalid' in order to delete keys.

Generated 2025-07-09 18:57:07.774 UTC