Repository navigation
Allow DOI form of note in IEEEtran rules - #22
Merged
Merged
Conversation
Previously, the IEEEtran ruleset only accepted the `note` field in the
form `[ONLINE]. Available: \url{...}, Accessed: YYYY-MM-DD`. For
entries with a DOI this is wrong: The IEEE Reference Guide gives a DOI
as `doi: 10.xxxx/yyy`, without the `[Online]` prefix and without an
access date, since a DOI is persistent. Additionally, a `doi` field
was silently dropped by `IEEEtran.bst` without any warning.
This change extends `check_url_field` to also accept
`doi: \href{https://doi.org/10.xxxx/yyy}{10.xxxx/yyy}` in `note`,
where the shown DOI must be the same as the DOI in the URL. A `doi`
field is now flagged in the same way as `url`. The error message and
`docs/IEEEtran_best_practices.md` now list both forms and use the
date format `YYYY-MM-DD` that the check actually requires, instead
of `YYYY-mmm-dd`.
Tests for `check_url_field` are added. Since importing the IEEEtran
rules registers them globally, the existing `verify` tests now patch
the list of rules to only contain their own example rule.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Previously, the IEEEtran ruleset only accepted the
notefield in the form[ONLINE]. Available: \url{...}, Accessed: YYYY-MM-DD. For entries with a DOI this is wrong: The IEEE Reference Guide gives a DOI asdoi: 10.xxxx/yyy, without the[Online]prefix and without an access date, since a DOI is persistent. Additionally, adoifield was silently dropped byIEEEtran.bstwithout any warning.This change extends
check_url_fieldto also acceptdoi: \href{https://doi.org/10.xxxx/yyy}{10.xxxx/yyy}innote, where the shown DOI must be the same as the DOI in the URL. Adoifield is now flagged in the same way asurl. The error message anddocs/IEEEtran_best_practices.mdnow list both forms and use the date formatYYYY-MM-DDthat the check actually requires, instead ofYYYY-mmm-dd.Tests for
check_url_fieldare added. Since importing the IEEEtran rules registers them globally, the existingverifytests now patch the list of rules to only contain their own example rule.