aboutsummaryrefslogtreecommitdiff
path: root/MANUAL.txt
diff options
context:
space:
mode:
authorJohn MacFarlane <[email protected]>2025-06-22 16:33:42 -0700
committerJohn MacFarlane <[email protected]>2025-07-31 22:08:51 -0700
commitcfcd442b2fcdac4d5f49b0850f73de0153fa287f (patch)
tree1ccc5d77748394845d95086f5283c9aea71f44bb /MANUAL.txt
parentc77476b597ef89e9ab7baf3452f84cd4f5ff1a5a (diff)
Extract citationSuffix, citationPrefix.cite-prefix
In transforming pandoc Cite to citeproc Citation, extract a `citationSuffix` and `citationPrefix` from the last item's suffix and first item's prefix, respectively, if they contain a `|` character which separates the item's suffix or prefix from the whole Citation's. for example: [for example, see |@C1; @A3; @B4|, and others] Here "for example, see" acts as a prefix for the whole group and will remain at the beginning even if the citation items are reordered by citeproc. Similarly, ", and others" will be a suffix for the whole group. Closes #10894. Notes: 1. The org reader now adds global prefixes and suffixes the same way as the Markdown reader: as affixes to the first item's prefix or the last item's suffix, separated by a pipe (`|`). 2. The org writer, however, has not been modified to convert the `|` to a `;`, as required by org-cite syntax. 3. This change doesn't currently do what one would expect, because of changes that were made to citeproc to prevent citation items with prefixes and suffixes from being sorted. Hence in `test/command/10894.md`, we have test output ``` (Doe, 2020; Smith, 2021) ``` without affixes, but ``` (see Smith, 2021; Doe, 2020, and others) ``` with affixes. To make this work well, we'd need to remove the citeproc code that prevented bad results before we had proper global prefixes and suffixes. However, removing this code would mean that existing documents would render differently, unless the new pipe syntax for citation affixes were used. That may be something we want to avoid. 4. The use of pipes to separate out global affixes from item-level affixes is a kludge that could be avoided if we added additional fields to Cite in the pandoc AST. However, AST changes are disruptive, so perhaps it's not worth doing that.
Diffstat (limited to 'MANUAL.txt')
-rw-r--r--MANUAL.txt13
1 files changed, 13 insertions, 0 deletions
diff --git a/MANUAL.txt b/MANUAL.txt
index 1f9f04362..24b3429bc 100644
--- a/MANUAL.txt
+++ b/MANUAL.txt
@@ -5865,6 +5865,19 @@ the suffix as locator by prepending curly braces:
[@smith, {pp. iv, vi-xi, (xv)-(xvii)} with suffix here]
[@smith{}, 99 years later]
+A prefix or suffix can be marked as going with the whole citation
+rather than an individual item. A horizontal bar (`|`) is used
+to separate the global citation prefix or suffix from the individual
+items:
+
+ [for example, see |@C1; @A3; @B4, in part|, and others]
+
+The global prefix/suffix will always be at the beginning/end
+of the rendered citation, even if the style causes the
+items to be sorted in a different order. By contrast, the
+prefixes and suffixes on each item will move with the items when
+they are sorted.
+
A minus sign (`-`) before the `@` will suppress mention of
the author in the citation. This can be useful when the
author is already mentioned in the text: