Class: Jekyll::ReferencesTag

Inherits:
Liquid::Tag
  • Object
show all
Defined in:
lib/jekyll-references.rb

Instance Method Summary collapse

Constructor Details

#initialize(tag_name, text, tokens) ⇒ ReferencesTag

Returns a new instance of ReferencesTag.



8
9
10
11
 
# File 'lib/jekyll-references.rb', line 8

def initialize(tag_name, text, tokens)
  super
  @title = text
end

Instance Method Details

#parse_ref(ref, ref_style, ref_lang) ⇒ Object 



250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
 
# File 'lib/jekyll-references.rb', line 250

def parse_ref(ref, ref_style, ref_lang)
  # Initialize return reference
  final_reference = ""

  if ref_style == 'chicago' or ref_style == 'turabian' or ref_style == 'chicago/turabian'
    ref_style = 'chicago-annotated-bibliography'
  elsif ref_style == ''
    ref_style = 'vancouver'
  end

  if ref["doi"]
    # If there is a DOI set, retrieve data from it
    URI.open("https://doi.org/" + ref["doi"].to_s, 'Accept' => "text/bibliography; style=#{ref_style}; lang=#{ref_lang}") do |f|
      f.each do |line|
        final_reference = line
      end
    end
    case ref_style
    when 'apa', 'american psychological association'
      final_reference.gsub!(/(https?:\/\/doi.org\/.+)$/, '<a href="\1" targer="_blank">DOI</a>')
    when 'mla', 'modern language association'
      final_reference.gsub!(/.”/, "&rdquo;.")
      final_reference.gsub!(/Crossref, (https?:\/\/doi.org\/.+)\.$/, '<a href="\1" targer="_blank">Crossref</a>.')
    when 'chicago', 'turabian', 'chicago/turabian'
      final_reference.gsub!(/,”/, "&rdquo;,")
    when 'ieee', 'institute of electrical and electronics engineers'
      final_reference.gsub!(/^\[\d+\]/, '')
      final_reference.gsub!(/,”/, "&rdquo;,")
      final_reference.gsub!(/doi: (.+)\.$/, '<a href="https://doi.org/\1" targer="_blank">doi</a>.')
    else # Vancouver, the default
      final_reference.gsub!(/^\d+\./, '')
      final_reference.gsub!(/Available from: (.+)/, 'Available <a href="\1" targer="_blank">here</a>.')
    end
  else
    # If there isn't a DOI, mount it from metadata
    final_reference = reference(ref_style, ref)
  end

  # Return parsed reference
  final_reference
end

#reference(style, ref) ⇒ Object 



13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
 
# File 'lib/jekyll-references.rb', line 13

def reference(style, ref)
  # Initialize return reference
  final_reference = ''

  # Parse article data according to style
  case style
  when 'apa', 'american psychological association'
    # Parse authors
    if ref["organization"].to_s != ''
      # If organization, use full name
      final_reference = ref["organization"].to_s + "."
    else
      # Otherwise, use APA abbreviations
      ref["authors"].map! do |author|
        author = author.split
        last_name = author.pop
        fist_names = author.map do |n|
          n[0].upcase + "."
        end
        fist_names = fist_names.join
        author = last_name + " " + fist_names

        author
      end
      final_reference = ref["authors"].join(', ') + "."
    end
    # Parse publication date
    if ref["publication"].to_s != ''
      final_reference += " (" + ref["publication"].to_s + ")."
    end
    # Parse article title
    final_reference += " " + ref["title"] + "."
    # If published in a journal
    if ref["journal"].to_s != ''
      # Parse journal
      final_reference += " " + ref["journal"]
      # Parse volume and issue
      if ref["volume"].to_s != '' and ref["issue"].to_s != ''
        final_reference += ", " + ref["volume"].to_s + "(" + ref["issue"].to_s + ")"
      elsif ref["volume"].to_s != ''
        final_reference += ", " + ref["volume"].to_s
      end
      # Parse pages
      if ref["pages"].to_s != ''
        final_reference += ", " + ref["pages"].to_s
      end
    end
    final_reference += "."
  when 'mla', 'modern language association'
    # Parse authors
    if ref["organization"].to_s != ''
      # If organization, use full name
      final_reference = ref["organization"].to_s + ". "
    elsif ref["authors"].length > 0
      # Otherwise, use authors' list
      author = ref["authors"][0].split
      last_name = author.pop
      author = author.join(" ")
      author = last_name + ", " + author

      # Append 'et al' is more than 1 author
      if ref["authors"].length > 1
        author += ", et al"
      end

      # Begin reference with author(s)
      final_reference = author + ". "
    end
    # Parse article title
    final_reference += "&ldquo;" + ref["title"] + "&rdquo;."
    # Parse journal
    if ref["journal"].to_s != ''
      final_reference += " " + ref["journal"]
    end
    # Parse volume
    if ref["volume"].to_s != ''
      final_reference += ", vol. " + ref["volume"].to_s
    end
    # Parse issue
    if ref["issue"].to_s != ''
      final_reference += ", no. " + ref["issue"].to_s
    end
    # Parse publication date
    if ref["publication"].to_s != ''
      final_reference += ", " + ref["publication"].to_s
    end
    # Parse pages
    if ref["pages"].to_s != ''
      final_reference += ", " + (ref["pages"].include?("-") ? "pp" : "p") + ". "
      final_reference += ref["pages"].to_s
    end
    final_reference += "."
  when 'chicago-annotated-bibliography'
    final_reference = []
    # Parse authors
    if ref["organization"].to_s != ''
      # If organization, use full name
      final_reference.push(ref["organization"].to_s)
    else
      # Otherwise, use Chicago listing
      if ref["authors"].length > 2
        last_author = ref["authors"].pop
        final_reference.push(ref["authors"].join(', ') + ", &amp; " + last_author)
      elsif ref["authors"].length == 2
        final_reference.push(ref["authors"].join(" &amp; "))
      else
        final_reference.push(ref["authors"][0])
      end
    end
    # Parse publication date
    if ref["publication"].to_s != ''
      final_reference.push(ref["publication"].to_s)
    end
    # Parse article title
    final_reference.push("&ldquo;" + ref["title"] + "&rdquo;")
    # Parse journal
    if ref["journal"].to_s != ''
      journal = ref["journal"]
      # Parse volume and issue
      if ref["volume"].to_s != '' and ref["issue"].to_s != ''
        journal += " " + ref["volume"].to_s + "(" + ref["issue"].to_s + ")"
      elsif ref["volume"].to_s != ''
        journal += " " + ref["volume"].to_s
      end
      # Parse pages
      if ref["pages"].to_s != ''
        journal += ": " + ref["pages"].to_s
      end

      final_reference.push(journal)
    end
    final_reference = final_reference.join(", ") + "."
  when 'ieee', 'institute of electrical and electronics engineers'
    final_reference = []
    # Parse authors
    if ref["organization"].to_s != ''
      # If organization, use full name
      final_reference.push(ref["organization"].to_s)
    else
      # Parse authors' name to IEEE abbreviation
      ref["authors"].map! do |author|
        author = author.split
        last_name = author.pop
        author.map do |name|
          name[0].upcase + "."
        end
        author = author.join(' ') + ' ' + last_name

        author
      end
      # And join them using Oxford-comma-conventions
      if ref["authors"].length > 2
        last_author = ref["authors"].pop
        final_reference.push(ref["authors"].join(', ') + ", &amp; " + last_author)
      elsif ref["authors"].length == 2
        final_reference.push(ref["authors"].join(" &amp; "))
      else
        final_reference.push(ref["authors"][0])
      end
    end
    # Parse article title
    final_reference.push("&ldquo;" + ref["title"] + "&rdquo;")
    # Parse journal
    if ref["journal"].to_s != ''
      final_reference.push(ref["journal"])
    end
    # Parse volume
    if ref["volume"].to_s != ''
      final_reference.push("vol. " + ref["volume"].to_s)
    end
    # Parse issue
    if ref["issue"].to_s != ''
      final_reference.push("no. " + ref["issue"].to_s)
    end
    # Parse pages
    if ref["pages"].to_s != ''
      final_reference.push((ref["pages"].include?("-") ? "pp" : "p") + ". " + ref["pages"].to_s)
    end
    # Parse publication date
    if ref["publication"].to_s != ''
      final_reference.push(ref["publication"].to_s)
    end
    final_reference = final_reference.join(", ") + "."
  else # Vancouver, the default
    # Parse authors
    if ref["organization"].to_s != ''
      # If organization, use full name
      final_reference = ref["organization"].to_s + "."
    else
      # Otherwise, use Vancouver abbreviations
      ref["authors"].map! do |author|
        author = author.split
        last_name = author.pop
        fist_names = author.map do |n|
          n[0].upcase
        end
        fist_names = fist_names.join('')
        author = last_name + " " + fist_names

        author
      end
      final_reference = ref["authors"].join(', ') + "."
    end
    # Parse article title
    final_reference += " " + ref["title"] + "."
    # If published in a journal
    if ref["journal"].to_s != ''
      # Parse journal
      final_reference += " " + ref["journal"] + "."
      # Parse publication date
      if ref["publication"].to_s != ''
        final_reference += " " + ref["publication"].to_s + ";"
      end
      # Parse volume and issue
      if ref["volume"].to_s != '' and ref["issue"].to_s != ''
        final_reference += ref["volume"].to_s + "(" + ref["issue"].to_s + ")"
      elsif ref["volume"].to_s != ''
        final_reference += ref["volume"].to_s
      end
      # Parse pages
      if ref["pages"].to_s != ''
        final_reference += ":" + ref["pages"].to_s
      end
    else
      # Parse publication date
      if ref["publication"].to_s != ''
        final_reference += " " + ref["publication"].to_s
      end
    end
    final_reference.gsub!(/;([:\.,])/, "\1")
    final_reference += "."
  end

  # Return parsed reference
  final_reference.gsub(/[\.,]{2}/, ".")
end

#render(context) ⇒ Object 



292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
 
# File 'lib/jekyll-references.rb', line 292

def render(context)
  # Retrieve references from page
  refs = context.registers[:page]["references"]
  # Retrieve references style
  ref_style = context.registers[:site].config["references"]["style"].downcase
  # Retrieve references language
  ref_lang = context.registers[:site].config["references"]["lang"]

  # Build output
  output = "<h2>#{@title}</h2>\n"
  output += "<ol>\n"
  refs.each do |r|
    output += "<li id=\"ref-#{r[0]}\">#{parse_ref(r[1], ref_style, ref_lang)}</li>\n"
  end
  output += "</ol>"
  # Return output
  output
end