JabRef / JabRef/user-documentation
Improve documentation for "Using Regular Expression Search for Auto-Linking"
Nobody has claimed this yet.
- Dominant language
- CSS
- Stars
- 54
- Forks
- 142
- Avg merge
- 23h 56m
- Merged PRs (30d)
- 12
Description
On https://docs.jabref.org/finding-sorting-and-cleaning-entries/filelinks#using-regular-expression-search-for-auto-linking, the explanation for the regular expressions is misleading. The explanation for * and ** is only valid for the beginning of the line.
Probably, it is also good to reference some general regex site explaining the usage in more detail.
Took me some time to figure out my mistakes and how to properly use this (I have not used regex and wasn't sure whether normal regex is used here or some modified version).
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 with the “Using Regular Expression Search for Auto-Linking” section at the linked filelinks page and review how it explains * and ** beyond the beginning of a line. Correct the misleading explanation and add a reference to a general regular-expression resource if appropriate; done means the documented behavior and regex terminology are clear to beginners.
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
- 45/100