openlibhums / openlibhums/janeway

Descriptive links within Citation Styles

Open
#4,084 2 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

a11y
Dominant language
Python
Stars
238
Forks
97
Avg merge
9d 1h
Merged PRs (30d)
8

Description

The Problem

  • Descriptive links are required for accessibility (see BirkbeckCTP/hourglass#338)
  • Citation styles, initially developed for print, often include the full URL rather than a descriptive link.

There is a discussion of this matter on APA style. The recommended approach is that

Users who develop online-only resources should adapt APA Style to fit their needs. This adaption includes, but is not limited to, the use of descriptive links throughout texts and reference lists.

They also suggest:

people creating online works in APA Style can put the DOI or URL beneath descriptive text. Some reference databases put DOIs or URLs beneath buttons labeled “Article.” Another approach is to link the title of the work to the work’s URL or DOI.

image

Tasks

  • Discuss how we wish to approach this within Janeway.
  • Implement our solution

Points for discussion

  • one solution or should there be some editorial choice? Different solutions on different themes?
  • which approach(es)
  • Can this be done on top of existing XML?

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 reviewing the open questions in this issue and how citation styles are produced from the existing XML. Agree whether the approach is global or editorially configurable and which descriptive-link pattern to support; done means the chosen approach is implemented consistently for citation-style output.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
accessibility, content
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.