Skip to content
This repository has been archived by the owner on Apr 26, 2022. It is now read-only.

proper use of rel #52

Open
RachelComerford opened this issue May 9, 2018 · 5 comments
Open

proper use of rel #52

RachelComerford opened this issue May 9, 2018 · 5 comments
Assignees
Labels
Best Practice use for Best Practice documentation questions and suggestions

Comments

@RachelComerford
Copy link
Contributor

From BISG survey

@RachelComerford RachelComerford added the Best Practice use for Best Practice documentation questions and suggestions label May 9, 2018
@dauwhe
Copy link
Contributor

dauwhe commented May 11, 2018

I'd love to hear some more context on this. We're all used to rel=stylesheet. Do reading systems do much with other rel values? Are people hoping for some change in behavior of reading systems based on the rel value of a link?

@JayPanoz
Copy link

I’m assuming we’re discussing <link> and <a> elements?

@mattgarrish
Copy link
Member

This is definitely vague. Could also be the oddball stuff we have/had for package document links.

@RachelComerford
Copy link
Contributor Author

@BillKasdorf this was a request from your response - perhaps you could provide more information?

@RachelComerford
Copy link
Contributor Author

Bill - can you provide clarification and take ownership of the initial documentation for this one?

As you explore this topic - please keep this guiding structure in mind:

  • identify quirks or exceptions in specific reading systems (edited)
  • Identify gaps in documentation that need to be developed
  • Identify variations based of business verticals - how might you implement this standard differently as journal publisher vs a textbook publisher? A magazine vs scholarly? etc.
  • Use plain language. Use diagrams where they will help (and provide alt text). Tag your colleagues for assistance.
  • If you reference prior art, older development projects, or other materials, provide clarifying information including a basic definition and the importance to the best practice

When you are proposing language/contributions to best practice, please consider and respond to the following questions:

  • What is the problem you are trying to solve?
  • What is your preferred solution and why do you believe this is the best option?
  • What alternatives did you consider?
  • What’s the best fallback/back up plan?

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
Best Practice use for Best Practice documentation questions and suggestions
Projects
None yet
Development

No branches or pull requests

5 participants