Fix text block in bibliography (#94)

Author: zepinglee

.vscode/settings.json

@@ -6,7 +6,8 @@
         "editor.tabSize": 2
     },
     "[lua]": {
-        "editor.tabSize": 2
+        "editor.tabSize": 2,
+        "editor.formatOnSaveMode": "file"
     },
     "busted-test-explorer.args": [
         "-lua=texlua",

CHANGELOG.md

@@ -7,6 +7,11 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+### Added
+
+- Add support for grouping bibliography by authors ([#94](https://github.com/zepinglee/citeproc-lua/issues/94)).
+- Add `bib-name-sep` and `bib-after-name-sep` options to control the vertical space of author groups ([#94](https://github.com/zepinglee/citeproc-lua/issues/94)).
+
 ### Fixed
 
 - Fix missing `keyword` field when converted from BibTeX ([#97](https://github.com/zepinglee/citeproc-lua/issues/97)).

citeproc/citeproc-engine.lua

@@ -111,6 +111,7 @@ local Position = util.Position
 ---@field requires_sorting boolean
 ---@field widest_label string
 ---@field maxoffset integer
+---@field second_field_align string | boolean
 local Registry = {}
 
 
@@ -182,6 +183,7 @@ function CiteProc.new(sys, style, lang, force_lang)
       requires_sorting = false,
       widest_label = "",
       maxoffset = 0,
+      second_field_align = false,
     },
 
     cite_first_note_numbers = {},
@@ -486,7 +488,7 @@ function CiteProc:makeBibliography(bibsection)
 
   local params = {
     hangingindent = self.style.bibliography.hanging_indent,
-    ["second-field-align"] = self.style.bibliography.second_field_align or false,
+    ["second-field-align"] = self.style.bibliography.second_field_align or self.registry.second_field_align or false,
     linespacing = self.style.bibliography.line_spacing,
     entryspacing = self.style.bibliography.entry_spacing,
     maxoffset = self.registry.maxoffset,

citeproc/citeproc-manager.lua

@@ -822,6 +822,10 @@ function CslCitationManager:make_bibliography(filter_str)
         value = "{" .. table.concat(value, ", ") .. "}"
       else
         value = tostring(value)
+        if string.match(value, ",") or string.match(value, "^%s")
+            or string.match(value, "%s$") then
+          value = "{" .. value .. "}"
+        end
       end
       if value ~= "" then
         table.insert(bib_option_list, string.format("%s = %s", option, value))

citeproc/citeproc-node-group.lua

@@ -21,8 +21,8 @@ else
   util = require("citeproc.util")
 end
 
-local Element = element.Element
 
+local Element = element.Element
 
 ---@class Group: Element
 ---@field delimiter string?
@@ -50,6 +50,9 @@ function Group:build_ir(engine, state, context)
     ir.formatting = util.clone(self.formatting)
     ir.affixes = util.clone(self.affixes)
     ir.display = self.display
+    if self.display == "left-margin" then
+      engine.registry.second_field_align = "flush"
+    end
   end
   return ir
 end

citeproc/citeproc-node-text.lua

@@ -79,6 +79,11 @@ function Text:from_node(node)
   o:set_quotes_attribute(node)
   o:set_strip_periods_attribute(node)
   o:set_text_case_attribute(node)
+  -- `apa-annotated-bibliography.csl` uses `display="block"` for annotation.
+  -- Use display="indent" instead
+  if o.display == "block" and (o.variable == "note" or o.variable == "abstract") then
+    o.display = "indent"
+  end
   return o
 end
 
@@ -196,6 +201,9 @@ function Text:build_year_suffix_ir(engine, state, context)
   ir.group_var = group_var
   ir.affixes = util.clone(self.affixes)
   ir.display = self.display
+  if self.display == "left-margin" then
+    engine.registry.second_field_align = "flush"
+  end
   ir.formatting = util.clone(self.formatting)
   if self.quotes then
     ir.quotes = context:get_localized_quotes()

citeproc/citeproc-output.lua

@@ -1965,17 +1965,16 @@ LatexWriter.markups = {
   ["@vertical-align/baseline"] = false,
   ["@cite/entry"] = false,
   ["@bibliography/entry"] = function (str, context)
-    if string.match(str, "\\bibitem") then
-      str = str .. "\n"
-    else
-      str = "\\bibitem{" .. context.id .. "}\n" .. str .. "\n"
+    if not string.match(str, "\\bibitem") then
+      str = "\\bibitem{" .. context.id .. "}\n" .. str
     end
+    str = str .. "\n"
     return str
   end,
-  -- ["@display/block"] = false,
+  ["@display/block"] = "\\cslblock{%s}\n\n",
   -- ["@display/left-margin"] = '\n    <div class="csl-left-margin">%s</div>',
-  -- ["@display/right-inline"] = '<div class="csl-right-inline">%s</div>',
-  -- ["@display/indent"] = '<div class="csl-indent">%s</div>\n  ',
+  ["@display/right-inline"] = "%s",
+  ["@display/indent"] = "\n\n%s",
 }
 
 local latex_escape_table = {
@@ -2038,12 +2037,19 @@ function LatexWriter:write_display(inline, context)
     end
     res = string.format("\\bibitem[%s]{%s}\n", res, context.id)
 
-  elseif inline.div == "right-inline" then
-    return res
-
-  elseif inline.div == "block" then
-    res = "\n\n" .. res
-    return res
+  else
+    local key = string.format("@display/%s", inline.div)
+    if inline.div == "right-inline" then
+      -- Strip trailing spaces
+      -- variables_ContainerTitleShort.txt
+      res = string.gsub(res, "%s+$", "")
+    end
+    local format_str = self.markups[key]
+    if format_str then
+      res = string.format(format_str, res)
+    else
+      util.error("Unknown display type: " .. inline.div)
+    end
   end
   return res
 end

docs/citation-style-language-doc.tex

@@ -251,6 +251,20 @@ \section{Package setup}
   \cslsetup{bib-item-sep = 8 pt plus 4 pt minus 2 pt}
 \end{LaTeXdemo}
 
+\DescribeOption{bib-name-sep}
+Vertical space to be inserted between two name groups in a per-author reference
+list.
+The default value is zero.
+Note that this option only takes effect when its value is larger than
+\opt{bib-item-sep} because it's used with \cs{addvspace}.
+
+\DescribeOption{bib-after-name-sep}
+Vertical space to be inserted between the author block and the following
+entries in a per-author reference list.
+The default value is zero.
+Note that this option only takes effect when its value is larger than
+\opt{bib-item-sep} because it's used with \cs{addvspace}.
+
 \DescribeOption{bib-hang}
 The \opt{bib-hang} option sets the hanging indentation length which is
 usually used for author-date style references.

latex/citation-style-language-bib.sty

@@ -242,6 +242,7 @@
           }
       }
       { \skip_set:Nn \itemsep { \l__csl_bib_item_sep_tl } }
+    \bool_set_true:N \l_csl_bib_first_block_bool
   }
 
 
@@ -283,6 +284,26 @@
     \par
   }
 
+% Used for per-author publication listing
+\bool_new:N \l_csl_bib_first_block_bool
+
+\cs_new:Npn \cslblock #1
+  {
+    \bool_if:NF \l_csl_bib_first_block_bool
+      {
+        \skip_set:NV \l_tmpa_skip { \l__csl_bib_name_sep_tl }
+        \addvspace { \l_tmpa_skip }
+      }
+    \bool_set_false:N \l_csl_bib_first_block_bool
+    \item [ ]
+    \skip_horizontal:n { - \leftmargin }
+    % \hskip - \leftmargin \relax
+    #1
+    \par
+    \skip_set:NV \l_tmpa_skip { \l__csl_bib_after_name_sep_tl }
+    \addvspace { \l_tmpa_skip }
+  }
+
 \cs_new:Npn \__csl_print_back_refs:n #1
   % #1: list of {<page>}{<label>}{anchor}
   {

latex/citation-style-language.sty

@@ -76,6 +76,8 @@
 \tl_new:N \l__csl_bib_font_tl
 \bool_new:N \l__csl_bib_entry_page_break_bool
 \tl_new:N \l__csl_bib_item_sep_tl
+\tl_new:N \l__csl_bib_name_sep_tl
+\tl_new:N \l__csl_bib_block_sep_tl
 \tl_new:N \l__csl_bib_par_indent_tl
 \tl_new:N \l__csl_bib_hang_tl
 \str_new:N \l__csl_bib_ref_section_str
@@ -112,6 +114,8 @@
     bib-font .tl_set:N = \l__csl_bib_font_tl ,
     bib-entry-page-break .bool_set:N = \l__csl_bib_entry_page_break_bool ,
     bib-item-sep .tl_set:N = \l__csl_bib_item_sep_tl ,
+    bib-name-sep .tl_set:N = \l__csl_bib_name_sep_tl ,
+    bib-after-name-sep .tl_set:N = \l__csl_bib_after_name_sep_tl ,
     bib-par-indent .tl_set:N = \l__csl_bib_par_indent_tl ,
     bib-hang .tl_set:N = \l__csl_bib_hang_tl ,
     % ref section
@@ -141,6 +145,8 @@
     prefix-separator = { ~ } ,
     suffix-separator = { , ~ } ,
     bib-entry-page-break = true ,
+    bib-name-sep = { 0 pt } ,
+    bib-after-name-sep = { 0 pt } ,
     bib-par-indent = { \parindent } ,
     bib-hang = { 1 em } ,
     ref-section = none ,