From 63f50d84df2fb9879ddee5643d221792606a5c8a Mon Sep 17 00:00:00 2001
From: Apoorv Khandelwal <mail@apoorvkh.com>
Date: Wed, 30 Nov 2022 14:17:37 -0800
Subject: [PATCH] Added comments to textprocessing.html

---
 layouts/partials/textprocessing.html | 11 +++++++++++
 1 file changed, 11 insertions(+)

diff --git a/layouts/partials/textprocessing.html b/layouts/partials/textprocessing.html
index 24c65d07f..bc8d7d32a 100644
--- a/layouts/partials/textprocessing.html
+++ b/layouts/partials/textprocessing.html
@@ -26,29 +26,39 @@
 
   {{if not $incode}}
 
+    <!-- remove link delimiters -->
     {{$inner := . | strings.TrimPrefix "!" | strings.TrimPrefix "[[" | strings.TrimSuffix "]]" }}
+    <!-- split from alias -->
     {{$split := split $inner "|"}}
+    <!-- separate link path -->
     {{$path := index $split 0}}
 
     {{$reference := split $path "#"}}
+    <!-- path with heading link removed -->
     {{$title := index $reference 0}}
+    <!-- $display is hyperlink display text -->
+    <!-- use alias, else title -->
     {{$display := default $title (index $split 1)}}
+    <!-- remove subfolder from title -->
     {{$display := index (last 1 (split $display "/")) 0}}
 
     {{$curpage := $page.GetPage $title}}
     {{$relpath := relURL $path}}
 
+    <!-- If path to Hugo page -->
     {{if not (eq $curpage.String "nopPage") }}
       {{$block := default "" (index $reference 1)}}
       {{$block = strings.TrimRight "/" (cond (eq $block "") $block (printf "#%s" $block)) | urlize | lower}}
       {{$href := strings.TrimRight "/" $curpage.RelPermalink}}
       {{$link := printf "<a href=\"%s%s\" rel=\"noopener\" class=\"internal-link\" data-src=\"%s\">%s</a>" $href $block $href $display}}
       {{$content = replace $content . $link}}
+    <!-- If path to existing file -->
     {{else if fileExists $relpath}}
       {{$splitpath := split $relpath "/"}}
       {{$dirname := first (sub (len $splitpath) 1) $splitpath | path.Join | urlize}}
       {{$basename := index (last 1 $splitpath) 0}}
       {{$href := printf "/%s/%s" $dirname $basename}}
+      <!-- Embedded? -->
       {{if (hasPrefix . "!")}}
         {{$width := index $split 1}}
         {{$link := printf "<img src=\"%s\" width=\"%s\" />" $href (default "auto" $width)}}
@@ -57,6 +67,7 @@
         {{$link := printf "<a href=\"%s\" rel=\"noopener\" class=\"internal-link\">%s</a>" $href $display}}
         {{$content = replace $content . $link}}
       {{end}}
+    <!-- Broken path -->
     {{else}}
       {{$link := printf "<a class=\"internal-link broken\">%s</a>" $display}}
       {{$content = replace $content . $link}}