speced / speced/bikeshed

Wrap inlined/long bibliography entries

Open
#2,011 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

bug
Dominant language
HTML
Stars
1.3k
Forks
220
Avg merge
6d 37m
Merged PRs (30d)
1

Description

Bikeshed prevents bibliography references from wrapping.

[data-link-type=biblio] {
    white-space: pre;
}

For [[FOOBAR]], that's reasonable, but for [[FOOBAR inline]] or [[FOOBAR|some decently long replacement]] that's a lot less desirable.

Should that be fixed by adding a class=has-replacement-text (or similar) to such elements, and changing the selector to [data-link-type=biblio]:not(.has-replacement-text), or should we not mark such things as data-link-type=biblio, or something else?

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 bibliography markup and the [data-link-type=biblio] CSS rule shown in the issue, then inspect how plain, inline, and replacement-text references are generated. The fix is done when ordinary bibliography references retain their current no-wrap behavior while inline and replacement-text entries can wrap appropriately.

Written by the indexing model from the issue text.

Assessment

Tech stack
css, html
Domain
documentation, frontend
Issue type
Bug
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.