Background:

We are writing a new task for the ArcGis Explorer, this task needs to place images on the globe using its X,Y coordinates.
While for each instance on the globe we need to render its details as html.

Mission:

Rendering the objects to html, we are still didn't find the right place (on the server or on the client), but let assume that they both need to do the same job.

Ideas:

1. Render in code:
   This is the naive way of thinking. while you are first thinking about this  problem you might think to add the object an ToHtml() method.
   Always think about the: Single Responsibility Principle (SRP).
   You can still think about Writing an HtmlWriter or HtmlRenderer class that gets object and render the object using reflection or something else, but than you will find yourself indenting you JavaScript\html\CSS in C#, for example you can watch this code:
   
   

      1: var items = new List<string> {"Shani", "Doron", "Nati", "Yossi"};

      2: var sb = new StringBuilder();

      3: items.ForEach(currentItem => 

      4:         sb.AppendFormat("<li>{0}</li>", currentItem)

      5:         );

      6: string data = sb.ToString();

   Let's think about the time we will need to change the UI from <li> to one with style or maybe even change the list to be styled as table...
    
2. XSL - is pretty more dynamic than code, isn't it?
   So we are now looking for something more dynamic, something that we can read from a file so we can give it to our designer to play with the UI.
   This lead us to the second option: at my past all our reports were rendered using XSL files, personally I don't like this option.
   But the main reason is that we will need to serialize our objects to XML, while in most cases all you need is to render only few fields.
   
3. Let's found another Template Engine:
   The first one I can think of is the MVC Engine or Brail. after some searching reading and Testing I found StringTemplate.
   Here is a simple code for using the API:
   
   

      1: var templateFolder = new StringTemplateGroup("SimpleLoopTemplate", @"\TemplateEngineTestCase\WinApp");

      2: var template = templateFolder.GetInstanceOf("3_simpleLoop");

      3: //here we are binding our list to the template

      4: template.SetAttribute("items", new List<string> {"Shani", "Doron", "Nati", "Yossi"});

      5: var data = template.ToString();

   
   and here is the template (file name: 3_simpleLoop.st):
   

      1: $items: {num1| 

      2:   <li>$num1$</li>

      3:   }$

      4: $end$

    

Conclusion:

I thought about the time we all spend on reading some well known patterns. I found this strange reading again and again the same logic. We all know the pattern but we doing it to be sure we use all the best practices.

Inspired by the book: Head First - Design Patterns, I rewrite the two basic patterns of Strategy and Observer. and create a snippets for your own use. so next time you won't need to get to Google it up.

Here are the snippets, for your own use: (right click & download)
Strategy.snippet
Observer.snippet

More to come on the next posts.

---

Remark: There could be a lot of variation for those patterns, those I wrote here were taken as a combination of the books samples and a few best practices I found out.