openlibhums / openlibhums/janeway

Add italics support in Keywords

Open
#3,489 2 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Metadata new feature Priority medium Size XL
Dominant language
Python
Stars
238
Forks
97
Avg merge
9d 1h
Merged PRs (30d)
8

Description

Is your feature request related to a problem? Please describe.
An author has requested that one of their keywords be set in italics (it's a Japanese word transliterated into Roman text). I just tried to do this the same way we do italics in article titles, but evidently if you put <i> tags in a keyword, the tags are not rendered, but instead are displayed visually on the HTML galley.

Describe the solution you'd like
It's not likely to come up often, but it would be nice if <i> tags within individual keywords could be used to render italic text on the HTML galley.

Additional context
I have removed the failed italic keyword so that it no longer displays on the article, but please see screenshots below for an illustration.

2023-04-17_16-50-07

2023-04-17_16-50-26

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by tracing how keywords are rendered in the HTML galley and compare that path with the existing italics handling for article titles. Confirm how tags are currently escaped or displayed, then make individual keyword italics render correctly without exposing the tags. The work is done when an italicized keyword displays as italic text in the HTML galley.

Written by the indexing model from the issue text.

Assessment

Tech stack
html, python
Domain
content, frontend
Issue type
Feature
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
38/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.