Punctuation Terms Missing: Leads to missing or misplaced spaces between labels and suffixes

[urshofer]

Hello –

Thanks for your lib. It's cool.

I found something that caused quite a lot of display errors in my case. It took me a while to get to the bottom of it.

(Most? All?) locale files define punctuations like this:

    <term name="open-quote">“</term>
    <term name="close-quote">”</term>
    <term name="open-inner-quote">‘</term>
    <term name="close-inner-quote">’</term>
    <term name="page-range-delimiter">–</term>

The Class Punctuation is defined like:

class Punctuation extends Enum
{
    public const OPEN_QUOTE = "open-quote";
    public const CLOSE_QUOTE = "close-quote";
    public const OPEN_INNER_QUOTE = "open-inner-quote";
    public const CLOSE_INNER_QUOTE = "close-inner-quote";
    public const PAGE_RANGE_DELIMITER = "page-range-delimiter";
    public const COLON = "colon";
    public const COMMA = "comma";
    public const SEMICOLON = "semicolon";

   ...

}

Obviously, there's a difference: Comma, Semicolon and Colon are missing.

This leads to render errors, for example here:

    private function appendLabel($data, $var, $name): string
    {
        $this->label->setVariable($var);
        $renderedLabel = trim($this->label->render($data));
        if (empty($renderedLabel)) {
            return $name;
        }
        if ($this->renderLabelBeforeName) {
            $delimiter = !in_array(
                trim($this->label->renderSuffix()),
                Punctuation::getAllPunctuations()
            ) ? " " : "";
            $result = $renderedLabel . $delimiter . trim($name);
        } else {
            $delimiter = !in_array(
                trim($this->label->renderPrefix()),
                Punctuation::getAllPunctuations()
            ) ? " " : "";
            $result = trim($name) . $delimiter . $renderedLabel;
        }
        return $result;
    }

Because Punctuation::getAllPunctuations() returns emtpy values for commas, semicolons and colons. A suffix like " " is trimmed to "" and equals therefore to Comma, Semicolon or Colon, which is obviously wrong.

Without changing the code, a simple workaround is to add the following terms to the csl file:

      <term name="comma">,</term>
      <term name="colon">:</term>
      <term name="semicolon">;</term>

Otherwise, setting a default for these 3 values might be better. Would be true for most of the locales.

❤️

[glorieux-f]

Could you provide a CSL-JSON record and a CSL style ? I’m working on this issue on my fork because I suspect it could be a reason of display errors for my cases.

[glorieux-f]

I have a working minimal example.

[
	{
		"type": "book",
		"title": "Title",
		"author": [
			{
				"family": "Author"
			}
		],
		"contributor": [
			{
				"family": "Contributor"
			}
		]
	}
]

With style APA.

<names variable="contributor" prefix="(" suffix=")">
    <label form="verb" suffix=" "/>
    <name name-as-sort-order="all" and="symbol" sort-separator=", " initialize-with=". " delimiter=", " delimiter-precedes-last="always"/>
</names>

Observed: Author (withContributor). Title.
Expected: Author (with Contributor). Title. (tne word “with” is followed by a space like in label/@suffix)

For this caye, Punctuation::getAllPunctuations() is not the problem here, the solution is to avoid trim in this line
https://github.com/seboettg/citeproc-php/blob/5a0c19916757aecc5e3ea55ee085fd6aec60f7a3/src/Rendering/Name/Names.php#L262

Who remember the intention behind this logic?