Skip to content

docs: Missing whitespace around inline elements on registry pages #53

Description

@maehr

Affected page or file

https://textrefs.org/reg/

What's missing, wrong, or unclear?

And also:

What's missing, wrong, or unclear?

Some inline HTML elements are rendered without whitespace text nodes between them and the surrounding text. This causes words, links, and code values to be concatenated when the page text is copied, indexed, read by assistive technology, or processed by text-extraction tools.

Examples from "/reg/" include:

  • "cited),citation systems" instead of "cited), citation systems"
  • "SeeURL layout" instead of "See URL layout"
  • "for how/id/" instead of "for how /id/"
  • "and/api/ fit" instead of "and /api/ fit"
  • "or thespecification" instead of "or the specification"

The work record header has a similar issue between the record IRI and the JSON link:

Although CSS margins may create visual separation between certain elements, margins do not provide semantic whitespace in the document text.

Suggested wording or fix

Add explicit Astro whitespace expressions ("{' '}") between adjacent inline elements and surrounding text instead of relying on source-code line breaks or CSS margins.

For example:

The TextRefs registry holds works (texts that get cited),{' '}
citation systems ...

See{' '}
URL layout for how{' '}
/id/, /reg/, /cite/, and{' '}
/api/ fit together, or the{' '}
specification for the data model.

For record headers:

{work.id}{' '}
JSON

It may also be worth auditing the other generated registry record templates—citation systems, references, and mappings—for adjacent inline elements without explicit whitespace.

Metadata

Metadata

Assignees

No one assigned

    Labels

    addressed-in-v0.1.0Addressed in the v0.1.0 release (PR #4)documentationImprovements or additions to documentation

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions