JabRef / JabRef/user-documentation
Expand the explanation of citation key patterns
Nobody has claimed this yet.
- Dominant language
- CSS
- Stars
- 54
- Forks
- 142
- Avg merge
- 23h 56m
- Merged PRs (30d)
- 12
Description
Currently, the description of patterns is short: https://docs.jabref.org/setup/citationkeypatterns#special-field-markers
For authshort, we had following description in the code:
given author names
- Isaac Newton and James Maxwell and Albert Einstein and N. Bohr
- Isaac Newton and James Maxwell and Albert Einstein
- Isaac Newton and James Maxwell
- Isaac Newton
yield
- NME+
- NME
- NM
- Newton
We should have a table putting all possibilities together? Or maybe have a table per key.
| author list | authorsalpha | authshort | ... |
|---|---|---|---|
| Isaac Newton | New | Newton | ... |
authIniN format
Each author gets (N div #authors) chars, the remaining (N mod #authors) chars are equally distributed to the authors first in the row. If (N < #authors), only the first N authors get mentioned.
For example if
- I. Newton and J. Maxwell and A. Einstein and N. Bohr (..)
- I. Newton and J. Maxwell and A. Einstein
- I. Newton and J. Maxwell
- I. Newton
- NMEB
- NeME
- NeMa
- Newt
auth.etal, authEtAl, ... format
- Isaac Newton and James Maxwell and Albert Einstein (1960)
- Isaac Newton and James Maxwell (1960)
auth.etal give (delim=".", append=".etal"):
- Newton.etal
- Newton.Maxwell
authEtAl give (delim="", append="EtAl"):
- NewtonEtAl
- NewtonMaxwell
auth.auth.ea format
- Isaac Newton and James Maxwell and Albert Einstein (1960)
- Isaac Newton and James Maxwell (1960)
- Newton.Maxwell.ea
- Newton.Maxwell
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start at the linked citation key patterns documentation section and compare its current explanation with the supplied authshort, authIniN, auth.etal, authEtAl, and auth.auth.ea examples. Expand the page with clear examples or tables covering the requested possibilities; done means newcomers can understand each pattern's output.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 68/100