openlibhums / openlibhums/janeway
Italicize journal titles in back office interfaces
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 238
- Forks
- 97
- Avg merge
- 9d 1h
- Merged PRs (30d)
- 8
Description
Problem statement
This is one of those small things that end up being distracting for users because it is unexpected. Not a make-or-break issue, but one that, if we fix, would ease someone's overall experience of Janeway.
Journal titles are usually italicized when referred to in running text. This is a widely adopted and widely documented editorial convention:
- “The title of a free-standing publication is set in italic type.... This category [includes] periodicals.” New Oxford Style Manual, 2nd ed. (Oxford University Press 2012), 8.22.
- “When mentioned in text, notes, or bibliography, the titles and subtitles of books and periodicals are italicized and capitalized headline-style.” Chicago Manual of Style, 17th ed., 8.168.
- “Use of Italics,” APA Style, https://apastyle.apa.org/style-grammar-guidelines/italics-quotations/italics.
Proposed solution
When importing the name of a journal into back-office copy in Janeway, we can mark up titles with the <i> element. I propose using <i> rather than <em> because we are not trying to convey emphasis semantically, but adhere to a presentational convention. For more see <i> vs <em> at MDN Web Docs.
Here is an example from the author-facing submission steps:
Alternatives
We could use CSS to create the italics for journal titles instead of the <i> element. This would make it easier to maintain and modify in the future, but would require consistently wrapping journal titles in a span with a class.
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 src/templates/admin/submission/submit_info.html at the linked journal-title example, then search the back-office templates for other places where journal names are imported into copy. Confirm the affected interfaces and apply the proposed markup consistently; done means journal titles render in italics throughout the identified back-office views.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- html
- Domain
- frontend
- Issue type
- Feature
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 42/100