openlibhums / openlibhums/janeway

<boxed-text> rendering as plain text, <caption> rendering as <h3>, and <xref> not working

Open
#2,987 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

bug XSLT
Dominant language
Python
Stars
239
Forks
97
Avg merge
9d 1h
Merged PRs (30d)
8

Description

Describe the bug
Vendor has used <boxed-text> tag (which seems valid) to wrap an item that, in the manuscript, appeared in a box and was treated similar to a figure (i.e., centered, with smaller caption text underneath it reading "Box 1: ...."). However, in Janeway, a number of things happened that seem less than ideal:

  • No box appears around the <boxed-text> content, nor is it otherwise distinctly formatted/indented/aligned. Instead, everything is aligned to the left margin, like the rest of the article body text. This makes it impossible to distinguish where Box 1 ends and regular text resumes (unless you inspect the elements to see the <div> tags)
  • The <label> for Box 1 is displaying the same as table and figure labels. But unlike tables and figures, the <caption> text for Box 1 is improperly rendering as <h3>, making it appear to be a subsection and linked on the TOC (with a duplicate name as the section it's nested within)
  • A link in the previous paragraph (<xref rid="BX1" ref-type="boxed-text">Box 1</xref>) is not directing to Box 1 as expected; it should work the same as any <xref> pointing to a figure or table.

Janeway version
1.4.2

To Reproduce
Steps to reproduce the behavior:

  1. Go to https://journals.publishing.umich.edu/ptpbio/plugins/typesetting/preview_galley/article/2096/galley/959/#heading13
  2. Scroll down to 'Box 1:'
  3. Note the issues described above.

Expected behavior
Everything wrapped in <boxed-text> should appear within a visible box (either a solid border or a shaded background) so that the contents of that element are easily identified. <label> and <caption> should render the same as they do for either tables or figures, depending on whether you choose to display a border or a shaded background. This element should be linkable just like a table or figure.

Screenshots
2022-07-06_16-30-25

Additional context
I'm not certain if this is a bug (i.e., <boxed-text> is expected to work in Janeway, but it isn't) or a feature request (i.e., there hasn't been any work to render <boxed-text> in a particular way in Janeway) but regardless, there appear to be some issues with the current rendering of this tag. In the meantime, as a workaround, perhaps we can just tag it as a single-celled table.

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 with the typesetting preview URL and inspect how the JATS elements , , , and are rendered. Verify the current output against the reported box, caption heading, table-of-contents, and link behaviors; done means boxed text is visually distinct, its caption matches figure or table styling, and references link to it.

Written by the indexing model from the issue text.

Assessment

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

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.