jekyll-zettel 0.6.10 → 0.7.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 80c15ccd85f0ce14846f04fab4b2b920dc94b2fae988de1ae795e5faac987c80
-  data.tar.gz: d358e7f2535c707f154ca46964afc366bdceb8aea3867a7c2b9df27d6edef370
+  metadata.gz: 6dc8ae8e1d8e9f8b35d24f2a711c77e1cac2bf42a8a7b3dd33d363a23fee5518
+  data.tar.gz: 79ef605ddec8abf5b96258b743f5c15772ffcf4c029d32d67dd45c654442fe1f
 SHA512:
-  metadata.gz: bac8b0c9347dd1c8a44694602936dc0aa3a7d5706f121aa4d3ce6861f5cd83063086e23e4e8aabbb55fc62944ba451121832080ae8b0cf157054c0d69e70f7e3
-  data.tar.gz: 200801da51afae64af29e3a00bd424aeb5f8ab71f67389480552f41d52868c9d674d5aa0386f14952f05e1cc27d8ee2b283b8b7328c9e7c94392a2c917fd6e3c
+  metadata.gz: 49dfaef4d13597586bd7c198440e2bf81de9beecf9820b75321925fac61b2dd2390546f4e62510e94de8831eff84402c352e347e14fdf58f742b9ec83b36af9a
+  data.tar.gz: 41b2e42ac0ab78a5f8b28f3261aaa502e3d2fd42ddbd22e1b7fdbe0a80ef04600f6ffa022e0fb274d7af8725b6ef65b545277915d59ed80559156606429dae8c

data/CHANGELOG.md

@@ -1,3 +1,19 @@
 ## 0.1.0
 
 - Initial Import
+
+## 0.7.x
+
+- Added inline citations
+
+### 0.7.1
+
+- Changed inline citation regex to be compatible with pandoc [@<key>…]
+- Emit warning when no reference for given _cite-key_ is found
+
+### 0.7.2
+
+- Objektkatalog aliases.json mit Mapping von Tag Klarnamen und Alternativen wird jetzt generiert
+- Log-Level beim Serialisieren der Objektkataloge auf debug gestellt
+- Jetzt werden auch Links auf Keywords erkannt und automatisch mit der jeweiligen Glosse verlinkt
+- 

data/jekyll-zettel.gemspec

@@ -31,4 +31,5 @@ Gem::Specification.new do |spec|
   spec.add_runtime_dependency 'csl-styles', '>= 2.0', '< 3.0'
   spec.add_runtime_dependency 'fileutils', '>= 1.4', '< 2.0'
   spec.add_runtime_dependency 'jekyll', '>= 3.8', '< 5.0'
+  spec.add_runtime_dependency 'kramdown', '>=2.0', '< 3.0'
 end

data/lib/jekyll/zettel/citedown.rb

@@ -0,0 +1,125 @@
+module Kramdown
+  module Parser
+    # Kramdown Parser mit inline Zitationen
+    class Citedown < Kramdown
+
+      def initialize(source, options)
+        super
+        site = Jekyll.sites[0]
+
+        @citeproc = site.config['citeproc']
+        @references = site.data['references']
+        @keywords = site.data['aliases']
+        @zettel = site.data['zettelkasten']
+
+        @span_parsers.unshift(:citation, :keyword)
+
+        # So geht’s mit <i>, <b>, <em> und <strong> weiter
+        # @span_parsers.delete(:emphasis)
+      end
+
+      CITATION = /\[@([\w,:]+)(;\s*(.*))?\]/.freeze
+
+      def parse_citation
+        start_line_number = @src.current_line_number
+        @src.pos += @src.matched_size
+
+        cite_key = @src[1]
+        note = @src[3]
+
+        if @references.key?(cite_key)
+          add_citation(cite_key, note, start_line_number)
+        else
+          log_warning('cite-key', cite_key)
+        end
+      end
+
+      def add_citation(cite_key, note, start_line_number)
+        citation = @citeproc.render :citation, id: cite_key, locator: note, label: :note
+        attributes = {
+          'href' => "/zettel/#{@references[cite_key]['id']}/",
+          'title' => @zettel[@references[cite_key]['id']]['title'],
+          'class' => 'citation'
+        }
+        link = Element.new(:a, nil, attributes, location: start_line_number)
+
+        link.children << Element.new(:raw, "<sup>#{citation}</sup>")
+        @tree.children << link
+      end
+
+      define_parser(:citation, CITATION, '\[@')
+
+      KEYWORD = /\[#([\w]+)\]/.freeze
+
+      def parse_keyword
+        start_line_number = @src.current_line_number
+        @src.pos += @src.matched_size
+
+        keyword = @src[1]
+        if @keywords.key?(keyword)
+          add_keyword(keyword, start_line_number)
+        else
+          log_warning('keyword', keyword)
+        end
+      end
+
+      def add_keyword(keyword, start_line_number)
+        attributes = {
+          'href' => "/glosse/#{@keywords[keyword]['slug']}/",
+          'title' => @keywords[keyword]['tag'],
+          'class' => 'keyword'
+        }
+        link = Element.new(:a, nil, attributes, location: start_line_number)
+
+        link.children << Element.new(:raw, keyword)
+        @tree.children << link
+      end
+
+      define_parser(:keyword, KEYWORD, '\[#')
+
+      def log_warning(catalog, entry)
+        Jekyll.logger.warn 'Zettel:', "Missing entry for #{catalog} `#{entry}`"
+        @tree.children << Element.new(:raw, "<span class=\"error\">Missing entry for #{catalog} `#{entry}`</span>")
+      end
+
+    end
+  end
+end
+# options => {
+#   :template => "",
+#   :auto_ids => true,
+#   :auto_id_stripping => false,
+#   :auto_id_prefix => "",
+#   :transliterated_header_ids => false,
+#   :parse_block_html => true,
+#   :parse_span_html => true,
+#   :html_to_native => false,
+#   :link_defs => {},
+#   :footnote_nr => 1,
+#   :entity_output => :as_char,
+#   :toc_levels => [1, 2, 3, 4, 5, 6],
+#   :line_width => 72,
+#   :latex_headers => ["section", "subsection", "subsubsection", "paragraph", "subparagraph", "subparagraph"],
+#   :smart_quotes => ["lsquo", "rsquo", "ldquo", "rdquo"],
+#   :typographic_symbols => {},
+#   :remove_block_html_tags => true,
+#   :remove_span_html_tags => false,
+#   :header_offset => 0,
+#   :syntax_highlighter => :rouge,
+#   :syntax_highlighter_opts => {
+#     :default_lang => "plaintext",
+#     :guess_lang => true
+#   },
+#   :math_engine => :mathjax,
+#   :math_engine_opts => {},
+#   :footnote_backlink => "▲",
+#   :footnote_backlink_inline => false,
+#   :footnote_prefix => "",
+#   :remove_line_breaks_for_cjk => false,
+#   :forbidden_inline_options => [:template],
+#   :input => "Citedown",
+#   :hard_wrap => false,
+#   :guess_lang => true,
+#   :show_warnings => false,
+#   :coderay => {}
+# }

data/lib/jekyll/zettel/reference.rb

@@ -4,9 +4,10 @@ module Jekyll
     class Reference < Liquid::Tag
 
       def render(context)
-        return unless context.registers[:page].key?('citekey')
+        doc = context.registers[:page]
+        return unless doc.key?('reference') && doc['reference'].key?('citation-key')
 
-        context.registers[:site].config['citeproc'].render :bibliography, id: context.registers[:page]['citekey']
+        context.registers[:site].config['citeproc'].render :bibliography, id: doc['reference']['citation-key']
       end
     end
   end

data/lib/jekyll/zettel/references.rb

@@ -42,13 +42,29 @@ module Jekyll
       end
 
       def register_reference(doc, file)
-        if doc.data['reference'].include?('id')
-          @site.data['references'][doc.data['reference']['id']] = doc.data['reference']
+        if doc.data['reference'].include?('citation-key') && doc.data['reference'].include?('id')
+          #
+          # Citeproc erwartet sich eine id, die dem citation-key entspricht,
+          # in den References (references.json) brauche ich jedoch die id des
+          # Zettels, um in diversen Anwendungen darauf referenzieren zu können.
+          # Also wird die id des Zettels zwischengespeichert und für die
+          # Registrierung bei Citeproc durch den citation-key ersetzt.
+          #
+          # ACHTUNG!
+          # Beim Übernehmen einer Reference aus Citavi muss die id manuell auf
+          # die id des Zettels gesetzt werden!
+          #
+          # store
+          id = doc.data['reference']['id']
+          @site.data['references'][doc.data['reference']['citation-key']] = doc.data['reference']
+          # set id for Citeproc and register Item
+          doc.data['reference']['id'] = doc.data['reference']['citation-key']
           @site.config['citeproc'].register doc.data['reference']
-          doc.data['citekey'] = doc.data['reference']['id']
+          # restore
+          doc.data['reference']['id'] = id
         else
-          Jekyll.logger.warn LOG_KEY, 'missing property @id'
-          Jekyll.logger.warn '', "./#{file}"
+          Jekyll.logger.warn LOG_KEY, 'missing property @citation-key'
+          Jekyll.logger.warn '', file
         end
       end
 

data/lib/jekyll/zettel/tags.rb

@@ -10,17 +10,26 @@ module Jekyll
 
       def generate(site)
         @site = site
+
+        @site.data['aliases'] = {}
         @site.data['tags'] = {}
         @site.data['tag2glosse'] = {}
 
-        site.pages.each do |page|
+        register
+
+        write_catalog 'aliases'
+        write_catalog 'tags'
+        write_catalog 'tag2glosse'
+      end
+
+      def register
+        @site.pages.each do |page|
           next unless SLUG_FORMAT.match?(page.path.to_s)
 
           register_tag(page)
+          register_tags(page)
+          register_aliases(page)
         end
-
-        write_catalog 'tags'
-        write_catalog 'tag2glosse'
       end
 
       def register_tag(doc)
@@ -33,17 +42,33 @@ module Jekyll
           'tags' => doc.data['tags']
         }
         doc.data['slug'] = parts[:slug]
-        register_tags(doc)
+      end
+
+      def register_aliases(doc)
+        @site.data['aliases'][doc.data['tag']] = {
+          'slug' => doc.data['slug'],
+          'tag' => doc.data['tag'],
+          'description' => doc.data['description']
+        }
+        return unless doc.data.key?('aliases')
+
+        doc.data['aliases'].each do |item|
+          @site.data['aliases'][item] = {
+            'slug' => doc.data['slug'],
+            'tag' => doc.data['tag'],
+            'description' => doc.data['description']
+          }
+        end
       end
 
       def register_tags(doc)
         return unless doc.data.key?('tags')
 
-        doc.data['tags'].each { |tag|
+        doc.data['tags'].each do |tag|
           @site.data['tag2glosse'][tag] = [] unless @site.data['tag2glosse'].key?(tag)
 
           @site.data['tag2glosse'][tag] << doc.data['slug']
-        }
+        end
       end
     end
   end

data/lib/jekyll/zettel/version.rb

@@ -1,5 +1,5 @@
 module Jekyll
   module Zettel
-    VERSION = '0.6.10'.freeze
+    VERSION = '0.7.2'.freeze
   end
 end

data/lib/jekyll/zettel.rb

@@ -3,6 +3,7 @@ require 'securerandom'
 require 'fileutils'
 require 'citeproc'
 require 'csl/styles'
+require 'kramdown/parser/kramdown'
 
 module Jekyll
   # Jekyll zettel to your service
@@ -15,7 +16,7 @@ module Jekyll
     class Error < StandardError; end
 
     def write_catalog(object)
-      Jekyll.logger.info LOG_KEY, "Created references in `#{@site.in_dest_dir('.objects', "#{object}.json")}`"
+      Jekyll.logger.debug LOG_KEY, "Created references in `#{@site.in_dest_dir('.objects', "#{object}.json")}`"
 
       page = Jekyll::PageWithoutAFile.new(@site, @site.source, '.objects', "#{object}.json").tap do |file|
         file.content = JSON.pretty_generate(@site.data[object.to_s])
@@ -89,6 +90,7 @@ end
 require 'jekyll/commands/scaffold'
 require 'jekyll/zettel/akteur'
 require 'jekyll/zettel/blatt'
+require 'jekyll/zettel/citedown'
 require 'jekyll/zettel/globals'
 require 'jekyll/zettel/glosse'
 require 'jekyll/zettel/reference'
@@ -98,3 +100,4 @@ require 'jekyll/zettel/timeline'
 require 'jekyll/zettel/zeitleiste'
 require 'jekyll/zettel/zettel'
 require 'jekyll/zettel/zettelkasten'
+

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: jekyll-zettel
 version: !ruby/object:Gem::Version
-  version: 0.6.10
+  version: 0.7.2
 platform: ruby
 authors:
 - Michael Gerzabek
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-02-09 00:00:00.000000000 Z
+date: 2022-03-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: citeproc-ruby
@@ -90,6 +90,26 @@ dependencies:
     - - "<"
       - !ruby/object:Gem::Version
         version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: kramdown
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '2.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '2.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '3.0'
 description: Coming soon…
 email:
 - michael.gerzabek@gmail.com
@@ -115,6 +135,7 @@ files:
 - lib/jekyll/zettel.rb
 - lib/jekyll/zettel/akteur.rb
 - lib/jekyll/zettel/blatt.rb
+- lib/jekyll/zettel/citedown.rb
 - lib/jekyll/zettel/globals.rb
 - lib/jekyll/zettel/glosse.rb
 - lib/jekyll/zettel/reference.rb