jekyll-scholar 0.0.2 → 0.0.3

data/README.md

@@ -91,11 +91,26 @@ also pass in a name to tell Jekyll-Scholar which bibliography it should render.
 
 Let's say you have two bibliographies stored in `_bibliography/books.bib` and
 `_bibliography/papers.bib`; you can include the bibliographies on your site
-by respectively calling:
+by respectively calling `{% bibliography books %}` and
+`{% bibliography papers %}`. For example, you could have a file `references.md`
+with several reference lists:
 
-    {% bibliography books %}
-    
-    {% bibliography papers %}
+    ---
+    title: My References
+    ---
+
+    {{ page.title }}
+    ================
+
+    The default Bibliography
+    ------------------------
+
+    {% bibliography %}
+
+    Secondary References
+    --------------------
+
+    {% bibliography secondary %}
 
 
 ### Citations
@@ -103,9 +118,34 @@ by respectively calling:
 If you want to reference books or papers from your bibliography in your blog
 posts, Jekyll-Scholar can help you, too. Simply use the `cite` tag with
 the appropriate key of the item you want to cite and Jekyll-Scholar will
-create a formatted citation reference for you. For example:
+create a formatted citation reference for you. For a quick example, take
+following blog post:
 
-    "Once upon a midnight dreary..." {{% cite poe %}}
+    ---
+    layout: default
+    title: A Blogging Scholar
+    ---
+
+    {{ page.title }}
+    ================
+
+    Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod tempor
+    incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis
+    nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat.
+    Duis 'aute irure dolor in reprehenderit in voluptate' {% cite derrida:purveyor %}
+    velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat
+    cupidatat non proident, 'sunt in culpa qui officia deserunt mollit anim id est
+    laborum' {% cite rabinowitz %}.
+
+    Duis 'aute irure dolor in reprehenderit in voluptate' {% cite breton:surrealism %}
+    velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat
+    cupidatat non proident, 'sunt in culpa qui officia deserunt mollit anim id est
+    laborum' {% cite rainey %}.
+
+    References
+    ----------
+
+    {% bibliography %}
 
 
 Contributing

data/lib/jekyll/scholar/tags/bibliography.rb

@@ -7,7 +7,7 @@ module Jekyll
     
       def initialize(tag_name, arguments, tokens)
         super
-        
+
         @config = Scholar.defaults.dup
         @file = arguments.strip
       end
@@ -15,10 +15,24 @@ module Jekyll
       def render(context)
         config.merge!(context.registers[:site].config['scholar'] || {})
 
-        entries.map { |e|
-          CiteProc.process e.to_citeproc, :style => config['style'],
+        references = entries.map do |e|
+          r = CiteProc.process e.to_citeproc, :style => config['style'],
             :locale => config['locale'], :format => 'html'
-        }.join("\n")
+                    
+          r = "<span id='#{e.key}'>#{r}</span>"
+          
+          if e.field?(:url)
+            r << "<a href='#{e.url}'>URL</a>"
+          end
+
+          if e.field?(:doi)
+            r << "<a href='#{e.doi}'>DOI</a>"
+          end
+          
+          "<li>#{r}</li>"
+        end
+        
+        "<ol>\n#{references.join("\n")}\n</ol>"
       end
       
       private
@@ -31,7 +45,7 @@ module Jekyll
         b = bibliography['@*']
 
         unless config['sort_by'] == 'none'
-          b.sort_by! { |e| e[config['sort_by']] }
+          b.sort_by! { |e| e[config['sort_by']].to_s }
           b.reverse! if config['order'] =~ /^(desc|reverse)/i
         end
         

data/lib/jekyll/scholar/tags/cite.rb

@@ -15,12 +15,13 @@ module Jekyll
       def render(context)
         config.merge!(context.registers[:site].config['scholar'] || {})
 
-        puts key
         e = bibliography[key]
-        puts e
+
         if e
-          CiteProc.process e.to_citeproc, :style => config['style'],
+          c = CiteProc.process e.to_citeproc, :style => config['style'],
             :locale => config['locale'], :format => 'html', :mode => :citation
+          
+          "<a href='##{e.key}'>#{c}</a>"
         else
           "(missing reference)"
         end

data/lib/jekyll/scholar/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: jekyll-scholar
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-04-22 00:00:00.000000000 Z
+date: 2012-04-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: jekyll
-  requirement: &70141486252080 !ruby/object:Gem::Requirement
+  requirement: &70204275141840 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -21,10 +21,10 @@ dependencies:
         version: '0.10'
   type: :runtime
   prerelease: false
-  version_requirements: *70141486252080
+  version_requirements: *70204275141840
 - !ruby/object:Gem::Dependency
   name: citeproc-ruby
-  requirement: &70141486251300 !ruby/object:Gem::Requirement
+  requirement: &70204275141040 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -32,10 +32,10 @@ dependencies:
         version: 0.0.6
   type: :runtime
   prerelease: false
-  version_requirements: *70141486251300
+  version_requirements: *70204275141040
 - !ruby/object:Gem::Dependency
   name: bibtex-ruby
-  requirement: &70141486249780 !ruby/object:Gem::Requirement
+  requirement: &70204275139520 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -43,10 +43,10 @@ dependencies:
         version: 2.0.5
   type: :runtime
   prerelease: false
-  version_requirements: *70141486249780
+  version_requirements: *70204275139520
 - !ruby/object:Gem::Dependency
   name: rake
-  requirement: &70141486264360 !ruby/object:Gem::Requirement
+  requirement: &70204275153920 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -54,10 +54,10 @@ dependencies:
         version: '0.9'
   type: :development
   prerelease: false
-  version_requirements: *70141486264360
+  version_requirements: *70204275153920
 - !ruby/object:Gem::Dependency
   name: rdoc
-  requirement: &70141486263420 !ruby/object:Gem::Requirement
+  requirement: &70204275153160 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -65,10 +65,10 @@ dependencies:
         version: '3.11'
   type: :development
   prerelease: false
-  version_requirements: *70141486263420
+  version_requirements: *70204275153160
 - !ruby/object:Gem::Dependency
   name: redgreen
-  requirement: &70141486262680 !ruby/object:Gem::Requirement
+  requirement: &70204275152420 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -76,10 +76,10 @@ dependencies:
         version: '1.2'
   type: :development
   prerelease: false
-  version_requirements: *70141486262680
+  version_requirements: *70204275152420
 - !ruby/object:Gem::Dependency
   name: shoulda
-  requirement: &70141486261140 !ruby/object:Gem::Requirement
+  requirement: &70204275150860 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -87,10 +87,10 @@ dependencies:
         version: '2.11'
   type: :development
   prerelease: false
-  version_requirements: *70141486261140
+  version_requirements: *70204275150860
 - !ruby/object:Gem::Dependency
   name: rr
-  requirement: &70141486260640 !ruby/object:Gem::Requirement
+  requirement: &70204275150340 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -98,10 +98,10 @@ dependencies:
         version: '1.0'
   type: :development
   prerelease: false
-  version_requirements: *70141486260640
+  version_requirements: *70204275150340
 - !ruby/object:Gem::Dependency
   name: cucumber
-  requirement: &70141486259820 !ruby/object:Gem::Requirement
+  requirement: &70204275149380 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - =
@@ -109,10 +109,10 @@ dependencies:
         version: '1.1'
   type: :development
   prerelease: false
-  version_requirements: *70141486259820
+  version_requirements: *70204275149380
 - !ruby/object:Gem::Dependency
   name: RedCloth
-  requirement: &70141486258100 !ruby/object:Gem::Requirement
+  requirement: &70204275147660 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -120,10 +120,10 @@ dependencies:
         version: '4.2'
   type: :development
   prerelease: false
-  version_requirements: *70141486258100
+  version_requirements: *70204275147660
 - !ruby/object:Gem::Dependency
   name: rdiscount
-  requirement: &70141486273300 !ruby/object:Gem::Requirement
+  requirement: &70204275162880 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -131,10 +131,10 @@ dependencies:
         version: '1.6'
   type: :development
   prerelease: false
-  version_requirements: *70141486273300
+  version_requirements: *70204275162880
 - !ruby/object:Gem::Dependency
   name: redcarpet
-  requirement: &70141486271560 !ruby/object:Gem::Requirement
+  requirement: &70204275161140 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -142,7 +142,7 @@ dependencies:
         version: '1.9'
   type: :development
   prerelease: false
-  version_requirements: *70141486271560
+  version_requirements: *70204275161140
 description: A set of jekyll extensions for academic blogging.
 email: http://sylvester.keil.or.at
 executables: []