Skip to content
GitLab
Projects
Groups
Snippets
/
Help
Help
Support
Community forum
Keyboard shortcuts
?
Submit feedback
Sign in
Toggle navigation
Menu
Open sidebar
caesr-pub
jekyll-scholar
Commits
b9d2331b
Commit
b9d2331b
authored
Apr 22, 2012
by
Sylvester Keil
Browse files
updated readme
parent
76500a79
Changes
3
Hide whitespace changes
Inline
Side-by-side
README.md
View file @
b9d2331b
...
...
@@ -22,10 +22,18 @@ to a file in your plugin directory (e.g., to `_plugins/ext.rb`):
require 'jekyll/scholar'
In your configuration you can now adjust the Jekyll-Scholar settings
citation_style: apa
citation_language: en
In your configuration you can now adjust the Jekyll-Scholar settings. The
default configuration is as follows:
scholar:
style: apa
locale: en
sort_by: none
order: ascending
source: ./_bibliography
bibliography: references.bib
You can use any style that ships with
[
CiteProc-Ruby
](
https://github.com/inukshuk/citeproc-ruby
)
by name (e.g.,
...
...
@@ -33,10 +41,14 @@ apa, mla, chicago-fullnote-bibliography), or else you can add a link
to any CSL style (e.g., you could link to any of the styles available at
the official
[
CSL style repository
](
https://github.com/citation-style-language/styles
)
).
The
`
citation_languag
e`
settings defines what language to use when formatting
The
`
local
e`
settings defines what language to use when formatting
your references (this typically applies to localized terms, e.g., 'Eds.' for
editors in English).
The
`source`
option indicates where your bibliographies are stored;
`bibliography`
is the name of your default bibliography.
### Bibliographies
Once you have loaded Jekyll-Scholar, all files with the extension
`.bib`
or
...
...
@@ -47,17 +59,17 @@ the citation style and language defined in your configuration file.
For example, if you had a file
`bibliography.bib`
in your root directory:
---
---
References
==========
@book{ruby,
title = {The Ruby Programming Language},
author = {Flanagan, David and Matsumoto, Yukihiro},
year = {2008},
publisher = {O'Reilly Media}
}
---
---
References
==========
@book{ruby,
title = {The Ruby Programming Language},
author = {Flanagan, David and Matsumoto, Yukihiro},
year = {2008},
publisher = {O'Reilly Media}
}
It would be converted to
`bibliography.html`
with the following content:
...
...
@@ -65,14 +77,50 @@ It would be converted to `bibliography.html` with the following content:
<p>Flanagan, D., & Matsumoto, Y. (2008). <i>The Ruby Programming Language</i>. O’Reilly Media.</p>
This makes it very easy for you to add you bibliography to your Jekyll-powered
This makes it very easy for you to add you
r
bibliography to your Jekyll-powered
blog or website.
If your using other converters to generate your site, don't worry, you can
still generate bibliographies using the
`bibliography`
tag. In your site
or blog post, simply call:
{% bibliography %}
This will generate your default bibliography; if you use multiple, you can
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:
{% bibliography books %}
{% bibliography papers %}
### Citations
Jekyll-Scholar will support inline citations and automatic generation of
a list of references for individual blog posts. Stay tuned.
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:
"Once upon a midnight dreary..." {{% cite poe %}}
Contributing
------------
The Jekyll-Scholar source code is
[
hosted on GitHub
](
http://github.com/inukshuk/jekyll-scholar/
)
.
You can check out a copy of the latest code using Git:
$ git clone https://github.com/inukshuk/jekyll-scholar.git
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.
License
...
...
lib/jekyll/scholar/converters/bibtex.rb
View file @
b9d2331b
...
...
@@ -27,10 +27,10 @@ module Jekyll
end
def
convert
(
content
)
content
=
BibTeX
.
parse
(
content
,
:include
=>
[
:meta_content
],
:filter
=>
[
:latex
]).
map
do
|
b
|
content
=
BibTeX
.
parse
(
content
,
:strict
=>
true
,
:include
=>
[
:meta_content
],
:filter
=>
[
:latex
]).
map
do
|
b
|
if
b
.
respond_to?
(
:to_citeproc
)
CiteProc
.
process
b
.
to_citeproc
,
:style
=>
@config
[
'
citation_
style'
],
:locale
=>
@config
[
'
citation_
locale'
],
:format
=>
'html'
CiteProc
.
process
b
.
to_citeproc
,
:style
=>
@config
[
'style'
],
:locale
=>
@config
[
'locale'
],
:format
=>
'html'
else
b
.
is_a?
(
BibTeX
::
MetaContent
)
?
b
.
to_s
:
''
end
...
...
lib/jekyll/scholar/tags/bibliography.rb
View file @
b9d2331b
...
...
@@ -39,6 +39,10 @@ module Jekyll
end
def
extend_path
(
name
)
if
name
.
nil?
||
name
.
empty?
name
=
config
[
'bibliography'
]
end
p
=
File
.
join
(
config
[
'source'
],
name
)
p
<<
'.bib'
unless
File
.
exists?
(
p
)
p
...
...
Write
Preview
Supports
Markdown
0%
Try again
or
attach a new file
.
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Cancel
Please
register
or
sign in
to comment