From 5b6f1db2838ea0c14545e81b80a7096d82ae2985 Mon Sep 17 00:00:00 2001
From: Toinedb <toine.de.boer@avivasolutions.nl>
Date: Fri, 1 Nov 2024 18:08:29 +0100
Subject: [PATCH 1/3] code block options

---
 src/MarkdownParser/IViewSupplier.cs           | 18 ++++
 src/MarkdownParser/ListBulletFormatter.cs     | 30 -------
 src/MarkdownParser/MarkdownParser.csproj      |  6 ++
 src/MarkdownParser/ViewFormatter.cs           | 13 ++-
 src/MarkdownParser/ViewWriter.cs              | 82 ++++++++++++++-----
 .../MarkdownParser.Test.csproj                |  6 ++
 .../MarkdownParserSectionsSpecs.cs            | 33 ++++++++
 .../Mocks/StringComponentSupplier.cs          | 15 ++++
 .../Resources/Examples/Sections/codeblocks.md |  8 ++
 9 files changed, 155 insertions(+), 56 deletions(-)
 delete mode 100644 src/MarkdownParser/ListBulletFormatter.cs
 create mode 100644 test/MarkdownParser.Test/Resources/Examples/Sections/codeblocks.md

diff --git a/src/MarkdownParser/IViewSupplier.cs b/src/MarkdownParser/IViewSupplier.cs
index 2c7e231..1eff70f 100644
--- a/src/MarkdownParser/IViewSupplier.cs
+++ b/src/MarkdownParser/IViewSupplier.cs
@@ -72,5 +72,23 @@ public interface IViewSupplier<T>
         /// <param name="placeholderName">placeholder string</param>
         /// <returns></returns>
         T GetPlaceholder(string placeholderName);
+
+        /// <summary>
+        /// a view that shows fenced code found in MD blocks starting with ```cs  
+        /// </summary>
+        /// <returns></returns>
+        T GetFencedCodeBlock(string content, string codeInfo);
+
+        /// <summary>
+        /// a view that shows indented code found in MD lines starting with at least 4 spaces
+        /// </summary>
+        /// <returns></returns>
+        T GetIndentedCodeBlock(string content);
+
+        /// <summary>
+        /// get a textual line break
+        /// </summary>
+        /// <returns></returns>
+        string GetTextualLineBreak();
     }
 }
diff --git a/src/MarkdownParser/ListBulletFormatter.cs b/src/MarkdownParser/ListBulletFormatter.cs
deleted file mode 100644
index 6a96d6a..0000000
--- a/src/MarkdownParser/ListBulletFormatter.cs
+++ /dev/null
@@ -1,30 +0,0 @@
-using System;
-using System.Globalization;
-
-namespace MarkdownParser
-{
-    public static class ListBulletFormatter
-    {
-        public static string GetListItemBullet(bool isOrderedList, int sequenceNumber, int listLevel, string listItemBulletOddCharacter, string listItemBulletEvenCharacter)
-        {
-            // 'listlevel' even or odd (list start at level 1 == odd)
-            var isListOddLeveled = (listLevel % 2) != 0;
-
-            if (!isOrderedList)
-            {
-                return (isListOddLeveled)
-                    ? listItemBulletOddCharacter
-                    : listItemBulletEvenCharacter;
-            }
-
-            const int aCharacterPosition = 97; // character 'a' position in ASCI table
-            var sequenceNumberCharacterPosition = -1 + aCharacterPosition + sequenceNumber;
-
-            var bullet = (isListOddLeveled)
-                        ? sequenceNumber.ToString()
-                        : Convert.ToChar(sequenceNumberCharacterPosition, CultureInfo.InvariantCulture).ToString();
-
-            return $"{bullet}.";
-        }
-    }
-}
diff --git a/src/MarkdownParser/MarkdownParser.csproj b/src/MarkdownParser/MarkdownParser.csproj
index dc60480..5e485e8 100644
--- a/src/MarkdownParser/MarkdownParser.csproj
+++ b/src/MarkdownParser/MarkdownParser.csproj
@@ -49,4 +49,10 @@
 		<None Include="..\..\README.md" Pack="true" PackagePath="\"/>
 	</ItemGroup>
 
+	<ItemGroup>
+		<AssemblyAttribute Include="System.Runtime.CompilerServices.InternalsVisibleToAttribute">
+			<_Parameter1>MarkdownParser.Test</_Parameter1>
+		</AssemblyAttribute>
+	</ItemGroup>
+
 </Project>
diff --git a/src/MarkdownParser/ViewFormatter.cs b/src/MarkdownParser/ViewFormatter.cs
index af12363..11ae746 100644
--- a/src/MarkdownParser/ViewFormatter.cs
+++ b/src/MarkdownParser/ViewFormatter.cs
@@ -69,17 +69,22 @@ private void WriteBlockToView(Block block, ViewWriter<T> writer, bool continueWi
                     writer.StartAndFinalizeThematicBreak();
                     break;
                 case BlockTag.FencedCode:
+                    writer.StartAndFinalizeFencedCodeBlock(block.StringContent, block.FencedCodeData.Info);
+                    break;
                 case BlockTag.IndentedCode:
-                    // not supported
+                    writer.StartAndFinalizeIndentedCodeBlock(block.StringContent);
                     break;
                 case BlockTag.HtmlBlock:
-                    // TODO.....if needed
+                    // TODO
+                    var currentBlock3 = block;
+                    break;
                     //writer.StartBlock(BlockTag.Paragraph, block.StringContent.ToString());
                     //WriteBlockToView(block.FirstChild, writer);
                     //writer.FinalizeParagraphBlock();
                     break;
                 case BlockTag.ReferenceDefinition:
-                    // not supported
+                    // TODO
+                    var currentBlock4 = block;
                     break;
                 default:
                     throw new CommonMarkException("Block type " + block.Tag + " is not supported.", block);
@@ -114,7 +119,7 @@ private void WriteInlineToView(Inline inline, ViewWriter<T> writer)
                     break;
                 case InlineTag.SoftBreak:
                 case InlineTag.LineBreak:
-                    writer.AddText(Environment.NewLine);
+                    writer.AddText(writer.GetTextualLineBreak());
                     break;
                 case InlineTag.Placeholder:
                     writer.StartAndFinalizePlaceholderBlock(inline.TargetUrl);
diff --git a/src/MarkdownParser/ViewWriter.cs b/src/MarkdownParser/ViewWriter.cs
index 6eb147d..2f3d6a4 100644
--- a/src/MarkdownParser/ViewWriter.cs
+++ b/src/MarkdownParser/ViewWriter.cs
@@ -1,7 +1,8 @@
-using System;
-using System.Collections.Generic;
+using System.Collections.Generic;
 using System.Diagnostics;
+using System.IO;
 using System.Linq;
+using System.Text;
 using CommonMark.Syntax;
 
 namespace MarkdownParser
@@ -10,8 +11,13 @@ public class ViewWriter<T>
     {
         private IViewSupplier<T> ViewSupplier { get; }
         private List<T> WrittenViews { get; set; } = new List<T>();
-
         private Stack<ViewWriterCache<T>> Workbench { get; } = new Stack<ViewWriterCache<T>>();
+
+        public ViewWriter(IViewSupplier<T> viewSupplier)
+        {
+            ViewSupplier = viewSupplier;
+        }
+
         private ViewWriterCache<T> GetWorkbenchItem()
         {
             if (Workbench.Count == 0)
@@ -22,11 +28,6 @@ private ViewWriterCache<T> GetWorkbenchItem()
             return Workbench.Peek();
         }
 
-        public ViewWriter(IViewSupplier<T> viewSupplier)
-        {
-            ViewSupplier = viewSupplier;
-        }
-
         public List<T> Flush()
         {
             var collectedViews = WrittenViews;
@@ -57,8 +58,9 @@ public void FinalizeParagraphBlock()
 
             foreach (var itemsCacheTuple in itemsCache)
             {
-                var view = !string.IsNullOrEmpty(itemsCacheTuple.Item1) ?
-                                ViewSupplier.GetTextView(itemsCacheTuple.Item1) : itemsCacheTuple.Item2;
+                var view = !string.IsNullOrEmpty(itemsCacheTuple.Item1) 
+                    ? ViewSupplier.GetTextView(itemsCacheTuple.Item1) 
+                    : itemsCacheTuple.Item2;
 
                 if (view != null)
                 {
@@ -94,7 +96,6 @@ public void FinalizeHeaderBlock(int headerLevel)
             var wbi = GetWorkbenchItem();
             if (wbi.ComponentType != BlockTag.AtxHeading
                 && wbi.ComponentType != BlockTag.SetextHeading)
-
             {
                 Debug.WriteLine($"Finalizing Header can not finalize {wbi.ComponentType}");
                 return;
@@ -107,8 +108,9 @@ public void FinalizeHeaderBlock(int headerLevel)
 
             foreach (var itemsCacheTuple in itemsCache)
             {
-                var view = !string.IsNullOrEmpty(itemsCacheTuple.Item1) ?
-                                ViewSupplier.GetHeaderView(itemsCacheTuple.Item1, headerLevel) : itemsCacheTuple.Item2;
+                var view = !string.IsNullOrEmpty(itemsCacheTuple.Item1) 
+                    ? ViewSupplier.GetHeaderView(itemsCacheTuple.Item1, headerLevel) 
+                    : itemsCacheTuple.Item2;
 
                 views.Add(view);
             }
@@ -155,8 +157,9 @@ public void FinalizeListItemBlock(ListData listData)
 
             foreach (var itemsCacheTuple in itemsCache)
             {
-                var view = !string.IsNullOrEmpty(itemsCacheTuple.Item1) ?
-                                ViewSupplier.GetTextView(itemsCacheTuple.Item1) : itemsCacheTuple.Item2;
+                var view = !string.IsNullOrEmpty(itemsCacheTuple.Item1) 
+                    ? ViewSupplier.GetTextView(itemsCacheTuple.Item1) 
+                    : itemsCacheTuple.Item2;
 
                 if (view != null)
                 {
@@ -164,9 +167,9 @@ public void FinalizeListItemBlock(ListData listData)
                 }
             }
 
-            var flattendView = StackViews(views);
+            var flattenedView = StackViews(views);
 
-            var listItemView = ViewSupplier.GetListItemView(flattendView, isOrderedList, sequenceNumber, depthLevel);
+            var listItemView = ViewSupplier.GetListItemView(flattenedView, isOrderedList, sequenceNumber, depthLevel);
 
             StoreView(listItemView);
         }
@@ -182,10 +185,26 @@ public void StartAndFinalizeImageBlock(string targetUrl, string subscription, st
             StoreView(imageView);
         }
 
+        public void StartAndFinalizeFencedCodeBlock(StringContent content, string blockInfo)
+        {
+            var parsedContent = ParseStringContentToString(content);
+
+            var codeBlock = ViewSupplier.GetFencedCodeBlock(parsedContent, blockInfo);
+            StoreView(codeBlock);
+        }
+
+        public void StartAndFinalizeIndentedCodeBlock(StringContent content)
+        {
+            var parsedContent = ParseStringContentToString(content);
+
+            var codeBlock = ViewSupplier.GetIndentedCodeBlock(parsedContent);
+            StoreView(codeBlock);
+        }
+
         public void StartAndFinalizeThematicBreak()
         {
-            var seperator = ViewSupplier.GetThematicBreak();
-            StoreView(seperator);
+            var separator = ViewSupplier.GetThematicBreak();
+            StoreView(separator);
         }
 
         public void StartAndFinalizePlaceholderBlock(string placeholderName)
@@ -194,16 +213,23 @@ public void StartAndFinalizePlaceholderBlock(string placeholderName)
             StoreView(placeholderView);
         }
 
+        public string GetTextualLineBreak()
+        {
+            return ViewSupplier.GetTextualLineBreak();
+        }
+
         private T StackViews(List<T> views)
         {
-            if (views == null || views.Count == 0)
+            if (views == null 
+                || views.Count == 0)
             {
                 return default(T);
             }
 
             // multiple views combine a single stack layout
-            var viewToStore = views.Count == 1 ?
-                views[0] : ViewSupplier.GetStackLayoutView(views);
+            var viewToStore = views.Count == 1 
+                ? views[0] 
+                : ViewSupplier.GetStackLayoutView(views);
 
             return viewToStore;
         }
@@ -226,6 +252,18 @@ private void StoreView(T view)
                 WrittenViews.Add(view);
             }
         }
+        
+        private string ParseStringContentToString(StringContent content)
+        {
+            var stringWriter = new StringWriter();
+            content.WriteTo(stringWriter);
+            var contentLines = stringWriter.ToString();
+
+            contentLines = contentLines.Replace("\r", "");
+            contentLines = contentLines.TrimEnd('\n');
+            contentLines = contentLines.Replace("\n", GetTextualLineBreak());
 
+            return contentLines;
+        }
     }
 }
diff --git a/test/MarkdownParser.Test/MarkdownParser.Test.csproj b/test/MarkdownParser.Test/MarkdownParser.Test.csproj
index f93842d..9637277 100644
--- a/test/MarkdownParser.Test/MarkdownParser.Test.csproj
+++ b/test/MarkdownParser.Test/MarkdownParser.Test.csproj
@@ -13,20 +13,26 @@
     <None Remove="Resources\Examples\Combined\basic-example.md" />
     <None Remove="Resources\Examples\Combined\full-example.md" />
     <None Remove="Resources\Examples\Combined\minimal-example.md" />
+    <None Remove="Resources\Examples\Sections\codeblocks.md" />
     <None Remove="Resources\Examples\Sections\headers.md" />
+    <None Remove="Resources\Examples\Sections\htmlblocks.md" />
     <None Remove="Resources\Examples\Sections\list.md" />
     <None Remove="Resources\Examples\Sections\nestedlist.md" />
     <None Remove="Resources\Examples\Sections\paragraphs.md" />
+    <None Remove="Resources\Examples\Sections\referencedefinitions.md" />
   </ItemGroup>
 
   <ItemGroup>
     <EmbeddedResource Include="Resources\Examples\Combined\basic-example.md" />
     <EmbeddedResource Include="Resources\Examples\Combined\full-example.md" />
     <EmbeddedResource Include="Resources\Examples\Combined\minimal-example.md" />
+    <EmbeddedResource Include="Resources\Examples\Sections\codeblocks.md" />
     <EmbeddedResource Include="Resources\Examples\Sections\headers.md" />
+    <EmbeddedResource Include="Resources\Examples\Sections\htmlblocks.md" />
     <EmbeddedResource Include="Resources\Examples\Sections\list.md" />
     <EmbeddedResource Include="Resources\Examples\Sections\nestedlist.md" />
     <EmbeddedResource Include="Resources\Examples\Sections\paragraphs.md" />
+    <EmbeddedResource Include="Resources\Examples\Sections\referencedefinitions.md" />
   </ItemGroup>
 
   <ItemGroup>
diff --git a/test/MarkdownParser.Test/MarkdownParserSectionsSpecs.cs b/test/MarkdownParser.Test/MarkdownParserSectionsSpecs.cs
index 5617526..d66bdc5 100644
--- a/test/MarkdownParser.Test/MarkdownParserSectionsSpecs.cs
+++ b/test/MarkdownParser.Test/MarkdownParserSectionsSpecs.cs
@@ -98,4 +98,37 @@ public void When_parsing_nested_list_it_should_output_nesting_by_level()
         splittedViews[12].Should().Be("_False.2.1_textview");
         splittedViews[13].Should().Be("item2-3<listview<stackview<listview");
     }
+
+    [TestMethod]
+    public void When_parsing_codeblocks_it_should_output_code_views()
+    {
+        //-----------------------------------------------------------------------------------------------------------
+        // Arrange
+        //-----------------------------------------------------------------------------------------------------------
+        var markdown = FileReader.ReadFile("Sections.codeblocks.md");
+
+        var mockComponentSupplier = new StringComponentSupplier();
+        var parser = new MarkdownParser<string>(mockComponentSupplier);
+
+        //-----------------------------------------------------------------------------------------------------------
+        // Act
+        //-----------------------------------------------------------------------------------------------------------
+        var parseResult = parser.Parse(markdown);
+
+        //-----------------------------------------------------------------------------------------------------------
+        // Assert
+        //-----------------------------------------------------------------------------------------------------------
+        parseResult.Count.Should().Be(2);
+
+        var view0Parts = parseResult[0].Split('|');
+        view0Parts[0].Should().Be("fencedcodeview>");
+        view0Parts[1].Should().Be("(cs)");
+        view0Parts[2].Should().Be("var myNumber = 1;\r\nmyNumber++;");
+        view0Parts[3].Should().Be("<fencedcodeview");
+
+        var view1Parts = parseResult[1].Split('|');
+        view1Parts[0].Should().Be("indentedview>");
+        view1Parts[1].Should().Be("the first line for IndentedCode code block\r\nthe second line for IndentedCode code block\r\nthe third line for IndentedCode code block");
+        view1Parts[2].Should().Be("<indentedview");
+    }
 }
diff --git a/test/MarkdownParser.Test/Mocks/StringComponentSupplier.cs b/test/MarkdownParser.Test/Mocks/StringComponentSupplier.cs
index 1f7dd6d..41dad75 100644
--- a/test/MarkdownParser.Test/Mocks/StringComponentSupplier.cs
+++ b/test/MarkdownParser.Test/Mocks/StringComponentSupplier.cs
@@ -51,4 +51,19 @@ public string GetPlaceholder(string placeholderName)
     {
         return $"placeholderview:{placeholderName}";
     }
+
+    public string GetFencedCodeBlock(string content, string codeInfo)
+    {
+        return $"fencedcodeview>|({codeInfo})|{content}|<fencedcodeview";
+    }
+
+    public string GetIndentedCodeBlock(string content)
+    {
+        return $"indentedview>|{content}|<indentedview";
+    }
+
+    public string GetTextualLineBreak()
+    {
+        return Environment.NewLine;
+    }
 }
diff --git a/test/MarkdownParser.Test/Resources/Examples/Sections/codeblocks.md b/test/MarkdownParser.Test/Resources/Examples/Sections/codeblocks.md
new file mode 100644
index 0000000..8353e57
--- /dev/null
+++ b/test/MarkdownParser.Test/Resources/Examples/Sections/codeblocks.md
@@ -0,0 +1,8 @@
+```cs
+var myNumber = 1;
+myNumber++;
+```
+
+    the first line for IndentedCode code block
+    the second line for IndentedCode code block
+    the third line for IndentedCode code block
\ No newline at end of file

From aae441968ffa64c9c253b8722c9660df465f689f Mon Sep 17 00:00:00 2001
From: Toinedb <toine.de.boer@avivasolutions.nl>
Date: Sat, 2 Nov 2024 14:26:33 +0100
Subject: [PATCH 2/3] html support

---
 src/MarkdownParser/IViewSupplier.cs           | 14 +++-
 src/MarkdownParser/ViewFormatter.cs           |  7 +-
 src/MarkdownParser/ViewWriter.cs              | 23 ++++--
 .../MarkdownParserSectionsSpecs.cs            | 75 ++++++++++++++++---
 .../Mocks/StringComponentSupplier.cs          |  5 ++
 .../Resources/Examples/Sections/htmlblocks.md | 14 ++++
 6 files changed, 110 insertions(+), 28 deletions(-)
 create mode 100644 test/MarkdownParser.Test/Resources/Examples/Sections/htmlblocks.md

diff --git a/src/MarkdownParser/IViewSupplier.cs b/src/MarkdownParser/IViewSupplier.cs
index 1eff70f..c68b5c9 100644
--- a/src/MarkdownParser/IViewSupplier.cs
+++ b/src/MarkdownParser/IViewSupplier.cs
@@ -4,6 +4,12 @@ namespace MarkdownParser
 {
     public interface IViewSupplier<T>
     {
+        /// <summary>
+        /// get a textual line break
+        /// </summary>
+        /// <returns></returns>
+        string GetTextualLineBreak();
+
         /// <summary>
         /// a default text view
         /// </summary>
@@ -74,21 +80,21 @@ public interface IViewSupplier<T>
         T GetPlaceholder(string placeholderName);
 
         /// <summary>
-        /// a view that shows fenced code found in MD blocks starting with ```cs  
+        /// a view that shows fenced code (found in MD blocks starting with ```cs )
         /// </summary>
         /// <returns></returns>
         T GetFencedCodeBlock(string content, string codeInfo);
 
         /// <summary>
-        /// a view that shows indented code found in MD lines starting with at least 4 spaces
+        /// a view that shows indented code (found in MD lines starting with at least 4 spaces)
         /// </summary>
         /// <returns></returns>
         T GetIndentedCodeBlock(string content);
 
         /// <summary>
-        /// get a textual line break
+        /// a view that shows html content
         /// </summary>
         /// <returns></returns>
-        string GetTextualLineBreak();
+        T GetHtmlBlock(string content);
     }
 }
diff --git a/src/MarkdownParser/ViewFormatter.cs b/src/MarkdownParser/ViewFormatter.cs
index 11ae746..a1d67d4 100644
--- a/src/MarkdownParser/ViewFormatter.cs
+++ b/src/MarkdownParser/ViewFormatter.cs
@@ -75,12 +75,7 @@ private void WriteBlockToView(Block block, ViewWriter<T> writer, bool continueWi
                     writer.StartAndFinalizeIndentedCodeBlock(block.StringContent);
                     break;
                 case BlockTag.HtmlBlock:
-                    // TODO
-                    var currentBlock3 = block;
-                    break;
-                    //writer.StartBlock(BlockTag.Paragraph, block.StringContent.ToString());
-                    //WriteBlockToView(block.FirstChild, writer);
-                    //writer.FinalizeParagraphBlock();
+                    writer.StartAndFinalizeHtmlBlock(block.StringContent);
                     break;
                 case BlockTag.ReferenceDefinition:
                     // TODO
diff --git a/src/MarkdownParser/ViewWriter.cs b/src/MarkdownParser/ViewWriter.cs
index 2f3d6a4..78134f2 100644
--- a/src/MarkdownParser/ViewWriter.cs
+++ b/src/MarkdownParser/ViewWriter.cs
@@ -2,7 +2,6 @@
 using System.Diagnostics;
 using System.IO;
 using System.Linq;
-using System.Text;
 using CommonMark.Syntax;
 
 namespace MarkdownParser
@@ -187,18 +186,26 @@ public void StartAndFinalizeImageBlock(string targetUrl, string subscription, st
 
         public void StartAndFinalizeFencedCodeBlock(StringContent content, string blockInfo)
         {
-            var parsedContent = ParseStringContentToString(content);
+            var parsedContent = StringContentToStringWithLineBreaks(content);
 
-            var codeBlock = ViewSupplier.GetFencedCodeBlock(parsedContent, blockInfo);
-            StoreView(codeBlock);
+            var blockView = ViewSupplier.GetFencedCodeBlock(parsedContent, blockInfo);
+            StoreView(blockView);
         }
 
         public void StartAndFinalizeIndentedCodeBlock(StringContent content)
         {
-            var parsedContent = ParseStringContentToString(content);
+            var parsedContent = StringContentToStringWithLineBreaks(content);
 
-            var codeBlock = ViewSupplier.GetIndentedCodeBlock(parsedContent);
-            StoreView(codeBlock);
+            var blockView = ViewSupplier.GetIndentedCodeBlock(parsedContent);
+            StoreView(blockView);
+        }
+        
+        public void StartAndFinalizeHtmlBlock(StringContent content)
+        {
+            var parsedContent = StringContentToStringWithLineBreaks(content);
+
+            var blockView = ViewSupplier.GetHtmlBlock(parsedContent);
+            StoreView(blockView);
         }
 
         public void StartAndFinalizeThematicBreak()
@@ -253,7 +260,7 @@ private void StoreView(T view)
             }
         }
         
-        private string ParseStringContentToString(StringContent content)
+        private string StringContentToStringWithLineBreaks(StringContent content)
         {
             var stringWriter = new StringWriter();
             content.WriteTo(stringWriter);
diff --git a/test/MarkdownParser.Test/MarkdownParserSectionsSpecs.cs b/test/MarkdownParser.Test/MarkdownParserSectionsSpecs.cs
index d66bdc5..a9022e4 100644
--- a/test/MarkdownParser.Test/MarkdownParserSectionsSpecs.cs
+++ b/test/MarkdownParser.Test/MarkdownParserSectionsSpecs.cs
@@ -120,15 +120,70 @@ public void When_parsing_codeblocks_it_should_output_code_views()
         //-----------------------------------------------------------------------------------------------------------
         parseResult.Count.Should().Be(2);
 
-        var view0Parts = parseResult[0].Split('|');
-        view0Parts[0].Should().Be("fencedcodeview>");
-        view0Parts[1].Should().Be("(cs)");
-        view0Parts[2].Should().Be("var myNumber = 1;\r\nmyNumber++;");
-        view0Parts[3].Should().Be("<fencedcodeview");
-
-        var view1Parts = parseResult[1].Split('|');
-        view1Parts[0].Should().Be("indentedview>");
-        view1Parts[1].Should().Be("the first line for IndentedCode code block\r\nthe second line for IndentedCode code block\r\nthe third line for IndentedCode code block");
-        view1Parts[2].Should().Be("<indentedview");
+        var codeViewComponentsGroup0 = parseResult[0].Split('|');
+        codeViewComponentsGroup0.Length.Should().Be(4);
+        codeViewComponentsGroup0[0].Should().Be("fencedcodeview>");
+        codeViewComponentsGroup0[1].Should().Be("(cs)");
+        codeViewComponentsGroup0[2].Should().Be("var myNumber = 1;\r\nmyNumber++;");
+        codeViewComponentsGroup0[3].Should().Be("<fencedcodeview");
+
+        var codeViewComponentsGroup1 = parseResult[1].Split('|');
+        codeViewComponentsGroup1.Length.Should().Be(3);
+        codeViewComponentsGroup1[0].Should().Be("indentedview>");
+        codeViewComponentsGroup1[1].Should().Be("the first line for IndentedCode code block\r\nthe second line for IndentedCode code block\r\nthe third line for IndentedCode code block");
+        codeViewComponentsGroup1[2].Should().Be("<indentedview");
+    }
+    
+    [TestMethod]
+    public void When_parsing_htmlblocks_it_should_output_html_views()
+    {
+        //-----------------------------------------------------------------------------------------------------------
+        // Arrange
+        //-----------------------------------------------------------------------------------------------------------
+        var markdown = FileReader.ReadFile("Sections.htmlblocks.md");
+
+        var mockComponentSupplier = new StringComponentSupplier();
+        var parser = new MarkdownParser<string>(mockComponentSupplier);
+
+        var newLineIndicator = mockComponentSupplier.GetTextualLineBreak();
+
+        //-----------------------------------------------------------------------------------------------------------
+        // Act
+        //-----------------------------------------------------------------------------------------------------------
+        var parseResult = parser.Parse(markdown);
+
+        //-----------------------------------------------------------------------------------------------------------
+        // Assert
+        //-----------------------------------------------------------------------------------------------------------
+        parseResult.Count.Should().Be(2);
+
+        var htmlViewComponentsGroup0 = parseResult[0].Split('|');
+        htmlViewComponentsGroup0.Length.Should().Be(3);
+        htmlViewComponentsGroup0.First().Should().Be("htmlview>");
+        htmlViewComponentsGroup0.Last().Should().Be("<htmlview");
+
+        var firstHtmlViewContentGroup = htmlViewComponentsGroup0[1].Split(newLineIndicator);
+        firstHtmlViewContentGroup.Length.Should().Be(5);
+        firstHtmlViewContentGroup[0].Trim().Should().Be("<p>First text in block</p>");
+        firstHtmlViewContentGroup[1].Trim().Should().Be("<div>");
+        firstHtmlViewContentGroup[2].Trim().Should().Be("<h1>Header</h1>");
+        firstHtmlViewContentGroup[3].Trim().Should().Be("<p>Same block but nested element</p>");
+        firstHtmlViewContentGroup[4].Trim().Should().Be("</div>");
+
+        var htmlViewComponentsGroup1 = parseResult[1].Split('|');
+        htmlViewComponentsGroup1.Length.Should().Be(3);
+        htmlViewComponentsGroup1.First().Should().Be("htmlview>");
+        htmlViewComponentsGroup1.Last().Should().Be("<htmlview");
+
+        var secondHtmlViewContentGroup = htmlViewComponentsGroup1[1].Split(newLineIndicator);
+        secondHtmlViewContentGroup.Length.Should().Be(8);
+        secondHtmlViewContentGroup[0].Trim().Should().Be("<article>");
+        secondHtmlViewContentGroup[1].Trim().Should().Be("<header>");
+        secondHtmlViewContentGroup[2].Trim().Should().Be("<h1>A heading</h1>");
+        secondHtmlViewContentGroup[3].Trim().Should().Be("<p>Posted by John Doe</p>");
+        secondHtmlViewContentGroup[4].Trim().Should().Be("<p>Some additional information here</p>");
+        secondHtmlViewContentGroup[5].Trim().Should().Be("</header>");
+        secondHtmlViewContentGroup[6].Trim().Should().Be("<p>Lorem Ipsum...</p>");
+        secondHtmlViewContentGroup[7].Trim().Should().Be("</article>");
     }
 }
diff --git a/test/MarkdownParser.Test/Mocks/StringComponentSupplier.cs b/test/MarkdownParser.Test/Mocks/StringComponentSupplier.cs
index 41dad75..254fb8c 100644
--- a/test/MarkdownParser.Test/Mocks/StringComponentSupplier.cs
+++ b/test/MarkdownParser.Test/Mocks/StringComponentSupplier.cs
@@ -62,6 +62,11 @@ public string GetIndentedCodeBlock(string content)
         return $"indentedview>|{content}|<indentedview";
     }
 
+    public string GetHtmlBlock(string content)
+    {
+        return $"htmlview>|{content}|<htmlview";
+    }
+
     public string GetTextualLineBreak()
     {
         return Environment.NewLine;
diff --git a/test/MarkdownParser.Test/Resources/Examples/Sections/htmlblocks.md b/test/MarkdownParser.Test/Resources/Examples/Sections/htmlblocks.md
new file mode 100644
index 0000000..5c5295d
--- /dev/null
+++ b/test/MarkdownParser.Test/Resources/Examples/Sections/htmlblocks.md
@@ -0,0 +1,14 @@
+<p>First text in block</p>
+<div>
+   <h1>Header</h1>
+   <p>Same block but nested element</p>
+</div>
+
+<article>
+  <header>
+    <h1>A heading</h1>
+    <p>Posted by John Doe</p>
+    <p>Some additional information here</p>
+  </header>
+  <p>Lorem Ipsum...</p>
+</article>
\ No newline at end of file

From 74d714140e730673df6babe112a98b3ddfcb27b5 Mon Sep 17 00:00:00 2001
From: Toinedb <toine.de.boer@avivasolutions.nl>
Date: Sat, 2 Nov 2024 16:36:03 +0100
Subject: [PATCH 3/3] suport reference definitions

---
 src/MarkdownParser/IViewSupplier.cs           |  7 ++++
 .../MarkdownReferenceDefinition.cs            | 10 +++++
 src/MarkdownParser/ViewFormatter.cs           |  7 +++-
 src/MarkdownParser/ViewWriter.cs              | 34 ++++++++++++++++
 .../MarkdownParserSectionsSpecs.cs            | 40 +++++++++++++++++++
 .../Mocks/StringComponentSupplier.cs          | 16 ++++++++
 .../Examples/Sections/referencedefinitions.md |  7 ++++
 7 files changed, 119 insertions(+), 2 deletions(-)
 create mode 100644 src/MarkdownParser/MarkdownReferenceDefinition.cs
 create mode 100644 test/MarkdownParser.Test/Resources/Examples/Sections/referencedefinitions.md

diff --git a/src/MarkdownParser/IViewSupplier.cs b/src/MarkdownParser/IViewSupplier.cs
index c68b5c9..522bb28 100644
--- a/src/MarkdownParser/IViewSupplier.cs
+++ b/src/MarkdownParser/IViewSupplier.cs
@@ -96,5 +96,12 @@ public interface IViewSupplier<T>
         /// </summary>
         /// <returns></returns>
         T GetHtmlBlock(string content);
+
+        /// <summary>
+        /// a view that shows reference definitions ([link]s usually at the end of the document)
+        /// </summary>
+        /// <param name="markdownReferenceDefinitions">collection of Reference Definitions</param>
+        /// <returns></returns>
+        T GetReferenceDefinitions(IEnumerable<MarkdownReferenceDefinition> markdownReferenceDefinitions);
     }
 }
diff --git a/src/MarkdownParser/MarkdownReferenceDefinition.cs b/src/MarkdownParser/MarkdownReferenceDefinition.cs
new file mode 100644
index 0000000..5ab3892
--- /dev/null
+++ b/src/MarkdownParser/MarkdownReferenceDefinition.cs
@@ -0,0 +1,10 @@
+namespace MarkdownParser
+{
+    public class MarkdownReferenceDefinition
+    {
+        public string Label { get; set; }
+        public string Url { get; set; }
+        public string Title { get; set; }
+        public bool IsPlaceholder { get; set; }
+    }
+}
\ No newline at end of file
diff --git a/src/MarkdownParser/ViewFormatter.cs b/src/MarkdownParser/ViewFormatter.cs
index a1d67d4..851e480 100644
--- a/src/MarkdownParser/ViewFormatter.cs
+++ b/src/MarkdownParser/ViewFormatter.cs
@@ -17,12 +17,15 @@ public ViewFormatter(IViewSupplier<T> viewSupplier)
         public List<T> Format(Block markdownBlock)
         {
             WriteBlockToView(markdownBlock, _writer);
+            _writer.StartAndFinalizeReferenceDefinitions();
+
             return _writer.Flush();
         }
 
         public List<T> FormatSingleBlock(Block markdownBlock)
         {
             WriteBlockToView(markdownBlock, _writer, false);
+
             return _writer.Flush();
         }
 
@@ -36,6 +39,7 @@ private void WriteBlockToView(Block block, ViewWriter<T> writer, bool continueWi
             switch (block.Tag)
             {
                 case BlockTag.Document:
+                    _writer.RegisterReferenceDefinitions(block.Document.ReferenceMap);
                     WriteBlockToView(block.FirstChild, writer);
                     break;
                 case BlockTag.Paragraph:
@@ -78,8 +82,7 @@ private void WriteBlockToView(Block block, ViewWriter<T> writer, bool continueWi
                     writer.StartAndFinalizeHtmlBlock(block.StringContent);
                     break;
                 case BlockTag.ReferenceDefinition:
-                    // TODO
-                    var currentBlock4 = block;
+                    // ignore, handled at the end of document by _writer.StartAndFinalizeReferenceDefinitions()
                     break;
                 default:
                     throw new CommonMarkException("Block type " + block.Tag + " is not supported.", block);
diff --git a/src/MarkdownParser/ViewWriter.cs b/src/MarkdownParser/ViewWriter.cs
index 78134f2..2578803 100644
--- a/src/MarkdownParser/ViewWriter.cs
+++ b/src/MarkdownParser/ViewWriter.cs
@@ -11,6 +11,7 @@ public class ViewWriter<T>
         private IViewSupplier<T> ViewSupplier { get; }
         private List<T> WrittenViews { get; set; } = new List<T>();
         private Stack<ViewWriterCache<T>> Workbench { get; } = new Stack<ViewWriterCache<T>>();
+        private Dictionary<string, Reference> _referenceDefinitions;
 
         public ViewWriter(IViewSupplier<T> viewSupplier)
         {
@@ -35,6 +36,11 @@ public List<T> Flush()
             return collectedViews;
         }
 
+        public void RegisterReferenceDefinitions(Dictionary<string, Reference> referenceDefinitions)
+        {
+            _referenceDefinitions = referenceDefinitions;
+        }
+
         public void StartBlock(BlockTag blockType, string content = "")
         {
             Workbench.Push(new ViewWriterCache<T> { ComponentType = blockType });
@@ -208,6 +214,34 @@ public void StartAndFinalizeHtmlBlock(StringContent content)
             StoreView(blockView);
         }
 
+        public void StartAndFinalizeReferenceDefinitions()
+        {
+            if (_referenceDefinitions == null || _referenceDefinitions.Count == 0)
+            {
+                return;
+            }
+
+            var markdownReferenceDefinition = new List<MarkdownReferenceDefinition>();
+            foreach (var referenceDefinition in _referenceDefinitions)
+            {
+                if (referenceDefinition.Value == null)
+                {
+                    continue;
+                }
+
+                markdownReferenceDefinition.Add(new MarkdownReferenceDefinition()
+                {
+                    IsPlaceholder = referenceDefinition.Value.IsPlaceholder,
+                    Label = referenceDefinition.Value.Label,
+                    Title = referenceDefinition.Value.Title,
+                    Url = referenceDefinition.Value.Url
+                });
+            }
+
+            var view = ViewSupplier.GetReferenceDefinitions(markdownReferenceDefinition);
+            StoreView(view);
+        }
+
         public void StartAndFinalizeThematicBreak()
         {
             var separator = ViewSupplier.GetThematicBreak();
diff --git a/test/MarkdownParser.Test/MarkdownParserSectionsSpecs.cs b/test/MarkdownParser.Test/MarkdownParserSectionsSpecs.cs
index a9022e4..8500dba 100644
--- a/test/MarkdownParser.Test/MarkdownParserSectionsSpecs.cs
+++ b/test/MarkdownParser.Test/MarkdownParserSectionsSpecs.cs
@@ -186,4 +186,44 @@ public void When_parsing_htmlblocks_it_should_output_html_views()
         secondHtmlViewContentGroup[6].Trim().Should().Be("<p>Lorem Ipsum...</p>");
         secondHtmlViewContentGroup[7].Trim().Should().Be("</article>");
     }
+
+    [TestMethod]
+    public void When_parsing_reference_definitions_it_should_output_specific_views()
+    {
+        //-----------------------------------------------------------------------------------------------------------
+        // Arrange
+        //-----------------------------------------------------------------------------------------------------------
+        var markdown = FileReader.ReadFile("Sections.referencedefinitions.md");
+
+        var mockComponentSupplier = new StringComponentSupplier();
+        var parser = new MarkdownParser<string>(mockComponentSupplier);
+
+        //-----------------------------------------------------------------------------------------------------------
+        // Act
+        //-----------------------------------------------------------------------------------------------------------
+        var parseResult = parser.Parse(markdown);
+
+        //-----------------------------------------------------------------------------------------------------------
+        // Assert
+        //-----------------------------------------------------------------------------------------------------------
+        parseResult.Count.Should().Be(2);
+        parseResult[0].Should().StartWith("stackview>:+textview");
+
+        var referenceDefinitionsViewGroup = parseResult[1].Split('|');
+        referenceDefinitionsViewGroup.Length.Should().Be(4);
+        referenceDefinitionsViewGroup.First().Should().Be("referencedefinitions>");
+        referenceDefinitionsViewGroup.Last().Should().Be("<referencedefinitions");
+
+        var firstReferenceDefinition = referenceDefinitionsViewGroup[1].Split("*");
+        firstReferenceDefinition[0].Trim().Should().Be("False");
+        firstReferenceDefinition[1].Trim().Should().Be("LINK");
+        firstReferenceDefinition[2].Trim().Should().Be("title");
+        firstReferenceDefinition[3].Trim().Should().Be("/uri");
+
+        var secondReferenceDefinition = referenceDefinitionsViewGroup[2].Split("*");
+        secondReferenceDefinition[0].Trim().Should().Be("False");
+        secondReferenceDefinition[1].Trim().Should().Be("PORTTITOR NON QUAM");
+        secondReferenceDefinition[2].Trim().Should().Be("");
+        secondReferenceDefinition[3].Trim().Should().Be("https://lipsum.com/");
+    }
 }
diff --git a/test/MarkdownParser.Test/Mocks/StringComponentSupplier.cs b/test/MarkdownParser.Test/Mocks/StringComponentSupplier.cs
index 254fb8c..6711785 100644
--- a/test/MarkdownParser.Test/Mocks/StringComponentSupplier.cs
+++ b/test/MarkdownParser.Test/Mocks/StringComponentSupplier.cs
@@ -67,6 +67,22 @@ public string GetHtmlBlock(string content)
         return $"htmlview>|{content}|<htmlview";
     }
 
+    public string GetReferenceDefinitions(IEnumerable<MarkdownReferenceDefinition> markdownReferenceDefinitions)
+    {
+        var content = "referencedefinitions>";
+        foreach (var markdownReferenceDefinition in markdownReferenceDefinitions)
+        {
+            content += $"|{markdownReferenceDefinition.IsPlaceholder}";
+            content += $"*{markdownReferenceDefinition.Label}";
+            content += $"*{markdownReferenceDefinition.Title}";
+            content += $"*{markdownReferenceDefinition.Url}";
+        }
+
+        content += "|<referencedefinitions";
+
+        return content;
+    }
+
     public string GetTextualLineBreak()
     {
         return Environment.NewLine;
diff --git a/test/MarkdownParser.Test/Resources/Examples/Sections/referencedefinitions.md b/test/MarkdownParser.Test/Resources/Examples/Sections/referencedefinitions.md
new file mode 100644
index 0000000..75933d9
--- /dev/null
+++ b/test/MarkdownParser.Test/Resources/Examples/Sections/referencedefinitions.md
@@ -0,0 +1,7 @@
+[link]: /uri "title"
+
+Vestibulum dictum lacinia lacus, at ornare quam consequat ultrices.
+Nam quam leo, aliquet in luctus in, [porttitor non quam]. Donec tincidunt augue nisi,
+sed pellentesque nisl porttitor vel.
+
+[porttitor non quam]: https://lipsum.com/
\ No newline at end of file