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

Display volume, issue, pages #53

Open
bnewbold opened this issue Feb 11, 2021 · 3 comments
Open

Display volume, issue, pages #53

bnewbold opened this issue Feb 11, 2021 · 3 comments
Labels
enhancement New feature or request good first issue Good for newcomers

Comments

@bnewbold
Copy link
Member

In the "journal" row, after the journal name. Not sure what the style should be, eg:

Vol. 1, Iss. 2, p3-4

Or full words?

Volume 1, Issue 2, p3-4

Or citation style?

1(2) p3-4

@bnewbold bnewbold added enhancement New feature or request good first issue Good for newcomers labels Feb 11, 2021
@dwaipayan05
Copy link

dwaipayan05 commented Feb 13, 2021

Hi @bnewbold In my opinion since it's about Research Papers/Journals majorly, people visiting would be acquainted with the style. Hence, the firsts one 'Vol. 1, Iss. 2, p3-4' seems legit.

@AniketShahane
Copy link
Contributor

@bnewbold I'd like to help with this issue. I'm new to the open source contribution process. I'm fairly skilled with python and have worked with fastAPI quite a bit. I'd like to start contributing to this project. Can you guide me? What should be my first steps? Thanks and Regards.

@bnewbold
Copy link
Member Author

I would start by writing tests, or modifying existing tests. I don't actually know if there is a good way to do tests of jinja2 template "macro" functions, but you could probably figure something out by calling the jinja2 template macros directly.

The place this code path would live is in the "journal row" macro: https://github.com/internetarchive/fatcat-scholar/blob/master/fatcat_scholar/templates/search_macros.html#L141

Implementation needs to handle:

  • metadata records which have any combination of volume, issue, pages. Eg, only issue defined; volume and pages but not issue; all three; none; etc.
  • at least for issue and volume, the value might be integer (in string format) or non-integer. there are both volume (str) and volume_int (int) fields in the schema, which can help detect these conditions: https://github.com/internetarchive/fatcat-scholar/blob/master/schema/scholar_fulltext.v01.json#L93
  • internationalization (translation). note that some languages will style numbers in different ways.

While the basic feature is pretty simple, I think that figuring out how to do testing, and then handling translations, could make it a bit tricky.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request good first issue Good for newcomers
Projects
None yet
Development

No branches or pull requests

3 participants