Merge pull request #9 from eScholarship/6-footnotes-endnotes-more-info

more footnote rendering logic updates

Author: nicktahani

batch_convert.sh

@@ -17,6 +17,11 @@ fi
 # Create output directory if it doesn't exist
 mkdir -p "$OUTPUT_DIR"
 
+# Copy CSS file to output directory (for uploading)
+if [ -f "templates/styles.css" ]; then
+    cp templates/styles.css "$OUTPUT_DIR/styles.css"
+fi
+
 count=0
 total=$(find "$INPUT_DIR" -name "*.xml" | wc -l)
 

lib/ucpec_static/tei/elements/note.rb

@@ -15,9 +15,6 @@ class Note < UCPECStatic::TEI::Nodes::Element
 
         on_xml_attribute!(:type) do |value|
           @type = value
-          # Only capture inline footnotes, or endnotes with corresp (noteref-style)
-          # Endnotes without corresp (secref-style) render in place
-          @counts_as_footnote = value == "footnote"
           @is_endnote = value == "endnote"
         end
 
@@ -29,6 +26,9 @@ class Note < UCPECStatic::TEI::Nodes::Element
           @corresp = value
         end
 
+        after_process_xml_attributes :set_counts_as_footnote!
+        after_process_xml_attributes :add_acknowledgement_class!
+
         # @return [String, nil]
         attr_reader :target
 
@@ -43,37 +43,64 @@ class Note < UCPECStatic::TEI::Nodes::Element
 
         alias is_endnote? is_endnote
 
-        # Capture noteref-style endnotes (with corresp) but not secref-style (without corresp)
-        def counts_as_footnote?
-          super || (is_endnote? && corresp.present?)
+        # Check if this note is inside a back element
+        def in_back_matter?
+          ancestors.any? { |ancestor| ancestor.is_a?(BackMatter) }
         end
 
-        # Should add anchor/backlink for notes that will be captured (have backlink target)
-        # Secref-style endnotes (without corresp) render in place without backlinks
-        def should_add_anchor?
-          counts_as_footnote? && has_backlink_target?
+        # Capture inline notes that are actually referenced
+        # Endnotes always render in place (never captured)
+
+        private
+
+        # Set counts_as_footnote based on type and corresp
+        # Capture footnotes that should be moved to the bottom
+        def set_counts_as_footnote!
+          # type="footnote" - always capture (inline footnotes)
+          # type="note" with corresp - capture (referenced notes)
+          # type="note" without corresp - render in place (chapter acknowledgements)
+          # type="endnote" - never capture, always render in place
+          if type == "footnote"
+            @counts_as_footnote = true
+          elsif type == "note"
+            @counts_as_footnote = corresp.present?
+          else
+            @counts_as_footnote = false
+          end
+        end
+
+        # Add a CSS class for acknowledgement notes (unreferenced notes)
+        def add_acknowledgement_class!
+          if type == "note" && corresp.blank?
+            html_classes << "acknowledgement-note"
+          end
         end
 
-        # Check if this note has a backlink target (corresp for endnotes, or is a footnote)
-        def has_backlink_target?
-          corresp.present? || type == "footnote"
+        # Add anchor for all notes with an id (for bidirectional linking)
+        def should_add_anchor?
+          target.present?
         end
 
-        private
+        # Add backlink if note has corresp OR is a captured footnote
+        # Endnotes in back matter without corresp (secref-style) won't have backlinks
+        def has_backlink?
+          corresp.present? || (counts_as_footnote? && target.present?)
+        end
 
         # @return [void]
         def add_anchor!
           # :nocov:
           return if target.blank?
           # :nocov:
 
-          # For noteref/endnote with corresp: corresp points to the ref's id
-          # For fnoteref/footnote: use target (same as note's id)
-          ref_id = corresp.presence || target
-
           html_builder.nav(class: "footnote--nav") do
             html_builder.a(nil, name: target, class: "footnote--anchor")
-            html_builder.a("Back", href: "##{ref_id}-ref", class: "footnote--backlink", title: "Return to previous location in text")
+
+            # Only add backlink if corresp exists (bidirectional linking)
+            if has_backlink?
+              ref_id = corresp.presence || target
+              html_builder.a("Back", href: "##{ref_id}-ref", class: "footnote--backlink", title: "Return to previous location in text")
+            end
           end
         end
       end

templates/styles.css

@@ -226,28 +226,35 @@ footer.footnotes li {
   margin: 1.5rem 0;
 }
 
-footer.footnotes > ul > li > aside {
+/* Shared styles for all notes (in footer and in-place) */
+footer.footnotes > ul > li > aside,
+aside[data-tei-tag="note"] {
   background: white;
   border-left: 4px solid;
   padding: 1.25rem;
   border-radius: 0 6px 6px 0;
   box-shadow: 0 2px 6px rgba(0,0,0,0.08);
   transition: all 0.3s ease;
+  margin: 1.5rem 0;
 }
 
-footer.footnotes > ul > li > aside:hover {
+
+footer.footnotes > ul > li > aside:hover,
+aside[data-tei-tag="note"]:hover {
   box-shadow: 0 4px 12px rgba(0,0,0,0.15);
   transform: translateX(4px);
 }
 
-footer.footnotes aside p {
+footer.footnotes aside p,
+aside[data-tei-tag="note"] p {
   margin: 0.5rem 0;
   font-size: 0.95rem;
   line-height: 1.7;
 }
 
 /* Reset nested asides to not have the border */
-footer.footnotes aside aside {
+footer.footnotes aside aside,
+aside[data-tei-tag="note"] aside {
   border-left: none;
   padding: 0;
   box-shadow: none;
@@ -265,7 +272,8 @@ footer.footnotes aside aside {
 }
 
 /* Hide backlinks in nested asides since they point to the same footnote */
-footer.footnotes aside aside .footnote--nav {
+footer.footnotes aside aside .footnote--nav,
+aside[data-tei-tag="note"] aside .footnote--nav {
   display: none;
 }
 
@@ -294,6 +302,21 @@ footer.footnotes aside aside .footnote--nav {
   transform: translateX(-3px);
 }
 
+/* Special styling for acknowledgement notes */
+aside.acknowledgement-note {
+  background: #f8f9fa;
+  border-left-color: #000;
+  font-style: italic;
+}
+
+aside.acknowledgement-note nav {
+  border-bottom: none;
+}
+
+aside.acknowledgement-note p {
+  font-size: 0.9rem;
+}
+
 /* Footnote reference links in text */
 section[data-tei-tag="body"] a[data-tei-tag="ref"] {
   color: #e74c3c;