The purpose of this post is I want to practice Find apis – Synonym, refer to this document. The exercise this time is creating a tool for creating all English synonyms.
The English synonyms resource I found at this website and I try to gather them to a list of useful Episerver Find synonyms.
Step by step
1. First of all, I create a console app in Visual Studio as usual, name asÂEnglishSynonymsCreator
2. Install EPiServer.Find package from Episerver package resources
3. Get theÂISynonymsClient (simple trick)
And as document said, we need to use those code:
1 | var synonymsClient = client.Synonyms(); |
This method is call only when install EPiServer.Find.Cms. However, I found that installing all this package is not necessary.
If you have a site that installed EPiServer.Find.Cms already, you can copyÂEPiServer.Find.Optimizations.dll and add it to your project’s references.
After that we can get the client:
1 | var client = EPiServer.Find.Client.CreateFromConfig()?.Optimizations()?.Synonyms(); |
4. Add synonyms to Find
Now, everything is pretty easy using:
1 | client.Add(new Synonym(pharse, synonymPharse, true)); |
I prepare a list of synonym fromÂhttps://www.englisch-hilfen.de/en/words/synonyms.htm, loop through it and use this Find api to add it to Find synonyms:
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 | foreach (KeyValuePair<string, string> entry in _synonymsEnglishList) { var key = entry.Key.Trim(); var value = entry.Value.Trim(); if (key.Contains(",") || key.Contains(" ") || value.Contains(" ")) { continue; } foreach (var v in value.Split(',')) { try { client.Add(new Synonym(key, v.Trim(), true)); } catch (Exception ex) { Console.WriteLine($"Creating Synonym ({key},{v}) error: {ex.Message}"); continue; } } } |
5. Add your Find url configuration to app.config
6. Done, now press F5 to execute this console app then access to your site for preview the result.
I put my practice to my github as well, you can find it atÂhttps://github.com/sondn2010/EnglishSynonymsCreator
This repository is just a sample code for “how to use” Find APIs, you could improve it by reading dictionary from a file, from database or other source.
Hope this helps your life easier.
/Son Do