jekyll-scholar 5.7.2 → 5.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c87d13eba6259db001b9e45d8c5e6be1880850eb
-  data.tar.gz: 67cad6edde00f6385a32f062bcf5f0b88200dfdf
+  metadata.gz: 59e9726fd29959f5065efcb1c1a6948128f20eb2
+  data.tar.gz: 37a408bb19e1af81bb6884bc2a6abf37a4751f29
 SHA512:
-  metadata.gz: 66076962697bcababa64494ad7f81a754c9e16b1c5cf81cfe69c56ea0dd89bf8893a7931085b2706ca7bbf76e54d2190597b4780edbeda0410896677a3c439f9
-  data.tar.gz: 66a4ba75e7035dfd1413453ff34cf0e249bcf97eab03ba4233d21cd0814512864fec6968b3c5d47813ddcf887226cd8739735133406015a072bb72c4696c7459
+  metadata.gz: 4d0b131b2bea9952706288b62796f0c0acf25916ee796b38245e4ea8452dedc7d4ef183588a45980dcf8cb7907bcd5c51516143e2d4a0b2f2a9acd09942cdf86
+  data.tar.gz: 151bffaa573b6415f66e4ab6a9a092b3dbbf529b4f163dffdae8e4fb23d66451ba687031c4f29f59adc71d3ccdb6ad8a7c7164ba93beb47d2cb5c84fe6cb8976

data/README.md

@@ -361,13 +361,18 @@ like: `...as Matz explains (2008, p. 42)`.
 
 #### Page numbers and locators
 
-If you would like to add page numbers to your citation, you can use the
-`-l` or `--locator` option. For example, `{% cite ruby -l 23-5 %}` would
+If you would like to add page numbers or similar locators to your citation,
+use the `-l` or `--locator` option. For example, `{% cite ruby --locator 23-5 %}` would
 produce a citation like `(Matsumoto, 2008, pp. 23-5)`.
 
 When quoting multiple items (see above) you can add multiple locators after
 the list of ids. For example, `{% cite ruby microscope -l 2 -l 24 & 32 %}`.
 
+Page is the default locator, however, you can indicate the type of locator
+by adding a `-L` or `--label` option (one for each locator) for instance,
+`{% cite ruby microscope --label chapter --locator 3 -L figure -l 24 & 32 %}`
+produces something like: `(Matsumoto, 2008, chap. 3; Shaughnessy, 2013, figs. 24 & 32)`.
+
 #### Displaying formatted references
 
 If you want to display the full formatted reference entry, you can use the

data/features/bibtex.feature

@@ -187,6 +187,36 @@ Feature: BibTeX
     And the "_site/scholar.html" file should exist
     And I should see "<abbr>1 book \[ruby\]</abbr>Matsumoto" in "_site/scholar.html"
 
+  @tags @bibliography @config @template @names
+  Scenario: Simple Bibliography With Custom Template and Name Parsing
+    Given I have a scholar configuration with:
+      | key                   | value                         |
+      | source                | ./_bibliography               |
+      | bibliography_template | <span>{{entry.author}}</span> |
+    And I have the following BibTeX options:
+      | key                   | value  |
+      | parse_names           | false  |
+    And I have a "_bibliography" directory
+    And I have a file "_bibliography/references.bib":
+      """
+      @book{ruby,
+        title     = {The Ruby Programming Language},
+        author    = {David Flanagan and Matsumoto, Yukihiro},
+        year      = {2008},
+        publisher = {O'Reilly Media}
+      }
+      """
+    And I have a page "scholar.html":
+      """
+      ---
+      ---
+      {% bibliography -f references %}
+      """
+    When I run jekyll
+    Then the _site directory should exist
+    And the "_site/scholar.html" file should exist
+    And I should see "David Flanagan and Matsumoto, Yukihiro" in "_site/scholar.html"
+
   @tags @filter
   Scenario: Filtered Bibliography Loaded From Default Directory
     Given I have a scholar configuration with:

data/features/citation.feature

@@ -235,6 +235,66 @@ Feature: Citations
     And the "_site/scholar.html" file should exist
     And I should see "Matsumoto, 2008, pp. 2-3; Shaughnessy, 2013, pp. 23 & 42" in "_site/scholar.html"
 
+  @tags @cite @locator @label
+  Scenario: Citations with locator labels
+    Given I have a scholar configuration with:
+      | key          | value             |
+      | source       | ./_bibliography   |
+      | bibliography | my_references     |
+    And I have a "_bibliography" directory
+    And I have a file "_bibliography/my_references.bib":
+      """
+      @book{ruby,
+        title     = {The Ruby Programming Language},
+        author    = {Flanagan, David and Matsumoto, Yukihiro},
+        year      = {2008},
+        publisher = {O'Reilly Media}
+      }
+      @book{microscope,
+        title     = {Ruby Under a Microscope},
+        author    = {Pat Shaughnessy},
+        year      = {2013},
+        publisher = {No Starch Press}
+      }
+      """
+    And I have a page "scholar.html":
+      """
+      ---
+      ---
+      {% cite ruby microscope --label chapter --locator 2-3 -L figure -l 4,5 %}
+      """
+    When I run jekyll
+    Then the _site directory should exist
+    And the "_site/scholar.html" file should exist
+    And I should see "Matsumoto, 2008, chaps. 2-3; Shaughnessy, 2013, figs. 4,5" in "_site/scholar.html"
+
+  @tags @cite @locator @label
+  Scenario: Citations with multiple locator labels
+    Given I have a scholar configuration with:
+      | key          | value             |
+      | source       | ./_bibliography   |
+      | bibliography | my_references     |
+    And I have a "_bibliography" directory
+    And I have a file "_bibliography/my_references.bib":
+      """
+      @book{ruby,
+        title     = {The Ruby Programming Language},
+        author    = {Matsumoto, Yukihiro},
+        year      = {2008},
+        publisher = {O'Reilly Media}
+      }
+      """
+    And I have a page "scholar.html":
+      """
+      ---
+      ---
+      {% cite ruby --label chapter --locator 3 %}
+      """
+    When I run jekyll
+    Then the _site directory should exist
+    And the "_site/scholar.html" file should exist
+    And I should see "Matsumoto, 2008, chap. 3" in "_site/scholar.html"
+
   @tags @cite @citation_number
   Scenario: Multiple citations using citation numbers
     Given I have a scholar configuration with:

data/features/filter.feature

@@ -41,9 +41,9 @@ Feature: BibTeX
   @tags @filters
   Scenario: Jekyll Filters
     Given I have a scholar configuration with:
-      | key    | value             |
-      | source | ./_bibliography   |
-      | bibliography_template | template |
+      | key                   | value             |
+      | source                | ./_bibliography   |
+      | bibliography_template | template          |
     And I have a "_bibliography" directory
     And I have a file "_bibliography/references.bib":
       """
@@ -279,3 +279,79 @@ Feature: BibTeX
     Then the _site directory should exist
     And the "_site/scholar.html" file should exist
     And I should see "<sup>ü ü ž</sup>" in "_site/scholar.html"
+
+  @tags @superscript
+  Scenario: LaTeX Superscript as HTML with embedded LaTeX chars left untouched
+    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     = {\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>\\"u \\"\{u\} \\v\{z\}</sup>" in "_site/scholar.html"
+
+  @tags @superscript
+  Scenario: LaTeX Superscript with subsequent groups 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     = {This is \textsuperscript{superscript text} this should not be superscript {even} {with {additional} groups}.}
+      }
+      """
+    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> this should not be superscript even with additional groups." in "_site/scholar.html"
+
+  @tags @superscript
+  Scenario: LaTeX Superscript with subsequent groups untouched in 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} this should not be superscript {even} {with {additional} groups}.}
+      }
+      """
+    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> this should not be superscript \{even\} \{with \{additional\} groups\}." in "_site/scholar.html"

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

@@ -2,9 +2,10 @@ 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>"
+        # Use of \g<1> pattern back-reference to allow for capturing nested {} groups.
+        # The first (outermost) capture of $1 is used.
+        value.to_s.gsub(/\\textsuperscript(\{(?:[^{}]|\g<1>)*\})/) {
+          "<sup>#{$1[1..-2]}</sup>"
         }
       end
     end

data/lib/jekyll/scholar/utilities.rb

@@ -21,7 +21,6 @@ module Jekyll
       attr_reader :config, :site, :context, :prefix, :text, :offset, :max
 
 
-
       def split_arguments(arguments)
 
         tokens = arguments.strip.split(/\s+/)
@@ -69,6 +68,10 @@ module Jekyll
             locators << locator
           end
 
+          opts.on('-L', '--label LABEL') do |label|
+            labels << label
+          end
+
           opts.on('-o', '--offset OFFSET') do |offset|
             @offset = offset.to_i
           end
@@ -98,7 +101,7 @@ module Jekyll
           end
         end
 
-        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|))/)
+        argv = arguments.split(/(\B-[cCfqptTsgGOlLomA]|\B--(?:cited(_in_order)?|file|query|prefix|text|style|group_(?:by|order)|type_order|template|locator|label|offset|max|suppress_author|))/)
 
         parser.parse argv.map(&:strip).reject(&:empty?)
       end
@@ -107,6 +110,10 @@ module Jekyll
         @locators ||= []
       end
 
+      def labels
+        @labels ||= []
+      end
+
       def bibtex_files
         @bibtex_files ||= [config['bibliography']]
       end
@@ -512,9 +519,6 @@ module Jekyll
         e
       end
 
-      def bibtex_skip_fields
-      end
-
       def generate_details?
         site.layouts.key?(File.basename(config['details_layout'], '.html'))
       end
@@ -566,12 +570,13 @@ module Jekyll
       end
 
       def render_citation(items)
-        renderer.render items.zip(locators).map { |entry, locator|
+        renderer.render items.zip(locators.zip(labels)).map { |entry, (locator, label)|
           cited_keys << entry.key
           cited_keys.uniq!
 
           item = citation_item_for entry, citation_number(entry.key)
           item.locator = locator
+          item.label = label unless label.nil?
 
           item
         }, STYLES[style].citation

data/lib/jekyll/scholar/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: jekyll-scholar
 version: !ruby/object:Gem::Version
-  version: 5.7.2
+  version: 5.8.0
 platform: ruby
 authors:
 - Sylvester Keil
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-03-06 00:00:00.000000000 Z
+date: 2016-04-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: jekyll
@@ -141,7 +141,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: 1.3.6
 requirements: []
 rubyforge_project: jekyll-scholar
-rubygems_version: 2.4.5.1
+rubygems_version: 2.6.3
 signing_key: 
 specification_version: 4
 summary: Jekyll extensions for the academic blogger.