jekyll-hyperlinkify-glossary 0.1.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 41e9782180bc4ffd77b76f183662c4e31699de31caa970d8df05f0ea35d12ac1
+  data.tar.gz: cc88cf2676d7d04ca84f91087e634978fcef9ad9bff420aa28568c84f89b744b
+SHA512:
+  metadata.gz: 2bd4a877e1c070f42cb71d35e90cc83795fd1b8850684d9e3380c90efaa8a2c2232dd6302f744060ec639b3cfc39d16c6aaf79d2f11cfcd0d6b54fc4fc69d925
+  data.tar.gz: ff77b9cc5540c1a73ff237473e6c6657d2e2377a30bcaa8868cc796529f401141da18149cb82b5f39543751df79ced0a199ca015bf4ced04db157640c61c4344

data/lib/hooks/enrich_documents_with_glossary.rb

@@ -0,0 +1,15 @@
+# Enrich all documents and pages with an array of all glossary entries and their synonyms
+Jekyll::Hooks.register :site, :post_read do |site|
+    puts 'Enriching documents with glossary collection'
+    glossary_entries = []
+    site.collections["glossary"].docs.each do |item|
+      next_glossary_entry = [[item.url, item.data['title']],item.data['synonyms']].compact.reduce([], :|)
+      glossary_entries.push next_glossary_entry.map(&:downcase )
+    end
+    site.documents.each{ |document|
+      document.data['glossary_entries'] = glossary_entries
+    }
+    site.pages.each{ |document|
+      document.data['glossary_entries'] = glossary_entries
+    }
+end

data/lib/jekyll-hyperlinkify-glossary.rb

@@ -0,0 +1,65 @@
+require 'jekyll'
+require 'hooks/enrich_documents_with_glossary'
+
+# Get all glossary entries from the page an replace all terms with appropriate hyperlinks
+module Jekyll 
+  class HyperlinkGlossaryEntries
+      BODY_START_TAG = "<body"
+      OPENING_BODY_TAG_REGEX = %r!<body(.*)>\s*!
+      class << self
+          # Replace all oocurances of glossary entries with a hyperlink.
+          def hyperlinkify(document)
+              @glossary_entries = document.data["glossary_entries"]
+              if @glossary_entries.nil?
+                  puts "This document has no glossary entries: " + document.data["title"].to_s
+                  return
+              end
+              @test_word = "icf"
+              @test_array = ["icf","inklusion"]
+              @test_url = "/glossary/icf.html"
+              document.output = if document.output.include? BODY_START_TAG
+                                  process_document(document)
+                              else
+                                  process_html_body(document.output)
+                              end
+
+          end
+
+          # Determine if the content should be processed.
+          def processable?(document)
+              (document.is_a?(Jekyll::Page) || document.write?) &&
+              (document.output_ext == ".html" || document.permalink&.end_with?("/")) &&
+              (document.data["jekyll-hyperlink-glossary"] != false)
+          end
+
+          private
+
+          # Process html content which has an body opening tag
+          def process_document(document)
+              head, opener, tail = document.output.partition(OPENING_BODY_TAG_REGEX)
+              body_content, *rest = tail.partition("</body>")
+              
+              processed_markup = process_html_body(body_content, document.data["title"])
+
+              document.output = String.new(head) << opener << processed_markup << rest.join
+          end
+
+          # Process every word of content and replace glossary entries
+          def process_html_body(html, title)
+              @glossary_entries.each do |glossary_entry|   
+                  if glossary_entry[1].to_s != title.to_s.downcase
+                      exclude_regex="\\b(?!<(h\\d|a).*>)(?!.*<\/(h\\d|a)>)(?!.html)"
+                      glossary_entry_regex = Regexp.new("\\b"+glossary_entry.drop(1).join(exclude_regex+"|")+exclude_regex, true)
+                      first_half_of_hyperlink = "<a href=\"#{ glossary_entry[0] }\">"
+                      html = html.gsub(glossary_entry_regex, first_half_of_hyperlink+ '\0</a>')
+                  end
+              end
+              html
+          end
+      end
+  end
+end
+
+Jekyll::Hooks.register %i[documents pages], :post_render do |document|
+  Jekyll::HyperlinkGlossaryEntries.hyperlinkify(document) if Jekyll::HyperlinkGlossaryEntries.processable?(document)
+end

metadata

@@ -0,0 +1,58 @@
+--- !ruby/object:Gem::Specification
+name: jekyll-hyperlinkify-glossary
+version: !ruby/object:Gem::Version
+  version: 0.1.2
+platform: ruby
+authors:
+- Marc Schmidt
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2021-06-09 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: jekyll
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.7'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.7'
+description: A Jekyll gem to replace glossary entries in html with hyperlinks
+email:
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/hooks/enrich_documents_with_glossary.rb
+- lib/jekyll-hyperlinkify-glossary.rb
+homepage: https://github.com/MarcSchmidt/jekyll-hyperlinkify-glossary
+licenses:
+- MIT
+metadata: {}
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.4.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.2.19
+signing_key:
+specification_version: 4
+summary: A Jekyll gem to replace glossary entries in html with hyperlinks
+test_files: []