jekyll-zettel 0.6.8 → 0.7.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 29649f733d538f436b123e0d30fecdd10128e7818fbad3c5191939ed2f350f8c
-  data.tar.gz: bf96f17c9f7042a03e070b3743875acb8617c7dc3bbf14dd8ee4c6ba60e6c537
+  metadata.gz: 1b6da890e13652de4456d21ad0d8f880dff08e04e1a26fab37a6d14cb9ba81bf
+  data.tar.gz: f7bbaa9687435ed01409d8fde19f71e7ca19020e25c60eb261ba49c3ff938518
 SHA512:
-  metadata.gz: 5323a2ec3f2dcb617dff426d5a2e5201ca12092efff07fe8350eaad564358fbfbbcc2618cb09d985fd3b407416afb6b92d4997bb2e5444e468ff385fc9eac2e5
-  data.tar.gz: '06979ee7a379a8d22a5d66a3b841d84f048412c489d48dda6771f2694910d9d75cd3feb7928cffa8d770bfe79057c0c6a949e642c16d2894112270463c137280'
+  metadata.gz: a4d14c20181512d33bbf3bec360cb9a8ab7e5582d4f8ba38d8cfaee5558d604c3685501ad08db20a3c01c48cdbec8a638f29a9f67d055eaaeba8928f66f14a32
+  data.tar.gz: 51f95e04a356377ac683e0421c587d263d830acd55d1396be9f10b4cdf2b35fbc4124e52c17b7b99ae30340e54c26ea127ea803e67d39eacefc59d4c541d0132

data/CHANGELOG.md

@@ -1,3 +1,12 @@
 ## 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

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,90 @@
+module Kramdown
+  module Parser
+    # Kramdown Parser mit inline Zitationen
+    class Citedown < Kramdown
+
+      def initialize(source, options)
+        super
+        @citeproc = Jekyll.sites[0].config['citeproc']
+        @references = Jekyll.sites[0].data['references']
+        @zettel = Jekyll.sites[0].data['zettelkasten']
+        @span_parsers.unshift(:citation)
+      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
+          add_error(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']]['description'],
+          'style' => 'box-shadow: initial; border: none;'
+        }
+        link = Element.new(:a, nil, attributes, location: start_line_number)
+
+        link.children << Element.new(:raw, "<sup>#{citation}</sup>")
+        @tree.children << link
+      end
+
+      def add_error(cite_key)
+        Jekyll.logger.warn 'Zettel:', "Missing entry for cite-key @#{cite_key}"
+        @tree.children << Element.new(:raw, "<span class=\"error\">Missing entry for cite-key @#{cite_key}</span>")
+      end
+
+      define_parser(:citation, CITATION, '\[@')
+
+    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

@@ -28,7 +28,7 @@ module Jekyll
         @site.data['tags'][parts[:slug]] = {
           'slug' => parts[:slug],
           'tag' => doc.data['tag'] || 'Missing @tag',
-          'label' => doc.data['title'] || 'Missing @title',
+          'title' => doc.data['title'] || 'Missing @title',
           'description' => doc.data['description'] || 'Missing @description',
           'tags' => doc.data['tags']
         }

data/lib/jekyll/zettel/version.rb

@@ -1,5 +1,5 @@
 module Jekyll
   module Zettel
-    VERSION = '0.6.8'.freeze
+    VERSION = '0.7.1'.freeze
   end
 end

data/lib/jekyll/zettel/zettelkasten.rb

@@ -45,7 +45,7 @@ module Jekyll
         doc.data['tags'].each { |tag|
           @site.data['tag2zettel'][tag] = [] unless @site.data['tag2zettel'].key?(tag)
 
-          @site.data['tag2zettel'][tag] << doc.data['zettel']
+          @site.data['tag2zettel'][tag] << doc.data['id']
         }
       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
@@ -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.8
+  version: 0.7.1
 platform: ruby
 authors:
 - Michael Gerzabek
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-01-28 00:00:00.000000000 Z
+date: 2022-02-21 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