Skip to content

Commit f8544c8

Browse files
authored
Add ADR-0047 (#13621)
1 parent d33d55c commit f8544c8

File tree

1 file changed

+107
-0
lines changed

1 file changed

+107
-0
lines changed
Lines changed: 107 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,107 @@
1+
---
2+
nav_order: 47
3+
parent: Decision Records
4+
status: accepted
5+
date: 2025-07-31
6+
decision-makers: "@ryan-carpenter, @ThiloteE, @SiedlerChr, @callixtus, @koppor"
7+
---
8+
<!-- markdownlint-disable-next-line MD025 -->
9+
# Use References Headings in Citations Tab
10+
11+
## Context and Problem Statement
12+
13+
The tab "Citation relations" shows the references of the paper as well as the papers citing the current paper.
14+
It is layouted using two columns.
15+
When not working deeply with citation relations, it is unclar, what the left column and the right column present.
16+
Before July 2025, JabRef used "cites" and "cited by" as headings, but these were too short.
17+
18+
There is only one form of citation. Citation is always "backward", so there is nothing wrong with cites and cited by, except that sometimes you need a noun to refer to things that are cited or cited by, and there is only one word for that.
19+
It's "citations".
20+
That's a problem when you want to distinguishe between citations that mean cites and citations that mean cited by. Hence the use of forward and backward.
21+
22+
How to name the headings of these two areas?
23+
24+
## Decision Drivers
25+
26+
* Headings should be understandable by (nearly) all user groups
27+
* Headings should be consistent with terms used in certain fields
28+
29+
## Considered Options
30+
31+
* "References cited in {citationkey}" and "References that cite {citationkey}"
32+
* "backward (cites)" and "forward (cited by)"
33+
* "Backward Citations" and "Forward Citations"
34+
* "References (cites)" and "Citations (cited by)"
35+
* "References" and "Cited by"
36+
* "Cites" and "Cited by"
37+
38+
## Decision Outcome
39+
40+
Chosen option: ""References cited in {citationkey}" and "References that cite {citationkey}""", because comes out best (see below).
41+
42+
## Pros and Cons of the Options
43+
44+
## "References cited in {citationkey}" and "References that cite {citationkey}"
45+
46+
{citationkey} - if not available, use "this entry".
47+
48+
Tooltip left: Also called "backward citations"
49+
50+
Tooltrip right: Also called "forward citations"
51+
52+
Regarding "cited in {citationkey}" or "cited by {citationkey}", either would do, but I am going on the theory that user-x thinks of {citationkey} as the paper, so the most natural cognitive process is that the references are cited by the authors in the paper.
53+
54+
* Good, because no confusion regarding "References" and "Citations".
55+
* Good, because left and right cite are different on purpose to create contrast.
56+
57+
## "backward (cites)" and "forward (cited by)"
58+
59+
Tooltip: outgoing citations - works that are cited by this work. "Backward", because looking back in time.
60+
61+
Tooltip: incoming citations - works that cite this work. "Forward", because looking forward in time.
62+
63+
* Good, because all lower case
64+
* Good, because combines two concepts in the heading
65+
* Bad, because uses braces
66+
67+
## "Backward Citations" and "Forward Citations"
68+
69+
Backward citations
70+
71+
Tooltip: Outgoing citations - works that are cited by this work. "Backward", because looking back in time.
72+
73+
Forward citations
74+
75+
Tooltip: Incoming citations - works that cite this work. "Forward", because looking forward on the time axis, with the time the work was created being the dividing line between backwards and forwards.
76+
77+
Technical words should be defined in the tooltip explicitly. Forward and backwards and sideways and upwards and outgoing and incoming are all technical words.
78+
79+
* Good, because common terms in SLR
80+
* Bad, because "backward" and forward" sound too technical
81+
* Bad, because too abstract for the average user and does not have clear semantics
82+
83+
## "References (cites)" and "Citations (cited by)"
84+
85+
References (cites)
86+
Tooltip: Works cited by the work at hand
87+
88+
Citations (cited by)
89+
Tooltip: Works citing the work at hand
90+
91+
* Good, because used by Semantic Scholar
92+
* Good, because combines two concepts in the heading
93+
* Bad, because the braces in the heading are unusual
94+
95+
## "References" and "Cited by"
96+
97+
Example: <https://dblp.org/rec/conf/zeus/VoigtKW21.html>
98+
99+
* Good, because used by DBLP
100+
* Good, because "Cited by" is easy to understand.
101+
* Good, because "Cited by" is also used by Google Scholar
102+
* Bad, because mix of noun and verb
103+
104+
## "Cites" and "Cited by"
105+
106+
* Good, because verbs
107+
* Bad, because too close to each other

0 commit comments

Comments
 (0)