jekyll-scholar 1.0.0 → 1.1.0

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    Y2VlZTg5Njk5MjEzNjZhMmQxYjZmYzc2ZTBmMTdlODJlYTBmNzAyZg==
+    YjIwNWM2NmQ3MWVlMDdlMGU4MTBjMjUyYmZiNmNhZjdlMjEzYTJiOA==
   data.tar.gz: !binary |-
-    OGNmMjQ4NzA1MWUzOThhMjEzNjgyYWFjYzA1ZWUwYTc4YmExMTc5OQ==
+    YTg5Y2YxZDMyN2Y3N2Q2MTU5OWQwZWM0MWI3OGU1MWYwODg0OWVkZg==
 !binary "U0hBNTEy":
   metadata.gz: !binary |-
-    NjhiNGUzYWQ3NTk0MDY4MDQ1OWZkMGYzYjlmYzJhMmY0Njk3YzhhMzRjYjMw
-    ODdmYzU0ZmFmNWY1OGU2ZDQ2Yzg4MGMxZmE2NDk3NWY2ZTM4ZmZjOGM2NDI4
-    MWFmNTEyYmEzYmYzNTk5ODIyNTVhMzY3NGI4MTBkMWNjNjUzMzE=
+    MmI1YTYzMmFjYzJkMDVhOTJmMTAyOWFmMmI4YzY1NTNiNmU0NGI4NjQ5OGI2
+    ODM4NDFlNWIwNTBhZmVhYzkxOWQ1ZDk5MzU4ZWVmMjVmZDZlMTQ1YTYwM2M0
+    NzdkOTFjYjc5MGM3N2Y5NzNlOWE1ZmYzMTRhNmVmZjMzZWQxZjY=
   data.tar.gz: !binary |-
-    MzVjYTkzMjhjYzU0MjYxZWVkODBkZTI3MDY4Y2VlNjQxNzY0ZGViYTVjMTAz
-    MjIxYzBjNTFjMDNmYjVjYzQ4ODA3MGY3YzZhM2YwYzc4YmMwMWFhNWFmYzUx
-    ODFhNTMzODcxZjhiNDYyYjgwNjA3MGNiY2FjNDRmMGJmZmJjMWU=
+    YThmN2Q5ZTY0MDc2MzM1NTM5Y2E4NjlmZjdjNDFlODY4NDIzYWJkYTEyZTk3
+    MDA1NGQ1OGY3ZjAzNDlmOTgzNjk2ZjAwMmEyZmJiZDJhOWY3MWQ1ZTkxNzhk
+    MDZkYWUwOTliNmU1ZTU0ZjM1ODg5YjlhMmQ2NmFhMDI4MzRmOGQ=

data/.travis.yml

@@ -0,0 +1,12 @@
+language: ruby
+bundler_args: --without debug
+rvm:
+  - 2.0.0
+  - 1.9.2
+  - 1.9.3
+notifications:
+  email:
+    recipients:
+      - sylvester@keil.or.at
+    on_success: change
+    on_failure: always

data/Gemfile

@@ -1,8 +1,20 @@
 source 'https://rubygems.org'
 gemspec
 
-gem 'unicode_utils'
-
 group 'development' do
-	gem 'debugger'
+  gem 'rake'
+  gem 'redgreen', '~> 1.2'
+  gem 'shoulda', '~> 3.3.2'
+  gem 'rr', '~> 1.0'
+  gem 'cucumber', '~> 1.2.1'
+  gem 'RedCloth', '~> 4.2'
+  gem 'rdiscount', '~> 1.6'
+  gem 'redcarpet', '~> 2.2.2'
+  gem 'launchy', '~> 2.1.2'
+
+  gem 'unicode_utils'  
+end
+
+group 'debug' do
+  gem 'debugger'
 end

data/README.md

@@ -9,13 +9,14 @@ and gives your blog posts citation super-powers.
 For additional features you may also want to take a look at
 [jekyll-scholar-extras](https://github.com/hdpatel/jekyll-scholar-extras).
 
+[![Build Status](https://travis-ci.org/inukshuk/jekyll-scholar.png?branch=master)](https://travis-ci.org/inukshuk/jekyll-scholar)
+
 
 Installation
 ------------
 
     $ [sudo] gem install jekyll-scholar
 
-
 Usage
 -----
 
@@ -38,7 +39,8 @@ default configuration is as follows:
       
       source: ./_bibliography
       bibliography: references.bib
-      
+      bibliography_template: %{reference}
+
       details_dir:    bibliography
       details_layout: bibtex.html
       details_link:   Details
@@ -140,6 +142,26 @@ For more details about filters, see the corresponding section below or
 consult the [BibTeX-Ruby](https://github.com/inukshuk/bibtex-ruby)
 documentation.
 
+### Bibliography Template
+
+Your bibliography is always rendered as an ordered list. Additionally,
+each reference is wrapped in an HTML tag (`span` by default but you can
+change this using the `reference_tagname` setting) with the cite key
+as id. The reference string itself is governed by the rules in your
+CSL style but you can also customize the main template a little bit.
+By default, the template is `%{reference}` – this renders only the
+reference tag. The template uses Ruby string interpolation and, in
+addition to the reference, exposes the cite-key (as `key`), the
+entry's `type` and the `index` in the bibliography. Thus, you could
+customize the template in your configuration as follows:
+
+    scholar:
+      bibliography_template: <abbr>[%{key}]</abbr>%{reference}
+
+This would be processed into something like:
+
+    <li><abbr>[ruby]</abbr><span id="ruby">Matsumoto, Y. (2008). <i>The Ruby Programming Language</i>. O&#8217;Reilly Media.</span></li>
+
 
 ### Citations
 
@@ -226,14 +248,14 @@ a specific page. As an example, the tag
 will attempt to read the key `ruby` from file `/home/foo/bar.bib`. It will not
 fallback to the default BibTeX file.
 
-#### Citations to multiple bibliographies within one document (like [multibib.sty](http://www.ctan.org/pkg/multibib))
+#### Multiple bibliographies within one document (like [multibib.sty](http://www.ctan.org/pkg/multibib))
 
 When you have multiple `{% bibliography %}` sections in one file,
-Jekyll-Scholar will generate serveral lists containing the same
+Jekyll-Scholar will generate several lists containing the same
 publications that have the same `id` attributes. As a result, when you
 cite a reference the link to an `id` attribute cannot be resolved
 uniquely. Your browser will always take you take you to the first
-occurence of the `id`. Moreover, valid HTML requires unique `id`
+occurrence of the `id`. Moreover, valid HTML requires unique `id`
 attributes. This scenario may happen, for example, if you cite the
 same reference in different blog posts, and all of these posts are
 shown in one html document.
@@ -275,9 +297,9 @@ For the second blog post you would cite as follows:
 
     {% bibliography --cited --prefix post2 %}
 
-Even though both posts cite rabinowitz, both citations will be
-assigned unique identifiers linking to the respective References
-section., even if both posts will be rendered into a single HTML
+Even though both posts cite 'rabinowitz', both citations will be
+assigned unique identifiers linking to the respective references
+section, although both posts will be rendered into a single HTML
 document.
 
 
@@ -339,8 +361,9 @@ configuration option. For example:
     query: "@*[url]" #=> includes all entries with a url field
     query: "@*[status!=review]" #=> includes all entries whose status field is not set to 'review' 
     query: "@book[year <= 1900 && author ^= Poe]" #=> Books published before 1900 where the author matches /Poe/ 
+    query: "!@book" #=> includes all entries with a type other than book
     
-Please note that some of these queries require bibtex-ruby 2.0.7 or
+Please note that some of these queries require BibTeX-Ruby 2.3.0 or
 later versions. You can also overwrite the configuration's query parameter
 in each bibliography tag individually as described above.
 
@@ -356,16 +379,26 @@ You can check out a copy of the latest code using Git:
 To use this lasted version instead of the one provide by RubyGems,
 just add the line
 
-  $:.unshift '/full/path/to/the/repository/lib'
+    $:.unshift '/full/path/to/the/repository/lib'
 
 to your `_plugins/ext.rb` before requiring 'jekyll/scholar', where
-`/full/path/to/the/repository` is where you have cloned jekyll-scholar into.
+`/full/path/to/the/repository` is the path to your local version
+of Jekyll-Scholar.
+
+When contributing to Jekyll-Scholar, please make sure to install
+all dependencies and run the cucumber features:
+
+    $ bundle install
+    $ rake
 
 If you've found a bug or have a question, please open an issue on the
 [Jekyll-Scholar issue tracker](http://github.com/inukshuk/jekyll-scholar/issues).
 Or, for extra credit, clone the Jekyll-Scholar repository, write a failing
 example, fix the bug and submit a pull request.
 
+Additionally, if we merged at least one of your pull request you will get
+write permissions to the repository if you want them.
+
 License
 -------
 

data/Rakefile

@@ -0,0 +1,23 @@
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'rake'
+
+require 'jekyll/scholar/version'
+
+require 'cucumber/rake/task'
+Cucumber::Rake::Task.new(:features)
+
+task :default => [:features]
+
+task :release do |t|
+  system "gem build jekyll-scholar.gemspec"
+  system "git tag #{Jekyll::Scholar::VERSION}"
+  system "git push --tags"
+  system "gem push jekyll-scholar-#{Jekyll::Scholar::VERSION}.gem"
+end

data/cucumber.yml

@@ -0,0 +1 @@
+default: --require features --color

data/features/bibtex.feature

@@ -4,156 +4,184 @@ Feature: BibTeX
   In order to share my awesome references with my peers
 
   @converters
-	Scenario: Simple Bibliography
-	  Given I have a scholar configuration with:
-		  | key   | value |
-		  | style | apa   |
-		 And I have a page "references.bib":
-			"""
-			---
-			---
-			@book{ruby,
-			  title     = {The Ruby Programming Language},
-			  author    = {Flanagan, David and Matsumoto, Yukihiro},
-			  year      = {2008},
-			  publisher = {O'Reilly Media}
-			}
-			"""
-	  When I run jekyll
-	  Then the _site directory should exist
-		And the "_site/references.html" file should exist
-	  And I should see "<i>The Ruby Programming Language</i>" in "_site/references.html"
+  Scenario: Simple Bibliography
+    Given I have a scholar configuration with:
+      | key   | value |
+      | style | apa   |
+     And I have a page "references.bib":
+      """
+      ---
+      ---
+      @book{ruby,
+        title     = {The Ruby Programming Language},
+        author    = {Flanagan, David and Matsumoto, Yukihiro},
+        year      = {2008},
+        publisher = {O'Reilly Media}
+      }
+      """
+    When I run jekyll
+    Then the _site directory should exist
+    And the "_site/references.html" file should exist
+    And I should see "<i>The Ruby Programming Language</i>" in "_site/references.html"
 
   @converters
-	Scenario: Markdown Formatted Bibliography
+  Scenario: Markdown Formatted Bibliography
     Given I have a scholar configuration with:
-  	  | key   | value |
-  	  | style | apa   |
-	  And I have a page "references.bib":
-			"""
-			---
-			---
-			References
-			==========
-			
-			@book{ruby,
-			  title     = {The Ruby Programming Language},
-			  author    = {Flanagan, David and Matsumoto, Yukihiro},
-			  year      = {2008},
-			  publisher = {O'Reilly Media}
-			}
-			"""
-	  When I run jekyll
-	  Then I should see "<h1[^>]*>References</h1>" in "_site/references.html"
+      | key   | value |
+      | style | apa   |
+    And I have a page "references.bib":
+      """
+      ---
+      ---
+      References
+      ==========
+      
+      @book{ruby,
+        title     = {The Ruby Programming Language},
+        author    = {Flanagan, David and Matsumoto, Yukihiro},
+        year      = {2008},
+        publisher = {O'Reilly Media}
+      }
+      """
+    When I run jekyll
+    Then I should see "<h1[^>]*>References</h1>" in "_site/references.html"
 
   @latex
-	Scenario: Simple Bibliography with LaTeX directives
+  Scenario: Simple Bibliography with LaTeX directives
     Given I have a scholar configuration with:
-  	  | key   | value |
-  	  | style | apa   |
-	  And I have a page "references.bib":
-			"""
-			---
-			---
-			@misc{umlaut,
-			  title     = {Look, an umlaut: \"u!},
-			}
-			"""
-	  When I run jekyll
-	  Then the _site directory should exist
-		And the "_site/references.html" file should exist
-	  And I should see "Look, an umlaut: ü!" in "_site/references.html"
+      | key   | value |
+      | style | apa   |
+    And I have a page "references.bib":
+      """
+      ---
+      ---
+      @misc{umlaut,
+        title     = {Look, an umlaut: \"u!},
+      }
+      """
+    When I run jekyll
+    Then the _site directory should exist
+    And the "_site/references.html" file should exist
+    And I should see "Look, an umlaut: ü!" in "_site/references.html"
 
   @tags
-	Scenario: Simple Bibliography Loaded From Default Directory
+  Scenario: Simple Bibliography Loaded From Default Directory
+    Given I have a scholar configuration with:
+      | key    | value             |
+      | source | ./_bibliography   |
+    And I have a "_bibliography" directory
+    And I have a file "_bibliography/references.bib":
+      """
+      @book{ruby,
+        title     = {The Ruby Programming Language},
+        author    = {Flanagan, David 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 "<i>The Ruby Programming Language</i>" in "_site/scholar.html"
+
+  @tags @bibliography @config
+  Scenario: Simple Bibliography With Custom Template
     Given I have a scholar configuration with:
-  	  | key    | value             |
-  	  | source | ./_bibliography   |
-		And I have a "_bibliography" directory
-	  And I have a file "_bibliography/references.bib":
-			"""
-			@book{ruby,
-			  title     = {The Ruby Programming Language},
-			  author    = {Flanagan, David 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 "<i>The Ruby Programming Language</i>" in "_site/scholar.html"
+      | key                   | value                                      |
+      | source                | ./_bibliography                            |
+      | bibliography_template | <abbr>%{index} [%{key}]</abbr>%{reference} |
+    And I have a "_bibliography" directory
+    And I have a file "_bibliography/references.bib":
+      """
+      @book{ruby,
+        title     = {The Ruby Programming Language},
+        author    = {Flanagan, David 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 "<i>The Ruby Programming Language</i>" in "_site/scholar.html"
+    And I should see "<abbr>1 \[ruby\]</abbr><span" in "_site/scholar.html"
 
   @tags @filter
-	Scenario: Filtered Bibliography Loaded From Default Directory
+  Scenario: Filtered Bibliography Loaded From Default Directory
     Given I have a scholar configuration with:
-  	  | key    | value             |
-  	  | source | ./_bibliography   |
-		And I have a "_bibliography" directory
-	  And I have a file "_bibliography/references.bib":
-			"""
-			@book{ruby,
-			  title     = {The Ruby Programming Language},
-			  author    = {Flanagan, David and Matsumoto, Yukihiro},
-			  year      = {2008},
-			  publisher = {O'Reilly Media}
-			},
-			@book{smalltalk,
-			  title     = {Smalltalk Best Practice Patterns},
-			  author    = {Kent Beck},
-			  year      = {1996},
-			  publisher = {Prentice Hall}
-			}
+      | key    | value             |
+      | source | ./_bibliography   |
+    And I have a "_bibliography" directory
+    And I have a file "_bibliography/references.bib":
+      """
+      @book{ruby,
+        title     = {The Ruby Programming Language},
+        author    = {Flanagan, David and Matsumoto, Yukihiro},
+        year      = {2008},
+        publisher = {O'Reilly Media}
+      },
+      @book{smalltalk,
+        title     = {Smalltalk Best Practice Patterns},
+        author    = {Kent Beck},
+        year      = {1996},
+        publisher = {Prentice Hall}
+      }
 
-			"""
-	  And I have a page "scholar.html":
-			"""
-			---
-			---
-			{% bibliography -f references --query @book[year <= 2000] %}
-			"""
-	  When I run jekyll
-	  Then the _site directory should exist
-		And the "_site/scholar.html" file should exist
-	  And I should not see "<i>The Ruby Programming Language</i>" in "_site/scholar.html"
-	  And I should see "<i>Smalltalk Best Practice Patterns</i>" in "_site/scholar.html"
+      """
+    And I have a page "scholar.html":
+      """
+      ---
+      ---
+      {% bibliography -f references --query @book[year <= 2000] %}
+      """
+    When I run jekyll
+    Then the _site directory should exist
+    And the "_site/scholar.html" file should exist
+    And I should not see "<i>The Ruby Programming Language</i>" in "_site/scholar.html"
+    And I should see "<i>Smalltalk Best Practice Patterns</i>" in "_site/scholar.html"
 
   @tags @bibliography @prefix
-	Scenario: A Prefixed Bibliography
+  Scenario: A Prefixed Bibliography
     Given I have a scholar configuration with:
-  	  | key    | value             |
-  	  | source | ./_bibliography   |
-		And I have a "_bibliography" directory
-	  And I have a file "_bibliography/references.bib":
-			"""
-			@book{ruby,
-			  title     = {The Ruby Programming Language},
-			  author    = {Flanagan, David and Matsumoto, Yukihiro},
-			  year      = {2008},
-			  publisher = {O'Reilly Media}
-			},
-			@book{smalltalk,
-			  title     = {Smalltalk Best Practice Patterns},
-			  author    = {Kent Beck},
-			  year      = {1996},
-			  publisher = {Prentice Hall}
-			}
+      | key    | value             |
+      | source | ./_bibliography   |
+    And I have a "_bibliography" directory
+    And I have a file "_bibliography/references.bib":
+      """
+      @book{ruby,
+        title     = {The Ruby Programming Language},
+        author    = {Flanagan, David and Matsumoto, Yukihiro},
+        year      = {2008},
+        publisher = {O'Reilly Media}
+      },
+      @book{smalltalk,
+        title     = {Smalltalk Best Practice Patterns},
+        author    = {Kent Beck},
+        year      = {1996},
+        publisher = {Prentice Hall}
+      }
 
-			"""
-	  And I have a page "scholar.html":
-			"""
-			---
-			---
-			{% bibliography --file references --prefix a -q @book[year <= 2000] %}
-			"""
-	  When I run jekyll
-	  Then the _site directory should exist
-		And the "_site/scholar.html" file should exist
-	  And I should not see "ruby" in "_site/scholar.html"
-	  And I should see "id=\"a-smalltalk\"" in "_site/scholar.html"
+      """
+    And I have a page "scholar.html":
+      """
+      ---
+      ---
+      {% bibliography --file references --prefix a -q @book[year <= 2000] %}
+      """
+    When I run jekyll
+    Then the _site directory should exist
+    And the "_site/scholar.html" file should exist
+    And I should not see "ruby" in "_site/scholar.html"
+    And I should see "id=\"a-smalltalk\"" in "_site/scholar.html"