Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add RFC Standard Fetcher #3971

Closed
Siedlerchr opened this issue Apr 21, 2018 · 6 comments · Fixed by #3988
Closed

Add RFC Standard Fetcher #3971

Siedlerchr opened this issue Apr 21, 2018 · 6 comments · Fixed by #3988
Labels
fetcher good first issue An issue intended for project-newcomers. Varies in difficulty. type: enhancement

Comments

@Siedlerchr
Copy link
Member

While all RFCs have a DOI, the doi import does not correspond to the real bibtex data.

Implementation is totally easy: Just add the rfc number in the url:

  • Search input should accept number only and RFC followed by number

The IETF datatracker tool has a direct export for bibtex:
https://datatracker.ietf.org/doc/rfc1945/
https://datatracker.ietf.org/doc/rfc1945/bibtex/

@Siedlerchr Siedlerchr added type: enhancement fetcher good first issue An issue intended for project-newcomers. Varies in difficulty. labels Apr 21, 2018
@kenneth-miura
Copy link

kenneth-miura commented Apr 23, 2018

I'd like to try my hand at this, but i'm confused on where to start. Are there any specific classes or documentation that I should look at?

@Siedlerchr
Copy link
Member Author

Siedlerchr commented Apr 23, 2018

Hi,
thanks for your interest. For this I recommend you take a look at the DOI Fetcher or other fetchers. They reside in org.jabref.gui.importer and org.jabref.logic.importer.fetcher

For some general information I suggest taking a look at the contribution guidelines, there a also some code howtos and overview of our code structure linked:
https://github.com/JabRef/jabref/blob/master/CONTRIBUTING.md

For any further questions, just ask here or on our gitter chat

@tobiasdiez
Copy link
Member

@Siedlerchr to be honest, the issue description reads a bit cryptic. Do you propose to add an id-based fetcher for those "RFC numbers"?

@Siedlerchr
Copy link
Member Author

Yes, an RFC id based fetcher. I enter the rfc number or Rfc 123 and I get the bibtex entry

@jacksonrya
Copy link
Contributor

@Quunii I am interested in helping as well. This would be my first contribution to open source... I started to parse through the problem, and I've already made a solution... I assume this is bad open source etiquette since I didn't mention my interest in the first place? :/ Maybe we can work together to finish it?

My solution adds a new entry type to the id-based entry generator list, per @Siedlerchr's clarified request. I added a new RFC fetcher class, a test class, and added the RFC fetcher to the list of ID-Based Entry Generators so that it appears in the dropdown. The entry can accept an ID with or without the "rfc" prefix.

Should I just submit the pull request?

@kenneth-miura
Copy link

@jacksonrya go ahead, and don't worry about it.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
fetcher good first issue An issue intended for project-newcomers. Varies in difficulty. type: enhancement
Projects
None yet
Development

Successfully merging a pull request may close this issue.

4 participants