asciidoctor-csl 0.3.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 91d11025bf31c30262f9edf298ebf53b5039c458d3d8415e782ee69778a0b2e5
-  data.tar.gz: 3f06bc987a676662545763a41483833e86a2eaade05cb4eb8aa7dff773171208
+  metadata.gz: 3b880f935d5f43d4ccfb97b46ff5622cd61aeea3bc71f6b97a18cb010ca68d32
+  data.tar.gz: 64a474f6dd9e279f965687eb3296aed7a4a27c0f30b1396020c4a6ced437bfbb
 SHA512:
-  metadata.gz: 75b1473dd6047b43cab042abc3d5cc1ea1cb3f0ec515342afa4db5f17a3d922b79a6a14b8abb22413b4d6ca0680c9bf580bb3ccd4819cddf6a02a9602010d1a3
-  data.tar.gz: ae2b790ba2d632736f6b1f9d61335b69ea86610f431623f5896f0e2b308d9fdc0da8023579cc0ca5ae716cd48bf9045bca8546c43f4924f2707da1938e5e03ce
+  metadata.gz: a5d3e789eb43329656c173d70668e30d1aa456066a61debb33c1da10c163b2f888d3548afcc14b9e31bcd6a9330bc0e89197ce41e0370e5480fe9b7184770e9e
+  data.tar.gz: 0e323c23f6adea8c4c701626971ee37a5a9af23475ef345b26802440e2605c6c663513d6c94f0062ebbd62a430dc89f349a34a6e80bc99e2b4021e0c972612d1

data/README.adoc

@@ -80,6 +80,10 @@ Other values are `book`, `column`, `figure`, `folio`, `issue`, `line`, `note`, `
 |`link`
 |If the document has a bibliography, each cited item links to its entry.
 Use `link=false` to disable this for a single citation.
+
+|`parens`
+|Use `parens=false` to leave out the parentheses around the citation, e.g. to write "(see Smith, 2020, or the appendix)" yourself.
+This removes the prefix and suffix the style puts around the whole citation; it does not affect brackets around each item, as in IEEE.
 |===
 
 With multiple keys, the locator and suffix apply to the last source, and the prefix to the first.

data/lib/asciidoctor-csl/citation_macro.rb

@@ -7,7 +7,7 @@ require 'citeproc'
 module AsciidoctorCsl
   # CitationMacro
   #
-  # The `cite:key1,key2[locator, label, prefix=..., suffix=..., link=false]` macro.
+  # The `cite:key1,key2[locator, label, prefix=..., suffix=..., link=false, parens=false]` macro.
   class CitationMacro < ::Asciidoctor::Extensions::InlineMacroProcessor
     include ::Asciidoctor::Logging
 
@@ -43,12 +43,8 @@ module AsciidoctorCsl
 
       items.last[:suffix] = ", #{attributes['suffix']}" if attributes['suffix']
 
-      if csl.nil?
-        logger.warn 'cite: CSL style not found'
-        return nil
-      end
-
       csl.engine.format.link_citations = @bibliography && attributes['link'] != 'false'
+      csl.engine.format.bare_citations = attributes['parens'] == 'false'
       text = csl.render(:citation, items)
       return create_footnote parent, text if csl.engine.style.info.citation_format == :note
 

data/lib/asciidoctor-csl/csl_renderer.rb

@@ -8,6 +8,8 @@ module AsciidoctorCsl
     PROTECTED_RX = /<<[^,>]+,|\{[\w-]+}|\b[a-z][\w-]*:\S*?\[[^\]]*\]|\[[^\]]*\](?=#)|\+\+\+.*?\+\+\+|\+[^+]+\+/
     PLACEHOLDER_RX = /\u0000(\d+)\u0000/
     URL_VARIABLES = %w[URL DOI].freeze
+    BLOCK_EDGE = "\u0001"
+    LINE_BREAK = " +\n{empty}" # {empty} keeps the next line from starting a list, comment, etc.
 
     # Whether rendered citations link to their bibliography entry.
     attr_accessor :link_citations
@@ -21,6 +23,9 @@ module AsciidoctorCsl
     # Whether we are rendering inside a citation's cross-reference, where links cannot nest.
     attr_accessor :in_xref
 
+    # Whether citations leave out the affixes of their layout.
+    attr_accessor :bare_citations
+
     def bibliography(bibliography, _locale = nil)
       bibliography.connector = "\n\n"
       bibliography
@@ -76,6 +81,18 @@ module AsciidoctorCsl
       end
     end
 
+    # Blocks get their own line.
+    # AsciiDoc has no margins, so the margin column stays inline.
+    def apply_display
+      case options[:display]
+      when 'block', 'indent' then output.replace "#{BLOCK_EDGE}#{output}#{BLOCK_EDGE}"
+      when 'left-margin' then output << ' '
+      when 'right-inline' then nil
+      else
+        logger.warn "csl: unsupported display '#{options[:display]}'"
+      end
+    end
+
     # Replace the AsciiDoc syntax by placeholders without letters, so we only transform actual text.
     def apply_text_case
       protected = []
@@ -88,16 +105,24 @@ module AsciidoctorCsl
       output.gsub!(PLACEHOLDER_RX) { protected[Regexp.last_match(1).to_i] } if protected
     end
 
-    # An affix that became part of a link is not added again.
+    # An affix that became part of a link is not added again, and bare citations have no layout affixes.
     def prefix
-      @prefix_in_link ? '' : super
+      @prefix_in_link || bare_citation_layout? ? '' : super
+    end
+
+    def suffix
+      bare_citation_layout? ? '' : super
     end
 
     protected
 
-    # Escape URLs and DOIs before any formatting, so AsciiDoc does not parse them.
+    # Before formatting, escape URLs and DOIs, so AsciiDoc does not parse them,
+    # and turn block edges into line breaks, so the layout's affixes stay on the first and last line.
     def setup!
       super
+      if node.is_a?(CSL::Style::Layout)
+        output.replace output.split(BLOCK_EDGE).map(&:strip).reject(&:empty?).join(LINE_BREAK)
+      end
       escape_url if node.is_a?(CSL::Style::Text) && URL_VARIABLES.include?(node.variable)
     end
 
@@ -134,6 +159,10 @@ module AsciidoctorCsl
       "pass:c[#{text.gsub(']', '\]')}]"
     end
 
+    def bare_citation_layout?
+      bare_citations && node.is_a?(CSL::Style::Layout) && node.parent.is_a?(CSL::Style::Citation)
+    end
+
     def url?(text)
       text.match?(%r{\Ahttps?://}i)
     end

data/lib/asciidoctor-csl/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module AsciidoctorCsl
-  VERSION = '0.3.0'
+  VERSION = '0.4.0'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: asciidoctor-csl
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.4.0
 platform: ruby
 authors:
 - Niko Strijbol