JabRef / JabRef/user-documentation
Update modifiers in bibtex key pattern
Nobody has claimed this yet.
- Dominant language
- CSS
- Stars
- 54
- Forks
- 142
- Avg merge
- 23h 56m
- Merged PRs (30d)
- 12
Description
The list of possible modifiers should be extended to include at least a reference to the list of formatters. Moreover, the regex formatter needs special documentation (I think the syntax is [author:regexmyregex] where myregex is the regular expression).
Triggered by https://github.com/JabRef/jabref/issues/3582.
List of all available modifiers:
https://github.com/JabRef/jabref/blob/7895ae07443612c63fee950ddee88650fecb4d91/src/main/java/org/jabref/logic/formatter/Formatters.java#L35-L64
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
Open the BibTeX key patterns modifiers page and compare its modifier list with Formatters.java lines 35-64 at the referenced revision. Document the available formatters, give the regex modifier syntax and a regular-expression example, and verify that the help page clearly covers the requested information.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- java
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100