asciidoctor-bibtex 0.5.0 → 0.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: cad05b0990309ce242e6f8e83a5a5c0122f07f5a23130d77f740d8c635611162
-  data.tar.gz: '01323158119adf765dfa92c09e0e4a4da63a3bf4ca2b7390a47d687c1b4b2855'
+  metadata.gz: 6d1f03803a062ef4e551b3b974200595dd61e1b79d5b1e55f476b4aa9191abdb
+  data.tar.gz: edcba2be0db713c30e82b155cb350e70fc3ffe64db6709d7ab3740251ccb8e37
 SHA512:
-  metadata.gz: c52687565a3ac2de6a25cf020eabcf3a13732b693ec34bcc0d60c17cd2e526c53e528a08fe7a809a89604f88a027a362e526d769537e363b7de841ed7018178b
-  data.tar.gz: bdd90bb7544d361890da697587c0d2be118a03f7b894e579fd80bdea3d85eefa124f58e605dfcfdf895bde8ef7acc6cfaad4b41838ac9e5d13c005c540794cde
+  metadata.gz: 7ddbc0f7c25bc17f2bf25eb6e4711bbab5583a1e1ea472e911cacd04798a345c5bb6cf5a44bcf8504db65b4bb1efbf4a883c9f552d1fa40a9a94ea283c999c65
+  data.tar.gz: df997b1243e28c0f42e13083df3a6f57b7afadca8895d08268d4ede6ceba48ad34e1cd70b9948b247cda6e400aa61aa25c8b88d90f04a7b5d5937a6a0328de5e

data/README.adoc

@@ -0,0 +1,151 @@
+= asciidoctor-bibtex: bibtex integration for AsciiDoc
+// Settings:
+:idprefix:
+:idseparator: -
+ifndef::env-github[:icons: font]
+ifdef::env-github,env-browser[]
+:toc: macro
+:toclevels: 1
+endif::[]
+ifdef::env-github[]
+:!toc-title:
+:status:
+endif::[]
+// URLs:
+:url-asciidoctor: http://asciidoctor.org
+:url-asciidoctor-mathematical: https://github.com/asciidoctor/asciidoctor-mathematical
+:url-asciidoctor-pdf: https://github.com/asciidoctor/asciidoctor-pdf
+:url-asciidoctor-latex: https://github.com/asciidoctor/asciidoctor-latex
+:url-asciidoc-bib: https://github.com/petercrlane/asciidoc-bib
+:url-gem: https://rubygems.org/gems/asciidoctor-bibtex
+
+ifdef::status[]
+image:https://img.shields.io/travis/asciidoctor/asciidoctor-bibtex/master.svg[Build Status (Travis CI),link=https://travis-ci.org/asciidoctor/asciidoctor-bibtex]
+image:https://img.shields.io/gem/v/asciidoctor-bibtex.svg[Latest Release, link=https://rubygems.org/gems/asciidoctor-bibtex]
+endif::[]
+
+asciidoctor-bibtex adds bibtex integration to AsciiDoc documents by introducing three new macros: `cite:[KEY]`, `bibitem:[KEY]` and `bibliography::[]`. Citations are parsed and replaced with formatted inline texts, and reference lists are automatically generated and inserted into where `bibliography::[]` is placed. `bibitem:[KEY]` will insert a rendered bibliography item directly into the text.
+
+asciidoctor-bibtex is designed to be used as an extension to {url-asciidoctor}[Asciidoctor]. Thus this extension can be used together with other asciidoctor extensions such as {url-asciidoctor-mathematical}[asciidoctor-mathematical] and {url-asciidoctor-pdf}[asciidoctor-pdf] to enrich your AsciiDoc experience.
+
+NOTE: asciidoctor-bibtex no longer supports AsciiDoc-to-AsciiDoc conversion.
+
+== History
+
+asciidoctor-bibtex starts as a fork of {url-asciidoc-bib}[asciidoc-bib] and goes along a different path.
+The major reason for the fork at the time was the differences in citation and bibliography macros.
+asciidoc-bib failed to follow the grammar of macros in AsciiDoc and thus caused problems with existing documents and extensions.
+Thus, a fork was needed.
+Another reason was the inability to pass configuration via AsciiDoc attributes.
+
+While {url-asciidoc-bib}[asciidoc-bib] focuses on replacing citations in the original documents and produces new AsciiDoc documents, asciidoctor-bibtex focuses on compatibility with Asciidoctor and other Asciidoctor extensions at the very beginning.
+As time passes, asciidoctor-bibtex diverges significantly from its ancesstor.
+For example, asciidoctor-bibtex now supports generating real bibtex citations and bibliography, so it can be used together with {url-asciidoctor-latex}[asciidoctor-latex] for native bibtex support.
+
+== Install
+
+ $ gem install asciidoctor-bibtex
+
+asciidoctor-bibtex depends on https://github.com/inukshuk/bibtex-ruby[bibtex-ruby], https://github.com/inukshuk/citeproc-ruby[citeproc-ruby], and https://github.com/inukshuk/csl-styles[csl-styles].
+Ensure the `ruby-dev` and `libxslt1-dev` packages are installed on your machine so the dependencies will compile properly.
+
+{url-asciidoctor}[Asciidoctor] must also be installed for 'asciidoctor-bibtex' to work.
+Asciidoctor version 2.0.0 or higher is required.
+
+== Usage
+
+First, you need to have a valid bibtex file.
+You specify the location to this file using the `bibtex-file` document attribute.
+
+=== Macros
+
+Syntax for inserting a citation is the following inline macro:
+
+ cite|citenp:[ref(pages), ...]
+
+where '(pages)' is optional.
+
+Examples of "chicago-author-date" style:
+
+* `cite:[Lane12]` becomes "(Lane 2012)"
+* `citenp:[Lane12]` becomes "Lane (2012)"
+* `cite:[Lane12(59)]` becomes "(Lane 2012, 59)"
+
+For *apa* (Harvard-like) style:
+
+* `cite:[Lane12]` becomes "(Lane, 2012)"
+* `citenp:[Lane12]` becomes "Lane (2012)"
+* `cite:[Lane12(59)]` becomes "(Lane, 2012, p.59)"
+
+For *ieee*, a numeric style:
+
+`cite:[Lane12,Lane11]` becomes "[1, 2]"
+
+To add a list of formatted references, place `bibliography::[]` on a line by itself.
+
+One can use `bibitem:[Lane12]` to insert a rendered bibliography item inline, maybe to generate a cv. For example:
+
+[source, asciidoc]
+----
+= My CV
+
+== Publications
+
+=== 2019
+
+- bibitem:[Me2019a]
+- bibitem:[Me2019b]
+- bibitem:[Me2019c]
+----
+
+=== Configuration
+
+Configuration is applied in the form of AsciiDoc document attributes, which must be defined in the document header.
+
+|===
+| Attribute Name | Description | Valid Values | Default Value
+
+| bibtex-file
+| Bibtex database file
+| any string, or empty
+| Automatic searching
+
+| bibtex-style
+| Reference formatting style
+| any style supported by csl-styles
+| ieee
+
+| bibtex-order
+| Order of citations
+| `appearance` or `alphabetical`
+| `appearance`
+
+| bibtex-format
+| Formatting of citations and bibliography
+| `asciidoc`, `bibtex` or `biblatex`
+| `asciidoc`
+
+| bibtex-throw
+| Throw an error on unknown references
+| `true` or `false`
+| `false`
+
+| bibtex-citation-template
+| Custom citation template for numeric style
+| Any string matching `/(.+?)\$id(.+)/`
+| `[$id]`
+|===
+
+=== Commandline
+
+Use asciidoctor-bibtex as an extension with the CLI:
+
+ $ asciidoctor -r asciidoctor-bibtex sample.adoc
+
+== License
+
+The files within this project may be distributed under the terms of the http://owl.apotheon.org[Open Works License].
+
+== Links
+
+See {url-asciidoc-bib} for the original asciidoc-bib source.

data/lib/asciidoctor-bibtex/bibitem_macro.rb

@@ -0,0 +1,53 @@
+#
+# BibitemMacro.rb
+#
+# Copyright (c) Zhang Yang, 2020.
+#
+# Released under Open Works License, 0.9.2
+#
+
+module AsciidoctorBibtex
+  # BibitemMacro
+  #
+  # Class to hold information about a bibitem macro.  A bibtem macro has
+  # only text and key
+  #
+  # This class also provides a class method to extract macros from a line of
+  # text.
+  #
+  class BibitemMacro
+    #
+    # Grammar for the bibitem macro: bibitem:[key]
+    #
+
+    # matches a bibitem key
+    BIBITEM_KEY = /[^\s\]]+/.freeze
+    # matches the full macro
+    BIBITEM_MACRO = /bibitem:\[(#{BIBITEM_KEY})\]/.freeze
+
+    # Given a line, return a list of BibitemMacro instances
+    def self.extract_macros(line)
+      result = []
+      full = BIBITEM_MACRO.match line
+      while full
+        text = full[0]
+        key = full[1]
+        result << BibitemMacro.new(text, key)
+        # look for next citation on line
+        full = BIBITEM_MACRO.match full.post_match
+      end
+      result
+    end
+
+    attr_reader :text, :key
+
+    # Create a BibitemMacro object
+    #
+    # text: the full macro text matched by BIBITEM_MACRO
+    # key: bibitem key
+    def initialize(text, key)
+      @text = text
+      @key = key
+    end
+  end
+end

data/lib/asciidoctor-bibtex/{CitationMacro.rb → citation_macro.rb}

@@ -54,7 +54,7 @@ module AsciidoctorBibtex
 
     # Given a line, return a list of CitationData instances
     # containing information on each set of citation information
-    def self.extract_citations(line)
+    def self.extract_macros(line)
       result = []
       full = CITATION_MACRO.match line
       while full

data/lib/asciidoctor-bibtex/extensions.rb

@@ -7,8 +7,8 @@ require 'asciidoctor/extensions'
 require 'asciidoctor/reader'
 require 'asciidoctor/parser'
 
-require_relative 'PathUtils'
-require_relative 'Processor'
+require_relative 'path_utils'
+require_relative 'processor'
 
 module AsciidoctorBibtex
   module Asciidoctor
@@ -67,10 +67,14 @@ module AsciidoctorBibtex
         bibtex_order = ((document.attr 'bibtex-order') || 'appearance').to_sym
         bibtex_format = ((document.attr 'bibtex-format') || 'asciidoc').to_sym
         bibtex_throw = ((document.attr 'bibtex-throw') || 'false').to_s.downcase
+        bibtex_citation_template = ((document.attr 'bibtex-citation-template') || '[$id]').to_s
 
         # Fild bibtex file automatically if not supplied.
         if bibtex_file.empty?
-          bibtex_file = AsciidoctorBibtex::PathUtils.fild_bibfile '.'
+          bibtex_file = AsciidoctorBibtex::PathUtils.find_bibfile document.base_dir
+        end
+        if bibtex_file.empty?
+          bibtex_file = AsciidoctorBibtex::PathUtils.find_bibfile '.'
         end
         if bibtex_file.empty?
           bibtex_file = AsciidoctorBibtex::PathUtils.find_bibfile "#{ENV['HOME']}/Documents"
@@ -84,23 +88,32 @@ module AsciidoctorBibtex
         prose_blocks = document.find_by do |b|
           (b.content_model == :simple) ||
             (b.context == :list_item) ||
-            (b.context == :table_cell)
+            (b.context == :table_cell) ||
+            (b.title?)
         end
         return nil if prose_blocks.nil?
 
         processor = Processor.new bibtex_file, true, bibtex_style, bibtex_locale,
                                   bibtex_order == :appearance, bibtex_format,
-                                  bibtex_throw == 'true'
+                                  bibtex_throw == 'true', custom_citation_template: bibtex_citation_template
 
         # First pass: extract all citations.
         prose_blocks.each do |block|
           if block.context == :list_item || block.context == :table_cell
-            line = block.text
-            processor.process_citation_macros line
-          else
+            # NOTE: we access the instance variable @text for raw text.
+            # Otherwise the footnotes in the text will be pre-processed and
+            # ghost footnotes will be inserted (as of asciidoctor 2.0.10).
+            line = block.instance_variable_get(:@text)
+            unless line.nil? || line.empty?
+              processor.process_citation_macros line
+            end
+          elsif block.content_model == :simple
             block.lines.each do |line|
               processor.process_citation_macros line
             end
+          else
+            line = block.instance_variable_get(:@title)
+            processor.process_citation_macros line
           end
         end
         # Make processor finalize macro processing as required.
@@ -109,14 +122,25 @@ module AsciidoctorBibtex
         # Second pass: replace citations with citation texts.
         prose_blocks.each do |block|
           if block.context == :list_item || block.context == :table_cell
-            line = block.text
-            line = processor.replace_citation_macros(line)
-            block.text = line
-          else
+            # NOTE: we access the instance variable @text for raw text.
+            line = block.instance_variable_get(:@text)
+            unless line.nil? or line.empty?
+              line = processor.replace_citation_macros(line)
+              line = processor.replace_bibitem_macros(line)
+              block.text = line
+            end
+          elsif block.content_model == :simple
             block.lines.each_with_index do |line, index|
               line = processor.replace_citation_macros(line)
+              line = processor.replace_bibitem_macros(line)
               block.lines[index] = line
             end
+          else
+            # NOTE: we access the instance variable @text for raw text.
+            line = block.instance_variable_get(:@title)
+            line = processor.replace_citation_macros(line)
+            line = processor.replace_bibitem_macros(line)
+            block.title = line
           end
         end
 

data/lib/asciidoctor-bibtex/{Processor.rb → processor.rb}

@@ -16,10 +16,11 @@ require 'latex/decode/symbols'
 require 'latex/decode/greek'
 require 'set'
 
-require_relative 'CitationMacro'
-require_relative 'CitationUtils'
-require_relative 'StringUtils'
-require_relative 'StyleUtils'
+require_relative 'citation_macro'
+require_relative 'citation_utils'
+require_relative 'bibitem_macro'
+require_relative 'string_utils'
+require_relative 'style_utils'
 
 module AsciidoctorBibtex
   # This filter extends the original latex filter in bibtex-ruby to handle
@@ -49,7 +50,7 @@ module AsciidoctorBibtex
   class Processor
     def initialize(bibfile, links = false, style = 'ieee', locale = 'en-US',
                    numeric_in_appearance_order = false, output = :asciidoc,
-                   throw_on_unknown = false)
+                   throw_on_unknown = false, custom_citation_template: '[$id]')
       raise "File '#{bibfile}' is not found" unless FileTest.file? bibfile
 
       bibtex = BibTeX.open bibfile, filter: [LatexFilter]
@@ -62,6 +63,13 @@ module AsciidoctorBibtex
       @filenames = Set.new
       @output = output
       @throw_on_unknown = throw_on_unknown
+      @bibtex_ob = '['
+      @bibtex_cb = ']'
+      match = custom_citation_template.match(/^(.+?)\$id(.+)$/)
+      unless match.nil?
+        @bibtex_ob = match[1]
+        @bibtex_cb = match[2]
+      end
 
       if (output != :latex) && (output != :bibtex) && (output != :biblatex)
         @citeproc = CiteProc::Processor.new style: @style, format: :html, locale: @locale
@@ -75,7 +83,7 @@ module AsciidoctorBibtex
     # processor will build a list of all citation keys in the same order as they
     # appear in the original document.
     def process_citation_macros(line)
-      CitationMacro.extract_citations(line).each do |citation|
+      CitationMacro.extract_macros(line).each do |citation|
         @citations += citation.items.collect(&:key)
       end
     end
@@ -97,7 +105,10 @@ module AsciidoctorBibtex
           # Remove { } from grouped names for sorting.
           author = bibitem.author
           author = bibitem.editor if author.nil?
-          CitationUtils.author_chicago(author).collect { |s| s.upcase.gsub('{', '').gsub('}', '') } + [bibitem.year]
+          year = bibitem.year
+          sortable = CitationUtils.author_chicago(author).map { |s| s.upcase.delete '{}' }
+          sortable << year if year
+          sortable
         end
       end
       nil
@@ -107,19 +118,29 @@ module AsciidoctorBibtex
     #
     # Return new text with all macros replaced.
     def replace_citation_macros(line)
-      CitationMacro.extract_citations(line).each do |citation|
+      CitationMacro.extract_macros(line).each do |citation|
         line = line.gsub(citation.text, build_citation_text(citation))
       end
       line
     end
 
+    # Replace bibitem macros with rendered bibitem.
+    #
+    # Return new text with all macros replaced.
+    def replace_bibitem_macros(line)
+      BibitemMacro.extract_macros(line).each do |item|
+        line = line.gsub(item.text, build_bibitem_text(item.key))
+      end
+      line
+    end
+
     # Build the bibliography list just as bibtex.
     #
     # Return an array of texts representing an asciidoc list.
     def build_bibliography_list
       result = []
-      @citations.each do |ref|
-        result << build_bibliography_item(ref)
+      @citations.each_with_index do |ref, index|
+        result << build_bibliography_item(ref, index)
         result << ''
       end
       result
@@ -129,17 +150,42 @@ module AsciidoctorBibtex
     # Internal functions
     #
 
+    # Build the asciidoc text for a single bibliography item
+    def build_bibitem_text(key)
+      begin
+        if @biblio[key].nil?
+          puts "Unknown reference: #{key}"
+          cptext = key
+        else
+          cptext = @citeproc.render :bibliography, id: key
+          cptext = cptext.first
+        end
+      rescue Exception => e
+        puts "Failed to render #{key}: #{e}"
+        cptext = key
+      end
+      StringUtils.html_to_asciidoc(cptext)
+    end
+
     # Build bibliography text for a given reference
-    def build_bibliography_item(key)
+    def build_bibliography_item(key, index = 0)
+      index += 1
       result = ''
-      result << '. ' if StyleUtils.is_numeric? @style
 
       begin
-        cptext = @citeproc.render :bibliography, id: key
+        cptext = if @biblio[key].nil?
+                   nil
+                 else
+                   @citeproc.render :bibliography, id: key
+                 end
       rescue Exception => e
         puts "Failed to render #{key}: #{e}"
       end
+
       result << "[[#{key}]]" if @links
+      if StyleUtils.is_numeric? @style
+        result << "#{@bibtex_ob}#{index}#{@bibtex_cb} "
+      end
       if cptext.nil?
         return result + key
       else
@@ -174,8 +220,8 @@ module AsciidoctorBibtex
       else
         result = ''
         if StyleUtils.is_numeric? @style
-          ob = '+[+'
-          cb = '+]+'
+          ob = "+#{@bibtex_ob}+"
+          cb = "+#{@bibtex_cb}+"
           separator = ','
         elsif macro.type == 'cite'
           ob = '('
@@ -197,14 +243,14 @@ module AsciidoctorBibtex
           # if found, insert reference information
           if @biblio[cite.key].nil?
             if @throw_on_unknown
-              raise "Unknown reference: #{cite.ref}"
+              raise "Unknown reference: #{cite.key}"
             else
-              puts "Unknown reference: #{cite.ref}"
-              cite_text = cite.ref.to_s
+              puts "Unknown reference: #{cite.key}"
+              cite_text = cite.key.to_s
             end
           else
             cite_text = citation_text(macro, cite)
-           end
+          end
 
           result << StringUtils.html_to_asciidoc(cite_text)
           result << '>>' if @links
@@ -226,13 +272,13 @@ module AsciidoctorBibtex
         result << ' '
         # use p.x for single numerical page and pp.x for all others. This will
         # produce pp. 1 seq for complex locators, which is the correct behavior.
-        if @style.include? 'chicago'
-          result << cite.locator
-        elsif /^\d+$/ =~ cite.locator
-          result << "p.&#160;#{cite.locator}"
-        else
-          result << "pp.&#160;#{cite.locator}"
-        end
+        result << if @style.include? 'chicago'
+                    cite.locator
+                  elsif /^\d+$/ =~ cite.locator
+                    "p.&#160;#{cite.locator}"
+                  else
+                    "pp.&#160;#{cite.locator}"
+                  end
       end
 
       result
@@ -263,7 +309,7 @@ module AsciidoctorBibtex
         cite_text = @citeproc.render :citation, id: cite.key
         cite_text = cite_text.gsub('(', '')
         cite_text = cite_text.gsub(')', '')
-        cite_text = cite_text + format_locator(cite)
+        cite_text += format_locator(cite)
         year = @biblio[cite.key].year
         if !year.nil? && macro.type == 'citenp'
           segs = cite_text.partition(year.to_s)

data/lib/asciidoctor-bibtex/version.rb

@@ -1,3 +1,3 @@
 module AsciidoctorBibtex
-  VERSION = '0.5.0'
+  VERSION = '0.8.0'
 end

metadata

@@ -1,49 +1,43 @@
 --- !ruby/object:Gem::Specification
 name: asciidoctor-bibtex
 version: !ruby/object:Gem::Version
-  version: 0.5.0
+  version: 0.8.0
 platform: ruby
 authors:
 - Zhang YANG
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-08-11 00:00:00.000000000 Z
+date: 2020-07-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: asciidoctor
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 2.0.0
-    - - "<"
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.0.0
+        version: '2.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 2.0.0
-    - - "<"
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.0.0
+        version: '2.0'
 - !ruby/object:Gem::Dependency
   name: bibtex-ruby
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '4'
+        version: '5.1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '4'
+        version: '5.1'
 - !ruby/object:Gem::Dependency
   name: citeproc-ruby
   requirement: !ruby/object:Gem::Requirement
@@ -92,63 +86,50 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '5'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '5'
-- !ruby/object:Gem::Dependency
-  name: bundler
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '2'
+        version: 5.11.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2'
+        version: 5.11.0
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '12'
+        version: 12.3.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '12'
-description: |
-  asciidoctor-bibtex adds bibtex support for asciidoc documents by introducing
-  two new macros: `cite:[KEY]` and `bibliography::[]`. Citations are parsed and
-  replaced with formatted inline texts, and reference lists are automatically
-  generated and inserted into where `bibliography::[]` is placed.  The
-  references are formatted using styles provided by CSL.
-email: zyangmath@gmail.com
+        version: 12.3.0
+description: 'asciidoctor-bibtex is an Asciidocotor extension that adds bibtex support
+  for AsciiDoc documents. It does so by introducing two new macros: `cite:[KEY]` and
+  `bibliography::[]`. Citations are parsed and replaced with formatted inline text,
+  and reference lists are automatically generated and inserted where the `bibliography::[]`
+  macro is placed. The references are formatted using styles provided by CSL.'
+email:
+- zyangmath@gmail.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
 - LICENSE.txt
-- README.md
+- README.adoc
 - lib/asciidoctor-bibtex.rb
-- lib/asciidoctor-bibtex/CitationMacro.rb
-- lib/asciidoctor-bibtex/CitationUtils.rb
-- lib/asciidoctor-bibtex/PathUtils.rb
-- lib/asciidoctor-bibtex/Processor.rb
-- lib/asciidoctor-bibtex/StringUtils.rb
-- lib/asciidoctor-bibtex/StyleUtils.rb
+- lib/asciidoctor-bibtex/bibitem_macro.rb
+- lib/asciidoctor-bibtex/citation_macro.rb
+- lib/asciidoctor-bibtex/citation_utils.rb
 - lib/asciidoctor-bibtex/extensions.rb
+- lib/asciidoctor-bibtex/path_utils.rb
+- lib/asciidoctor-bibtex/processor.rb
+- lib/asciidoctor-bibtex/string_utils.rb
+- lib/asciidoctor-bibtex/style_utils.rb
 - lib/asciidoctor-bibtex/version.rb
 homepage: https://github.com/asciidoctor/asciidoctor-bibtex
 licenses:
@@ -160,17 +141,17 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - "~>"
+  - - ">="
     - !ruby/object:Gem::Version
-      version: '2.0'
+      version: 2.4.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
+rubygems_version: 3.1.2
 signing_key: 
 specification_version: 4
-summary: Adding bibtex functionality to asciidoc
+summary: An Asciidoctor extension that adds bibtex integration to AsciiDoc
 test_files: []

data/README.md

@@ -1,104 +0,0 @@
-# asciidoctor-bibtex: add bibtex functionality to asciidoc
-
-asciidoctor-bibtex adds bibtex support for asciidoc documents by introducing
-two new macros: `cite:[KEY]` and `bibliography::[]`. Citations are parsed and
-replaced with formatted inline texts, and reference lists are automatically
-generated and inserted into where `bibliography::[]` is placed. 
-
-asciidoctor-bibtex is designed to be used as an extension to
-[asciidoctor](http://asciidoctor.org). Thus this extension can be used
-together with other asciidoctor extensions such as
-[asciidoctor-mathematical][] and [asciidoctor-pdf][] to enrich your
-asciidoc experience. Note that asciidoctor-bibtex no longer support asciidoc-to-asciidoc conversion.
-
-[asciidoctor-mathematical]: https://github.com/asciidoctor/asciidoctor-mathematical
-[asciidoctor-pdf]: https://github.com/asciidoctor/asciidoctor-pdf
-
-## History
-
-asciidoctor-bibtex starts as a fork of [asciidoc-bib][] and goes along a
-different way. The major reason for the fork at the time was the differences in
-citation and bibliography macros. asciidoc-bib failed to follow the grammar of
-macros in asciidoc, thus to avoid breaking existing documents, a fork is
-inevitable. Other reasons include the inability to use asciidoctor arguments
-in asciidoc-bib. 
-
-While [asciidoc-bib][] focuses on replacing citations in the original
-documents and produces new asciidoc documents, asciidoctor-bibtex focuses on
-compatibility with asciidoctor and other asciidoctor extensions at the very
-beginning. As time passes, asciidoctor-bibtex diverges significantly from its
-ancesstor. For example, asciidoctor-bibtex now supports generating real bibtex
-citations and bibliography, so it can be used together with
-[asciidoctor-latex][] for native bibtex support.
-
-[asciidoc-bib]: https://github.com/petercrlane/asciidoc-bib
-[asciidoctor-latex]: https://github.com/asciidoctor/asciidoctor-latex
-
-## Install
-
-    gem install asciidoctor-bibtex
-
-asciidoctor-bibtex depends on
-[bibtex-ruby](http://github.com/inukshuk/bibtex-ruby),
-[citeproc-ruby](http://github.com/inukshuk/citeproc-ruby) and
-[csl-styles](http://github.com/inukshuk/csl-styles).  (Ensure 'ruby-dev' and
-'libxslt1-dev' are installed, so the dependencies will compile.)
-
-[asciidoctor](https://github.com/asciidoctor/asciidoctor) must also be
-installed for 'asciidoctor-bibtex' to work. asciidoctor version 1.5.2 or
-higher is required.
-
-## Usage
-
-### Macros
-
-Syntax for inserting a citation is the following inline macro:
-
-    cite|citenp:[ref(pages), ...]
-
-where '(pages)' is optional.
-
-Examples of "chicago-author-date" style:
-
-- `cite:[Lane12]` becomes "(Lane 2012)"
-- `citenp:[Lane12]` becomes "Lane (2012)"
-- `cite:[Lane12(59)]` becomes "(Lane 2012, 59)"
-
-For *apa* (Harvard-like) style:
-
-- `cite:[Lane12]` becomes "(Lane, 2012)"
-- `citenp:[Lane12]` becomes "Lane (2012)"
-- `cite:[Lane12(59)]` becomes "(Lane, 2012, p.59)"
-
-For *ieee*, a numeric style:
-
-`cite:[Lane12,Lane11]` becomes "[1, 2]"
-
-To add a list of formatted references, place `bibliography::[]` on a line by itself.
-
-### Document Attributes
-
-| Attribute Name | Description                              | Valid Values                         | Default Value       |
-| -------------- | ---------------                          | ----------                           | --------------      |
-| bibtex-file    | Bibtex database file                     | any string, or empty                 | Automatic searching |
-| bibtex-style   | Reference formatting style               | any style supported by csl-styles    | ieee                |
-| bibtex-order   | Order of citations                       | `appearance` or `alphabetical`       | `appearance`        |
-| bibtex-format  | Formatting of citations and bibliography | `asciidoc`, `bibtex` or `biblatex` | `asciidoc`          |
-| bibtex-throw  | Throw an error on unknown references | `true` or `false` | `false`          |
-
-### Commandline
-
-Use asciidoctor-bibtex as an extension:
-
-```bash
-asciidoctor -r asciidoctor-bibtex sample.adoc
-```
-
-## License
-
-The files within this project may be distributed under the terms of 
-the Open Works License: http://owl.apotheon.org
-
-## Links
-
-See https://github.com/petercrlane/asciidoc-bib for the original asciidoc-bib.