jekyll-scholar 5.7.0 → 5.7.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 5b7e5e1c9176f9047d2e7492f07b212bc6e247e7
-  data.tar.gz: 106254e255857e66c6e5b81ebbb95c74876c9fe8
+  metadata.gz: b87845c10bdf8d4c729fa3e2543aece9221b8cb0
+  data.tar.gz: 8c0098182b2c0a89b2a5957d48040c3d44c94e71
 SHA512:
-  metadata.gz: 6f2d2d642250db134aa6a63676ee588d9092cabf66e185c124275864e14df07316ee0121df3d0b0c5e59ee8e2bc4df23160eb589564f9bed00d4fb546f0bc95b
-  data.tar.gz: ffffd80dabf38c39cebdd07a7052ede50a7cc30e96f48a7da4e340e7d231f2a2794ad08b0270bf16f1d8e5e536f6993ec08f62f67c59c5b673fe17f3bc2ddb3e
+  metadata.gz: e3974e0b5e3097b099b6ec97eaa61826e6c8c848adb19711297eae4a25c8a419eda57b80eca928f84513e61ed4868695186d89c989c2968f2c892a27e310fe32
+  data.tar.gz: 7ce8a8fa7a7362c50670a48d7a509ae866c0912e363b76cebb3e852c10ae0428e93bf9601b8d7e282aaff100b701851160f40abf24ba779f0de14a23cf9d1d94

data/README.md

@@ -25,18 +25,18 @@ Or add it to your `Gemfile`:
     gem 'jekyll-scholar'
 
 ### Github Pages
-    
-Note that it is not possible to use this plugin with the 
+
+Note that it is not possible to use this plugin with the
   [default Github pages workflow](https://help.github.com/articles/using-jekyll-with-pages/). 
-Github does not allow any but a few select plugins to run for security reasons, 
-and Jekyll-Scholar is not among them. 
+Github does not allow any but a few select plugins to run for security reasons,
+and Jekyll-Scholar is not among them.
 You will have to generate your site locally and push the results to the `master` resp. `gh-pages` 
 branch of your site repository.
 You can keep sources, configuration and plugins in a separate branch; see e.g.
   [here](http://davidensinger.com/2013/07/automating-jekyll-deployment-to-github-pages-with-rake/)
 for details.
 
-    
+
 
 Usage
 -----
@@ -72,8 +72,11 @@ default configuration is as follows:
 
       replace_strings: true
       join_strings:    true
-      
+
       use_raw_bibtex_entry: false
+      bibtex_filters:
+      - superscript
+      - latex
 
       details_dir:    bibliography
       details_layout: bibtex.html
@@ -130,6 +133,12 @@ extended or overridden. For example, the default name for `article` is
 *Journal Articles*, but it can be changed to *Papers* using
 `type_name: { article => 'Papers' }`.
 
+The `bibtex_filters` option configures which
+[BibTeX-Ruby](https://github.com/inukshuk/bibtex-ruby) formatting filters
+values of entries should be passed through. This defaults to the `latex`
+filter which converts LaTeX character escapes into unicode, and `superscript`
+which converts the `\textsuperscript` command into a HTML `<sup>` tag.
+
 ### Bibliographies
 
 Once you have loaded Jekyll-Scholar, all files with the extension `.bib` or
@@ -385,9 +394,13 @@ will attempt to read the key `ruby` from file `/home/foo/bar.bib`. It will not
 fallback to the default BibTeX file.
 
 #### Citation pointing to another page in your site
-In some cases, you might want your citation to link to another page on your cite (ex. a separate works cited page). As a solution, Jekyll-Scholar provides the `--relative` tag. For example, if you wanted the link to point to an ID in a bibliography.html page, you would use:
+In some cases, you might want your citation to link to another page on your cite (ex. a separate works cited page). As a solution, add a relative path to your scholar configurations:
+
+~~~ yaml
+    scholar:
+      relative: "/relative/path/file.html"
+~~~
 
-    {% cite ruby --relative bibliography.html %}
 
 #### Multiple bibliographies within one document (like [multibib.sty](http://www.ctan.org/pkg/multibib))
 

data/features/bibtex.feature

@@ -63,6 +63,24 @@ Feature: BibTeX
     And the "_site/references.html" file should exist
     And I should see "Look, an umlaut: ü!" in "_site/references.html"
 
+  @superscript
+  Scenario: Simple Bibliography with LaTeX superscript
+    Given I have a scholar configuration with:
+      | key   | value |
+      | style | apa   |
+    And I have a page "references.bib":
+      """
+      ---
+      ---
+      @misc{umlaut,
+        title     = {Look, \textsuperscript{superscript}!},
+      }
+      """
+    When I run jekyll
+    Then the _site directory should exist
+    And the "_site/references.html" file should exist
+    And I should see "Look, <sup>superscript</sup>!" in "_site/references.html"
+
   @tags @bibtex
   Scenario: Embedded BibTeX
     Given I have a scholar configuration with:

data/features/details.feature

@@ -60,6 +60,7 @@ Feature: Details
       <html>
       <head></head>
       <body>
+      Page title: {{ page.title }}
       Title: {{ page.entry.title }}
       {{ page.entry.bibtex }}
       </body>
@@ -68,6 +69,7 @@ Feature: Details
     When I run jekyll
     Then the _site directory should exist
     And the "_site/bibliography/ruby.html" file should exist
+    And I should see "Page title: An Umlaut ä!" in "_site/bibliography/ruby.html"
     And I should see "Title: An Umlaut ä!" in "_site/bibliography/ruby.html"
     And I should see "title = {An Umlaut \\\"a!}" in "_site/bibliography/ruby.html"
 
@@ -93,6 +95,7 @@ Feature: Details
       <html>
       <head></head>
       <body>
+      Page title: {{ page.title }}
       Title: {{ page.entry.title }}
       {{ page.entry.bibtex }}
       </body>
@@ -101,6 +104,7 @@ Feature: Details
     When I run jekyll
     Then the _site directory should exist
     And the "_site/bibliography/ruby.html" file should exist
+    And I should see "Page title: An Umlaut \\\"a!" in "_site/bibliography/ruby.html"
     And I should see "Title: An Umlaut \\\"a!" in "_site/bibliography/ruby.html"
     And I should see "title = {An Umlaut \\\"a!}" in "_site/bibliography/ruby.html"
 

data/features/filter.feature

@@ -228,3 +228,54 @@ Feature: BibTeX
     Then the _site directory should exist
     And the "_site/scholar.html" file should exist
     And I should see "\[Pragmatic Bookshelf\]\(https://pragprog.com\)" in "_site/scholar.html"
+
+  @tags @superscript
+  Scenario: LaTeX Superscript as HTML
+    Given I have a scholar configuration with:
+      | key    | value             |
+      | source | ./_bibliography   |
+    And I have the following BibTeX filters:
+      | superscript |
+    And I have a "_bibliography" directory
+    And I have a file "_bibliography/references.bib":
+      """
+      @misc{pickaxe,
+        title     = {This is \textsuperscript{superscript text}.}
+      }
+      """
+    And I have a page "scholar.html":
+      """
+      ---
+      ---
+      {% bibliography %}
+      """
+    When I run jekyll
+    Then the _site directory should exist
+    And the "_site/scholar.html" file should exist
+    And I should see "This is <sup>superscript text</sup>." in "_site/scholar.html"
+
+  @tags @superscript
+  Scenario: LaTeX Superscript with embedded LaTeX chars as HTML
+    Given I have a scholar configuration with:
+      | key    | value             |
+      | source | ./_bibliography   |
+    And I have the following BibTeX filters:
+      | superscript |
+      | latex       |
+    And I have a "_bibliography" directory
+    And I have a file "_bibliography/references.bib":
+      """
+      @misc{pickaxe,
+        title     = {\textsuperscript{\"u \"{u} \v{z}}}
+      }
+      """
+    And I have a page "scholar.html":
+      """
+      ---
+      ---
+      {% bibliography %}
+      """
+    When I run jekyll
+    Then the _site directory should exist
+    And the "_site/scholar.html" file should exist
+    And I should see "<sup>ü ü ž</sup>" in "_site/scholar.html"

data/lib/jekyll/scholar.rb

@@ -21,3 +21,4 @@ require 'jekyll/scholar/tags/reference'
 require 'jekyll/scholar/generators/details'
 
 require 'jekyll/scholar/plugins/markdown_links'
+require 'jekyll/scholar/plugins/superscript'

data/lib/jekyll/scholar/converters/bibtex.rb

@@ -30,7 +30,8 @@ module Jekyll
       end
 
       def convert(content)
-        content = BibTeX.parse(content, :strict => true, :include => [:meta_content], :filter => [:latex]).map do |b|
+        content = BibTeX.parse(content, :strict => true, :include => [:meta_content],
+                               :filter => @config['scholar']['bibtex_filters']).map do |b|
           if b.respond_to?(:to_citeproc)
             render_bibliography b
           else

data/lib/jekyll/scholar/defaults.rb

@@ -17,7 +17,7 @@ module Jekyll
       'repository'             => nil,
 
       'bibtex_options'         => { :strip => false, :parse_months => true },
-      'bibtex_filters'         => [ :latex ],
+      'bibtex_filters'         => [ :superscript, :latex ],
       'bibtex_skip_fields'     => [ :abstract, :month_numeric ],
 
       'replace_strings'        => true,

data/lib/jekyll/scholar/generators/details.rb

@@ -15,8 +15,8 @@ module Jekyll
         process(@name)
         read_yaml(File.join(base, '_layouts'), config['details_layout'])
 
-        data['title'] = entry.title.to_s if entry.field?(:title)
         data.merge!(reference_data(entry))
+        data['title'] = data['entry']['title'] if data['entry'].has_key?('title')
       end
 
     end

data/lib/jekyll/scholar/plugins/superscript.rb

@@ -0,0 +1,12 @@
+module Jekyll
+  class Scholar
+    class Superscript < BibTeX::Filter
+      def apply(value)
+        # Use of \g<1> pattern back-reference to allow for capturing nested {} groups
+        value.to_s.gsub(/\\textsuperscript(\{((?:.|\g<1>)*)\})/) {
+          "<sup>#{$2}</sup>"
+        }
+      end
+    end
+  end
+end

data/lib/jekyll/scholar/utilities.rb

@@ -18,7 +18,7 @@ module Jekyll
     module Utilities
 
 
-      attr_reader :config, :site, :context, :prefix, :text, :offset, :max, :relative
+      attr_reader :config, :site, :context, :prefix, :text, :offset, :max
 
 
 
@@ -61,10 +61,6 @@ module Jekyll
             @prefix = prefix
           end
 
-          opts.on('-r', '--relative RELATIVE') do |relative|
-            @relative = relative.to_s.strip
-          end
-
           opts.on('-t', '--text TEXT') do |text|
             @text = text
           end
@@ -102,7 +98,7 @@ module Jekyll
           end
         end
 
-        argv = arguments.split(/(\B-[cCfqrptTsgGOlomA]|\B--(?:cited(_in_order)?|file|query|relative|prefix|text|style|group_(?:by|order)|type_order|template|locator|offset|max|suppress_author|))/)
+        argv = arguments.split(/(\B-[cCfqptTsgGOlomA]|\B--(?:cited(_in_order)?|file|query|prefix|text|style|group_(?:by|order)|type_order|template|locator|offset|max|suppress_author|))/)
 
         parser.parse argv.map(&:strip).reject(&:empty?)
       end
@@ -400,6 +396,10 @@ module Jekyll
         File.join site.source, source
       end
 
+      def relative
+        config['relative']
+      end
+
       def reference_tag(entry, index = nil)
         return missing_reference unless entry
 
@@ -560,7 +560,7 @@ module Jekyll
 
       def renderer(force = false)
         return @renderer if @renderer && !force
-          
+
         @renderer = CiteProc::Ruby::Renderer.new :format => 'html',
           :style => style, :locale => config['locale']
       end
@@ -598,8 +598,8 @@ module Jekyll
         (context['citation_numbers'] ||= {})[key] ||= cited_keys.length
       end
 
-      def link_target_for key
-        "#{base_url}#{relative}##{[prefix, key].compact.join('-')}"
+      def link_target_for(key)
+        "#{relative}##{[prefix, key].compact.join('-')}"
       end
 
       def cite(keys)

data/lib/jekyll/scholar/version.rb

@@ -1,5 +1,5 @@
 module Jekyll
   class Scholar
-    VERSION = '5.7.0'.freeze
+    VERSION = '5.7.1'.freeze
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: jekyll-scholar
 version: !ruby/object:Gem::Version
-  version: 5.7.0
+  version: 5.7.1
 platform: ruby
 authors:
 - Sylvester Keil
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-02-03 00:00:00.000000000 Z
+date: 2016-02-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: jekyll
@@ -112,6 +112,7 @@ files:
 - lib/jekyll/scholar/defaults.rb
 - lib/jekyll/scholar/generators/details.rb
 - lib/jekyll/scholar/plugins/markdown_links.rb
+- lib/jekyll/scholar/plugins/superscript.rb
 - lib/jekyll/scholar/tags/bibliography.rb
 - lib/jekyll/scholar/tags/bibtex.rb
 - lib/jekyll/scholar/tags/cite.rb