Skip to content

Commit 29dd504

Browse files
kopporsubhramit
andauthored
Add initial glossary (#14248)
Co-authored-by: Subhramit Basu <[email protected]>
1 parent aec5155 commit 29dd504

File tree

9 files changed

+311
-0
lines changed

9 files changed

+311
-0
lines changed

docs/architecture-and-components.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
11
---
2+
nav-order: 8
23
---
34
# Architecture and Components
45

docs/glossary/TEMPLATE.md

Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
1+
---
2+
parent: Glossary
3+
nav_order: 100 # remove this for the concrete term
4+
---
5+
6+
# {{Term}}
7+
8+
**Synonyms:** {{List of synonyms}}
9+
10+
## Meaning
11+
12+
{{Explain the meaning of the term, in ideally one or two sentences. Include what it represents, its purpose, or how it is used in context.}}
13+
14+
## Delimitation (Scope and Exclusions)
15+
16+
{{Clarify where this term applies and where it does not. Describe boundaries or cases that are explicitly excluded.}}
17+
18+
## Validity
19+
20+
{{Describe temporal, spatial, or contextual validity — for example, when or where the term is applicable.}}
21+
22+
## Naming and Uniqueness
23+
24+
{{Explain how the term is identified unambiguously — e.g., by an ID, key, or other defining attributes.}}
25+
26+
## Open Issues / Uncertainties
27+
28+
{{List unresolved questions, unclear definitions, or aspects pending clarification.}}
29+
30+
## Related Terms (Cross-References)
31+
32+
{{List (and possibly link) related or similar terms, e.g., “User”, “Identifier”, “Session Token”.}}

docs/glossary/bibliography.md

Lines changed: 52 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,52 @@
1+
---
2+
parent: Glossary
3+
---
4+
5+
# Bibliography
6+
7+
**Synonyms:** Literature list
8+
9+
## Meaning
10+
11+
A **bibliography** is a structured list or catalog of written works, such as books, articles, reports, or other publications, usually organized for scholarly or informational purposes.
12+
It can describe *all* literature relevant to a topic, not only those directly cited in a specific work.
13+
14+
In JabRef and literature management, a bibliography represents a **conceptual collection of bibliographic records** — the intellectual set of works compiled for study, documentation, or publication.
15+
16+
## Delimitation (Scope and Exclusions)
17+
18+
* **Not the same as references:**
19+
*[References](references.md)* are the specific sources cited within a publication; a *bibliography* may also include works *consulted but not cited*.
20+
* **Not the same as a [library](library.md):**
21+
A *library* is the concrete storage file (e.g., a `.bib` file) containing bibliographic data.
22+
A *bibliography* is the logical or thematic organization of that data.
23+
* **Not a [citation](citation.md):**
24+
A *citation* is an inline or textual reference to one bibliographic entry.
25+
26+
## Validity
27+
28+
A bibliography can exist:
29+
30+
* as part of a publication (e.g., “Bibliography” or “Works consulted” section),
31+
* as a standalone compilation (e.g., “Annotated bibliography”),
32+
* or as a conceptual subset within a reference manager such as JabRef.
33+
34+
## Naming and Uniqueness
35+
36+
Bibliographies may be organized by:
37+
38+
* topic,
39+
* author,
40+
* period,
41+
* or purpose (e.g., *project bibliography*, *course reading list*).
42+
43+
Uniqueness is defined by content and context, not by file identity.
44+
45+
## Open Issues / Uncertainties
46+
47+
* The distinction between “bibliography” and “references” is blurred in many publication styles.
48+
* Some citation styles (e.g., APA, IEEE) use the term “References” exclusively, even when a broader list would qualify as a bibliography.
49+
50+
## Related Terms (Cross-References)
51+
52+
[References](references.md), [Library](library.md), [Citation](citation.md)

docs/glossary/catalogue.md

Lines changed: 55 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,55 @@
1+
---
2+
parent: Glossary
3+
---
4+
5+
# Catalogue
6+
7+
**Synonyms:** Online library, Literature database, Reference source, Data provider
8+
9+
## Meaning
10+
11+
A **catalogue** is an online bibliographic data source that allows searching, retrieving, and importing metadata for scholarly works such as journal articles, conference papers, and books.
12+
In JabRef, a catalogue refers to an **external service or repository** — for example, ACM Digital Library, IEEE Xplore, Google Scholar, CrossRef, or arXiv — from which bibliographic entries can be fetched.
13+
14+
Catalogues provide structured metadata (author, title, DOI, year, etc.) that JabRef imports to enrich or create local entries in a user’s library.
15+
16+
## Delimitation (Scope and Exclusions)
17+
18+
* **Not the same as a library:**
19+
A *[library](library.md)* is the local `.bib` file managed in JabRef; a *catalogue* is an external source from which data is imported.
20+
* **Not the same as a bibliography:**
21+
A *[bibliography](bibliography.md)* is a conceptual collection of works; a *catalogue* is a retrieval system that provides access to such works.
22+
* **Not the same as references:**
23+
*[References](references.md)* are selected works cited in a publication, possibly originating from multiple catalogues.
24+
* **Not a search engine in general:**
25+
Although some catalogues expose web search interfaces, their primary function is structured metadata access.
26+
27+
## Validity
28+
29+
A catalogue is valid as long as its public interface (API or HTML interface) is operational and accessible.
30+
31+
Different catalogues may use:
32+
33+
* standard interfaces (e.g., **DOI**, **OAI-PMH**, **OpenSearch**),
34+
* custom APIs (e.g., **CrossRef REST API**),
35+
* or web-scraping-based access (e.g., Google Scholar).
36+
37+
## Naming and Uniqueness
38+
39+
Each catalogue is identified by:
40+
41+
* its **provider name** (e.g., “ACM Digital Library”), and
42+
* its **base URL** or **API endpoint**.
43+
44+
In JabRef’s internal configuration, catalogues correspond to **[fetchers](../code-howtos/fetchers.md)**, each implementing a standardized interface for metadata retrieval.
45+
46+
## Open Issues / Uncertainties
47+
48+
* Availability and licensing of catalogue APIs may change without notice.
49+
* Metadata quality and completeness vary by provider.
50+
* Rate limits or CAPTCHA systems can restrict automated access.
51+
* The term “catalogue” is JabRef-specific; other reference managers use “online database” or “data source.”
52+
53+
## Related Terms (Cross-References)
54+
55+
[Library](library.md), [Bibliography](bibliography.md), [Citation](citation.md)

docs/glossary/citation-key.md

Lines changed: 46 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,46 @@
1+
---
2+
parent: Glossary
3+
---
4+
5+
# Citation key
6+
7+
**Synonyms:** BibTeX key
8+
9+
## Meaning
10+
11+
A **citation key** is a short, unique identifier assigned to a bibliographic
12+
entry. It is used in documents (e.g. LaTeX) and tools (e.g. JabRef) to refer
13+
to that entry in citations, cross-references, and commands.
14+
15+
Example: `LunaOstos2024`
16+
17+
## Delimitation (Scope and Exclusions)
18+
19+
- It is **not** the same as:
20+
- a database primary key,
21+
- a persistent identifier (DOI, ISBN, URI),
22+
- a filename.
23+
- It is not globally unique across all users or projects, only within the scope where the bibliography is used.
24+
25+
## Validity
26+
27+
- Must be unique **within a given bibliography file or project**.
28+
- May change if the user renames it or regeneration rules change.
29+
- Not guaranteed to be stable across different tools or imported/exported files
30+
unless explicitly preserved.
31+
32+
## Naming and Uniqueness
33+
34+
- Allowed characters and format depend on the target system (e.g. BibTeX vs. BibLaTeX) but are typically ASCII without spaces.
35+
- JabRef and similar tools can **generate** citation keys based on patterns (author, year, title, etc.).
36+
- Uniqueness is usually enforced by the reference manager; collisions must be resolved.
37+
38+
## Open Issues / Uncertainties
39+
40+
- No universal standard across all tools and workflows.
41+
- Migration between tools or key-pattern changes can break existing documents if keys are not updated consistently.
42+
43+
## Related Terms (Cross-References)
44+
45+
- [Bibliography](bibliography.md)
46+
- [Citation](citation.md)

docs/glossary/citation.md

Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
1+
---
2+
parent: Glossary
3+
---
4+
5+
# Citation
6+
7+
## Meaning
8+
9+
A citation is a reference to a source. More precisely, a citation is an abbreviated alphanumeric expression embedded in the body of an intellectual work that denotes an entry in the bibliographic references section of the work for the purpose of acknowledging the relevance of the works of others to the topic of discussion at the spot where the citation appears.
10+
[Source: [WikiPedia](https://en.wikipedia.org/wiki/Citation)]
11+
12+
Example:
13+
14+
> In their study, Ostos et al. (2024) employed interviews with both plant workers and farmers to gather data, with the aim of corroborating existing reports and gaining new insights, respectively.
15+
16+
## Delimitation (Scope and Exclusions)
17+
18+
{{Clarify where this term applies and where it does not. Describe boundaries or cases that are explicitly excluded.}}
19+
20+
## Validity
21+
22+
{{Describe temporal, spatial, or contextual validity — for example, when or where the term is applicable.}}
23+
24+
## Naming and Uniqueness
25+
26+
{{Explain how the term is identified unambiguously — e.g., by an ID, key, or other defining attributes.}}
27+
28+
## Open Issues / Uncertainties
29+
30+
{{List unresolved questions, unclear definitions, or aspects pending clarification.}}
31+
32+
## Related Terms (Cross-References)
33+
34+
{{List (and possibly link) related or similar terms, e.g., “User”, “Identifier”, “Session Token”.}}

docs/glossary/index.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
---
2+
nav_order: 100
3+
has_children: true
4+
---
5+
# Glossary
6+
7+
This section collects important terms in the domain of JabRef.

docs/glossary/library.md

Lines changed: 48 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,48 @@
1+
# Library
2+
3+
**Synonyms:** BibTeX file, `.bib` file, Database file, Bibliographic library
4+
5+
## Meaning
6+
7+
A **library** is a data file that stores a collection of bibliographic entries in a structured format (**BibTeX** or **BibLaTeX**).
8+
In JabRef, a library is the **working data source** containing all references managed by the user — it is the digital equivalent of a physical card catalog.
9+
10+
Each library file typically has the extension `.bib` and can contain hundreds or thousands of bibliographic entries, along with metadata such as groups, keywords, and linked files.
11+
12+
## Delimitation (Scope and Exclusions)
13+
14+
* **Not the same as a bibliography:**
15+
A *[bibliography](bibliography.md)* is the conceptual list of relevant works; a *library* is the file storing the corresponding data.
16+
* **Not the same as references**:
17+
[References](references.md) are the specific works cited in a publication, often a subset of a larger library.
18+
* **Not the same as a database:**
19+
While technically similar, JabRef libraries are *file-based*; databases (e.g., SQL, Zotero, or shared repositories) provide multi-user or networked storage.
20+
* **Not the same as a citation:**
21+
A *[citation](citation.md)* refers to an entry in the library but is not part of the data container itself.
22+
23+
## Validity
24+
25+
A library is valid as long as it can be parsed by JabRef or other BibTeX-compatible tools.
26+
27+
It may represent:
28+
29+
* a user’s complete reference collection,
30+
* a project-specific subset,
31+
* or a shared file under version control.
32+
33+
## Naming and Uniqueness
34+
35+
* Identified by its **file path** and **name** (e.g., `references.bib`).
36+
* Each entry inside a library must have a **unique [citation key](citation-key]**.
37+
* Libraries may be linked or merged to form larger collections.
38+
39+
## Open Issues / Uncertainties
40+
41+
* Historically, this was called `database` in JabRef and there is still work to do to rename it.
42+
* Encoding inconsistencies (e.g., UTF-8 vs. legacy encodings) can affect portability.
43+
* Some tools extend the BibTeX syntax (e.g., BibLaTeX fields), leading to partial incompatibility.
44+
* Synchronization between multiple libraries can cause key collisions.
45+
46+
## Related Terms (Cross-References)
47+
48+
[Bibliography](bibliography.md), [Citation](citation.md), [Citation key](citation-key.md)

docs/glossary/references.md

Lines changed: 36 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,36 @@
1+
# References
2+
3+
**Synonyms:** Bibliographic References, Reference List, Literature, Literature List, Works Cited
4+
5+
## Meaning
6+
7+
**References** is a structured list of works cited in a scientific work.
8+
collection of bibliographic records describing scholarly works such as articles, books, or reports.
9+
10+
In JabRef, a bibliography usually corresponds to a **.bib file** (BibTeX or BibLaTeX format) that stores all entries used for citation and reference management.
11+
12+
## Delimitation (Scope and Exclusions)
13+
14+
A bibliography is not the same as:
15+
16+
- a **[citation](citation.md)**, which is an in-text reference to a work;
17+
- a **[library](library.md)**, which stores physical or digital documents;
18+
- a **database connection**, which may serve as a data source for bibliographic information but is not itself a bibliography.
19+
20+
## Validity
21+
22+
Applicable to all contexts in which bibliographic metadata is collected, organized, and exported — independent of citation style (BibTeX, BibLaTeX, CSL, etc.) or output format (PDF, HTML, DOCX).
23+
Valid both for local files and online collections managed through JabRef integrations.
24+
25+
## Naming and Uniqueness
26+
27+
Each bibliography is typically represented by a **file path** or **project identifier**.
28+
Within a bibliography, every **[citation key](citation-key.md)** (BibTeX key) must be unique to ensure unambiguous citation references.
29+
30+
## Open Issues / Uncertainties
31+
32+
The distinction between *references*, *bibliography* and *database* may vary across user communities.
33+
34+
## Related Terms (Cross-References)
35+
36+
[Bibliography](bibliography.md), [Citation](citation.md), [Citation key](citation-key.md)

0 commit comments

Comments
 (0)